LogFormatter.h

Go to the documentation of this file.

// -*- lsst-c++ -*-

/* 
 * LSST Data Management System
 * Copyright 2008, 2009, 2010 LSST Corporation.
 * 
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * 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 program 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 LSST License Statement and 
 * the GNU General Public License along with this program.  If not, 
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */
 
#ifndef LSST_PEX_LOGFORMATTER_H
#define LSST_PEX_LOGFORMATTER_H

#include <string>
#include <map>
#include <ostream>

#include "lsst/daf/base/PropertySet.h"
#include "boost/any.hpp"

namespace lsst {
namespace pex {
namespace logging {

// forward declaration
class LogRecord;

class LogFormatter {
public:

    LogFormatter() { }

    LogFormatter(const LogFormatter& that) { }

    virtual ~LogFormatter();  

    LogFormatter& operator=(const LogFormatter& that) { return *this; }

    virtual void write(std::ostream *strm, const LogRecord &rec) = 0;

};

class BriefFormatter : public LogFormatter {
public:

    explicit BriefFormatter(bool verbose=false) 
        : LogFormatter(), _doAll(verbose) 
    { }

    BriefFormatter(const BriefFormatter& that) 
        : LogFormatter(that), _doAll(that._doAll) 
    { }

    virtual ~BriefFormatter();

    BriefFormatter& operator=(const BriefFormatter& that) { 
        if (this == &that) return *this;

        dynamic_cast<LogFormatter*>(this)->operator=(that);
        _doAll = that._doAll;
        return *this; 
    }

    bool isVerbose() { return _doAll; }

    void setVerbose(bool printAll) { _doAll = printAll; }

    virtual void write(std::ostream *strm, const LogRecord& rec);

private:

    bool _doAll;
};

class IndentedFormatter : public BriefFormatter {
public: 

    explicit IndentedFormatter(bool verbose=false) 
        : BriefFormatter(verbose)
    { }

    IndentedFormatter(const IndentedFormatter& that) 
        : BriefFormatter(that)
    { }

    virtual ~IndentedFormatter();

    IndentedFormatter& operator=(const IndentedFormatter& that) { 
        if (this == &that) return *this;

        dynamic_cast<BriefFormatter*>(this)->operator=(that);
        return *this; 
    }

    virtual void write(std::ostream *strm, const LogRecord& rec);
};

class NetLoggerFormatter : public LogFormatter {
public: 
    
    explicit NetLoggerFormatter(const std::string& valueDelim = defaultValDelim);

    NetLoggerFormatter(const NetLoggerFormatter& that) 
        : LogFormatter(that), _tplookup(), _midfix(that._midfix)
    { 
        loadTypeLookup();
    }

    virtual ~NetLoggerFormatter();

    NetLoggerFormatter& operator=(const NetLoggerFormatter& that);

    const std::string& getValueDelimiter() const { return _midfix; }

    virtual void write(std::ostream *strm, const LogRecord& rec);

    static const std::string defaultValDelim;

private:
    typedef std::map<std::string, char> TypeSymbolMap;
    void loadTypeLookup();

    TypeSymbolMap _tplookup;
    std::string _midfix;
};

}}}     // end lsst::pex::logging

#endif  // end LSST_PEX_LOGFORMATTER_H