XMLFileReader Class Reference

Reads a file and passes the results through an XMLTagHandler. More...

#include <XMLFileReader.h>

Collaboration diagram for XMLFileReader:

Public Member Functions
	XMLFileReader ()
	~XMLFileReader ()
bool	Parse (XMLTagHandler *baseHandler, const FilePath &fname)
bool	ParseString (XMLTagHandler *baseHandler, const wxString &xmldata)
bool	ParseMemoryStream (XMLTagHandler *baseHandler, const MemoryStream &xmldata)
const TranslatableString &	GetErrorStr () const
const TranslatableString &	GetLibraryErrorStr () const

Static Public Member Functions
static void	startElement (void *userData, const char *name, const char **atts)
static void	endElement (void *userData, const char *name)
static void	charHandler (void *userData, const char *s, int len)

Private Types
using	Handlers = std::vector< XMLTagHandler * >

Private Member Functions
bool	ParseBuffer (XMLTagHandler *baseHandler, const char *buffer, size_t len, bool isFinal)

Private Attributes
XML_Parser	mParser
XMLTagHandler *	mBaseHandler
Handlers	mHandler
TranslatableString	mErrorStr
TranslatableString	mLibraryErrorStr
AttributesList	mCurrentTagAttributes

Detailed Description

Reads a file and passes the results through an XMLTagHandler.

Definition at line 19 of file XMLFileReader.h.

Member Typedef Documentation

Handlers

using XMLFileReader::Handlers = std::vector<XMLTagHandler*>

private

Definition at line 49 of file XMLFileReader.h.

Constructor & Destructor Documentation

XMLFileReader()

XMLFileReader::XMLFileReader

(

)

Definition at line 26 of file XMLFileReader.cpp.

{
   mParser = XML_ParserCreate(NULL);
   XML_SetUserData(mParser, (void *)this);
   XML_SetElementHandler(mParser, startElement, endElement);
   XML_SetCharacterDataHandler(mParser, charHandler);
   mBaseHandler = NULL;
   mHandler.reserve(128);
}

References charHandler(), endElement(), mBaseHandler, mHandler, mParser, and startElement().

Here is the call graph for this function:

~XMLFileReader()

XMLFileReader::~XMLFileReader

(

)

Definition at line 36 of file XMLFileReader.cpp.

{
   XML_ParserFree(mParser);
}

References mParser.

Member Function Documentation

charHandler()

void XMLFileReader::charHandler ( void *  userData, const char *  s, int  len  )

static

Definition at line 242 of file XMLFileReader.cpp.

{
   XMLFileReader *This = (XMLFileReader *)userData;
   Handlers &handlers = This->mHandler;
 
   if (XMLTagHandler *const handler = handlers.back())
      handler->ReadXMLContent(s, len);
}

References audacity::cloud::audiocom::anonymous_namespace{AuthorizationHandler.cpp}::handler, and mHandler.

Referenced by XMLFileReader().

Here is the caller graph for this function:

endElement()

void XMLFileReader::endElement ( void *  userData, const char *  name  )

static

Definition at line 230 of file XMLFileReader.cpp.

{
   XMLFileReader *This = (XMLFileReader *)userData;
   Handlers &handlers = This->mHandler;
 
   if (XMLTagHandler *const handler = handlers.back())
      handler->ReadXMLEndTag(name);
 
   handlers.pop_back();
}

References audacity::cloud::audiocom::anonymous_namespace{AuthorizationHandler.cpp}::handler, mHandler, and name.

Referenced by XMLFileReader().

Here is the caller graph for this function:

GetErrorStr()

const TranslatableString & XMLFileReader::GetErrorStr

(

)

const

Definition at line 182 of file XMLFileReader.cpp.

{
   return mErrorStr;
}

References mErrorStr.

Referenced by AUPImportFileHandle::Import(), EQCurveReader::LoadCurves(), VSTWrapper::LoadXML(), KeyConfigPrefs::OnImport(), and TagsEditorDialog::OnLoad().

Here is the caller graph for this function:

GetLibraryErrorStr()

const TranslatableString & XMLFileReader::GetLibraryErrorStr

(

)

const

Definition at line 187 of file XMLFileReader.cpp.

{
   return mLibraryErrorStr;
}

References mLibraryErrorStr.

Parse()

bool XMLFileReader::Parse	(	XMLTagHandler *	baseHandler,
		const FilePath &	fname
	)

Definition at line 41 of file XMLFileReader.cpp.

