registry.h

Go to the documentation of this file.

#ifndef CPPUT_REGISTRY_H_INCLUDED
# define CPPUT_REGISTRY_H_INCLUDED

# include <cpput/forwards.h>
# include <cpptl/conststring.h>
# include <cpptl/functor.h>
# include <deque>
# include <map>


namespace CppUT {

typedef CppTL::Functor0R<TestPtr> TestFactory;

typedef int TestFactoryId;


class CPPUT_API Registry
{
public:
   static std::string defaultParentSuiteName();

   static Registry &instance();

   Registry();

   void addChild( const std::string &parentSuiteName,
                  const std::string &childSuiteName );
   void addChildToDefault( const std::string &childSuiteName );

   bool removeChild( const std::string &parentSuiteName,
                     const std::string &childSuiteName );

   TestFactoryId add( const std::string &parentSuiteName,
                      const TestFactory &testFactory );
   TestFactoryId add( const std::string &parentSuiteName,
                      TestPtr (*factory)() );
   TestFactoryId add( const std::string &parentSuiteName,
                      TestPtr (*factory)( const std::string &suiteName ),
                      const std::string &suiteName = std::string("") );

   TestFactoryId addToDefault( const TestFactory &testFactory );
   TestFactoryId addToDefault( TestPtr (*factory)() );
   TestFactoryId addToDefault( TestPtr (*factory)( const std::string &suiteName ),
                               const std::string &suiteName = std::string("") );

   bool remove( TestFactoryId testFactoryId );

   TestSuitePtr createTests( const std::string &suiteName ) const;

   TestSuitePtr createDefaultTests() const;

   void addCreatedTests( const std::string &suiteName,
                         const TestSuitePtr &suite ) const;

private:
   void addChildSuite( const std::string &suiteName, 
                       const TestSuitePtr &suite ) const;

   void addSuiteRegisteredTests( const std::string &suiteName, 
                                 const TestSuitePtr &suite ) const;

   TestFactoryId nextFactoryId();

   typedef std::pair<TestFactory, TestFactoryId> TestFactoryWithId;
   
   typedef std::deque<TestFactoryWithId> TestFactories;
   typedef std::map<CppTL::ConstString,TestFactories> TestFactoryRegistry;
   TestFactoryRegistry registry_;

   typedef std::multimap<CppTL::ConstString,CppTL::ConstString> ParentChildRelationShips;
   ParentChildRelationShips relations_;

   typedef std::map<TestFactoryId,CppTL::ConstString> TestFactoryParentSuiteById;
   TestFactoryParentSuiteById parentSuiteById_;

   TestFactoryId nextId_;
};


namespace Impl {
   
   enum RegisterToNamedSuiteTag {
      registerToNamedSuite
   };

} // namespace Impl


template<class SuiteType>
class SuiteRegisterer
{
public:
   SuiteRegisterer()
   {
      testFactoryId_ = Registry::instance().addToDefault( &SuiteType::suite );
   }

   SuiteRegisterer( const std::string &suiteName )
   {
      testFactoryId_ = Registry::instance().addToDefault( &SuiteType::suite, 
                                                          suiteName );
   }

   SuiteRegisterer( Impl::RegisterToNamedSuiteTag,
                    const std::string &parentSuiteName )
   {
      testFactoryId_ = Registry::instance().add( parentSuiteName,
                                                 &SuiteType::suite );
   }

   SuiteRegisterer( Impl::RegisterToNamedSuiteTag,
                    const std::string &parentSuiteName, 
                    const std::string &suiteName )
   {
      testFactoryId_ = Registry::instance().add( parentSuiteName,
                                                 &SuiteType::suite,
                                                 suiteName );
   }

