catalog.h

Go to the documentation of this file.

/*******************************************************************************
 * wallaroo - A library for configurable creation and wiring of C++ classes.
 * Copyright (C) 2012 Daniele Pallastrelli
 *
 * This file is part of wallaroo.
 * For more information, see http://wallaroolib.sourceforge.net/
 *
 * Boost Software License - Version 1.0 - August 17th, 2003
 *
 * Permission is hereby granted, free of charge, to any person or organization
 * obtaining a copy of the software and accompanying documentation covered by
 * this license (the "Software") to use, reproduce, display, distribute,
 * execute, and transmit the Software, and to prepare derivative works of the
 * Software, and to permit third-parties to whom the Software is furnished to
 * do so, all subject to the following:
 *
 * The copyright notices in the Software and this entire statement, including
 * the above license grant, this restriction and the following disclaimer,
 * must be included in all copies of the Software, in whole or in part, and
 * all derivative works of the Software, unless such copies or derivative
 * works are solely in the form of machine-executable object code generated by
 * a source language processor.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
 * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
 * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 ******************************************************************************/

#ifndef WALLAROO_CATALOG_H_
#define WALLAROO_CATALOG_H_

#include <string>
#include <typeinfo>
#include <cassert>
#include "detail/partshell.h"
#include "cxx0x.h"
#include "part.h"
#include "class.h"

namespace wallaroo
{

// forward declarations:
class Context;
class UseAsExpression;
class UseExpression;

class Catalog
{
public:

    Catalog() {}

    detail::PartShell operator [] ( const std::string& id ) const
    {
        Parts::const_iterator i = parts.find( id );
        if ( i == parts.end() ) throw ElementNotFound( id );
        return detail::PartShell( i -> second );
    }

    void Add( const std::string& id, const cxx0x::shared_ptr< Part >& dev )
    {
        std::pair< Parts::iterator, bool > result = 
            parts.insert( std::make_pair( id, dev ) );
        if ( ! result.second ) throw DuplicatedElement( id );
    }

    void Remove( const std::string& id )
    {
        if ( parts.erase( id ) != 1 ) throw ElementNotFound( id );
    }

    void Clear() { parts.clear(); }

    std::size_t Size() const { return parts.size();  }

    template < class P1, class P2 >
    detail::PartShell Create( const std::string& id, const std::string& className, const P1& p1, const P2& p2 )
    {
        typedef Class< P1, P2 > C;
        C c = C::ForName( className );
        cxx0x::shared_ptr< Part > obj = c.NewInstance( p1, p2 );
        if ( obj.get() == NULL ) throw ElementNotFound( className );
        Add( id, obj );
        return detail::PartShell( obj );
    }

    template < class P >
    detail::PartShell Create( const std::string& id, const std::string& className, const P& p )
    {
        typedef Class< P, void > C;
        C c = C::ForName( className );
        cxx0x::shared_ptr< Part > obj = c.NewInstance( p );
        if ( obj.get() == NULL ) throw ElementNotFound( className );
        Add( id, obj );
        return detail::PartShell( obj );
    }

    detail::PartShell Create( const std::string& id, const std::string& className )
    {
        typedef Class< void, void > C;
        C c = C::ForName( className );
        cxx0x::shared_ptr< Part > obj = c.NewInstance();
        if ( obj.get() == NULL ) throw ElementNotFound( className );
        Add( id, obj );
        return detail::PartShell( obj );
    }

    bool IsWiringOk() const
    {
        return FindWrongMultiplicity().empty();
    }

    void CheckWiring() const
    {
        const std::string wrongPart = FindWrongMultiplicity();
        if ( !wrongPart.empty() ) throw WiringError( wrongPart );
    }

    void Init()
    {
        for ( Parts::const_iterator i = parts.begin(); i != parts.end(); ++i )
            i -> second -> Init();
    }

private:

    // copy ctor and assignment operator disabled
    Catalog( const Catalog& );
    Catalog& operator = ( const Catalog& );

    // returns the name of the first parts with wrong multiplicity
    // or the empty string if the test has success
    std::string FindWrongMultiplicity() const
    {
        for( Parts::const_iterator i = parts.begin(); i != parts.end(); ++i )
        {
            if ( ! i -> second -> MultiplicitiesOk() )
                return( i -> first );
        }
        return std::string();
    }

