loggers.h

Go to the documentation of this file.

/*
 * This file is part of the Code::Blocks IDE and licensed under the GNU Lesser General Public License, version 3
 * http://www.gnu.org/licenses/lgpl-3.0.html
 */

#ifndef LOGGERS_H
#define LOGGERS_H

#include "logger.h"

#include <wx/colour.h>
#include <wx/font.h>
#include <wx/ffile.h>
#include <wx/textctrl.h>

class wxListCtrl;

// this file contains some kinds of loggers, they can save/record messages to different kind of devices
// all these specific logger classes are derived from Logger class defined in logger.h

class DLLIMPORT NullLogger : public Logger
{
public:
    void Append(cb_unused const wxString& msg, cb_unused Logger::level lv) override{};
};

class DLLIMPORT StdoutLogger : public Logger
{
public:
    void Append(const wxString& msg, Logger::level lv) override
    {
        fputs(wxSafeConvertWX2MB(msg.wc_str()), lv < error ? stdout : stderr);
        fputs(::newline_string.mb_str(), lv < error ? stdout : stderr);
    }
};

class DLLIMPORT FileLogger : public Logger
{
protected:
    wxFFile f;
public:
    FileLogger(const wxString& filename) : f(filename, _T("wb")) {};
    FileLogger() {};

    void Append(const wxString& msg, cb_unused Logger::level lv) override
    {
        fputs(wxSafeConvertWX2MB(msg.wc_str()), f.fp());
        fputs(::newline_string.mb_str(), f.fp());
    };

    virtual void Open(const wxString& filename) { Close(); f.Open(filename, _T("wb")); };
    virtual void Close(){ if(f.IsOpened()) f.Close(); };
};

struct CSS
{
    wxString caption;
    wxString info;
    wxString warning;
    wxString success;
    wxString error;
    wxString critical;
    wxString failure;
    wxString pagetitle;
    wxString spacer;
    wxString asterisk;

    CSS();
    operator wxString();
};

class DLLIMPORT HTMLFileLogger : public FileLogger
{
    CSS css;
public:
    HTMLFileLogger(const wxString& filename);
    void SetCSS(const CSS& in_css) { css = in_css; };

    void Append(const wxString& msg, Logger::level lv) override;
    void Open(const wxString& filename) override;
    void Close() override;
};

class DLLIMPORT TextCtrlLogger : public Logger
{
protected:

    wxTextCtrl* control;
    bool        fixed;
    wxTextAttr  style[num_levels];

public:
    TextCtrlLogger(bool fixedPitchFont = false);
    ~TextCtrlLogger() override;

    void      CopyContentsToClipboard(bool selectionOnly = false) override;
    void      UpdateSettings() override;
    void      Append(const wxString& msg, Logger::level lv = info) override;
    void      Clear() override;
    wxWindow* CreateControl(wxWindow* parent) override;
    bool      GetWrapMode() const override;
    virtual void      ToggleWrapMode();
    bool      HasFeature(Feature::Enum feature) const override;
};

class DLLIMPORT TimestampTextCtrlLogger : public TextCtrlLogger
{
public:
    void Append(const wxString& msg, Logger::level lv = info) override;
};

class DLLIMPORT ListCtrlLogger : public Logger
{
protected:

    wxListCtrl*   control;
    bool          fixed;
    wxArrayString titles;
    wxArrayInt    widths;

    struct ListStyles
    {
        wxFont font;
        wxColour colour;
    };
    ListStyles style[num_levels];

    wxString GetItemAsText(long item) const;
public:

    ListCtrlLogger(const wxArrayString& titles, const wxArrayInt& widths, bool fixedPitchFont = false);
    ~ListCtrlLogger() override;

    void      CopyContentsToClipboard(bool selectionOnly = false) override;
    void      UpdateSettings() override;
    void      Append(const wxString& msg, Logger::level lv = info) override;
    virtual void      Append(const wxArrayString& colValues, Logger::level lv = info, int autoSize = -1);
    virtual size_t    GetItemsCount() const;
    void      Clear() override;
    wxWindow* CreateControl(wxWindow* parent) override;
    bool      HasFeature(Feature::Enum feature) const override;
    virtual void      AutoFitColumns(int column);
};

#endif // LOGGERS_H