CommandMessageTarget Class Reference

Interface for objects that can receive (string) messages from a command. More...

#include <CommandTargets.h>

Inheritance diagram for CommandMessageTarget:

Collaboration diagram for CommandMessageTarget:

Public Member Functions
	CommandMessageTarget ()
virtual	~CommandMessageTarget ()
virtual void	Update (const wxString &message)=0
virtual void	StartArray ()
virtual void	EndArray ()
virtual void	StartStruct ()
virtual void	EndStruct ()
virtual void	AddItem (const wxString &value, const wxString &name={})
virtual void	AddBool (const bool value, const wxString &name={})
virtual void	AddItem (const double value, const wxString &name={})
virtual void	StartField (const wxString &name={})
virtual void	EndField ()
virtual void	Flush ()
wxString	Escaped (const wxString &str)

Public Attributes
std::vector< int >	mCounts

Detailed Description

Interface for objects that can receive (string) messages from a command.

Definition at line 70 of file CommandTargets.h.

Constructor & Destructor Documentation

CommandMessageTarget()

CommandMessageTarget::CommandMessageTarget ( )

inline

Definition at line 73 of file CommandTargets.h.

{mCounts.push_back(0);}

~CommandMessageTarget()

CommandMessageTarget::~CommandMessageTarget ( )

virtual

Definition at line 22 of file CommandTargets.cpp.

{
   Flush();
}

References Flush().

Here is the call graph for this function:

Member Function Documentation

AddBool()

void CommandMessageTarget::AddBool ( const bool  value, const wxString &  name = {}  )

virtual

Reimplemented in CommandMessageTargetDecorator, LispyCommandMessageTarget, and BriefCommandMessageTarget.

Definition at line 66 of file CommandTargets.cpp.

                                                                             {
   if( name.empty() )
      Update( wxString::Format( "%s\"%s\"", (mCounts.back()>0)?", ":"", value?"true":"false"));
   else
      Update( wxString::Format( "%s\"%s\":\"%s\"", (mCounts.back()>0)?", ":"", name,value?"true":"false"));
   mCounts.back() += 1;
}

References TranslatableString::empty(), mCounts, name, and Update().

Here is the call graph for this function:

AddItem() [1/2]

void CommandMessageTarget::AddItem ( const double  value, const wxString &  name = {}  )

virtual

Reimplemented in CommandMessageTargetDecorator, LispyCommandMessageTarget, and BriefCommandMessageTarget.

Definition at line 74 of file CommandTargets.cpp.

                                                                             {
   std::stringstream str;
   std::locale nolocale("C");
   str.imbue(nolocale);
 
   if( name.empty() )
      str << ((mCounts.back()>0)? ", " : "") << value;
   else
      str << ((mCounts.back()>0)? ", " : "") << "\"" << name << "\"" << ":" << value;
 
   Update( str.str() );
   mCounts.back() += 1;
}

References TranslatableString::empty(), mCounts, name, str, and Update().

Here is the call graph for this function:

AddItem() [2/2]

void CommandMessageTarget::AddItem ( const wxString &  value, const wxString &  name = {}  )

virtual

Reimplemented in CommandMessageTargetDecorator, LispyCommandMessageTarget, and BriefCommandMessageTarget.

Definition at line 55 of file CommandTargets.cpp.

                                                                             {
   wxString Padding;
   Padding.Pad( mCounts.size() *2 -2);
   Padding = (( value.length() < 15 ) || (mCounts.back()<=0))  ? wxString{} : wxString("\n") + Padding;
   if( name.empty() )
      Update( wxString::Format( "%s%s\"%s\"", (mCounts.back()>0)?", ":"", Padding, Escaped(value)));
   else
      Update( wxString::Format( "%s%s\"%s\":\"%s\"", (mCounts.back()>0)?", ":"", Padding, name, Escaped(value)));
   mCounts.back() += 1;
}

References TranslatableString::empty(), Escaped(), mCounts, name, audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::Padding, and Update().

Here is the call graph for this function:

EndArray()

void CommandMessageTarget::EndArray ( )

virtual

Reimplemented in CommandMessageTargetDecorator, LispyCommandMessageTarget, and BriefCommandMessageTarget.

Definition at line 36 of file CommandTargets.cpp.

                                   {
   if( mCounts.size() > 1 ){
      mCounts.pop_back();
   }
   Update( " ]" );
}

References mCounts, and Update().

Here is the call graph for this function:

EndField()

void CommandMessageTarget::EndField ( )

virtual

Reimplemented in CommandMessageTargetDecorator, LispyCommandMessageTarget, and BriefCommandMessageTarget.

Definition at line 97 of file CommandTargets.cpp.

                                   {
   if( mCounts.size() > 1 ){
      mCounts.pop_back();
   }
}

