XMLWriter Class Reference

Base class for XMLFileWriter and XMLStringWriter that provides the general functionality for creating XML in UTF8 encoding. More...

#include <XMLWriter.h>

Inheritance diagram for XMLWriter:

Collaboration diagram for XMLWriter:

Public Member Functions
	XMLWriter ()
virtual	~XMLWriter ()
virtual void	StartTag (const wxString &name)
virtual void	EndTag (const wxString &name)
void	WriteAttr (const wxString &name, const Identifier &value)
virtual void	WriteAttr (const wxString &name, const wxString &value)
virtual void	WriteAttr (const wxString &name, const wxChar *value)
virtual void	WriteAttr (const wxString &name, int value)
virtual void	WriteAttr (const wxString &name, bool value)
virtual void	WriteAttr (const wxString &name, long value)
virtual void	WriteAttr (const wxString &name, long long value)
virtual void	WriteAttr (const wxString &name, size_t value)
virtual void	WriteAttr (const wxString &name, float value, int digits=-1)
virtual void	WriteAttr (const wxString &name, double value, int digits=-1)
virtual void	WriteData (const wxString &value)
virtual void	WriteSubTree (const wxString &value)
virtual void	Write (const wxString &data)=0

Protected Attributes
bool	mInTag
int	mDepth
wxArrayString	mTagstack
std::vector< int >	mHasKids

Static Private Member Functions
static wxString	XMLEsc (const wxString &s)

Detailed Description

Base class for XMLFileWriter and XMLStringWriter that provides the general functionality for creating XML in UTF8 encoding.

XMLWriter

Definition at line 25 of file XMLWriter.h.

Constructor & Destructor Documentation

XMLWriter()

XMLWriter::XMLWriter

(

)

XMLWriter base class

Definition at line 68 of file XMLWriter.cpp.

{
   mDepth = 0;
   mInTag = false;
   mHasKids.push_back(false);
}

References mDepth, mHasKids, and mInTag.

~XMLWriter()

XMLWriter::~XMLWriter ( )

virtual

Definition at line 75 of file XMLWriter.cpp.

{
}

Member Function Documentation

EndTag()

void XMLWriter::EndTag ( const wxString &  name )

virtual

Reimplemented in ProjectSerializer.

Definition at line 102 of file XMLWriter.cpp.

{
   int i;
 
   if (mTagstack.size() > 0) {
      if (mTagstack[0] == name) {
         if (mHasKids[1]) {  // There will always be at least 2 at this point
            if (mInTag) {
               Write(wxT("/>\n"));
            }
            else {
               for (i = 0; i < mDepth - 1; i++) {
                  Write(wxT("\t"));
               }
               Write(wxString::Format(wxT("</%s>\n"), name));
            }
         }
         else {
            Write(wxT(">\n"));
         }
         mTagstack.erase( mTagstack.begin() );
         mHasKids.erase(mHasKids.begin());
      }
   }
 
   mDepth--;
   mInTag = false;
}

References mDepth, mHasKids, mInTag, mTagstack, name, Write(), and wxT().

Referenced by ConvertLegacyTrack(), XMLFileWriter::PreCommit(), WaveTrack::WriteOneXML(), PluginDescriptor::WriteXML(), detail::PluginValidationResult::WriteXML(), RealtimeEffectState::WriteXML(), RealtimeEffectList::WriteXML(), and ProjectFileIO::WriteXML().

Here is the call graph for this function:

Here is the caller graph for this function:

StartTag()

void XMLWriter::StartTag ( const wxString &  name )

virtual

Reimplemented in ProjectSerializer.

Definition at line 79 of file XMLWriter.cpp.

{
   int i;
 
   if (mInTag) {
      Write(wxT(">\n"));
      mInTag = false;
   }
 
   for (i = 0; i < mDepth; i++) {
      Write(wxT("\t"));
   }
 
   Write(wxString::Format(wxT("<%s"), name));
 
   mTagstack.insert(mTagstack.begin(), name);
   mHasKids[0] = true;
   mHasKids.insert(mHasKids.begin(), false);
   mDepth++;
   mInTag = true;
}

References mDepth, mHasKids, mInTag, mTagstack, name, Write(), and wxT().

Referenced by ConvertLegacyTrack(), WaveTrack::WriteOneXML(), PluginDescriptor::WriteXML(), detail::PluginValidationResult::WriteXML(), RealtimeEffectState::WriteXML(), RealtimeEffectList::WriteXML(), and ProjectFileIO::WriteXML().

Here is the call graph for this function:

Here is the caller graph for this function:

Write()

virtual void XMLWriter::Write ( const wxString &  data )

pure virtual

