Header.hpp

Go to the documentation of this file.

#ifndef IFW_DIT_DID_HEADER_HPP_
#define IFW_DIT_DID_HEADER_HPP_

#include <string>

#include "ctd/defines/defines.hpp"

#include "ctd/file/Yaml.hpp"


namespace dit {
  namespace did {

    // TODO: Consider to use "enum class".
    typedef enum  {
      DID_HDR_FIELD_NAME         =  1,
      DID_HDR_FIELD_SCOPE        =  2,
      DID_HDR_FIELD_CRE_DATE     =  4,
      DID_HDR_FIELD_VERSION      =  8,
      DID_HDR_FIELD_INCLUDE      = 16,
      DID_HDR_FIELD_DESCRIPTION  = 32,

      DID_HDR_FIELD_ALL = (DID_HDR_FIELD_NAME | DID_HDR_FIELD_SCOPE | DID_HDR_FIELD_CRE_DATE |
      DID_HDR_FIELD_VERSION | DID_HDR_FIELD_INCLUDE | DID_HDR_FIELD_DESCRIPTION)
    } DidHdrField;

    const std::string HEADER_TAG = "Header";

    // Dictionary Header Fields.
    const std::string DID_HDR_FIELD_NAME_STR        = "Name";
    const std::string DID_HDR_FIELD_SCOPE_STR       = "Scope";
    const std::string DID_HDR_FIELD_CRE_DATE_STR    = "CreationDate";
    const std::string DID_HDR_FIELD_VERSION_STR     = "Version";
    const std::string DID_HDR_FIELD_INCLUDE_STR     = "Include";
    const std::string DID_HDR_FIELD_DESCRIPTION_STR = "Description";

    const std::map<DidHdrField, std::string> DID_HDR_FIELDS_NB_MAP = {
      {DidHdrField::DID_HDR_FIELD_NAME,        DID_HDR_FIELD_NAME_STR},
      {DidHdrField::DID_HDR_FIELD_SCOPE,       DID_HDR_FIELD_SCOPE_STR},
      {DidHdrField::DID_HDR_FIELD_CRE_DATE,    DID_HDR_FIELD_CRE_DATE_STR},
      {DidHdrField::DID_HDR_FIELD_VERSION,     DID_HDR_FIELD_VERSION_STR},
      {DidHdrField::DID_HDR_FIELD_INCLUDE,     DID_HDR_FIELD_INCLUDE_STR},
      {DidHdrField::DID_HDR_FIELD_DESCRIPTION, DID_HDR_FIELD_DESCRIPTION_STR}
    };

    const std::map<std::string, DidHdrField> DID_HDR_FIELDS_NAME_MAP {
      {DID_HDR_FIELD_NAME_STR,        DidHdrField::DID_HDR_FIELD_NAME},
      {DID_HDR_FIELD_SCOPE_STR,       DidHdrField::DID_HDR_FIELD_SCOPE},
      {DID_HDR_FIELD_CRE_DATE_STR,    DidHdrField::DID_HDR_FIELD_CRE_DATE},
      {DID_HDR_FIELD_VERSION_STR,     DidHdrField::DID_HDR_FIELD_VERSION},
      {DID_HDR_FIELD_INCLUDE_STR,     DidHdrField::DID_HDR_FIELD_INCLUDE},
      {DID_HDR_FIELD_DESCRIPTION_STR, DidHdrField::DID_HDR_FIELD_DESCRIPTION}
    };


    class Header {
    public:


      Header();

      explicit Header(const ctd::file::Yaml& did);

      ~Header();

      void Parse(const ctd::file::Yaml& did);

      std::string GetName() const;

      std::string GetScope() const;

      ctd::defines::IsoTime GetCreationDate() const;

      std::string GetVersion() const;

      const std::vector<std::string>& GetIncludes() const;

      std::string GetDescription() const;

      std::string ToString(const DidHdrField fields = DidHdrField::DID_HDR_FIELD_ALL,
                           const bool compact = false) const;

    private:
      std::string                      m_name;
      std::string                      m_scope;
      ctd::defines::IsoTime            m_creation_date;
      std::string                      m_version;
      std::vector<std::string>  m_includes;
      std::string                      m_description;
    };

  }
}

#endif // !IFW_DIT_DID_HEADER_HPP_