LibraryRegistry.h

Go to the documentation of this file.

/*
 * Copyright (C) by
 *   MetraLabs GmbH (MLAB), GERMANY
 * and
 *   Neuroinformatics and Cognitive Robotics Labs (NICR) at TU Ilmenau, GERMANY
 * All rights reserved.
 *
 * Contact: info@mira-project.org
 *
 * Commercial Usage:
 *   Licensees holding valid commercial licenses may use this file in
 *   accordance with the commercial license agreement provided with the
 *   software or, alternatively, in accordance with the terms contained in
 *   a written agreement between you and MLAB or NICR.
 *
 * GNU General Public License Usage:
 *   Alternatively, this file may be used under the terms of the GNU
 *   General Public License version 3.0 as published by the Free Software
 *   Foundation and appearing in the file LICENSE.GPL3 included in the
 *   packaging of this file. Please review the following information to
 *   ensure the GNU General Public License version 3.0 requirements will be
 *   met: http://www.gnu.org/copyleft/gpl.html.
 *   Alternatively you may (at your option) use any later version of the GNU
 *   General Public License if such license has been publicly approved by
 *   MLAB and NICR (or its successors, if any).
 *
 * IN NO EVENT SHALL "MLAB" OR "NICR" BE LIABLE TO ANY PARTY FOR DIRECT,
 * INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF
 * THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF "MLAB" OR
 * "NICR" HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * "MLAB" AND "NICR" SPECIFICALLY DISCLAIM ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND "MLAB" AND "NICR" HAVE NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS OR MODIFICATIONS.
 */

#include <map>

#include <utils/Singleton.h>

#include <serialization/PropertyHint.h>
#include <utils/MakeString.h>

#ifndef _MIRA_LIBRARYREGISTRY_H_
#define _MIRA_LIBRARYREGISTRY_H_

namespace mira {


struct LibraryVersion
{
    LibraryVersion() : mMajor(0), mMinor(0), mPatch(0) {}
    LibraryVersion(uint32 iMajor, uint32 iMinor, uint32 iPatch)
        : mMajor(iMajor), mMinor(iMinor), mPatch(iPatch) {}

    template<typename Reflector>
    void reflect(Reflector& r)
    {
        r.member( "Major", mMajor, "" );
        r.member( "Minor", mMinor, "" );
        r.member( "Patch", mPatch, "" );
    }

    bool operator==(const LibraryVersion& other) const
    {
        return (mMajor == other.mMajor) &&
               (mMinor == other.mMinor) &&
               (mPatch == other.mPatch);
    }

    bool operator!=(const LibraryVersion& other) const { return !operator==(other); }

    bool empty() { return (mMajor + mMinor + mPatch) == 0; }

    uint32 mMajor;
    uint32 mMinor;
    uint32 mPatch;
};

std::ostream& operator<<(std::ostream& s, const LibraryVersion& version);


struct LibraryInfo
{
    enum ErrorType {
        NoError = 0,
        ManifestRegisteredTwice,
        ManifestVersionConflict,
        LibraryLoadedTwice,
        LibraryVersionConflict
    };

    template<typename Reflector>
    void reflect(Reflector& r)
    {
        auto version = r.version(2, this);
        r.member("Version", mVersion, "Library version",
                 REFLECT_CTRLFLAG_MEMBER_AS_ROPROPERTY);
        r.member("HasManifest", mHasManifest, "Found a manifest for this lib",
                 REFLECT_CTRLFLAG_MEMBER_AS_ROPROPERTY);
        r.member("IsLoaded", mIsLoaded, "Lib was loaded",
                 REFLECT_CTRLFLAG_MEMBER_AS_ROPROPERTY);
        if (version >= 2) {
            r.member("LoadError", mLoadError, "Type of load error (or NoError)");
            r.roproperty("LoadError", mLoadError, "Type of load error (or NoError)",
                         PropertyHints::enumeration("0=None;"
                                                    "1=Manifest loaded twice;"
                                                    "2=Manifest version conflict;"
                                                    "3=Library loaded twice;"
                                                    "4=Library version conflict"));
            r.member("ConflictingVersion", mConflictingVersion,
                     "Version of manifest/library that was conflicting (if any)",
                     REFLECT_CTRLFLAG_MEMBER_AS_ROPROPERTY);
        }
    }

    void setLoadError(ErrorType error,
                      LibraryVersion conflictingVersion = LibraryVersion());

    std::string reportError() const;

    LibraryVersion mVersion;

    bool mHasManifest = false;
    bool mIsLoaded    = false;

    ErrorType mLoadError = NoError;
    LibraryVersion mConflictingVersion;
};


class LibraryRegistry : public LazySingleton<LibraryRegistry>
{
public:
    typedef std::map<std::string, LibraryInfo > Register;

public:

    static void registerManifest( const std::string& name,
                                  const LibraryVersion& version );

    static void registerLibrary( const std::string& name,
                                 const LibraryVersion& version) ;

    static Register getRegister()
    {
        boost::mutex::scoped_lock lock(instance().mMutex);
        return instance().mLibraries;
    }

    static bool hasLoadError();

    static std::string reportErrors();

private:
    boost::mutex mMutex;
    Register mLibraries;
};


} // namespace

#endif /* _MIRA_LIBRARYREGISTRY_H_ */