util/liblogger/logger_manipulators.h

// copyright 2009 t. schneider tes@mit.edu
// 
// this file is part of goby-logger,
// the goby logging library
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This software is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this software.  If not, see <http://www.gnu.org/licenses/>.

#ifndef LoggerManipulators20091110H
#define LoggerManipulators20091110H

#include <iostream>
#include <string>

#include "term_color.h"

namespace goby { namespace util { class FlexOstream; } }
           
inline std::ostream& die(std::ostream & os)
{ return (os << goby::util::tcolor::red << "(Error): " << goby::util::tcolor::nocolor); }

inline std::ostream& warn(std::ostream & os)
{ return (os << goby::util::tcolor::red << "(Warning): " << goby::util::tcolor::nocolor); }

inline std::ostream& debug(std::ostream & os)
{ return (os << "(Debug): "); }

class Group
{
  public:
  Group(const std::string& name = "",
        const std::string& description = "",
        goby::util::Colors::Color color = goby::util::Colors::nocolor)
      : name_(name),
        description_(description),
        color_(color),
        enabled_(true)
        {}



    std::string name() const
    { return name_; }
    std::string description() const
    { return description_; }        
    goby::util::Colors::Color color() const
    { return color_; }
    bool enabled() const
    { return enabled_; }


    void name(const std::string & s)        { name_ = s; }    
    void description(const std::string & s) { description_ = s; }    
    void color(goby::util::Colors::Color c) { color_ = c; }        
    void enabled(bool b)                    { enabled_ = b; }
    
  private:
    std::string name_;
    std::string description_;
    goby::util::Colors::Color color_;
    bool enabled_;
};


std::ostream& operator<< (std::ostream& os, const Group & g);

class GroupSetter
{
    
  public:
    explicit GroupSetter (const std::string& s) : group_(s) { }
    void operator()(std::ostream& os) const;
    void operator()(goby::util::FlexOstream& os) const;
    
  private:
    std::string group_;
};

inline GroupSetter group(std::string n) 
{ return(GroupSetter(n)); }

inline std::ostream& operator<<(std::ostream& os, const GroupSetter & gs)
{
    gs(os);
    return(os);
}

inline goby::util::FlexOstream& operator<<(goby::util::FlexOstream& os, const GroupSetter & gs)
{
    gs(os);
    return(os);
}

std::ostream& basic_log_header(std::ostream& os, const std::string& group_name);

#endif