---

SOMELibCatalog.h

/********************************************************************
** Copyright (C) 2000 SOMELib Project
**
** This library is free software; you can redistribute it and/or
** modify it under the terms of the GNU Library General Public
** License as published by the Free Software Foundation; either
** version 2 of the License, or (at your option) any later version.
**
** This library is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
** Library General Public License for more details.
**
** You should have received a copy of the GNU Library General Public
** License along with this library; if not, write to the
** Free Software Foundation, Inc., 59 Temple Place - Suite 330,
** Boston, MA  02111-1307, USA.
**
*******************************************************************/

#ifndef SOME_LIB_INFO_HEADER
#define SOME_LIB_INFO_HEADER

#include "UserConfig.h"
#include "BasicDynLib.h"
#include "SOMEClassCatalog.h"
#include "SOMEDefines.h"
#include <vector>
#include <set>
#include <string>
#include <exception>

namespace SOME
{

class LibCatalog
{
public:
    LibCatalog(BasicDynLib*);
    ~LibCatalog();

    const std::string & getPath() const;

    //set this info in your plugin library
    void setLibTitle(const std::string&);
    void setVersion(const std::string&);
    SOME::ClassCatalog *addClassCatalog(const std::string& classname,
                                        const std::string& category,
                                        ClassCatalog::ConstructFunc def = NULL,
                                        ClassCatalog::ConstructFunc one = NULL,
                                        ClassCatalog::ConstructFunc two = NULL);

    bool hasSingleClass()
    {
        return classes.size() == 1;
    }

    bool hasClass(const std::string&);
    const ClassCatalog& getClass(const std::string&);

    typedef std::vector < ClassCatalog > ClassContainer;
    ClassContainer getCategory(const std::string&);

    //get if the class catalog key == value
    ClassContainer getByCategory(const std::string& key, const std::string& value);

    //get all values for a peticular key in this lib
    std::set < std::string > enumCategory( const std::string& key );

    //get all values for a peticular key for classes in this lib
    //which corraspond to the category map
    std::set < std::string > enumCategory( const std::string& key, std::map < std::string, std::string > &catmap );

    //fix this for Microsoft's build since it does not like maps
    //get all class catalogs whoes categories corraspond to entries in a map
    ClassContainer getByCategory( std::map < std::string, std::string > &keys );

private:
    BasicDynLib* lib;
    ClassContainer classes;

    std::string title;
    std::string version;

    ClassContainer::size_type class_index_cache;
};

class ClassDoesNotExist: public std::exception
{
public:
    ClassDoesNotExist(const std::string& classname)
    {
        whatstr = classname + " does not exist in any of the libraries loaded.";
    }

    ClassDoesNotExist(const std::string& libtitle, const std::string& classname)
    {
        whatstr = classname + " does not exist in the library: " + libtitle;
    }

    const char* what()
    {
        return whatstr.c_str();
    }

private:
    std::string whatstr;
};

} //namespace SOME


//implement this function in your library
SOME_EXPORT void initSOMELibCatalog(SOME::LibCatalog*);


#endif //SOME_LIB_INFO_HEADER

---