libopenms-dev 1.11.1-3 / usr / include / OpenMS / FORMAT / SVOutStream.h

// --------------------------------------------------------------------------
//                   OpenMS -- Open-Source Mass Spectrometry
// --------------------------------------------------------------------------
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
// ETH Zurich, and Freie Universitaet Berlin 2002-2013.
//
// 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: Hendrik Weisser $
// $Authors: Hendrik Weisser $
// --------------------------------------------------------------------------

#ifndef OPENMS_FORMAT_SVOUTSTREAM_H
#define OPENMS_FORMAT_SVOUTSTREAM_H

#include <OpenMS/DATASTRUCTURES/String.h>
#include <ostream>
#include <boost/math/special_functions/fpclassify.hpp> // for "isnan"

namespace OpenMS
{
  /**
      @brief Stream class for writing to comma/tab/...-separated values files.

      Automatically inserts separators between items and handles quoting of strings. Requires @p std::endl as the line delimiter - @p "\n" won't be accepted.

      @ingroup Format
  */
  class OPENMS_DLLAPI SVOutStream :
    public std::ostream
  {
public:
    /**
         @brief Constructor

         @param out Output stream to write to (open file or @p cout)
         @param sep Separator string (typically comma, semicolon, or tab)
         @param replacement If @p quoting is @p NONE, used to replace occurrences of @p sep within strings before writing them
         @param quoting Quoting method for strings (see @p String::quote)
    */
    SVOutStream(std::ostream & out, const String & sep = "\t",
                const String & replacement = "_",
                String::QuotingMethod quoting = String::DOUBLE);


    /**
         @brief Stream output operator for @p String

         The argument is quoted before writing; it must not contain the newline character
    */
    SVOutStream & operator<<(String str);    // use call-by-value here


    /**
         @brief Stream output operator for @p std::string

         The argument is quoted before writing; it must not contain the newline character
    */
    SVOutStream & operator<<(const std::string & str);


    /**
         @brief Stream output operator for @p char*

         The argument is quoted before writing; it must not contain the newline character
    */
    SVOutStream & operator<<(const char * c_str);


    /**
         @brief Stream output operator for @p char

         The argument is quoted before writing; it must not contain the newline character
    */
    SVOutStream & operator<<(const char c);


    /// Stream output operator for manipulators (used to catch @p std::endl)
    SVOutStream & operator<<(std::ostream & (*fp)(std::ostream &));


    /// Generic stream output operator (for non-character-based types)
    template <typename T>
    SVOutStream & operator<<(const T & value)
    {
      if (!newline_) (std::ostream &) * this << sep_;
      else newline_ = false;
      (std::ostream &) * this << value;
      return *this;
    }

    /// Unformatted output (no quoting: useful for comments, but use only on a line of its own!)
    SVOutStream & write(const String & str);   // write unmodified string


    /**
         @brief Switch modification of strings (quoting/replacing of separators) on/off

         @return previous modification state
    */
    bool modifyStrings(bool modify);


    /// Write a numeric value or "nan"/"inf"/"-inf", if applicable (would not be needed for Linux)
    template <typename NumericT>
    SVOutStream & writeValueOrNan(NumericT thing)
    {
      if ((boost::math::isfinite)(thing)) return operator<<(thing);

      bool old = modifyStrings(false);
      if ((boost::math::isnan)(thing)) operator<<(nan_);
      else if (thing < 0) operator<<("-" + inf_);
      else operator<<(inf_);
      modifyStrings(old);
      return *this;
    }

protected:
    /// Separator string
    String sep_;

    /// Replacement for separator
    String replacement_;

    /// String to use for NaN values
    String nan_;

    /// String to use for Inf values
    String inf_;

    /// String quoting method
    String::QuotingMethod quoting_;

    /// On/off switch for modification of strings
    bool modify_strings_;

    /// Are we at the beginning of a line? (Otherwise, insert separator before next item.)
    bool newline_;
  };

}

#endif