IndentedStream.h

Go to the documentation of this file.

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2023.
//
// This software is released under a three-clause BSD license:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of any author or any participating institution
//    may be used to endorse or promote products derived from this software
//    without specific prior written permission.
// For a full list of authors, refer to the file AUTHORS.
// --------------------------------------------------------------------------
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Chris Bielow $
// --------------------------------------------------------------------------
 
#include <OpenMS/APPLICATIONS/ConsoleUtils.h>
 
#include <sstream>
 
using namespace std;
 
namespace OpenMS
{
  class Colorizer;
 
  class OPENMS_DLLAPI IndentedStream
  {
  public:
    IndentedStream(std::ostream& stream, const UInt indentation, const UInt max_lines);
 
    ~IndentedStream();
 
    IndentedStream& operator<<(Colorizer& colorizer);
    
    IndentedStream& operator<<(IndentedStream& self);
 
    template<typename T>
    IndentedStream& operator<<(const T& data)
    {
      // convert data to string
      std::stringstream str_data;
      str_data << data;
 
      auto result = ConsoleUtils::breakStringList(str_data.str(), indentation_, max_lines_, current_column_pos_);
      if (result.empty())
      {
        return *this;
      }
      
      if (result.size() == 1)
      { // no new linebreak. advance our position
        current_column_pos_ += result.back().size();
      }
      else
      { // new line: this is our new position
        current_column_pos_ = result.back().size();
      }
      
 
      // push result into stream
      *stream_ << result[0];
      for (size_t i = 1; i < result.size(); ++i)
      {
        *stream_ << '\n';
        *stream_ << result[i];
      }      
 
      return *this;
    }
        
    typedef std::ostream& (*StreamManipulator)(std::ostream&);
 
    IndentedStream& operator<<(StreamManipulator manip);
 
    IndentedStream& indent(const UInt new_indent);
 
  private:
    std::ostream* stream_;        
    UInt indentation_;            
    UInt max_lines_;              
    UInt max_line_width_;         
    Size current_column_pos_ = 0; 
  };
 
} // namespace OpenMS