a class used to (de)serialize the project catalog More...

#include <ProjectSerializer.h>

Inheritance diagram for ProjectSerializer:

Collaboration diagram for ProjectSerializer:

Public Member Functions
	ProjectSerializer (size_t allocSize=1024 *1024)

virtual	~ProjectSerializer ()

void	StartTag (const wxString &name) override

void	EndTag (const wxString &name) override

void	WriteAttr (const wxString &name, const wxString &value) override

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

void	WriteAttr (const wxString &name, int value) override

void	WriteAttr (const wxString &name, bool value) override

void	WriteAttr (const wxString &name, long value) override

void	WriteAttr (const wxString &name, long long value) override

void	WriteAttr (const wxString &name, size_t value) override

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

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

void	WriteData (const wxString &value) override

void	Write (const wxString &data) override

const MemoryStream &	GetDict () const

const MemoryStream &	GetData () const

bool	IsEmpty () const

bool	DictChanged () const

Public Member Functions inherited from XMLWriter
	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

Static Public Member Functions
static TranslatableString	FailureMessage (const FilePath &filePath)

static bool	Decode (BufferedStreamReader &in, XMLTagHandler *handler)

Private Member Functions
void	WriteName (const wxString &name)

Private Attributes
MemoryStream	mBuffer

bool	mDictChanged

Static Private Attributes
static NameMap	mNames

static MemoryStream	mDict

Additional Inherited Members
Protected Attributes inherited from XMLWriter
bool	mInTag

int	mDepth

wxArrayString	mTagstack

std::vector< int >	mHasKids

Detailed Description

a class used to (de)serialize the project catalog

Definition at line 36 of file ProjectSerializer.h.

Constructor & Destructor Documentation

◆ ProjectSerializer()

ProjectSerializer::ProjectSerializer ( size_t allocSize = 1024 * 1024 )

Definition at line 350 of file ProjectSerializer.cpp.

{
   static std::once_flag flag;
   std::call_once(flag, []{
      // Just once per run, store header information in the unique static
      // dictionary that will be written into each project that is saved.
      // Store the size of "wxStringCharType" so we can convert during recovery
      // in case the file is used on a system with a different character size.
      char size = sizeof(wxStringCharType);
      mDict.AppendByte(FT_CharSize);
      mDict.AppendData(&size, 1);
   });
 
   mDictChanged = false;
}

References MemoryStream::AppendByte(), MemoryStream::AppendData(), flag, FT_CharSize, mDict, mDictChanged, and size.

Here is the call graph for this function:

◆ ~ProjectSerializer()

ProjectSerializer::~ProjectSerializer ( )

virtual

Definition at line 366 of file ProjectSerializer.cpp.

367{

368}

Member Function Documentation

◆ Decode()

bool ProjectSerializer::Decode	(	BufferedStreamReader &	in,
		XMLTagHandler *	handler
	)

static

Definition at line 523 of file ProjectSerializer.cpp.

