ManifestAgent.h

Go to the documentation of this file.

/*
 * Copyright (C) 2012 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.
 */

#ifndef _MIRA_MANIFESTAGENT_H_
#define _MIRA_MANIFESTAGENT_H_

#include <vector>

#include <platform/Platform.h>
#include <factory/LibraryRegistry.h>
#include <factory/VacantClass.h>
#include <utils/Path.h>

#include <error/LoggingCore.h>
#include <utils/PathFinder.h>
#include <utils/Foreach.h>
#include <serialization/adapters/boost/shared_ptr.hpp>

namespace mira {


struct MIRA_BASE_EXPORT ManifestClassInfo {
    boost::shared_ptr<VacantClass>  mClass;
    std::vector< std::string >  mParents;

    bool operator ==( ManifestClassInfo const& other ) {
        return other.mClass == mClass;
    }

    template<typename Reflector>
    void reflect(Reflector& r)
    {
        r.member( "Class", mClass, "" );
        r.member( "Parents", mParents, "" );
    }
};


class MIRA_BASE_EXPORT ManifestAgent {
public:

    ManifestAgent() {}

    ManifestAgent( std::string const& libraryName );

    ManifestAgent( std::string const& libraryName,
                   std::vector< ClassProxy > const& classes );

    void setLibraryVersion( int major, int minor, int patch );

    void addClasses( std::vector< ClassProxy > const& classes );

    void loadFile( Path const& filePath );

    void saveToFile( Path const& filePath );

    void finalize();

    template<typename Reflector>
    void reflect(Reflector& r)
    {
        r.member( "LibraryName", mLibraryName, "" );
        r.member( "LibraryVersion", mVersion, "" );
        r.member( "Classes", mClasses, "" );
    }

protected:
    std::vector< ManifestClassInfo > mClasses;
    std::string mLibraryName;
    LibraryVersion mVersion;
};



#ifdef MIRA_WINDOWS
#  define MIRA_LIB_FOLDER "bin"
#else
#  define MIRA_LIB_FOLDER "lib"
#endif

inline void loadManifests(const Path& pattern = MIRA_LIB_FOLDER"/*.manifest")
{
    std::vector<Path> manifests = findProjectFiles(pattern);
    ManifestAgent manifestAgent;
    foreach(const auto& p, manifests)
    {
        try
        {
            manifestAgent.loadFile(p);
        } catch(XIO& ex)
        {
            // catch IO exceptions only (e.g. file not found, etc)
            // all other exceptions concerning loading manifests are critical !!!
            MIRA_LOG(ERROR) << "Failed to load manifest '" << p << "': " << ex.message();
        } catch(Exception& ex) {
            MIRA_RETHROW(ex, "in file '" << p.string() << "'");
        }
    }
    manifestAgent.finalize();
}


} // namespace

#endif /* _MIRA_MANIFESTAGENT_H_ */