/usr/include/codeblocks/logger.h is in codeblocks-dev 16.01+dfsg-2.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 | /*
* 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 LOGGER_H
#define LOGGER_H
#include "prep.h"
#include <wx/string.h>
#include "settings.h" // DLLIMPORT
class wxMenu;
class wxWindow;
namespace
{
static wxString temp_string(_T('\0'), 250);
static wxString newline_string(_T("\n"));
}
/** The base class for all kinds of loggers, see loggers.h for its derived classes */
class DLLIMPORT Logger
{
public:
/*
* The ubiquitous, standard log levels to use are: info, warning, error, critical
*
* info - I'm telling you, but you probably won't bother reading anyway.
* warning - You should know about this. I'm telling you now, so you can't sue me later.
* error - Something failed, but the world is not going to end.
* critical - Something failed, and it hit you right in the eye. It really hurts, you have to do something.
*
* Other log levels are for special uses and may have side effects that you don't know about,
* and they may not work like expected under the specific conditions they run in... don't use them.
*/
enum level { caption, info, warning, success, error, critical, failure, pagetitle, spacer, asterisk };
enum { num_levels = asterisk +1 };
struct Feature
{
enum Enum
{
IsWrappable = 0,
CanClear,
CanCopy,
Additional
};
};
Logger() {}
virtual ~Logger() {}
/* Logger writers:
* This is the One Function you must implement. Everything else is optional or bull.
* It must be possible to call this function in presence and in absence of GUI without crashing the application.
* It is not necessary to provide any actual output at all times, but it must be 100% safe to call this function at all times.
* You may not throw from this function, it must return in finite time, and it must not call logging functions (to prevent infinite recursion).
* Other than that, you can do anything you want with the log messages that you receive.
*/
virtual void Append(const wxString& msg, Logger::level lv = info) = 0;
virtual void Clear() {}
virtual void CopyContentsToClipboard(cb_optional bool selectionOnly = false) {}
virtual void UpdateSettings() {}
virtual wxWindow* CreateControl(cb_optional wxWindow* parent) { return nullptr; }
virtual bool GetWrapMode() const { return false; }
virtual bool HasFeature(cb_optional Feature::Enum feature) const { return false; }
virtual void AppendAdditionalMenuItems(cb_optional wxMenu &menu) {}
};
#endif
|