{
   if (handler == nullptr)
      return false;
 
   XMLTagHandlerAdapter adapter(handler);
 
   std::vector<char> bytes;
   IdMap mIds;
   std::vector<IdMap> mIdStack;
   char mCharSize = 0;
 
   mIds.clear();
 
   struct Error{}; // exception type for short-range try/catch
   auto Lookup = [&mIds]( UShort id ) -> std::string_view
   {
      auto iter = mIds.find( id );
      if (iter == mIds.end())
      {
         throw Error{};
      }
 
      return iter->second;
   };
 
   int64_t stringsCount = 0;
   int64_t stringsLength = 0;
 
   auto ReadString = [&mCharSize, &in, &bytes, &stringsCount, &stringsLength](int len) -> std::string
   {
      bytes.reserve( len );
      auto data = bytes.data();
      in.Read( data, len );
 
      stringsCount++;
      stringsLength += len;
      
      switch (mCharSize)
      {
         case 1:
            return std::string(bytes.data(), len);
 
         case 2:
            return FastStringConvert<char16_t>(bytes.data(), len);
 
         case 4:
            return FastStringConvert<char32_t>(bytes.data(), len);
 
         default:
            wxASSERT_MSG(false, wxT("Characters size not 1, 2, or 4"));
         break;
      }
 
      return {};
   };
 
   try
   {
      while (!in.Eof())
      {
         UShort id;
 
         switch (in.GetC())
         {
            case FT_Push:
            {
               mIdStack.push_back(mIds);
               mIds.clear();
            }
            break;
 
            case FT_Pop:
            {
               mIds = mIdStack.back();
               mIdStack.pop_back();
            }
            break;
 
            case FT_Name:
            {
               id = ReadUShort( in );
               auto len = ReadUShort( in );
               mIds[id] = ReadString(len);
            }
            break;
 
            case FT_StartTag:
            {
               id = ReadUShort( in );
 
               adapter.EmitStartTag(Lookup(id));
            }
            break;
 
            case FT_EndTag:
            {
               id = ReadUShort( in );
 
               adapter.EndTag(Lookup(id));
            }
            break;
 
            case FT_String:
            {
               id = ReadUShort( in );
               int len = ReadLength( in );
               
               adapter.WriteAttr(Lookup(id), ReadString(len));
            }
            break;
 
            case FT_Float:
            {
               float val;
 
               id = ReadUShort( in );
               in.Read(&val, sizeof(val));
               /* int dig = */ReadDigits(in);
 
               adapter.WriteAttr(Lookup(id), val);
            }
            break;
 
            case FT_Double:
            {
               double val;
 
               id = ReadUShort( in );
               in.Read(&val, sizeof(val));
               /*int dig = */ReadDigits(in);
 
               adapter.WriteAttr(Lookup(id), val);
            }
            break;
 
            case FT_Int:
            {
               id = ReadUShort( in );
               int val = ReadInt( in );
 
               adapter.WriteAttr(Lookup(id), val);
            }
            break;
 
            case FT_Bool:
            {
               unsigned char val;
 
               id = ReadUShort( in );
               in.Read(&val, 1);
 
               adapter.WriteAttr(Lookup(id), val);
            }
            break;
 
            case FT_Long:
            {
               id = ReadUShort( in );
               long val = ReadLong( in );
 
               adapter.WriteAttr(Lookup(id), val);
            }
            break;
 
            case FT_LongLong:
            {
               id = ReadUShort( in );
               long long val = ReadLongLong( in );
               adapter.WriteAttr(Lookup(id), val);
            }
            break;
 
            case FT_SizeT:
            {
               id = ReadUShort( in );
               size_t val = ReadULong( in );
 
               adapter.WriteAttr(Lookup(id), val);
            }
            break;
 
            case FT_Data:
            {
               int len = ReadLength( in );
               adapter.WriteData(ReadString(len));
            }
            break;
 
            case FT_Raw:
            {
               int len = ReadLength( in );
               adapter.WriteRaw(ReadString(len));
            }
            break;
 
            case FT_CharSize:
            {
               in.Read(&mCharSize, 1);
            }
            break;
 
            default:
               wxASSERT(true);
            break;
         }
      }
   }
   catch( const Error& )
   {
      // Document was corrupt, or platform differences in size or endianness
      // were not well canonicalized
      return false;
   }
 
   wxLogInfo(
      "Loaded %lld string %f Kb in size", stringsCount, stringsLength / 1024.0);
 
   return adapter.Finalize();
}

References Error, FT_Bool, FT_CharSize, FT_Data, FT_Double, FT_EndTag, FT_Float, FT_Int, FT_Long, FT_LongLong, FT_Name, FT_Pop, FT_Push, FT_Raw, FT_SizeT, FT_StartTag, FT_String, audacity::cloud::audiocom::anonymous_namespace{AuthorizationHandler.cpp}::handler, id, NumericConverterFormats::Lookup(), BufferedStreamReader::Read(), anonymous_namespace{ProjectSerializer.cpp}::ReadDigits, anonymous_namespace{ProjectSerializer.cpp}::ReadInt, anonymous_namespace{ProjectSerializer.cpp}::ReadLength, anonymous_namespace{ProjectSerializer.cpp}::ReadLong, anonymous_namespace{ProjectSerializer.cpp}::ReadLongLong, anonymous_namespace{ProjectSerializer.cpp}::ReadULong, anonymous_namespace{ProjectSerializer.cpp}::ReadUShort, and wxT().

Referenced by ProjectFileIO::LoadProject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DictChanged()

bool ProjectSerializer::DictChanged ( ) const

Definition at line 517 of file ProjectSerializer.cpp.

{
   return mDictChanged;
}

References mDictChanged.

◆ EndTag()

void ProjectSerializer::EndTag ( const wxString & name )

overridevirtual

Reimplemented from XMLWriter.

Definition at line 376 of file ProjectSerializer.cpp.

{
   mBuffer.AppendByte(FT_EndTag);
   WriteName(name);
}

References MemoryStream::AppendByte(), FT_EndTag, mBuffer, name, and WriteName().

Here is the call graph for this function:

◆ FailureMessage()

TranslatableString ProjectSerializer::FailureMessage ( const FilePath & filePath )

static

Definition at line 90 of file ProjectSerializer.cpp.

{
   return 
XO("This recovery file was saved by Audacity 2.3.0 or before.\n"
   "You need to run that version of Audacity to recover the project." );
}

References XO().

Here is the call graph for this function:

◆ GetData()

const MemoryStream & ProjectSerializer::GetData ( ) const

Definition at line 507 of file ProjectSerializer.cpp.

{
   return mBuffer;
}

References mBuffer.

