detail::PluginValidationResult Class Reference

#include <PluginIPCUtils.h>

Inheritance diagram for detail::PluginValidationResult:

Collaboration diagram for detail::PluginValidationResult:

Public Member Functions
bool	IsValid () const noexcept
bool	HasError () const noexcept
const wxString &	GetErrorMessage () const noexcept
void	Add (PluginDescriptor &&desc)
void	SetError (const wxString &msg)
const std::vector< PluginDescriptor > &	GetDescriptors () const noexcept
bool	HandleXMLTag (const std::string_view &tag, const AttributesList &attrs) override
void	HandleXMLEndTag (const std::string_view &) override
XMLTagHandler *	HandleXMLChild (const std::string_view &tag) override
void	WriteXML (XMLWriter &writer) const
Public Member Functions inherited from XMLTagHandler
	XMLTagHandler ()
virtual	~XMLTagHandler ()
virtual bool	HandleXMLTag (const std::string_view &tag, const AttributesList &attrs)=0
virtual void	HandleXMLEndTag (const std::string_view &WXUNUSED(tag))
virtual void	HandleXMLContent (const std::string_view &WXUNUSED(content))
virtual XMLTagHandler *	HandleXMLChild (const std::string_view &tag)=0
void	ReadXMLEndTag (const char *tag)
void	ReadXMLContent (const char *s, int len)
XMLTagHandler *	ReadXMLChild (const char *tag)

Private Attributes
std::vector< PluginDescriptor >	mDescriptors
wxString	mErrorMessage
bool	mHasError {false}

Detailed Description

Host uses this structure to build a response and store it into xml form before sending to the other side. Main application uses this structure to restore response from the xml document received as a message

Definition at line 59 of file PluginIPCUtils.h.

Member Function Documentation

Add()

void PluginValidationResult::Add

(

PluginDescriptor &&

desc

)

Definition at line 102 of file PluginIPCUtils.cpp.

{
   mDescriptors.push_back(std::move(desc));
}

References anonymous_namespace{ExportPCM.cpp}::desc, and mDescriptors.

Referenced by anonymous_namespace{PluginHost.cpp}::Discover().

Here is the caller graph for this function:

GetDescriptors()

const std::vector< PluginDescriptor > & PluginValidationResult::GetDescriptors ( ) const

noexcept

Definition at line 113 of file PluginIPCUtils.cpp.

{
   return mDescriptors;
}

References mDescriptors.

GetErrorMessage()

const wxString & PluginValidationResult::GetErrorMessage ( ) const

noexcept

Definition at line 97 of file PluginIPCUtils.cpp.

{
   return mErrorMessage;
}

References mErrorMessage.

HandleXMLChild()

XMLTagHandler * PluginValidationResult::HandleXMLChild ( const std::string_view &  tag )

overridevirtual

Implements XMLTagHandler.

Definition at line 135 of file PluginIPCUtils.cpp.

{
   if(tag == PluginDescriptor::XMLNodeName)
   {
      mDescriptors.resize(mDescriptors.size() + 1);
      return &mDescriptors.back();
   }
   return nullptr;
}

References mDescriptors, and PluginDescriptor::XMLNodeName.

HandleXMLEndTag()

void PluginValidationResult::HandleXMLEndTag ( const std::string_view &  )

override

Definition at line 133 of file PluginIPCUtils.cpp.

{ }

HandleXMLTag()

bool PluginValidationResult::HandleXMLTag ( const std::string_view &  tag, const AttributesList &  attrs  )

overridevirtual

Implements XMLTagHandler.

Definition at line 118 of file PluginIPCUtils.cpp.

{
   if(tag == NodeError)
   {
      mHasError = true;
      for(auto& p : attrs)
      {
         auto key = wxString(p.first.data(), p.first.length());
         auto& attr = p.second;
         if(key == AttrErrorMessage)
            mErrorMessage = attr.ToWString();
      }
   }
   return true;
}

References anonymous_namespace{PluginIPCUtils.cpp}::AttrErrorMessage, key, mErrorMessage, mHasError, and anonymous_namespace{PluginIPCUtils.cpp}::NodeError.

HasError()

bool PluginValidationResult::HasError ( ) const

noexcept

Definition at line 92 of file PluginIPCUtils.cpp.

{
   return mHasError;
}

References mHasError.

IsValid()

bool PluginValidationResult::IsValid ( ) const

noexcept

Result is valid if error flag was not set and contains at least one plugin descriptor.

Definition at line 87 of file PluginIPCUtils.cpp.

{
   return !mHasError && !mDescriptors.empty();
}

References mDescriptors, and mHasError.

SetError()

void PluginValidationResult::SetError

(

const wxString &

msg

)

Definition at line 107 of file PluginIPCUtils.cpp.

{
   mHasError = true;
   mErrorMessage = msg;
}

References mErrorMessage, and mHasError.

Referenced by anonymous_namespace{PluginHost.cpp}::Discover(), AsyncPluginValidator::Impl::OnDisconnect(), and PluginHost::Serve().

Here is the caller graph for this function:

WriteXML()

void PluginValidationResult::WriteXML

(

XMLWriter &

writer

)

const

Definition at line 145 of file PluginIPCUtils.cpp.

{
   if(mHasError)
   {
      writer.StartTag(NodeError);
      writer.WriteAttr(AttrErrorMessage, mErrorMessage);
      writer.EndTag(NodeError);
   }
   if(!mDescriptors.empty())
   {
      writer.StartTag(NodePlugin);
      for(auto& desc : mDescriptors)
         desc.WriteXML(writer);
      writer.EndTag(NodePlugin);
   }
}

References anonymous_namespace{PluginIPCUtils.cpp}::AttrErrorMessage, anonymous_namespace{ExportPCM.cpp}::desc, XMLWriter::EndTag(), mDescriptors, mErrorMessage, mHasError, anonymous_namespace{PluginIPCUtils.cpp}::NodeError, anonymous_namespace{PluginIPCUtils.cpp}::NodePlugin, XMLWriter::StartTag(), and XMLWriter::WriteAttr().

Referenced by PluginHost::Serve().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mDescriptors

std::vector<PluginDescriptor> detail::PluginValidationResult::mDescriptors

private

Definition at line 61 of file PluginIPCUtils.h.

Referenced by Add(), GetDescriptors(), HandleXMLChild(), IsValid(), and WriteXML().

mErrorMessage

wxString detail::PluginValidationResult::mErrorMessage

private

Definition at line 62 of file PluginIPCUtils.h.

Referenced by GetErrorMessage(), HandleXMLTag(), SetError(), and WriteXML().

mHasError

bool detail::PluginValidationResult::mHasError {false}

private

Definition at line 63 of file PluginIPCUtils.h.

Referenced by HandleXMLTag(), HasError(), IsValid(), SetError(), and WriteXML().

---

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

• PluginIPCUtils.h
• PluginIPCUtils.cpp