XMLUtf8BufferWriter Class Reference

#include <XMLWriter.h>

Collaboration diagram for XMLUtf8BufferWriter:

Public Member Functions
void	StartTag (const std::string_view &name)
void	EndTag (const std::string_view &name)
void	WriteAttr (const std::string_view &name, const Identifier &value)
void	WriteAttr (const std::string_view &name, const std::string_view &value)
void	WriteAttr (const std::string_view &name, int value)
void	WriteAttr (const std::string_view &name, bool value)
void	WriteAttr (const std::string_view &name, long value)
void	WriteAttr (const std::string_view &name, long long value)
void	WriteAttr (const std::string_view &name, size_t value)
void	WriteAttr (const std::string_view &name, float value, int digits=-1)
void	WriteAttr (const std::string_view &name, double value, int digits=-1)
void	WriteData (const std::string_view &value)
void	WriteSubTree (const std::string_view &value)
void	Write (const std::string_view &value)
MemoryStream	ConsumeResult ()

Private Member Functions
void	WriteEscaped (const std::string_view &value)

Private Attributes
MemoryStream	mStream
bool	mInTag { false }

Detailed Description

Definition at line 152 of file XMLWriter.h.

Member Function Documentation

ConsumeResult()

MemoryStream XMLUtf8BufferWriter::ConsumeResult

(

)

Definition at line 578 of file XMLWriter.cpp.

{
   return std::move(mStream);
}

References mStream.

EndTag()

void XMLUtf8BufferWriter::EndTag

(

const std::string_view &

name

)

Definition at line 446 of file XMLWriter.cpp.

{
   if (mInTag)
   {
      Write("/>");
      mInTag = false;
   }
   else
   {
      Write("</");
      Write(name);
      Write(">");
   }
}

References mInTag, name, and Write().

Here is the call graph for this function:

StartTag()

void XMLUtf8BufferWriter::StartTag

(

const std::string_view &

name

)

Definition at line 435 of file XMLWriter.cpp.

{
   if (mInTag)
      Write(">");
 
   Write("<");
   Write(name);
 
   mInTag = true;
}

References mInTag, name, and Write().

Here is the call graph for this function:

Write()

void XMLUtf8BufferWriter::Write

(

const std::string_view &

value

)

Definition at line 573 of file XMLWriter.cpp.

{
   mStream.AppendData(value.data(), value.length());
}

References MemoryStream::AppendData(), and mStream.

Referenced by EndTag(), StartTag(), WriteAttr(), WriteData(), WriteEscaped(), and WriteSubTree().

Here is the call graph for this function:

Here is the caller graph for this function:

WriteAttr() [1/9]

void XMLUtf8BufferWriter::WriteAttr	(	const std::string_view &	name,
		bool	value
	)

Definition at line 485 of file XMLWriter.cpp.

{
   WriteAttr(name, static_cast<long long>(value));
}

References name, and WriteAttr().

Here is the call graph for this function:

WriteAttr() [2/9]

void XMLUtf8BufferWriter::WriteAttr	(	const std::string_view &	name,
		const Identifier &	value
	)

Definition at line 461 of file XMLWriter.cpp.

{
   const wxScopedCharBuffer utf8Value = value.GET().utf8_str();
 
   WriteAttr(name, { utf8Value.data(), utf8Value.length() });
}

References Identifier::GET(), name, and WriteAttr().

Referenced by WriteAttr().

Here is the call graph for this function:

Here is the caller graph for this function:

WriteAttr() [3/9]

void XMLUtf8BufferWriter::WriteAttr	(	const std::string_view &	name,
		const std::string_view &	value
	)

Definition at line 468 of file XMLWriter.cpp.

{
   assert(mInTag);
 
   Write(" ");
   Write(name);
   Write("=\"");
   WriteEscaped(value);
   Write("\"");
}

References mInTag, name, Write(), and WriteEscaped().

Here is the call graph for this function:

WriteAttr() [4/9]

void XMLUtf8BufferWriter::WriteAttr	(	const std::string_view &	name,
		double	value,
		int	digits = -1
	)

Definition at line 534 of file XMLWriter.cpp.

{
   constexpr size_t bufferSize = std::numeric_limits<double>::max_digits10 +
                                 5 + // No constexpr log2 yet!
                                 3;  // Dot, sign an 0 separator
 
   char buffer[bufferSize];
 
   const auto result = ToChars(buffer, buffer + bufferSize, value, digits);
 
   if (result.ec != std::errc())
      THROW_INCONSISTENCY_EXCEPTION;
 
   WriteAttr(name, std::string_view(buffer, result.ptr - buffer));
}

References name, THROW_INCONSISTENCY_EXCEPTION, ToChars(), and WriteAttr().