Referenced by audacity::cloud::audiocom::sync::ProjectCloudExtension::OnUpdateSaved(), and ProjectFileIO::WriteDoc().

Here is the caller graph for this function:

◆ GetDict()

const MemoryStream & ProjectSerializer::GetDict ( ) const

Definition at line 502 of file ProjectSerializer.cpp.

{
   return mDict;
}

References mDict.

Referenced by audacity::cloud::audiocom::sync::ProjectCloudExtension::OnUpdateSaved(), and ProjectFileIO::WriteDoc().

Here is the caller graph for this function:

◆ IsEmpty()

bool ProjectSerializer::IsEmpty ( ) const

Definition at line 512 of file ProjectSerializer.cpp.

{
   return mBuffer.GetSize() == 0;
}

References MemoryStream::GetSize(), and mBuffer.

Here is the call graph for this function:

◆ StartTag()

void ProjectSerializer::StartTag ( const wxString & name )

overridevirtual

Reimplemented from XMLWriter.

Definition at line 370 of file ProjectSerializer.cpp.

{
   mBuffer.AppendByte(FT_StartTag);
   WriteName(name);
}

References MemoryStream::AppendByte(), FT_StartTag, mBuffer, name, and WriteName().

Here is the call graph for this function:

◆ Write()

void ProjectSerializer::Write ( const wxString & data )

overridevirtual

Implements XMLWriter.

Definition at line 464 of file ProjectSerializer.cpp.

{
   mBuffer.AppendByte(FT_Raw);
   Length len = value.length() * sizeof(wxStringCharType);
   WriteLength( mBuffer, len );
   mBuffer.AppendData(value.wx_str(), len);
}

References MemoryStream::AppendByte(), MemoryStream::AppendData(), FT_Raw, mBuffer, and anonymous_namespace{ProjectSerializer.cpp}::WriteLength.

Here is the call graph for this function:

◆ WriteAttr() [1/9]

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

overridevirtual

Reimplemented from XMLWriter.

Definition at line 405 of file ProjectSerializer.cpp.

{
   mBuffer.AppendByte(FT_Bool);
   WriteName(name);
 
   mBuffer.AppendByte(value);
}

References MemoryStream::AppendByte(), FT_Bool, mBuffer, name, and WriteName().

Here is the call graph for this function:

◆ WriteAttr() [2/9]

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

overridevirtual

Reimplemented from XMLWriter.

Definition at line 382 of file ProjectSerializer.cpp.

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

References name, and WriteAttr().

Here is the call graph for this function:

◆ WriteAttr() [3/9]

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

overridevirtual

Reimplemented from XMLWriter.

Definition at line 387 of file ProjectSerializer.cpp.

{
   mBuffer.AppendByte(FT_String);
   WriteName(name);
 
   const Length len = value.length() * sizeof(wxStringCharType);
   WriteLength( mBuffer, len );
   mBuffer.AppendData(value.wx_str(), len);
}

References MemoryStream::AppendByte(), MemoryStream::AppendData(), FT_String, mBuffer, name, anonymous_namespace{ProjectSerializer.cpp}::WriteLength, and WriteName().

Referenced by WriteAttr().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WriteAttr() [4/9]

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

overridevirtual

Reimplemented from XMLWriter.

Definition at line 446 of file ProjectSerializer.cpp.

{
   mBuffer.AppendByte(FT_Double);
   WriteName(name);
 
   mBuffer.AppendData(&value, sizeof(value));
   WriteDigits( mBuffer, digits );
}

References MemoryStream::AppendByte(), MemoryStream::AppendData(), FT_Double, mBuffer, name, anonymous_namespace{ProjectSerializer.cpp}::WriteDigits, and WriteName().

Here is the call graph for this function:

◆ WriteAttr() [5/9]

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

overridevirtual

Reimplemented from XMLWriter.

Definition at line 437 of file ProjectSerializer.cpp.

{
   mBuffer.AppendByte(FT_Float);
   WriteName(name);
 
   mBuffer.AppendData(&value, sizeof(value));
   WriteDigits( mBuffer, digits );
}

References MemoryStream::AppendByte(), MemoryStream::AppendData(), FT_Float, mBuffer, name, anonymous_namespace{ProjectSerializer.cpp}::WriteDigits, and WriteName().

Here is the call graph for this function:

◆ WriteAttr() [6/9]

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

overridevirtual

Reimplemented from XMLWriter.

Definition at line 397 of file ProjectSerializer.cpp.

{
   mBuffer.AppendByte(FT_Int);
   WriteName(name);
 
   WriteInt( mBuffer, value );
}

References MemoryStream::AppendByte(), FT_Int, mBuffer, name, anonymous_namespace{ProjectSerializer.cpp}::WriteInt, and WriteName().

Here is the call graph for this function:

◆ WriteAttr() [7/9]

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

