EvioXMLDictionary.h

Go to the documentation of this file.

//
// Copyright 2020, Jefferson Science Associates, LLC.
// Subject to the terms in the LICENSE file found in the top-level directory.
//
// EPSCI Group
// Thomas Jefferson National Accelerator Facility
// 12000, Jefferson Ave, Newport News, VA 23606
// (757)-269-7100


#ifndef EVIO_6_0_EVIOXMLDICTIONARY_H
#define EVIO_6_0_EVIOXMLDICTIONARY_H


#include <stdexcept>
#include <string>
#include <regex>
#include <iostream>
#include <iterator>
#include <unordered_map>
#include <vector>
#include <sstream>
#include <algorithm>

#include "EvioDictionaryEntry.h"
#include "EvioException.h"
#include "Util.h"
#include "BaseStructure.h"
#include "pugixml.hpp"


namespace evio {


    class EvioXMLDictionary {

    private:

        static const std::string DICT_TOP_LEVEL;

        static const std::string ENTRY;

        static const std::string ENTRY_ALT;

        static const std::string ENTRY_BANK;

        static const std::string ENTRY_LEAF;

        static const std::string DESCRIPTION;

        static const std::string FORMAT;

        static const std::string TYPE;

        static const std::string NAME;

        static const std::string TAG;

        static const std::string NUM;

        static std::regex pattern_regex;

        std::string const delimiter = ".";

        pugi::xml_document doc;

    public:

        std::unordered_map<std::shared_ptr<EvioDictionaryEntry>, std::string> tagNumMap;

        std::unordered_map<std::shared_ptr<EvioDictionaryEntry>, std::string> tagOnlyMap;

        std::unordered_map<std::shared_ptr<EvioDictionaryEntry>, std::string> tagRangeMap;


    private:

        std::unordered_map<std::string, std::shared_ptr<EvioDictionaryEntry>> reverseMap;

        std::unordered_map<std::string, std::shared_ptr<EvioDictionaryEntry>> tagNumReverseMap;

        pugi::xml_node topLevelDoc;

        std::string stringRepresentation;


    public:


        static const std::string &NO_NAME_STRING();

        explicit EvioXMLDictionary(std::string const &path);
        EvioXMLDictionary(std::string const &xml, int dummy);


        void parseXML(pugi::xml_parse_result &domDocument);

        size_t size() const;

        const std::unordered_map<std::string, std::shared_ptr<EvioDictionaryEntry>> &getMap() const;


    private:


        void addHierarchicalDictEntries(std::vector<pugi::xml_node> &kidList,
                                        std::string const &parentName);

    public:

        std::string getName(std::shared_ptr<BaseStructure> &structure);
        std::string getName(uint16_t tag);
        std::string getName(uint16_t tag, uint8_t num);
        std::string getName(uint16_t tag, uint8_t num, uint16_t tagEnd);
        std::string getName(uint16_t tag, uint8_t num, uint16_t tagEnd,
                            uint16_t pTag, uint8_t pNum, uint16_t pTagEnd);
        std::string getName(uint16_t tag, uint8_t num, uint16_t tagEnd,
                            uint16_t pTag, uint8_t pNum, uint16_t pTagEnd,
                            bool numValid = true, bool parentValid = false,
                            bool parentNumValid = false);


    private:


        std::string getName(std::shared_ptr<EvioDictionaryEntry> key);
        std::shared_ptr<EvioDictionaryEntry> entryLookupByData(uint16_t tag, uint8_t num, uint16_t tagEnd);
        std::shared_ptr<EvioDictionaryEntry> entryLookupByName(std::string const &name);


    public:


        std::string getDescription(uint16_t tag, uint8_t num);
        std::string getDescription(uint16_t tag, uint8_t num, uint16_t tagEnd);
        std::string getDescription(std::string const &name);

        std::string getFormat(uint16_t tag, uint8_t num);
        std::string getFormat(uint16_t tag, uint8_t num, uint16_t tagEnd);
        std::string getFormat(std::string const &name);

        DataType getType(uint16_t tag, uint8_t num);
        DataType getType(uint16_t tag, uint8_t num, uint16_t tagEnd);
        DataType getType(std::string const &name);

        bool getTagNum(std::string const &name, uint16_t *tag, uint8_t *num, uint16_t *tagEnd);
        bool getTag(std::string const &name, uint16_t *tag);
        bool getTagEnd(std::string const &name, uint16_t *tagEnd);

        bool getNum(std::string const &name, uint8_t *num);


        std::string toString();
    };

}


#endif //EVIO_6_0_EVIOXMLDICTIONARY_H