Here is the call graph for this function:

WriteAttr() [5/9]

void XMLUtf8BufferWriter::WriteAttr	(	const std::string_view &	name,
		float	value,
		int	digits = -1
	)

Definition at line 517 of file XMLWriter.cpp.

{
   constexpr size_t bufferSize = std::numeric_limits<float>::max_digits10 +
                                 5 + // No constexpr log2 yet! example - e-308
                                 3; // Dot, sign an 0 separator
 
   char buffer[bufferSize];
 
   const auto result = ToChars(buffer, buffer + bufferSize, value, digits);
 
   if (result.ec != std::errc())
      THROW_INCONSISTENCY_EXCEPTION;
 
   WriteAttr(name, std::string_view(buffer, result.ptr - buffer));
}

References name, THROW_INCONSISTENCY_EXCEPTION, ToChars(), and WriteAttr().

Here is the call graph for this function:

WriteAttr() [6/9]

void XMLUtf8BufferWriter::WriteAttr	(	const std::string_view &	name,
		int	value
	)

Definition at line 480 of file XMLWriter.cpp.

{
   WriteAttr(name, static_cast<long long>(value));
}

References name, and WriteAttr().

Here is the call graph for this function:

WriteAttr() [7/9]

void XMLUtf8BufferWriter::WriteAttr	(	const std::string_view &	name,
		long long	value
	)

Definition at line 496 of file XMLWriter.cpp.

{
   // -9223372036854775807 is the worst case
   constexpr size_t bufferSize = 21;
   char buffer[bufferSize];
 
   const auto result = ToChars(buffer, buffer + bufferSize, value);
 
   if (result.ec != std::errc())
      THROW_INCONSISTENCY_EXCEPTION;
 
   WriteAttr(name, std::string_view(buffer, result.ptr - buffer));
}

References name, THROW_INCONSISTENCY_EXCEPTION, ToChars(), and WriteAttr().

Here is the call graph for this function:

WriteAttr() [8/9]

void XMLUtf8BufferWriter::WriteAttr	(	const std::string_view &	name,
		long	value
	)

Definition at line 490 of file XMLWriter.cpp.

{
   // long can be int or long long. Assume the longest!
   WriteAttr(name, static_cast<long long>(value));
}

References name, and WriteAttr().

Here is the call graph for this function:

WriteAttr() [9/9]

void XMLUtf8BufferWriter::WriteAttr	(	const std::string_view &	name,
		size_t	value
	)

Definition at line 511 of file XMLWriter.cpp.

{
   // Well, that maintains the original behavior
   WriteAttr(name, static_cast<long long>(value));
}

References name, and WriteAttr().

Here is the call graph for this function:

WriteData()

void XMLUtf8BufferWriter::WriteData

(

const std::string_view &

value

)

Definition at line 551 of file XMLWriter.cpp.

{
   if (mInTag)
   {
      Write(">");
      mInTag = false;
   }
 
   WriteEscaped(value);
}

References mInTag, Write(), and WriteEscaped().

Here is the call graph for this function:

WriteEscaped()

void XMLUtf8BufferWriter::WriteEscaped ( const std::string_view &  value )

private

Definition at line 583 of file XMLWriter.cpp.

{
   for (auto c : value)
   {
      switch (c)
      {
      case wxT('\''):
         Write("'");
         break;
 
      case wxT('"'):
         Write(""");
         break;
 
      case wxT('&'):
         Write("&");
         break;
 
      case wxT('<'):
         Write("&lt;");
         break;
 
      case wxT('>'):
         Write("&gt;");
         break;
      default:
         if (static_cast<uint8_t>(c) > 0x1F || charXMLCompatiblity[c] != 0)
            mStream.AppendByte(c);
      }
   }
}

References MemoryStream::AppendByte(), charXMLCompatiblity, mStream, Write(), and wxT().

Referenced by WriteAttr(), and WriteData().

Here is the call graph for this function:

Here is the caller graph for this function:

WriteSubTree()

void XMLUtf8BufferWriter::WriteSubTree

(

const std::string_view &

value

)

Definition at line 562 of file XMLWriter.cpp.

{
   if (mInTag)
   {
      Write(">");
      mInTag = false;
   }
 
   Write(value);
}

References mInTag, and Write().

Here is the call graph for this function:

Member Data Documentation

mInTag

bool XMLUtf8BufferWriter::mInTag { false }

private

Definition at line 184 of file XMLWriter.h.

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

mStream

MemoryStream XMLUtf8BufferWriter::mStream

private

Definition at line 182 of file XMLWriter.h.

Referenced by ConsumeResult(), Write(), and WriteEscaped().

---

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

• XMLWriter.h
• XMLWriter.cpp