enumLoader.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2024 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/


#pragma once

#include <vlpi/enumDictionary.h>
#include <vlutil/vlMachineTypes.h>

#include <map>
#include <vector>
#include <list>
#include <functional>
#include <libxml/xmlmemory.h>
#include <libxml/parser.h>

class DT_DLL_VLPROTIND DtEnumLoader
{
public:

   typedef DtEnumLoader*(*EnumLoaderCreator)();

   typedef std::list<DtEntityTypeRange> Applicability;

   typedef std::function<bool(const DtFilename&, DtEnumDictionary&)> FileLoaderFcn;

   typedef std::function<unsigned(const DtFilename&)> FilePriorityReaderFcn;

   typedef std::function<void(xmlNodePtr, const Applicability&, DtEnumDictionary&)> XmlEntityTypeEntryReaderFcn;

   typedef std::function<void(xmlNodePtr, DtEnumDictionary&)> XmlEntryReaderFcn;

public:

   static DtEnumLoader* create();

   static void setCreator(EnumLoaderCreator creator);

   virtual ~DtEnumLoader();

   virtual bool loadFromDirectory(const DtFilename& directory, DtEnumDictionary& dict);

   virtual bool loadFile(const DtFilename& file, DtEnumDictionary& dict);



   virtual void addInterestInEnum(DtEnumUid uid);

   virtual void addInterestInEnumRange(DtEnumUid lowerUid, DtEnumUid upperUid);

   virtual void addInterestInEntityTypeEnum(DtEnumUid uid, DtEntityTypeField);




   virtual void registerFileLoader(const DtString& fileExt, FileLoaderFcn fcn);

   virtual void unregisterFileLoader(const DtString& fileExt);

   virtual void registerFilePriorityReader(const DtString& fileExt, FilePriorityReaderFcn fcn);

   virtual void unregisterFilePriorityReader(const DtString& fileExt);

   virtual void registerUidEntryReader(DtEnumUid uid, XmlEntryReaderFcn fcn);

   virtual void unregisterUidEntryReader(DtEnumUid uid);

   virtual void registerUidRangeEntryReader(DtEnumUid lowerUid, 
      DtEnumUid upperUid, XmlEntryReaderFcn fcn);

   virtual void unregisterUidRangeEntryReader(DtEnumUid lowerUid, 
      DtEnumUid upperUid);

   virtual void registerEntityTypeUidEntryReader(DtEnumUid uid,
      XmlEntityTypeEntryReaderFcn fcn);

   virtual void unregisterEntityTypeUidEntryReader(DtEnumUid uid);

   virtual void registerEntityTypeFieldEntryReader(DtEntityTypeField lvl,
      XmlEntityTypeEntryReaderFcn fcn);

   virtual void unregisterEntityTypeFieldEntryReader(DtEntityTypeField lvl);


protected:

   DtEnumLoader();

   virtual void registerDefaultLoaders();

   virtual bool loadFromXml(const DtFilename& fn, DtEnumDictionary& dict);

   virtual unsigned readPriorityFromXml(const DtFilename& fn);


   virtual void readEntityTypeEnum(xmlNodePtr node, DtEntityTypeField field,
      const Applicability& applics, DtEnumDictionary& dict) const;
   virtual void readEntityTypesHierarchy(xmlNodePtr node, DtEnumDictionary& dict) const;
   virtual void readEnum(xmlNodePtr node, DtEnumDictionary& dict) const;

   virtual DtEnumUid processSingleLevelEntry(xmlNodePtr node, 
      DtEnumDictionary::EnumMap& enums, DtString& name) const;

   virtual void processMultiLevelEntry(xmlNodePtr node, DtEntityTypeField field,
      const DtEntityTypeRange& applic, DtEnumDictionary& dict, DtEnumUid parentUid) const;
   
   virtual void setEntityTypeLevel(unsigned lvl, int lowerVal, int upperVal, 
      DtEntityTypeRange& etRange) const;

   virtual DtEntityTypeField parseApplicability(const xmlChar* c, 
      std::list<DtEntityTypeRange>& applics) const;

   virtual int xmlCharToInt(const xmlChar* c) const;
   
protected:

   typedef std::map<DtString, FileLoaderFcn> FileLoaderMap;
   typedef std::map<DtString, FilePriorityReaderFcn> FilePriorityReaderMap;
   typedef std::map<int, XmlEntryReaderFcn> XmlUidReaderMap;
   typedef std::pair<int, int> XmlUidRange;
   typedef std::map<XmlUidRange, XmlEntryReaderFcn> XmlUidRangeReaderMap;
   typedef std::map<int, XmlEntityTypeEntryReaderFcn> XmlEntityTypeUidReaderMap;
   typedef std::map<DtEntityTypeField, XmlEntityTypeEntryReaderFcn> XmlEntityTypeLevelReaderMap;

   bool myDefaultLoadersRegistered;

   FileLoaderMap myFileLoaders;
   FilePriorityReaderMap myFilePriorityReaders;
   XmlUidReaderMap myReadersByUid;
   XmlUidRangeReaderMap myReadersByUidRange;
   XmlEntityTypeUidReaderMap myEntityTypeReadersByUid;
   XmlEntityTypeLevelReaderMap myEntityTypeReadersByLevel;

   DtEnumDictionary* myDict;

   DtFilename myCurrFilename;

   static EnumLoaderCreator theCreator;
};