References mCounts.

EndStruct()

void CommandMessageTarget::EndStruct ( )

virtual

Reimplemented in CommandMessageTargetDecorator, LispyCommandMessageTarget, and BriefCommandMessageTarget.

Definition at line 49 of file CommandTargets.cpp.

                                    {
   if( mCounts.size() > 1 ){
      mCounts.pop_back();
   }
   Update( " }" );
}

References mCounts, and Update().

Here is the call graph for this function:

Escaped()

wxString CommandMessageTarget::Escaped

(

const wxString &

str

)

Definition at line 106 of file CommandTargets.cpp.

                                                           {
   wxString Temp = str;
   Temp.Replace( "\"", "\\\"");
   return Temp;
}

References str.

Referenced by AddItem(), and LispyCommandMessageTarget::AddItem().

Here is the caller graph for this function:

Flush()

void CommandMessageTarget::Flush ( )

virtual

Reimplemented in CommandMessageTargetDecorator, ResponseTarget, and MessageDialogTarget.

Definition at line 103 of file CommandTargets.cpp.

                                {
}

Referenced by ~CommandMessageTarget().

Here is the caller graph for this function:

StartArray()

void CommandMessageTarget::StartArray ( )

virtual

Reimplemented in CommandMessageTargetDecorator, LispyCommandMessageTarget, and BriefCommandMessageTarget.

Definition at line 27 of file CommandTargets.cpp.

{
   wxString Padding;
   Padding.Pad( mCounts.size() *2 -2);
   Update( wxString::Format( "%s%s[ ", ( mCounts.back() > 0 ) ? ",\n" : "\n", Padding ));
   mCounts.back() += 1;
   mCounts.push_back( 0 );
}

References mCounts, audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::Padding, and Update().

Here is the call graph for this function:

StartField()

void CommandMessageTarget::StartField ( const wxString &  name = {} )

virtual

Reimplemented in CommandMessageTargetDecorator, LispyCommandMessageTarget, and BriefCommandMessageTarget.

Definition at line 88 of file CommandTargets.cpp.

                                                         {
   if( name.empty() )
      Update( wxString::Format( "%s", (mCounts.back()>0)? ", " : ""));
   else
      Update( wxString::Format( "%s\"%s\":", (mCounts.back()>0) ?", ":"", name));
   mCounts.back() += 1;
   mCounts.push_back( 0 );
}

References TranslatableString::empty(), mCounts, name, and Update().

Here is the call graph for this function:

StartStruct()

void CommandMessageTarget::StartStruct ( )

virtual

Reimplemented in CommandMessageTargetDecorator, LispyCommandMessageTarget, and BriefCommandMessageTarget.

Definition at line 42 of file CommandTargets.cpp.

                                      {
   wxString Padding;
   Padding.Pad( mCounts.size() *2 -2);
   Update( wxString::Format( "%s%s{ ", ( mCounts.back() > 0 ) ? ",\n" : "\n", Padding ));
   mCounts.back() += 1;
   mCounts.push_back( 0 );
}

References mCounts, audacity::cloud::audiocom::sync::anonymous_namespace{CloudSyncStatusField.cpp}::Padding, and Update().

Here is the call graph for this function:

Update()

virtual void CommandMessageTarget::Update ( const wxString &  message )

pure virtual

Implemented in NullMessageTarget, CommandMessageTargetDecorator, MessageBoxTarget, ResponseTarget, CombinedMessageTarget, MessageDialogTarget, and StatusBarTarget.

Referenced by AddBool(), AddItem(), EndArray(), EndStruct(), StartArray(), StartField(), and StartStruct().

Here is the caller graph for this function:

Member Data Documentation

mCounts

std::vector<int> CommandMessageTarget::mCounts

Definition at line 87 of file CommandTargets.h.

Referenced by AddBool(), LispyCommandMessageTarget::AddBool(), BriefCommandMessageTarget::AddBool(), AddItem(), LispyCommandMessageTarget::AddItem(), EndArray(), LispyCommandMessageTarget::EndArray(), BriefCommandMessageTarget::EndArray(), EndField(), LispyCommandMessageTarget::EndField(), BriefCommandMessageTarget::EndField(), EndStruct(), LispyCommandMessageTarget::EndStruct(), BriefCommandMessageTarget::EndStruct(), StartArray(), LispyCommandMessageTarget::StartArray(), BriefCommandMessageTarget::StartArray(), StartField(), LispyCommandMessageTarget::StartField(), BriefCommandMessageTarget::StartField(), StartStruct(), LispyCommandMessageTarget::StartStruct(), and BriefCommandMessageTarget::StartStruct().

---

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

• CommandTargets.h
• CommandTargets.cpp