Xml.h

Go to the documentation of this file.

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

#include <iosfwd>
#include <string>
#include <vector>
#include <list>
#include <set>
#include <map>

#include "zypp/base/Easy.h"
#include "zypp/base/String.h"
#include "zypp/parser/xml/XmlEscape.h"

namespace zypp
{
  namespace xmlout
  {
    using xml::escape;
    using xml::unescape;

    template <class Tp>
    std::string asXmlNodeAttr( const Tp & val_r )
    { return asString( val_r ); }

    struct NodeAttr : public std::pair<std::string,std::string>
    {
      typedef std::pair<std::string,std::string> Pair;

      template <typename Tp>
      NodeAttr( std::string key_r, const Tp & val_r )
      : Pair( std::move(key_r), asXmlNodeAttr(val_r) )
      {}

      NodeAttr( std::string key_r, std::string val_r )
      : Pair( std::move(key_r), std::move(val_r) )
      {}
    };

    struct Node
    {
      NON_COPYABLE_BUT_MOVE( Node );
      typedef NodeAttr Attr;

      struct OptionalContentType {};    
      static constexpr OptionalContentType optionalContent = OptionalContentType();

      Node( std::ostream & out_r, std::string name_r, const std::initializer_list<Attr> & attrs_r = {} )
      : _out( out_r ), _name( std::move(name_r) ), _hasContent( true )
      { printStart( attrs_r ); }

      Node( std::ostream & out_r, std::string name_r, Attr attr_r )
      : Node( out_r, std::move(name_r), { attr_r } )
      {}

      Node( std::ostream & out_r, std::string name_r, OptionalContentType, const std::initializer_list<Attr> & attrs_r = {} )
      : _out( out_r ), _name( std::move(name_r) ), _hasContent( false )
      { printStart( attrs_r ); }

      Node( std::ostream & out_r, std::string name_r, OptionalContentType, Attr attr_r )
      : Node( out_r, std::move(name_r), optionalContent, { attr_r } )
      {}

      ~Node()
      {
        if ( isComment() )
          _out << "-->";
        else
        {
          if ( _hasContent )
            _out << "</" << _name << ">";
          else
            _out << "/>";
        }
      }

      struct HasContentException{};

      Node & addAttr( const std::initializer_list<Attr> & attrs_r = {} )
      {
        if ( _hasContent )
          throw HasContentException();
        printAttr( attrs_r );
        return *this;
      }

      Node & addAttr( const Attr & attr_r )
      { return addAttr( { attr_r } ); }


      std::ostream & operator*()
      {
        if ( ! _hasContent )
        {
          _hasContent = true;
          if ( isComment() )
            _out << "|";
          else
            _out << ">";
        }
        return _out;
      }

    private:
      void printStart( const std::initializer_list<Attr> & attrs_r )
      {
        if ( _name.empty() || _name[0] == '!' )
        {
          _out << "<!--" << _name;
          _name.clear();        // a comment
        }
        else
          _out << "<" << _name;

        printAttr( attrs_r );

        if ( !isComment() && _hasContent )
          _out << ">";
      }

      void printAttr( const std::initializer_list<Attr> & attrs_r )
      {
        for ( const auto & pair : attrs_r )
          _out << " " << pair.first << "=\"" << xml::escape( pair.second ) << "\"";
      }

      bool isComment() const
      { return _name.empty();  }

    private:
      std::ostream & _out;
      std::string _name;
      bool _hasContent;
    };

    inline std::ostream & node( std::ostream & out_r, const std::string & name_r, const std::initializer_list<Node::Attr> & attrs_r = {} )
    {
      Node( out_r, name_r, Node::optionalContent, attrs_r );
      return out_r;
    }
    inline std::ostream & node( std::ostream & out_r, const std::string & name_r, Node::Attr attr_r )
    { return node( out_r, name_r, { attr_r } ); }

  } // namespace xmlout


  template <class Tp>
  inline std::ostream & dumpAsXmlOn( std::ostream & str, const Tp & obj, const std::string & name_r )
  {
    xmlout::Node guard( str, name_r, xmlout::Node::optionalContent );
    const std::string & content( asString( obj ) );
    if ( ! content.empty() ) *guard << xml::escape( content );
    return str;
  }
  //
} // namespace zypp
#endif // ZYPP_BASE_XML_H