Logger.h

Go to the documentation of this file.

/*
 * opencog/util/Logger.h
 *
 * Copyright (C) 2002-2007 Novamente LLC
 * Copyright (C) 2008 by Singularity Institute for Artificial Intelligence
 * All Rights Reserved
 *
 * Written by Andre Senna <senna@vettalabs.com>
 *            Gustavo Gama <gama@vettalabs.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License v3 as
 * published by the Free Software Foundation and including the exceptions
 * at http://opencog.org/wiki/Licenses
 *
 * 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 GNU Affero General Public License
 * along with this program; if not, write to:
 * Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef _OPENCOG_LOGGER_H
#define _OPENCOG_LOGGER_H

#include <string>

#include <cstdarg>
#include <pthread.h>

//#undef ERROR
//#undef DEBUG

namespace opencog
{

class Logger
{

public:

    //WARNING: if you change the levels don't forget to update
    //levelStrings[] in Logger.cc
    enum Level { NONE, ERROR, WARN, INFO, DEBUG, FINE };

    static const Level getLevelFromString(const std::string&);
    static const char* getLevelString(const Level);


    // ***********************************************/
    // Constructors/destructors
    ~Logger();

    Logger(const std::string &fileName = "opencog.log", Level level = INFO, bool timestampEnabled = true);

    Logger(const Logger&);

    // ***********************************************/
    // API

    void setLevel(Level);

    Level getLevel() const;

    void setBackTraceLevel(Level);

    Level getBackTraceLevel() const;

    /* filename property */
    void setFilename(const std::string&);
    const std::string& getFilename();

    void setTimestampFlag(bool flag);

    void setPrintToStdoutFlag(bool flag);

    void setPrintErrorLevelStdout();

    void log  (Level level, const std::string &txt);
    void error(const std::string &txt);
    void warn (const std::string &txt);
    void info (const std::string &txt);
    void debug(const std::string &txt);
    void fine (const std::string &txt);

    void logva(Level level, const char *, va_list args);
    void log  (Level level, const char *, ...);
    void error(const char *, ...);
    void warn (const char *, ...);
    void info (const char *, ...);
    void debug(const char *, ...);
    void fine (const char *, ...);

    bool isEnabled(Level level) const;
    bool isErrorEnabled() const;
    bool isWarnEnabled() const;
    bool isInfoEnabled() const;
    bool isDebugEnabled() const;
    bool isFineEnabled() const;

    void enable();

    void disable();

private:

    std::string fileName;
    bool timestampEnabled;
    Level currentLevel;
    Level backTraceLevel;
    bool logEnabled;
    bool printToStdout;
    pthread_mutex_t lock;
    FILE *f;

}; // class

// singleton instance (following meyer's design pattern)
Logger& logger();

}  // namespace opencog

#endif // _OPENCOG_LOGGER_H