{
   wxFFile theXMLFile(fname, wxT("rb"));
   if (!theXMLFile.IsOpened()) {
      mErrorStr = XO("Could not open file: \"%s\"").Format( fname );
      return false;
   }
 
   mBaseHandler = baseHandler;
 
   const size_t bufferSize = 16384;
   char buffer[16384];
   int done = 0;
   do {
      size_t len = fread(buffer, 1, bufferSize, theXMLFile.fp());
      done = (len < bufferSize);
      if (!XML_Parse(mParser, buffer, len, done)) {
 
         // Embedded error string from expat doesn't translate (yet)
         // We could make a table of XOs if we wanted so that it could
         // If we do, uncomment the second constructor argument so it's not
         // a verbatim string
         mLibraryErrorStr = Verbatim(
            XML_ErrorString(XML_GetErrorCode(mParser)) // , {}
         );
 
         mErrorStr = XO("Error: %s at line %lu").Format(
            mLibraryErrorStr,
            (long unsigned int)XML_GetCurrentLineNumber(mParser)
         );
 
         theXMLFile.Close();
         return false;
 
// If we did want to handle every single parse error, these are they....
/*
    XML_L("out of memory"),
    XML_L("syntax error"),
    XML_L("no element found"),
    XML_L("not well-formed (invalid token)"),
    XML_L("unclosed token"),
    XML_L("partial character"),
    XML_L("mismatched tag"),
    XML_L("duplicate attribute"),
    XML_L("junk after document element"),
    XML_L("illegal parameter entity reference"),
    XML_L("undefined entity"),
    XML_L("recursive entity reference"),
    XML_L("asynchronous entity"),
    XML_L("reference to invalid character number"),
    XML_L("reference to binary entity"),
    XML_L("reference to external entity in attribute"),
    XML_L("XML or text declaration not at start of entity"),
    XML_L("unknown encoding"),
    XML_L("encoding specified in XML declaration is incorrect"),
    XML_L("unclosed CDATA section"),
    XML_L("error in processing external entity reference"),
    XML_L("document is not standalone"),
    XML_L("unexpected parser state - please send a bug report"),
    XML_L("entity declared in parameter entity"),
    XML_L("requested feature requires XML_DTD support in Expat"),
    XML_L("cannot change setting once parsing has begun"),
    XML_L("unbound prefix"),
    XML_L("must not undeclare prefix"),
    XML_L("incomplete markup in parameter entity"),
    XML_L("XML declaration not well-formed"),
    XML_L("text declaration not well-formed"),
    XML_L("illegal character(s) in public id"),
    XML_L("parser suspended"),
    XML_L("parser not suspended"),
    XML_L("parsing aborted"),
    XML_L("parsing finished"),
    XML_L("cannot suspend in external parameter entity"),
    XML_L("reserved prefix (xml) must not be undeclared or bound to another namespace name"),
    XML_L("reserved prefix (xmlns) must not be declared or undeclared"),
    XML_L("prefix must not be bound to one of the reserved namespace names")
*/
      }
   } while (!done);
 
   theXMLFile.Close();
 
   // Even though there were no parse errors, we only succeed if
   // the first-level handler actually got called, and didn't
   // return false.
   if (mBaseHandler)
      return true;
   else {
      mErrorStr = XO("Could not load file: \"%s\"").Format( fname );
      return false;
   }
}

References mBaseHandler, mErrorStr, mLibraryErrorStr, mParser, Verbatim(), wxT(), and XO().

Referenced by FFmpegPresets::FFmpegPresets(), AUPImportFileHandle::Import(), FFmpegPresets::ImportPresets(), EQCurveReader::LoadCurves(), anonymous_namespace{MenuHelper.cpp}::LoadEffectsMenuGroups(), VSTWrapper::LoadXML(), KeyConfigPrefs::OnImport(), TagsEditorDialog::OnLoad(), and EQCurveReader::UpdateDefaultCurves().

Here is the call graph for this function:

Here is the caller graph for this function:

ParseBuffer()

bool XMLFileReader::ParseBuffer ( XMLTagHandler *  baseHandler, const char *  buffer, size_t  len, bool  isFinal  )

private

Definition at line 251 of file XMLFileReader.cpp.

{
   if (!XML_Parse(mParser, buffer, len, isFinal))
   {
 
      // Embedded error string from expat doesn't translate (yet)
      // We could make a table of XOs if we wanted so that it could
      // If we do, uncomment the second constructor argument so it's not
      // a verbatim string
      mLibraryErrorStr =
         Verbatim(XML_ErrorString(XML_GetErrorCode(mParser)) // , {}
         );
 
      mErrorStr = XO("Error: %s at line %lu")
                     .Format(
                        mLibraryErrorStr,
                        (long unsigned int)XML_GetCurrentLineNumber(mParser));
 
      wxLogMessage(
         wxT("ParseString error: %s\n===begin===%s\n===end==="),
         mErrorStr.Debug(), buffer);
 
      return false;
   }
 
   return true;
}