overridevirtual

Reimplemented from XMLWriter.

Definition at line 421 of file ProjectSerializer.cpp.

{
   mBuffer.AppendByte(FT_LongLong);
   WriteName(name);
 
   WriteLongLong( mBuffer, value );
}

References MemoryStream::AppendByte(), FT_LongLong, mBuffer, name, anonymous_namespace{ProjectSerializer.cpp}::WriteLongLong, and WriteName().

Here is the call graph for this function:

◆ WriteAttr() [8/9]

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

overridevirtual

Reimplemented from XMLWriter.

Definition at line 413 of file ProjectSerializer.cpp.

{
   mBuffer.AppendByte(FT_Long);
   WriteName(name);
 
   WriteLong( mBuffer, value );
}

References MemoryStream::AppendByte(), FT_Long, mBuffer, name, anonymous_namespace{ProjectSerializer.cpp}::WriteLong, and WriteName().

Here is the call graph for this function:

◆ WriteAttr() [9/9]

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

overridevirtual

Reimplemented from XMLWriter.

Definition at line 429 of file ProjectSerializer.cpp.

{
   mBuffer.AppendByte(FT_SizeT);
   WriteName(name);
 
   WriteULong( mBuffer, value );
}

References MemoryStream::AppendByte(), FT_SizeT, mBuffer, name, WriteName(), and anonymous_namespace{ProjectSerializer.cpp}::WriteULong.

Here is the call graph for this function:

◆ WriteData()

void ProjectSerializer::WriteData ( const wxString & value )

overridevirtual

Reimplemented from XMLWriter.

Definition at line 455 of file ProjectSerializer.cpp.

{
   mBuffer.AppendByte(FT_Data);
 
   Length len = value.length() * sizeof(wxStringCharType);
   WriteLength( mBuffer, len );
   mBuffer.AppendData(value.wx_str(), len);
}

References MemoryStream::AppendByte(), MemoryStream::AppendData(), FT_Data, mBuffer, and anonymous_namespace{ProjectSerializer.cpp}::WriteLength.

Here is the call graph for this function:

◆ WriteName()

void ProjectSerializer::WriteName ( const wxString & name )

private

Definition at line 472 of file ProjectSerializer.cpp.

{
   wxASSERT(name.length() * sizeof(wxStringCharType) <= SHRT_MAX);
   UShort id;
 
   auto nameiter = mNames.find(name);
   if (nameiter != mNames.end())
   {
      id = nameiter->second;
   }
   else
   {
      // mNames is static.  This appends each name to static mDict only once
      // in each run.
      UShort len = name.length() * sizeof(wxStringCharType);
 
      id = mNames.size();
      mNames[name] = id;
 
      mDict.AppendByte(FT_Name);
      WriteUShort( mDict, id );
      WriteUShort( mDict, len );
      mDict.AppendData(name.wx_str(), len);
 
      mDictChanged = true;
   }
 
   WriteUShort( mBuffer, id );
}

References MemoryStream::AppendByte(), MemoryStream::AppendData(), FT_Name, id, mBuffer, mDict, mDictChanged, mNames, name, and anonymous_namespace{ProjectSerializer.cpp}::WriteUShort.

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ mBuffer

MemoryStream ProjectSerializer::mBuffer

private

Definition at line 75 of file ProjectSerializer.h.

Referenced by EndTag(), GetData(), IsEmpty(), StartTag(), Write(), WriteAttr(), WriteData(), and WriteName().

◆ mDict

MemoryStream ProjectSerializer::mDict

staticprivate

Definition at line 79 of file ProjectSerializer.h.

Referenced by GetDict(), ProjectSerializer(), and WriteName().

◆ mDictChanged

bool ProjectSerializer::mDictChanged

private

Definition at line 76 of file ProjectSerializer.h.

Referenced by DictChanged(), ProjectSerializer(), and WriteName().

◆ mNames

NameMap ProjectSerializer::mNames

staticprivate

Definition at line 78 of file ProjectSerializer.h.

Referenced by WriteName().

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ProjectSerializer()

◆ ~ProjectSerializer()

Member Function Documentation

◆ Decode()

◆ DictChanged()

◆ EndTag()

◆ FailureMessage()

◆ GetData()

◆ GetDict()

◆ IsEmpty()

◆ StartTag()

◆ Write()

◆ WriteAttr() [1/9]

◆ WriteAttr() [2/9]

◆ WriteAttr() [3/9]

◆ WriteAttr() [4/9]

◆ WriteAttr() [5/9]

◆ WriteAttr() [6/9]

◆ WriteAttr() [7/9]

◆ WriteAttr() [8/9]

◆ WriteAttr() [9/9]

◆ WriteData()

◆ WriteName()

Member Data Documentation

◆ mBuffer

◆ mDict

◆ mDictChanged

◆ mNames