Implemented in ProjectSerializer, XMLFileWriter, and XMLStringWriter.

Referenced by EndTag(), StartTag(), WriteAttr(), WriteData(), WriteSubTree(), and ProjectFileIO::WriteXMLHeader().

Here is the caller graph for this function:

WriteAttr() [1/10]

void XMLWriter::WriteAttr ( const wxString &  name, bool  value  )

virtual

Reimplemented in ProjectSerializer.

Definition at line 154 of file XMLWriter.cpp.

{
   Write(wxString::Format(wxT(" %s=\"%d\""),
      name,
      value));
}

References name, Write(), and wxT().

Here is the call graph for this function:

WriteAttr() [2/10]

void XMLWriter::WriteAttr ( const wxString &  name, const Identifier &  value  )

inline

Definition at line 36 of file XMLWriter.h.

      { WriteAttr( name, value.GET() ); }

References Identifier::GET(), and name.

Referenced by ConvertLegacyTrack(), SqliteSampleBlock::SaveXML(), WriteAttr(), Track::WriteCommonXMLAttributes(), WaveTrack::WriteOneXML(), PluginDescriptor::WriteXML(), detail::PluginValidationResult::WriteXML(), RealtimeEffectState::WriteXML(), RealtimeEffectList::WriteXML(), NoteTrackRange::WriteXML(), ProjectFileIO::WriteXML(), WaveformAppearance::WriteXMLAttributes(), WaveColorAttachment::WriteXMLAttributes(), ChannelView::WriteXMLAttributes(), and PlayableTrack::WriteXMLAttributes().

Here is the call graph for this function:

Here is the caller graph for this function:

WriteAttr() [3/10]

void XMLWriter::WriteAttr ( const wxString &  name, const wxChar *  value  )

virtual

Reimplemented in ProjectSerializer.

Definition at line 140 of file XMLWriter.cpp.

{
   WriteAttr(name, wxString(value));
}

References name, and WriteAttr().

Here is the call graph for this function:

WriteAttr() [4/10]

void XMLWriter::WriteAttr ( const wxString &  name, const wxString &  value  )

virtual

Reimplemented in ProjectSerializer.

Definition at line 132 of file XMLWriter.cpp.

{
   Write(wxString::Format(wxT(" %s=\"%s\""),
      name,
      XMLEsc(value)));
}

References name, Write(), wxT(), and XMLEsc().

Here is the call graph for this function:

WriteAttr() [5/10]

void XMLWriter::WriteAttr ( const wxString &  name, double  value, int  digits = -1  )

virtual

Reimplemented in ProjectSerializer.

Definition at line 194 of file XMLWriter.cpp.

{
   Write(wxString::Format(wxT(" %s=\"%s\""),
      name,
      Internat::ToString(value, digits)));
}

References name, Internat::ToString(), Write(), and wxT().

Here is the call graph for this function:

WriteAttr() [6/10]

void XMLWriter::WriteAttr ( const wxString &  name, float  value, int  digits = -1  )

virtual

Reimplemented in ProjectSerializer.

Definition at line 186 of file XMLWriter.cpp.

{
   Write(wxString::Format(wxT(" %s=\"%s\""),
      name,
      Internat::ToString(value, digits)));
}

References name, Internat::ToString(), Write(), and wxT().

Here is the call graph for this function:

WriteAttr() [7/10]

void XMLWriter::WriteAttr ( const wxString &  name, int  value  )

virtual

Reimplemented in ProjectSerializer.

Definition at line 146 of file XMLWriter.cpp.

{
   Write(wxString::Format(wxT(" %s=\"%d\""),
      name,
      value));
}

References name, Write(), and wxT().

Here is the call graph for this function:

WriteAttr() [8/10]

void XMLWriter::WriteAttr ( const wxString &  name, long long  value  )

virtual

Reimplemented in ProjectSerializer.

Definition at line 170 of file XMLWriter.cpp.

{
   Write(wxString::Format(wxT(" %s=\"%lld\""),
      name,
      value));
}

References name, Write(), and wxT().

Here is the call graph for this function:

WriteAttr() [9/10]

void XMLWriter::WriteAttr ( const wxString &  name, long  value  )

virtual

Reimplemented in ProjectSerializer.

Definition at line 162 of file XMLWriter.cpp.

{
   Write(wxString::Format(wxT(" %s=\"%ld\""),
      name,
      value));
}

References name, Write(), and wxT().

Here is the call graph for this function:

WriteAttr() [10/10]

void XMLWriter::WriteAttr ( const wxString &  name, size_t  value  )

virtual

Reimplemented in ProjectSerializer.

Definition at line 178 of file XMLWriter.cpp.

