PluginFrame.h

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                          ____ _   __ __ ___                          |
|                         |__  / \ / / . \ . \                         |
|                           / / \ V /|  _/  _/                         |
|                          / /__ | | | | | |                           |
|                         /_____||_| |_| |_|                           |
|                                                                      |
\---------------------------------------------------------------------*/
#ifndef ZYPP_PLUGINFRAME_H
#define ZYPP_PLUGINFRAME_H

#include <iosfwd>
#include <string>
#include <map>

#include "zypp/base/PtrTypes.h"
#include "zypp/base/SafeBool.h"

#include "zypp/PluginFrameException.h"

namespace zypp
{ 

  class PluginFrame : private base::SafeBool<PluginFrame>
  {
    friend std::ostream & operator<<( std::ostream & str, const PluginFrame & obj );
    friend bool operator==( const PluginFrame & lhs, const PluginFrame & rhs );

    public:
      static const std::string & ackCommand();
      static const std::string & errorCommand();

    public:
      typedef PluginFrameException Exception;

      PluginFrame();

      PluginFrame( const std::string & command_r );

      PluginFrame( const std::string & command_r, const std::string body_r );

      PluginFrame( std::istream & stream_r );

    public:
      bool empty() const;

      using base::SafeBool<PluginFrame>::operator bool_type;

    public:
      const std::string & command() const;

      void setCommand( const std::string & command_r );

      bool isAckCommand() const
      { return command() == ackCommand(); }

      bool isErrorCommand() const
      {return command() == errorCommand(); }

      const std::string & body() const;

      std::string & bodyRef();

      void setBody( const std::string & body_r );

    public:
      typedef std::multimap<std::string, std::string> HeaderList;

      typedef HeaderList::const_iterator HeaderListIterator;

    private:
      HeaderList & headerList();

    public:
      const HeaderList & headerList() const;

      bool headerEmpty() const
      { return headerList().empty(); }

      unsigned headerSize() const
      { return headerList().size(); }

      HeaderListIterator headerBegin() const
      { return headerList().begin(); }

      HeaderListIterator headerEnd() const
      { return headerList().end(); }

      void headerClear()
      { headerList().clear(); }


      bool hasKey( const std::string & key_r ) const
      { return keyEmpty( key_r ); }

      bool keyEmpty( const std::string & key_r ) const
      { return headerList().find( key_r ) == headerEnd(); }

      bool keySize( const std::string & key_r ) const
      { return headerList().count( key_r ); }

      HeaderListIterator keyBegin( const std::string & key_r ) const
      { return headerList().lower_bound( key_r ); }

      HeaderListIterator keyEnd( const std::string & key_r ) const
      { return headerList().upper_bound( key_r ); }


      const std::string & getHeader( const std::string & key_r ) const;

      const std::string & getHeader( const std::string & key_r, const std::string & default_r ) const;

      const std::string & getHeaderNT( const std::string & key_r, const std::string & default_r = std::string() ) const;

      void setHeader( const std::string & key_r, const std::string & value_r = std::string() );

      void addHeader( const std::string & key_r, const std::string & value_r = std::string() );

      void clearHeader( const std::string & key_r );

    public:
      std::ostream & writeTo( std::ostream & stream_r ) const;

      static std::ostream & writeTo( std::ostream & stream_r, const PluginFrame & frame_r )
      { return frame_r.writeTo( stream_r ); }

      std::istream & readFrom( std::istream & stream_r )
      { *this = PluginFrame( stream_r ); return stream_r; }

      static std::istream & readFrom( std::istream & stream_r, PluginFrame & frame_r )
      { frame_r = PluginFrame( stream_r ); return stream_r; }

    private:
      friend base::SafeBool<PluginFrame>::operator bool_type() const;
      bool boolTest() const
      { return empty(); }
    public:
      class Impl;
    private:
      RWCOW_pointer<Impl> _pimpl;
  };

  std::ostream & operator<<( std::ostream & str, const PluginFrame & obj );

  inline std::ostream & dumpOn( std::ostream & str, const PluginFrame & obj )
  { return PluginFrame::writeTo( str, obj ); }

  inline std::istream & operator>>( std::istream & str, PluginFrame & obj )
  { return PluginFrame::readFrom( str, obj ); }

  bool operator==( const PluginFrame & lhs, const PluginFrame & rhs );

  inline bool operator!=( const PluginFrame & lhs, const PluginFrame & rhs )
  { return( ! operator==( lhs, rhs ) ); }

} // namespace zypp
#endif // ZYPP_PLUGINFRAME_H