logger_manipulators.h

Go to the documentation of this file.

// Copyright 2012-2021:
//   GobySoft, LLC (2013-)
//   Massachusetts Institute of Technology (2007-2014)
//   Community contributors (see AUTHORS file)
// File authors:
//   Toby Schneider <toby@gobysoft.org>
//
//
// 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 GOBY_UTIL_DEBUG_LOGGER_LOGGER_MANIPULATORS_H
#define GOBY_UTIL_DEBUG_LOGGER_LOGGER_MANIPULATORS_H
 
#include <iostream>
#include <string>
#include <utility>
 
#include "term_color.h"
 
namespace goby
{
namespace util
{
class FlexOstream;
 
namespace logger
{
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& 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: "); }
 
 
class Group
{
  public:
    Group(std::string name = "", std::string description = "",
          goby::util::Colors::Color color = goby::util::Colors::nocolor)
        : name_(std::move(name)), description_(std::move(description)), color_(color)
    {
    }
 
 
    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_{true};
};
 
class GroupSetter
{
  public:
    explicit GroupSetter(std::string s) : group_(std::move(s)) {}
    void operator()(std::ostream& os) const;
    void operator()(goby::util::FlexOstream& os) const;
 
  private:
    std::string group_;
};
 
std::ostream& basic_log_header(std::ostream& os, const std::string& group_name);
 
std::ostream& operator<<(std::ostream& os, const Group& g);
inline std::ostream& operator<<(std::ostream& os, const GroupSetter& gs)
{
    gs(os);
    return (os);
}
 
goby::util::FlexOstream& operator<<(goby::util::FlexOstream& os, const GroupSetter& gs);
 
} // namespace logger
} // namespace util
} // namespace goby
 
using goby::util::logger::operator<<;
 
inline goby::util::logger::GroupSetter group(std::string n)
{
    return (goby::util::logger::GroupSetter(std::move(n)));
}
 
#endif