{
   Write(wxString::Format(wxT(" %s=\"%lld\""),
      name,
      (long long) value));
}

References name, Write(), and wxT().

Here is the call graph for this function:

WriteData()

void XMLWriter::WriteData ( const wxString &  value )

virtual

Reimplemented in ProjectSerializer.

Definition at line 202 of file XMLWriter.cpp.

{
   int i;
 
   for (i = 0; i < mDepth; i++) {
      Write(wxT("\t"));
   }
 
   Write(XMLEsc(value));
}

References mDepth, Write(), wxT(), and XMLEsc().

Here is the call graph for this function:

WriteSubTree()

void XMLWriter::WriteSubTree ( const wxString &  value )

virtual

Definition at line 214 of file XMLWriter.cpp.

{
   if (mInTag) {
      Write(wxT(">\n"));
      mInTag = false;
      mHasKids[0] = true;
   }
 
   Write(value);
}

References mHasKids, mInTag, Write(), and wxT().

Here is the call graph for this function:

XMLEsc()

wxString XMLWriter::XMLEsc ( const wxString &  s )

staticprivate

Definition at line 227 of file XMLWriter.cpp.

{
   wxString result;
   int len = s.length();
 
   for(int i=0; i<len; i++) {
      wxUChar c = s.GetChar(i);
 
      switch (c) {
         case wxT('\''):
            result += wxT("&apos;");
         break;
 
         case wxT('"'):
            result += wxT("&quot;");
         break;
 
         case wxT('&'):
            result += wxT("&amp;");
         break;
 
         case wxT('<'):
            result += wxT("&lt;");
         break;
 
         case wxT('>'):
            result += wxT("&gt;");
         break;
 
         default:
            if (sizeof(c) == 2 && c >= MIN_HIGH_SURROGATE && c <= MAX_HIGH_SURROGATE && i < len - 1) {
               // If wxUChar is 2 bytes, then supplementary characters (those greater than U+FFFF) are represented
               // with a high surrogate (U+D800..U+DBFF) followed by a low surrogate (U+DC00..U+DFFF).
               // Handle those here.
               wxUChar c2 = s.GetChar(++i);
               if (c2 >= MIN_LOW_SURROGATE && c2 <= MAX_LOW_SURROGATE) {
                  // Surrogate pair found; simply add it to the output string.
                  result += c;
                  result += c2;
               }
               else {
                  // That high surrogate isn't paired, so ignore it.
                  i--;
               }
            }
            else if (!wxIsprint(c)) {
               //ignore several characters such ase eot (0x04) and stx (0x02) because it makes expat parser bail
               //see xmltok.c in expat checkCharRefNumber() to see how expat bails on these chars.
               //also see wxWidgets-2.8.12/src/expat/lib/asciitab.h to see which characters are nonxml compatible
               //post decode (we can still encode '&' and '<' with this table, but it prevents us from encoding eot)
               //everything is compatible past ascii 0x20 except for surrogates and the noncharacters U+FFFE and U+FFFF,
               //so we don't check the compatibility table higher than this.
               if((c> 0x1F || charXMLCompatiblity[c]!=0) &&
                     (c < MIN_HIGH_SURROGATE || c > MAX_LOW_SURROGATE) &&
                     c != NONCHARACTER_FFFE && c != NONCHARACTER_FFFF)
                  result += wxString::Format(wxT("&#x%04x;"), c);
            }
            else {
               result += c;
            }
         break;
      }
   }
 
   return result;
}

References charXMLCompatiblity, MAX_HIGH_SURROGATE, MAX_LOW_SURROGATE, MIN_HIGH_SURROGATE, MIN_LOW_SURROGATE, NONCHARACTER_FFFE, NONCHARACTER_FFFF, and wxT().

Referenced by WriteAttr(), and WriteData().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mDepth

int XMLWriter::mDepth

protected

Definition at line 66 of file XMLWriter.h.

Referenced by EndTag(), StartTag(), WriteData(), and XMLWriter().

mHasKids

std::vector<int> XMLWriter::mHasKids

protected

Definition at line 68 of file XMLWriter.h.

Referenced by EndTag(), StartTag(), WriteSubTree(), and XMLWriter().

mInTag

bool XMLWriter::mInTag

protected

Definition at line 65 of file XMLWriter.h.

Referenced by EndTag(), StartTag(), WriteSubTree(), and XMLWriter().

mTagstack

wxArrayString XMLWriter::mTagstack

protected

Definition at line 67 of file XMLWriter.h.

Referenced by EndTag(), XMLFileWriter::PreCommit(), and StartTag().

---

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

• XMLWriter.h
• XMLWriter.cpp