LogConfigHandler.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: Timo Sachsenberg$
// $Authors: Stephan Aiche$
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/CONCEPT/LogStream.h>
#include <OpenMS/CONCEPT/StreamHandler.h>
 
#include <OpenMS/DATASTRUCTURES/StringListUtils.h>
#include <OpenMS/DATASTRUCTURES/Param.h>
 
namespace OpenMS
{
 
  class OPENMS_DLLAPI LogConfigHandler
  {
public:
 
    static String PARAM_NAME; 
 
    Param parse(const StringList & setting);
 
    void configure(const Param & param);
 
    std::ostream & getStream(const String & stream_name);
 
    void setLogLevel(const String & log_level);
 
    static LogConfigHandler * getInstance();
 
    virtual ~LogConfigHandler();
 
protected:
 
    Logger::LogStream & getLogStreamByName_(const String & stream_name);
 
    std::set<String> & getConfigSetByName_(const String & stream_type);
 
    StreamHandler::StreamType getStreamTypeByName_(const String & stream_type);
 
    std::set<String> debug_streams_; 
    std::set<String> info_streams_; 
    std::set<String> warn_streams_; 
    std::set<String> error_streams_; 
    std::set<String> fatal_streams_; 
 
    std::map<String, StreamHandler::StreamType> stream_type_map_; 
 
private:
    friend OPENMS_DLLAPI std::ostream & operator<<(std::ostream & os, LogConfigHandler const & lch);
 
    // the pointer to the single instance
    static LogConfigHandler * instance_;
 
    // it is a singleton so we hide all c' and d'tors
 
    LogConfigHandler();
 
    LogConfigHandler(const LogConfigHandler & source);
 
    virtual LogConfigHandler & operator=(const LogConfigHandler & source);
  };
 
  OPENMS_DLLAPI std::ostream & operator<<(std::ostream & os, LogConfigHandler const & lch);
 
} // end namespace OpenMS