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 <ifw/core/dit/did/header.hpp>
#include <ifw/core/dit/did/record.hpp>
 
namespace ifw::core::dit::did {

    typedef enum {
        NONE = 0,
        FIRST,
        LAST,
        ALL
    } HdrSpec;

    class Did {
    public:
        static std::string SubstituteIndeces(const std::string& key);

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

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

        void Clear();

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

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

        const std::vector<ifw::core::dit::did::Header>& GetHeaders() const;

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

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

        bool LookUp(const std::string &pattern,
                    std::vector<ifw::core::dit::did::Record>& records,
                    const bool allow_idx_subst = true,
                    const bool exception = false) const;

        void GetKeys(std::vector<std::string>& keys) const;

        std::string ToString(HdrSpec header = HdrSpec::LAST,
                             const std::string& pattern = "",
                             const bool compact = false) const;

        friend std::ostream &operator<<(std::ostream& os, const Did &did);
 
    private:
        std::unique_ptr<elt::configng::CiiConfigDocument> m_did_doc;
 
        // List of dictionaries (filenames) currently loaded
        // (m_dids_loaded[0] = first DID loaded).
        std::vector<std::string> m_dids_loaded;
        std::vector<std::string> m_dids_loaded_complete_path;
 
        // Maps dictionary filename into the header of that dictionary.
        std::vector<ifw::core::dit::did::Header> m_headers;
 
        // Maps keyword names into keyword records.
        std::map<std::string, ifw::core::dit::did::Record> m_records;
 
        // Map with alternative keyword names for keys with optional indeces.
        std::map<std::string, ifw::core::dit::did::Record*> m_alt_records;
 
        int16_t _LookUp(const std::string& pattern,
                        std::vector<ifw::core::dit::did::Record> &records,
                        const bool allow_idx_subst,
                        const bool exception,
                        const int16_t max_records) const;
    };
 
} // namespace ifw::core::dit::did
 
#endif // !IFW_DIT_DID_HPP_