IOStream.h

Go to the documentation of this file.

/*---------------------------------------------------------------------\
|                          ____ _   __ __ ___                          |
|                         |__  / \ / / . \ . \                         |
|                           / / \ V /|  _/  _/                         |
|                          / /__ | | | | | |                           |
|                         /_____||_| |_| |_|                           |
|                                                                      |
\---------------------------------------------------------------------*/
#ifndef ZYPP_BASE_IOSTREAM_H
#define ZYPP_BASE_IOSTREAM_H
 
#include <iosfwd>
#include <boost/io/ios_state.hpp>
#include <utility>
 
#include <zypp-core/base/Flags.h>
#include <zypp-core/base/PtrTypes.h>
#include <zypp-core/base/Function.h>
#include <zypp-core/base/NonCopyable.h>

namespace zypp
{ 

  namespace iostr
  { 

    using IosFmtFlagsSaver = boost::io::ios_base_all_saver;
 

    std::string getline( std::istream & str ) ZYPP_API;

    inline std::ostream & copy( std::istream & from_r, std::ostream & to_r )
    {
      if ( from_r && to_r )
      {
        char ch = 0;
        while ( from_r && from_r.get( ch ) )
          to_r.put( ch );
      }
      return to_r;
    }

    inline std::ostream & copyIndent( std::istream & from_r, std::ostream & to_r, const std::string & indent_r = "> " )
    {
      if ( from_r && to_r )
      {
        char ch = 0;
        bool indent = true;
        while ( from_r && from_r.get( ch ) )
        {
          if ( indent )
            to_r << indent_r;
          indent = ( ch == '\n' );
          to_r.put( ch );
        }
      }
      return to_r;
    }

    inline void tee( std::istream & from_r, std::ostream & to1_r, std::ostream & to2_r )
    {
      if ( from_r && ( to1_r ||to2_r ) )
      {
        char ch = 0;
        while ( from_r && from_r.get( ch ) )
        {
          to1_r.put( ch );
          to2_r.put( ch );
        }
      }
    }

    //
    //  CLASS NAME : EachLine
    //
    class ZYPP_API EachLine : private base::NonCopyable
    {
      public:
        EachLine( std::istream & str_r, unsigned lineNo_r = 0 );

        bool valid() const
        { return _valid; }

        explicit operator bool() const
        { return _valid; }

        unsigned lineNo() const
        { return _lineNo; }
 
        std::streamoff lineStart() const
        { return _lineStart; };

        void setLineNo( unsigned lineNo_r )
        { _lineNo = lineNo_r; }

        const std::string & operator*() const
        { return _line; }

        std::string & operator*()
        { return _line; }

        const std::string * operator->() const
        { return &_line; }

        bool next();

        bool next( unsigned num_r )
        {
          while ( num_r-- && next() )
            ; /* EMPTY */
          return valid();
        }
 
      private:
        std::istream & _str;
        std::string    _line;
        std::streamoff _lineStart;
        unsigned       _lineNo;
        bool           _valid;
    };


     int forEachLine( std::istream & str_r, const function<bool(int, std::string)>& consume_r ) ZYPP_API;

     enum ParseFlag
     {
       PF_LTRIM                 = 1 << 0,               //< left trim whitespace
       PF_RTRIM                 = 1 << 1,               //< right trim whitespace
       PF_TRIM                   = PF_LTRIM | PF_RTRIM,  //< trim whitespace
       PF_SKIP_EMPTY               = 1 << 2,               //< skip lines containing whitespace only
       PF_SKIP_SHARP_COMMENT       = 1 << 3                //< skip lines beginning with '#'
     };
     ZYPP_DECLARE_FLAGS( ParseFlags, ParseFlag );
     ZYPP_DECLARE_OPERATORS_FOR_FLAGS( ParseFlags );

     int simpleParseFile( std::istream & str_r, ParseFlags flags_r, function<bool(int, std::string)> consume_r ) ZYPP_API;

     inline int simpleParseFile( std::istream & str_r, function<bool(int, std::string)> consume_r )
     { return simpleParseFile( str_r, PF_TRIM | PF_SKIP_EMPTY | PF_SKIP_SHARP_COMMENT , std::move(consume_r) ); }

  } // namespace iostr
} // namespace zypp
#endif // ZYPP_BASE_IOSTREAM_H