PluginIPCUtils.h

Go to the documentation of this file.

/**********************************************************************
 
  Audacity: A Digital Audio Editor
 
  @file PluginIPCUtils.h
 
  @author Vitaly Sverchinsky
 
  @brief Provides a set of internal commonly used functions/structures
 
  Part of lib-module-manager library.
 
**********************************************************************/
 
#pragma once
 
#include <vector>
#include <wx/string.h>
#include "XMLTagHandler.h"
 
class IPCChannel;
class PluginDescriptor;
class XMLWriter;
 
namespace detail
{
   bool ParseRequestString(const wxString& req, wxString& providerId, wxString& pluginPath);
 
   wxString MakeRequestString(const wxString& providerId, const wxString& pluginPath);
 
   void PutMessage(IPCChannel& channel, const wxString& value);
 
   class InputMessageReader
   {
      std::vector<char> mBuffer;
   public:
      void ConsumeBytes(const void* bytes, size_t length);
 
      bool CanPop() const noexcept;
      wxString Pop();
   };
 
   class PluginValidationResult final : public XMLTagHandler
   {
      std::vector<PluginDescriptor> mDescriptors;
      wxString mErrorMessage;
      bool mHasError{false};
   public:
 
      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;
   };
 
}