   ~SuiteRegisterer()
   {
      Registry::instance().remove( testFactoryId_ );
   }

protected:
   SuiteRegisterer( TestFactoryId testFactoryId ):
         testFactoryId_( testFactoryId )
   {
   }

private:
   TestFactoryId testFactoryId_;
};



#define CPPUT_REGISTER_NAMED_SUITE_TO_DEFAULT( TestFixtureType, suiteName )  \
  static CppUT::SuiteRegisterer< TestFixtureType >                           \
             CPPTL_MAKE_UNIQUE_NAME(cpputSuiteRegisterer )(suiteName);


#define CPPUT_REGISTER_SUITE_TO_DEFAULT( TestFixtureType )                   \
  static CppUT::SuiteRegisterer< TestFixtureType >                           \
             CPPTL_MAKE_UNIQUE_NAME(cpputSuiteRegisterer );


#define CPPUT_REGISTER_SUITE_IN( TestFixtureType, parentSuiteName )          \
  static CppUT::SuiteRegisterer< TestFixtureType >                           \
             CPPTL_MAKE_UNIQUE_NAME(cpputSuiteRegisterer)(                   \
                     CppUT::Impl::registerToNamedSuite,                      \
                     parentSuiteName );


#define CPPUT_REGISTER_NAMED_SUITE_IN( TestFixtureType,                      \
                                       parentSuiteName,                      \
                                       suiteName )                           \
  static CppUT::SuiteRegisterer< TestFixtureType >                           \
             CPPTL_MAKE_UNIQUE_NAME(cpputSuiteRegisterer )(                  \
                     CppUT::Impl::registerToNamedSuite,                      \
                     parentSuiteName,                                        \
                     suiteName );

class SuiteRelationshipRegisterer
{
public:
   explicit SuiteRelationshipRegisterer( const std::string &childSuiteName )
      : childSuiteName_( childSuiteName )
      , parentSuiteName_( Registry::defaultParentSuiteName() )
   {
      Registry::instance().addChildToDefault( childSuiteName );
   }

   SuiteRelationshipRegisterer( const std::string &parentSuiteName,
                                const std::string &childSuiteName )
      : parentSuiteName_( parentSuiteName )
      , childSuiteName_( childSuiteName )
   {
      Registry::instance().addChild( parentSuiteName, childSuiteName );
   }

   ~SuiteRelationshipRegisterer()
   {
      Registry::instance().removeChild( parentSuiteName_.str(), 
                                        childSuiteName_.str() );
   }

private:
   CppTL::ConstString parentSuiteName_;
   CppTL::ConstString childSuiteName_;
};


#define CPPUT_REGISTER_SUITE_RELATIONSHIP( parentSuiteName, childSuiteName ) \
   static ::CppUT::SuiteRelationshipRegisterer                               \
             CPPTL_MAKE_UNIQUE_NAME(cpputSuiteRelationShipRegisterer )(      \
                                            parentSuiteName,                 \
                                            childSuiteName )


#define CPPUT_REGISTER_SUITE_RELATIONSHIP_TO_DEFAULT( childSuiteName )       \
   static ::CppUT::SuiteRelationshipRegisterer                               \
             CPPTL_MAKE_UNIQUE_NAME(cpputSuiteRelationShipRegisterer )(      \
                                            childSuiteName )


// Plain C function tests

class TestFactoryRegisterer
{
public:
   typedef TestPtr (*FactoryFn)();

   TestFactoryRegisterer( FactoryFn testFactory )
   {
      testFactoryId_ = Registry::instance().addToDefault( CppTL::cfn0r<TestPtr>(testFactory) );
   }

   TestFactoryRegisterer( TestFactory testFactory )
   {
      testFactoryId_ = Registry::instance().addToDefault( testFactory );
   }

   TestFactoryRegisterer( TestFactory testFactory, const std::string &parentSuiteName )
   {
      testFactoryId_ = Registry::instance().add( parentSuiteName, testFactory );
   }

   TestFactoryRegisterer( FactoryFn testFactory, const std::string &parentSuiteName )
   {
      testFactoryId_ = Registry::instance().add( parentSuiteName, CppTL::cfn0r<TestPtr>(testFactory) );
   }

   ~TestFactoryRegisterer()
   {
      Registry::instance().remove( testFactoryId_ );
   }

private:
   TestFactoryId testFactoryId_;
};

#define CPPUT_REGISTER_TESTFACTORY_TO_DEFAULT( testFactory )               \
   static ::CppUT::TestFactoryRegisterer                                   \
      CPPTL_MAKE_UNIQUE_NAME(cpputTestFactoryRegisterer)( testFactory )

#define CPPUT_REGISTER_TESTFACTORY_IN( testFactory, parentSuiteName )      \
   static ::CppUT::TestFactoryRegisterer                                   \
      CPPTL_MAKE_UNIQUE_NAME(cpputTestFactoryRegisterer)( testFactory, parentSuiteName )

} // namespace CppUT


#endif // CPPUT_REGISTRY_H_INCLUDED