Colorizer.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-2022.
//
// 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, Moritz Berger $
// $Authors: Chris Bielow, Moritz Berger $
// --------------------------------------------------------------------------

#pragma once

#include <OpenMS/config.h>

#include <array>
#include <iosfwd>
#include <sstream>

namespace OpenMS
{
  enum class ConsoleColor
  { // note: the order is important here! See Colorizer::colors_
    RED,
    GREEN,
    YELLOW,
    BLUE,
    MAGENTA,
    CYAN,
    UNDERLINE,
    BRIGHT, 
    INVERT, 
  };

  class OPENMS_DLLAPI Colorizer
  {
  public:
    friend OPENMS_DLLAPI std::ostream& operator<<(std::ostream& o_stream, Colorizer& col);
    friend class IndentedStream; // to manipulate the internal string data before writing to a stream

    Colorizer(const ConsoleColor color);

    Colorizer() = delete;

    //. Explicitly deleted here, since stringstream member has no copy c'tor either
    Colorizer(const Colorizer& rhs) = delete;

    ~Colorizer() = default;

    Colorizer& operator()()
    {
      input_.str(""); // clear the internal buffer
      undo_ = false;
      undo_all_ = false;
      undos_only = false;
      return *this;
    }

    template<typename T>
    Colorizer& operator()(T s)
    {
      input_.str(""); // clear the internal buffer
      input_ << s;    // add new data
      undo_ = true;
      undo_all_ = false;
      undos_only = false;
      return *this;
    }

    Colorizer& undo();

    Colorizer& undoAll();

    static bool isTTY(const std::ostream& stream);

  protected:
    void outputToStream_(std::ostream& o_stream);

    static void colorStream_(std::ostream& stream, const char* ANSI_command);

    const ConsoleColor color_;

    bool undo_ = true;

    bool undo_all_ = true;

    bool undos_only = false;

    const std::stringstream& getInternalChars_() const
    {
      return input_;
    }


    void setInternalChars_(const std::string& data)
    {
      input_.str(data);
    }


    struct ColorWithUndo_
    {
      const char* enable; 
      const char* disable; 
    };
    
    inline static const constexpr std::array<ColorWithUndo_, 9> colors_ {
      ColorWithUndo_ {"\033[91m", "\033[39m"}, // red
      ColorWithUndo_ {"\033[92m", "\033[39m"}, // green
      ColorWithUndo_ {"\033[93m", "\033[39m"}, // yellow
      ColorWithUndo_ {"\033[94m", "\033[39m"}, // blue
      ColorWithUndo_ {"\033[95m", "\033[39m"}, // magenta
      ColorWithUndo_ {"\033[96m", "\033[39m"}, // cyan
      ColorWithUndo_ {"\033[4m", "\033[24m"},  // underline
      ColorWithUndo_ {"\033[1m", "\033[22m"},  // bright/intensified
      ColorWithUndo_ {"\033[7m",  "\033[27m"}, // invert FG/BG
    };
    const char* color_undo_all_ = "\033[0m"; 

    std::stringstream input_;

  }; // class Colorizer

  // declaration of all global colorizer objects
  extern OPENMS_DLLAPI Colorizer red;
  extern OPENMS_DLLAPI Colorizer green;
  extern OPENMS_DLLAPI Colorizer yellow;
  extern OPENMS_DLLAPI Colorizer blue;
  extern OPENMS_DLLAPI Colorizer magenta;
  extern OPENMS_DLLAPI Colorizer cyan;
  extern OPENMS_DLLAPI Colorizer bright;
  extern OPENMS_DLLAPI Colorizer underline;
  extern OPENMS_DLLAPI Colorizer invert;

  OPENMS_DLLAPI std::ostream& operator<<(std::ostream& o_stream, OpenMS::Colorizer& col);
} // namespace OpenMS