xmlFedReader.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1992-2025 MAK Technologies, Inc
** All rights reserved.
*********************************************************************/

#pragma once


#include <stdio.h>
#include <string>

#include "fedReader.h"

#include <vlutil/vlString.h>
#include <vlutil/vlFilename.h>
#include <vlutil/vlFedTarget.h>

// 
// 
// //! Forward declarations
// struct _xmlNode;
// struct _xmlDoc;
// typedef unsigned char xmlChar;
// typedef struct _xmlNode xmlNode;
// typedef struct _xmlDoc xmlDoc;

#ifdef DtUSE_UTILITIES_NAMESPACE
namespace DtUSE_UTILITIES_NAMESPACE
{
#endif

class DT_DLL_MTL DtXmlFedReader : public DtFedReader
{
public:

   DtXmlFedReader();

   virtual ~DtXmlFedReader();

private:

   DtXmlFedReader( const DtXmlFedReader& );
   DtXmlFedReader& operator=( const DtXmlFedReader& );

public:

   virtual DtFedReadStatus readFedFilePtr(FILE* filePointer, DtFedTarget *fedTarget, DtFilename fileName,
      unsigned int strictCheckingMask=DtFedReadStrictDisabled, bool useDTD=false, bool dontParseSwitches=false ) = 0;

public:


   static DtFomType fomType(void* fedFilePtr);
   static DtFomType fomType(xmlNode*  rootNode);

   static xmlNode* getNodeByName(xmlNode* currentNode, const xmlChar* nodeName);

   static const xmlChar* childContentByName(xmlNode* node, const xmlChar *name);

protected:

   virtual DtFedReadStatus processFed(xmlNode* fedObj) = 0;
   
   virtual DtFedReadStatus parseTransportationsList(xmlNode* currentNode) = 0;

   virtual DtFedReadStatus processObjects(xmlNode* currentNode) = 0;

   virtual DtFedReadStatus processInteractions(xmlNode* currentNode) = 0;

   virtual DtFedReadStatus parseObjectTree(xmlNode* currentNode, const DtString& parentName) = 0;

   virtual DtFedReadStatus parseAttribute(xmlNode* currentNode, const DtString& parentName) = 0;

   virtual DtFedReadStatus parseAttributeDimensions( xmlNode* currentNode, DtString const& objectClass,
      DtString const& attribute) = 0;

   virtual DtFedReadStatus parseInteractionTree(xmlNode* currentNode, const DtString& parentName) = 0;

   virtual DtFedReadStatus parseInteractionDimensions(xmlNode *currentNode, DtString const& interactionClass) = 0;

   virtual DtFedReadStatus parseDimensionList(xmlNode* currentNode) = 0;

   virtual DtFedReadStatus parseDimension(xmlNode* currentNode) = 0;

   virtual DtFedReadStatus parseSwitches(xmlNode* currentNode) = 0;

   virtual DtFedReadStatus parseParameter(xmlNode* currentNode, const DtString& parentName) = 0;

   virtual DtFedReadStatus parseTransportationTree(xmlNode* currentNode);

   virtual DtFedReadStatus parseDataTypeTree(xmlNode* currentNode) = 0;

   virtual DtFedReadStatus parseNotesTree(xmlNode* currentNode) = 0;

   virtual DtFedReadStatus parseTagsTree(xmlNode* currentNode) = 0;

   virtual DtFedReadStatus parseBasicDataTypesTree(xmlNode* currentNode) = 0;

   virtual DtFedReadStatus parseSimpleDataTypesTree(xmlNode* currentNode) = 0;

   virtual DtFedReadStatus parseArrayDataTypesTree(xmlNode* currentNode) = 0;

   virtual DtFedReadStatus parseEnumeratedDataTypesTree(xmlNode* currentNode) = 0;

   virtual DtFedReadStatus parseFixedRecordDataTypesTree(xmlNode* currentNode) = 0;

   virtual DtFedReadStatus parseVariantRecordDataTypesTree(xmlNode* currentNode) = 0;

   virtual void appendNodeProperties(xmlNode*  currentNode, DtString& output) const;

   virtual void appendNodeContent(xmlNode*  node, DtString& output) const;

   virtual bool isBlankText(xmlNode*  node) const;

   virtual const xmlChar* propertyByName( xmlNode* node, const xmlChar *name);

   virtual bool getPropertyByName( xmlNode* node, const xmlChar *name, DtString& propertyContent);

   virtual bool getChildrenContent(xmlNode* node, DtString& content) const;

   virtual DtString childrenContent(xmlNode* node) const;

   virtual bool getChildContentByName(xmlNode* node, const xmlChar *name, DtString& childContent);

   virtual bool convertStringToULong(std::string numericString, unsigned long& value);

   // template supports char* (or other char like w_char) and also basic_string.
   template<typename stringType, typename charType> void clipPrefix(stringType& valueSpec, charType c);

protected:

   DtFedTarget* myFedTarget;
   DtFilename myFileBeingRead;

   protected:

      static const DtString theValueObjectRoot;
      static const DtString theValuePrivilegeToDelete;
      static const DtString theValueEnabled;

};

template<typename stringType, typename charType> void DtXmlFedReader::clipPrefix(stringType& valueSpec, charType c)
{
   typename stringType::size_type tokenPos = valueSpec.find_first_not_of(c);
   if (tokenPos != stringType::npos)
   {
      valueSpec.erase(0, tokenPos);
   }
}

#ifdef DtUSE_UTILITIES_NAMESPACE
} 
#endif