    typedef cxx0x::unordered_map< std::string, cxx0x::shared_ptr< Part > > Parts;
    Parts parts;

    friend class Context;
    friend class UseAsExpression;
    friend class SetExpression;
    friend UseExpression use( const std::string& destClass );
    friend bool IsWiringOk();
    friend void CheckWiring();


    static Catalog*& Current()
    {
        static Catalog* current = NULL;
        return current;
    }
};


// This is a helper class that provides the result of the use().as() function
// useful to concatenate use().as() with of().
class UseAsExpression
{
public:
    UseAsExpression( detail::PartShell& _destClass, const std::string& _attribute ) :
      destClass( _destClass ),
      attribute( _attribute )
    {
    }
    // throw ElementNotFound If @c attribute does not exist in @c srcClass.
    // throw WrongType If @c destClass has not a type compatible with the dependency.
    void of( const detail::PartShell& srcClass )
    {
        // perform the final assignment:
        srcClass.Wire( attribute, destClass );
    }
    // throw CatalogNotSpecified if the current catalog has not been selected with wallaroo_within
    // throw ElementNotFound If @c attribute does not exist in this part or 
    //       if @c srcClass key is not found in the current catalog.
    // throw WrongType If @c destClass has not a type compatible with the dependency.
    void of( const std::string& srcClass )
    {
        // default container case
        Catalog* current = Catalog::Current();
        if ( ! current ) throw CatalogNotSpecified();
        of( ( *current )[ srcClass ] );
    }
private:
    const detail::PartShell destClass;
    const std::string attribute;
};

// This is a helper class that provides the result of the use() function
// useful to concatenate use() with as().
class UseExpression
{
public:
    explicit UseExpression( const detail::PartShell& _destClass )
        : destClass( _destClass )
    {
    }
    UseAsExpression as( const std::string& attribute )
    {
        return UseAsExpression( destClass, attribute );
    }
private:
    detail::PartShell destClass;
};


inline UseExpression use( const detail::PartShell& destClass )
{
    return UseExpression( destClass );
}

inline UseExpression use( const std::string& destClass )
{
    // default container case
    Catalog* current = Catalog::Current();
    if ( ! current ) throw CatalogNotSpecified();
    return use( ( *current )[ destClass ] );
}


// This is a helper class that provides the result of the set_attribute().of() function
// useful to concatenate set_attribute().of() with to().
class SetOfExpression
{
public:
    SetOfExpression( const detail::PartShell& _part, const std::string& _attribute ) :
        part( _part ), attribute( _attribute ) {}
    // throw ElementNotFound If attribute does not exist in this part.
    // throw WrongType If @c value has not a type compatible with the attribute.
    template < typename T >
    void to( const T& value )
    {
        // perform the final assignment:
        part.SetAttribute( attribute, value );
    }
private:
    const detail::PartShell part;
    const std::string attribute;
};

// This is a helper class that provides the result of the set_attribute() function
// useful to concatenate set_attribute() with of().
class SetExpression
{
public:
    explicit SetExpression( const std::string& att ) : attribute( att ) {}
    SetOfExpression of( const detail::PartShell& part ) { return SetOfExpression( part, attribute ); }
    // throw CatalogNotSpecified if the current catalog has not been selected including
    // this function in a wallaroo_within section
    SetOfExpression of( const std::string& part )
    {
        // default container case
        Catalog* current = Catalog::Current( );
        if ( !current ) throw CatalogNotSpecified( );
        return SetOfExpression( ( *current )[ part ], attribute );
    }
private:
    const std::string attribute;
};

inline SetExpression set_attribute( const std::string& attribute ) { return SetExpression( attribute ); }


// Helper class that changes the current catalog on the ctor and
// restores the previous on the dtor
class Context
{
public:
    Context( Catalog& c ) :
      firstTime( true )
    {
        previous = Catalog::Current();
        Catalog::Current() = &c;
    }
    ~Context()
    {
        Catalog::Current() = previous;
    }
    bool FirstTime() const
    {
        return firstTime;
    }
    void Terminate()
    {
        firstTime = false;
    }
private:
    bool firstTime;
    Catalog* previous;
};


#define wallaroo_within( C ) \
    for ( wallaroo::Context context( C ); context.FirstTime(); context.Terminate() )


} // namespace

#endif