Did.hpp

Go to the documentation of this file.

#ifndef IFW_DIT_DID_HPP_
#define IFW_DIT_DID_HPP_

#include <limits.h>

#include <string>

#include "ctd/defines/defines.hpp"

#include "dit/did/Header.hpp"
#include "dit/did/Record.hpp"


namespace dit {
namespace did {

class Did {
public:

    static std::string SubstituteIndeces(const std::string& key);

    static std::string SubstituteIndex(const std::string& key);

    typedef enum {
        DID_HDR_NONE = 0,
        DID_HDR_FIRST,
        DID_HDR_LAST,
        DID_HDR_ALL
    } HeaderSpecifier;

    Did();

    ~Did();

    void Load(const std::string& did_filename,
              const bool merge = false);

    void Clear();

    const ctd::defines::List<std::string>& GetDidsLoaded() const;

    const ctd::defines::List<dit::did::Header>& GetHeaders() const;

    bool HasRecord(const std::string& pattern,
                   const bool allow_idx_subst = true) const;

    bool LookUp(const std::string& pattern,
                dit::did::Record& record,
                const bool allow_idx_subst = true,
                const bool exception = true) const;

    void Scan(const std::string& pattern,
              ctd::defines::List<dit::did::Record>& records,
              const bool allow_idx_subst = true,
              const bool stop_first_match = false,
              const std::list<std::string>& classes = {"*"},
              const ctd::defines::DataType data_types = ctd::defines::DATA_TYPE_ALL,
              const std::string& format_req_ex = "*",
              const std::string& default_value_reg_ex = "*",
              const std::string& unit_reg_ex = "*",
              const std::string& comment_req_ex = "*",
              const std::list<std::string>& tags_reg_ex = {"*"},
              const std::string& description_req_ex = "*") const;

    bool LookUp(const std::string& pattern,
                ctd::defines::List<dit::did::Record>& records,
                const bool allow_idx_subst = true,
                const bool exception = false) const;

    void Add(dit::did::Record& record);

    void GetKeys(ctd::defines::List<std::string>& keys) const;

    std::string Print(const HeaderSpecifier print_header = DID_HDR_LAST,
                      const std::string& pattern = "",
                      const bool compact = false) const;

private:
    // Maps keyword names into keyword records.
    std::map<std::string, dit::did::Record> m_records;

    // List of dictionaries (filenames) currently loaded
    // (m_dids_loaded[0] = first DID loaded).
    ctd::defines::List<std::string> m_dids_loaded;

    // Maps dictionary filename into the header of that dictionary.
    ctd::defines::List<dit::did::Header> m_headers;

    void _Load(const std::string& did_filename,
               int8_t& recurse_level);

    int16_t _LookUp(const std::string& pattern,
                    ctd::defines::List<dit::did::Record>& records,
                    const bool allow_idx_subst,
                    const bool exception,
                    const int16_t max_records) const;

};

} // namespace dit
} // namespace did

#endif // !IFW_DIT_DID_HPP_