References TranslatableString::Debug(), mErrorStr, mLibraryErrorStr, mParser, Verbatim(), wxT(), and XO().

Referenced by ParseMemoryStream(), and ParseString().

Here is the call graph for this function:

Here is the caller graph for this function:

ParseMemoryStream()

bool XMLFileReader::ParseMemoryStream	(	XMLTagHandler *	baseHandler,
		const MemoryStream &	xmldata
	)

Definition at line 159 of file XMLFileReader.cpp.

{
   mBaseHandler = baseHandler;
 
   for (auto chunk : xmldata)
   {
      if (!ParseBuffer(baseHandler, static_cast<const char*>(chunk.first), chunk.second, false))
         return false;
   }
 
   if (!ParseBuffer(baseHandler, nullptr, 0, true))
      return false;
 
   if (!mBaseHandler)
   {
      mErrorStr = XO("Could not parse XML");
      return false;
   }
 
   return true;
}

References mBaseHandler, mErrorStr, ParseBuffer(), and XO().

Here is the call graph for this function:

ParseString()

bool XMLFileReader::ParseString	(	XMLTagHandler *	baseHandler,
		const wxString &	xmldata
	)

Definition at line 135 of file XMLFileReader.cpp.

{
   auto utf8 = xmldata.ToUTF8();
   const char *buffer = utf8.data();
   int len = utf8.length();
 
   mBaseHandler = baseHandler;
 
   if (!ParseBuffer(baseHandler, utf8.data(), utf8.length(), true))
      return false;
 
   // Even though there were no parse errors, we only succeed if
   // the first-level handler actually got called, and didn't
   // return false.
   if (!mBaseHandler)
   {
      mErrorStr = XO("Could not parse XML");
      return false;
   }
 
   return true;
}

References mBaseHandler, mErrorStr, ParseBuffer(), and XO().

Referenced by AsyncPluginValidator::Impl::OnDataAvailable(), and UpdateDataParser::Parse().

Here is the call graph for this function:

Here is the caller graph for this function:

startElement()

void XMLFileReader::startElement ( void *  userData, const char *  name, const char **  atts  )

static

Definition at line 193 of file XMLFileReader.cpp.

{
   XMLFileReader *This = (XMLFileReader *)userData;
   Handlers &handlers = This->mHandler;
 
   if (handlers.empty()) {
      handlers.push_back(This->mBaseHandler);
   }
   else {
      if (XMLTagHandler *const handler = handlers.back())
         handlers.push_back(handler->ReadXMLChild(name));
      else
         handlers.push_back(NULL);
   }
 
   if (XMLTagHandler *& handler = handlers.back()) {
      This->mCurrentTagAttributes.clear();
 
      while(*atts)
      {
         const char* name = *atts++;
         const char* value = *atts++;
 
         This->mCurrentTagAttributes.emplace_back(
            std::string_view(name), XMLAttributeValueView(std::string_view(value)));
      }
 
      if (!handler->HandleXMLTag(name, This->mCurrentTagAttributes)) {
         handler = nullptr;
         if (handlers.size() == 1)
            This->mBaseHandler = nullptr;
      }
   }
}

References audacity::cloud::audiocom::anonymous_namespace{AuthorizationHandler.cpp}::handler, mBaseHandler, mCurrentTagAttributes, mHandler, and name.

Referenced by XMLFileReader().

Here is the caller graph for this function:

Member Data Documentation

mBaseHandler

XMLTagHandler* XMLFileReader::mBaseHandler

private

Definition at line 48 of file XMLFileReader.h.

Referenced by Parse(), ParseMemoryStream(), ParseString(), startElement(), and XMLFileReader().

mCurrentTagAttributes

AttributesList XMLFileReader::mCurrentTagAttributes

private

Definition at line 55 of file XMLFileReader.h.

Referenced by startElement().

mErrorStr

TranslatableString XMLFileReader::mErrorStr

private

Definition at line 51 of file XMLFileReader.h.

Referenced by GetErrorStr(), Parse(), ParseBuffer(), ParseMemoryStream(), and ParseString().

mHandler

Handlers XMLFileReader::mHandler

private

Definition at line 50 of file XMLFileReader.h.

Referenced by charHandler(), endElement(), startElement(), and XMLFileReader().

mLibraryErrorStr

TranslatableString XMLFileReader::mLibraryErrorStr

private

Definition at line 52 of file XMLFileReader.h.

Referenced by GetLibraryErrorStr(), Parse(), and ParseBuffer().

mParser

XML_Parser XMLFileReader::mParser

private

Definition at line 47 of file XMLFileReader.h.

Referenced by Parse(), ParseBuffer(), XMLFileReader(), and ~XMLFileReader().

---

The documentation for this class was generated from the following files:

• XMLFileReader.h
• XMLFileReader.cpp