mirror of
https://github.com/TorqueGameEngines/Torque3D.git
synced 2026-01-20 12:44:46 +00:00
2b295fb7f0
virtuals removed and replaced with override where necessary on the rest of the code base, clang-tidy to the rescue.
127 lines
4.3 KiB
C++
127 lines
4.3 KiB
C++
//-----------------------------------------------------------------------------
|
|
// Copyright (c) 2012 GarageGames, LLC
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to
|
|
// deal in the Software without restriction, including without limitation the
|
|
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
|
|
// sell copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
|
|
// IN THE SOFTWARE.
|
|
//-----------------------------------------------------------------------------
|
|
|
|
#ifndef _CONSOLE_LOGGER_H_
|
|
#define _CONSOLE_LOGGER_H_
|
|
|
|
#ifndef _SIMOBJECT_H_
|
|
#include "console/simObject.h"
|
|
#endif
|
|
#ifndef _CONSOLE_H_
|
|
#include "console/console.h"
|
|
#endif
|
|
#ifndef _FILESTREAM_H_
|
|
#include "core/stream/fileStream.h"
|
|
#endif
|
|
|
|
|
|
/// @ingroup console_system Console System
|
|
/// @{
|
|
|
|
typedef ConsoleLogEntry::Level LogLevel;
|
|
DefineEnumType( LogLevel );
|
|
|
|
/// A class designed to be used as a console consumer and log
|
|
/// the data it receives to a file.
|
|
class ConsoleLogger : public SimObject
|
|
{
|
|
typedef SimObject Parent;
|
|
|
|
private:
|
|
|
|
bool mLogging; ///< True if it is currently consuming and logging
|
|
FileStream mStream; ///< File stream this object writes to
|
|
static bool smInitialized; ///< This is for use with the default constructor
|
|
bool mAppend; ///< If false, it will clear the file before logging to it.
|
|
StringTableEntry mFilename; ///< The file name to log to.
|
|
|
|
/// List of active ConsoleLoggers to send log messages to
|
|
static Vector<ConsoleLogger *> mActiveLoggers;
|
|
|
|
/// The log function called by the consumer callback
|
|
/// @param consoleLine Line of text to log
|
|
void log( const char *consoleLine );
|
|
|
|
/// Utility function, sets up the object (for script interface) returns true if successful
|
|
bool init();
|
|
|
|
public:
|
|
|
|
// @name Public console variables
|
|
/// @{
|
|
ConsoleLogEntry::Level mLevel; ///< The level of log messages to log
|
|
/// @}
|
|
|
|
DECLARE_CONOBJECT( ConsoleLogger );
|
|
|
|
static void initPersistFields();
|
|
|
|
/// Console constructor
|
|
///
|
|
/// @code
|
|
/// // Example script constructor usage.
|
|
/// %obj = new ConsoleLogger( objName, logFileName, [append = false] );
|
|
/// @endcode
|
|
bool processArguments( S32 argc, ConsoleValue *argv ) override;
|
|
|
|
/// Default constructor, make sure to initalize
|
|
ConsoleLogger();
|
|
|
|
/// Constructor
|
|
/// @param fileName File name to log to
|
|
/// @param append If false, it will clear the file, then start logging, else it will append
|
|
ConsoleLogger( const char *fileName, bool append = false );
|
|
|
|
/// Destructor
|
|
~ConsoleLogger();
|
|
|
|
/// Attach to the console and begin logging
|
|
///
|
|
/// Returns true if the action is successful
|
|
bool attach();
|
|
|
|
/// Detach from the console and stop logging
|
|
///
|
|
/// Returns true if the action is successful
|
|
bool detach();
|
|
|
|
/// Sets the level of console messages to log.
|
|
///
|
|
/// @param level Log level. Only items of the specified level or
|
|
/// lower are logged.
|
|
/// @see ConsoleLogEntry::Level
|
|
void setLogLevel( ConsoleLogEntry::Level level );
|
|
|
|
/// Returns the level of console messages to log
|
|
ConsoleLogEntry::Level getLogLevel() const;
|
|
|
|
/// The callback for the console consumer
|
|
///
|
|
/// @note This is a global callback, not executed per-instance.
|
|
/// @see Con::addConsumer
|
|
static void logCallback( U32 level, const char *consoleLine );
|
|
};
|
|
|
|
/// @}
|
|
|
|
#endif // _CONSOLE_LOGGER_H_
|