logger_manipulators.h

// Copyright 2009-2018 Toby Schneider (http://gobysoft.org/index.wt/people/toby)
//                     GobySoft, LLC (2013-)
//                     Massachusetts Institute of Technology (2007-2014)
//                     Community contributors (see AUTHORS file)
//
//
// This file is part of the Goby Underwater Autonomy Project Libraries
// ("The Goby Libraries").
//
// The Goby Libraries are free software: you can redistribute them and/or modify
// them under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 2.1 of the License, or
// (at your option) any later version.
//
// The Goby Libraries are distributed in the hope that they will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with Goby.  If not, see <http://www.gnu.org/licenses/>.

#ifndef LoggerManipulators20091110H
#define LoggerManipulators20091110H

#include <iostream>
#include <string>

#include "term_color.h"

namespace goby
{
namespace common
{
class FlexOstream;

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

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

inline std::ostream& verbose(std::ostream& os) { return (os); }

inline std::ostream& debug1(std::ostream& os) { return (os << "D: "); }

inline std::ostream& debug2(std::ostream& os) { return (os << "D2: "); }

inline std::ostream& debug3(std::ostream& os) { return (os << "D3: "); }

} // namespace logger
} // namespace common
} // namespace goby

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


    std::string name() const { return name_; }
    std::string description() const { return description_; }
    goby::common::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::common::Colors::Color c) { color_ = c; }
    void enabled(bool b) { enabled_ = b; }

  private:
    std::string name_;
    std::string description_;
    goby::common::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::common::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);
}

goby::common::FlexOstream& operator<<(goby::common::FlexOstream& os, const GroupSetter& gs);

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

#endif