package_info.hpp

Go to the documentation of this file.

/*
** Author(s):
**  - Laurent Lec <llec@aldebaran-robotics.com>
**  - Clément Geiger <cgeiger@aldebaran-robotics.com>
**
** Copyright (C) 2012-2015 Aldebaran Robotics
*/

#pragma once
#ifndef _QI_PACKAGE_PACKAGE_INFO_HPP_
#define _QI_PACKAGE_PACKAGE_INFO_HPP_

#include <string>
#include <list>
#include <qipackage/api.hpp>
#include <alvalue/alvalue.h>
#include <qipackage/language_info.hpp>
#include <qipackage/behavior_info.hpp>
#include <qipackage/dialog_info.hpp>
#include <qi/macro.hpp>
#include <qi/anyobject.hpp>
#include <qi/type/typeinterface.hpp>
#include <QFile>

namespace qi
{
  class PackageInfoPrivate;

  struct WebInfo;

  struct QI_PACKAGE_API PackageInfo2
  {
    std::string uuid; 
    std::string version; 
    std::string author; 
    std::string channel; 
    std::string organization; 
    std::string date; 
    std::string typeVersion; 
    std::string installer; 
    std::string path; 

    std::map<std::string, qi::AnyValue> elems;

    std::map<std::string, qi::AnyValue> contents() const;
    std::map<std::string, qi::AnyValue>& contents();

    std::vector<qi::BehaviorInfo> behaviors() const;
    std::vector<qi::BehaviorInfo>& behaviors();

    std::vector<qi::DialogInfo> dialogs() const;
    std::vector<qi::DialogInfo>& dialogs();

    std::vector<qi::LanguageInfo> languages() const;
    std::vector<qi::LanguageInfo>& languages();

    qi::WebInfo web() const;
    qi::WebInfo& web();
  };

  QI_PACKAGE_API qi::PackageInfo2 loadManifest(const std::string& manifestPath);


  struct QI_PACKAGE_API RobotRequirement
  {
    std::string model; 
    std::string minHeadVersion; 
    std::string maxHeadVersion; 
    std::string minBodyVersion; 
    std::string maxBodyVersion; 
  };

  struct QI_PACKAGE_API NaoqiRequirement
  {
    std::string minVersion; 
    std::string maxVersion; 
  };

  struct QI_PACKAGE_API PackageService
  {
    std::string execStart; 
    std::string name; 
    bool autoRun; 
  };

  struct QI_PACKAGE_API WebInfo
  {
    std::string path; 
  };

  class QI_PACKAGE_API PackageInfo
  {
  public:
    PackageInfo();

    PackageInfo(const PackageInfo &package);
    PackageInfo(const PackageInfo2 &package);
    ~PackageInfo();

    PackageInfo operator=(const PackageInfo& package);

    /* For serialization purpose */
    PackageInfo(const AL::ALValue& alvalue);
    void toALValue(AL::ALValue &alvalue);

    bool loadFromManifestFile(const std::string& filePath);
    bool loadFromManifestFile(QFile &file);
    bool loadFromManifestContent(const std::string& manifestContent);

    void trimExtraInfo();

    bool saveToManifestFile(const std::string& filePath) const;
    bool saveToManifestFile(QFile &file) const;
    std::string saveToManifestContent() const;

    const std::string& installer() const;
    void setInstaller(const std::string &installer);

    const std::string& uuid() const;
    void setUuid(const std::string &uuid);

    const std::string& version() const;
    void setVersion(const std::string &version);

    const std::string& typeVersion() const;
    void setTypeVersion(const std::string &typeVersion);

    const std::string& author() const;
    void setAuthor(const std::string &author);

    const std::string& organization() const;
    void setOrganization(const std::string &organization);

    const std::string& date() const;
    void setDate(const std::string &date);

    const std::string& channel() const;
    void setChannel(const std::string &channel);

    const std::string& path() const;
    void setPath(const std::string &path);

    const std::string& name(const std::string &lang) const;
    const std::map<std::string, std::string> &names() const;
    void setName(const std::string &name,
                 const std::string &lang);
    void clearNames();

    const std::list<std::string>& supportedLanguages() const;
    void addSupportedLanguage(const std::string & language);
    void removeSupportedLanguage(const std::string & language);
    void clearSupportedLanguages();

    const std::list<std::string>& descriptionLanguages() const;
    void addDescriptionLanguage(const std::string & language);
    void removeDescriptionLanguage(const std::string & language);
    void clearDescriptionLanguages();

    const std::string& description(const std::string &lang) const;
    const std::map<std::string, std::string> &descriptions() const;
    void setDescription(const std::string description,
                        const std::string &lang);

    std::list<RobotRequirement>& robotRequirements() const;
    void addRobotRequirement(const RobotRequirement& requirement);
    void clearRobotRequirements();

    std::list<NaoqiRequirement>& naoqiRequirements() const;
    void addNaoqiRequirement(const NaoqiRequirement& requirement);
    void clearNaoqiRequirements();

    std::list<BehaviorInfo> & behaviors();
    const std::list<BehaviorInfo>& behaviors() const;
    void addBehavior(const BehaviorInfo& behavior);
    bool hasBehavior() const;
    void clearBehaviors();

    const std::list<DialogInfo>& dialogs() const;
    void addDialog(const DialogInfo& dialog);
    void clearDialogs();

    const std::list<LanguageInfo>& languages() const;
    void addLanguage(const LanguageInfo& language);

    const std::list<PackageService> &services() const;
    void addService(const PackageService &service);
    void clearServices();

    const std::list<std::string> &executableFiles() const;
    void addExecutableFile(const std::string &executableFile);

    PackageInfoPrivate *_p;
  };

  typedef std::vector<PackageInfo> PackageInfoList;

  QI_PACKAGE_API std::ostream& operator<<(std::ostream& os,
                                          const PackageInfo& package);
}


QI_TYPE_STRUCT(::qi::RobotRequirement, model, minHeadVersion, maxHeadVersion, minBodyVersion, maxBodyVersion);
QI_TYPE_STRUCT(::qi::NaoqiRequirement, minVersion, maxVersion);
QI_TYPE_STRUCT(::qi::PackageService, execStart, name, autoRun);
QI_TYPE_STRUCT(::qi::PackageInfo2, uuid, version, author, channel, organization, date, typeVersion, installer, path, elems);
QI_TYPE_STRUCT(::qi::WebInfo, path);

#endif  // _QI_PACKAGE_PACKAGE_INFO_HPP_