Класс DebugPrint

Закрытые статические члены
static void	OnInit ()
static void	Log (string msg)
	Prints debug message with normal prio.
static void	LogAndTrace (string msg)
	Prints debug message as normal message and prints stack trace of calls.
static void	LogWarning (string msg)
	Prints debug message as warning message.
static void	LogWarningAndTrace (string msg)
	Prints debug message as warning message and prints stack trace of calls.
static void	LogError (string msg)
	Prints debug message as error message.
static void	LogErrorAndTrace (string msg)
	Prints debug message as error message and prints stack trace of calls.
static string	AdjustDebugLog (string msg)
	Function adjust received message for debug console (Do not use)
static void	EnableTracingLogs (bool enable)
bool	IsDebugLog (string msg)
string	TrimDebugLog (string msg)
bool	IsStackTrace (string msg)
string	TrimStackTrace (string msg)
void	LogMessage (string msg, int msg_type, bool trace=false)

Закрытые статические данные
const int	MSG_LOG = 0
const int	MSG_WARNING = 1
const int	MSG_ERROR = 2
const int	MSG_COUNT = 3
string	s_MsgPrefix [MSG_COUNT]
string	s_MsgStackMarkStart
string	s_MsgStackMarkEnd
bool	s_MsgStackMarked
bool	s_TraceAllLogs

Подробное описание

Методы

AdjustDebugLog()

static string AdjustDebugLog ( string msg )

inlinestaticprivate

Function adjust received message for debug console (Do not use)

Аргументы

msg	string Message for adjust

Возвращает

string Adjusted Message

string msg = DebugPrint.AdjustDebugLog("s = 'Hello World, this is error log'");
DebugPrint.Log(msg);
 
>> Hello World, this is error log

    {
        if ( IsStackTrace(msg) )
        {
            return TrimStackTrace(msg);
        }
        
        if ( IsDebugLog(msg) ) 
        {
            return TrimDebugLog(msg);
        }
        
        return msg;
    }

Перекрестные ссылки IsDebugLog(), IsStackTrace(), TrimDebugLog() и TrimStackTrace().

EnableTracingLogs()

static void EnableTracingLogs ( bool enable )

inlinestaticprivate

    {
        s_TraceAllLogs = enable;
    }

Перекрестные ссылки s_TraceAllLogs.

IsDebugLog()

bool IsDebugLog ( string msg )

inlinestaticprivate

    {
        for ( int i = 0; i < MSG_COUNT; ++i )
        {
            if ( msg.IndexOf(s_MsgPrefix[i]) != -1 )
            {
                return true;
            }
        }
        
        return false;
    }

Перекрестные ссылки MSG_COUNT и s_MsgPrefix.

Используется в AdjustDebugLog().

IsStackTrace()

bool IsStackTrace ( string msg )

inlinestaticprivate

    {
        if ( s_MsgStackMarked && msg.IndexOf(s_MsgStackMarkEnd) != -1 )
        {
            s_MsgStackMarked = false;
            return false;
        }
        
        if ( s_MsgStackMarked )
        {
            return true;
        }
        
        if ( msg.IndexOf(s_MsgStackMarkStart) != -1 )
        {
            s_MsgStackMarked = true;
            return true;
        }
        
        return false;
    }

Перекрестные ссылки s_MsgStackMarked, s_MsgStackMarkEnd и s_MsgStackMarkStart.

Используется в AdjustDebugLog().

Log()

static void Log ( string msg )

inlinestaticprivate

Prints debug message with normal prio.

Аргументы

msg	string Debug message for print

Возвращает

void None

DebugPrint.Log("Hello World");
 
>> [Log]: Hello World;

    {
        LogMessage(msg, MSG_LOG, s_TraceAllLogs);
    }

Перекрестные ссылки LogMessage(), MSG_LOG и s_TraceAllLogs.

LogAndTrace()

static void LogAndTrace ( string msg )

inlinestaticprivate

Prints debug message as normal message and prints stack trace of calls.

Аргументы

msg	string Debug message for print

Возвращает

void None

DebugPrint.LogAndTrace("Hello World, this is normal log");
 
>> [Log]: Hello World, this is normal log
>>      -- Stack trace --
>>      OnKeyPress() Scripts/mission/missionGameplay.c : 230
>>      OnKeyPress() Scripts/DayZGame.c : 346
>>      -----------------

    {
        LogMessage(msg, MSG_LOG, true);
    }

Перекрестные ссылки LogMessage() и MSG_LOG.

LogError()

static void LogError ( string msg )

inlinestaticprivate

Prints debug message as error message.

Аргументы

msg	string Debug message for error print

Возвращает

void None

DebugPrint.LogError("Hello World, this is error log");
 
>> [Error]: Hello World, this is error log

    {
        LogMessage(msg, MSG_ERROR, s_TraceAllLogs);
    }

Перекрестные ссылки LogMessage(), MSG_ERROR и s_TraceAllLogs.

LogErrorAndTrace()

static void LogErrorAndTrace ( string msg )

inlinestaticprivate

Prints debug message as error message and prints stack trace of calls.

Аргументы

msg	string Debug message for error print

Возвращает

void None

DebugPrint.LogErrorAndTrace("Hello World, this is error log");
 
>> [Error]: Hello World, this is error log
>>      -- Stack trace --
>>      OnKeyPress() Scripts/mission/missionGameplay.c : 230
>>      OnKeyPress() Scripts/DayZGame.c : 346
>>      -----------------

    {
        LogMessage(msg, MSG_ERROR, true);
    }

Перекрестные ссылки LogMessage() и MSG_ERROR.

Используется в OnlineServices::ErrorCaught(), OnlineServices::LoadFriends(), OnlineServices::LoadMPPrivilege(), OnlineServices::LoadPermissions(), OnlineServices::LoadServers(), OnlineServices::LoadVoicePrivilege(), OnlineServices::SetServerFavorited(), OnlineServices::ShowInviteScreen() и OnlineServices::ShowUserProfile().

LogMessage()

void LogMessage ( string msg, int msg_type, bool trace = false )

inlinestaticprivate

    {   
        string mesg = "["+s_MsgPrefix[msg_type]+"]: "+msg;
        
        Print(mesg);
        
        if ( trace )
        {
            DumpStack();
        }
    }

Перекрестные ссылки DumpStack(), Print() и s_MsgPrefix.

Используется в Log(), LogAndTrace(), LogError(), LogErrorAndTrace(), LogWarning() и LogWarningAndTrace().

LogWarning()

static void LogWarning ( string msg )

inlinestaticprivate

Prints debug message as warning message.

Аргументы

msg	string Debug message for warning print

Возвращает

void None

DebugPrint.LogWarning("Hello World, this is warning log");
 
>> [Warning]: Hello World, this is warning log

    {
        LogMessage(msg, MSG_WARNING, s_TraceAllLogs);
    }

Перекрестные ссылки LogMessage(), MSG_WARNING и s_TraceAllLogs.

LogWarningAndTrace()

static void LogWarningAndTrace ( string msg )

inlinestaticprivate

Prints debug message as warning message and prints stack trace of calls.

Аргументы

msg	string Debug message for warning print

Возвращает

void None

DebugPrint.LogWarningAndTrace("Hello World, this is warning log");
 
>> [Warning]: Hello World, this is warning log
>>      -- Stack trace --
>>      OnKeyPress() Scripts/mission/missionGameplay.c : 230
>>      OnKeyPress() Scripts/DayZGame.c : 346
>>      -----------------

    {
        LogMessage(msg, MSG_WARNING, true);
    }

Перекрестные ссылки LogMessage() и MSG_WARNING.

OnInit()

static void OnInit ( )

inlinestaticprivate

    {
        s_MsgPrefix[MSG_LOG]        = "Log";
        s_MsgPrefix[MSG_WARNING]    = "Warning";
        s_MsgPrefix[MSG_ERROR]      = "Error";
        
        s_MsgStackMarkStart         = "-- Stack trace --";
        s_MsgStackMarked            = false;
        s_MsgStackMarkEnd           = "-----------------";
        
        s_TraceAllLogs              = false;
    }

Перекрестные ссылки MSG_ERROR, MSG_LOG, MSG_WARNING, s_MsgPrefix, s_MsgStackMarked, s_MsgStackMarkEnd, s_MsgStackMarkStart и s_TraceAllLogs.

TrimDebugLog()

string TrimDebugLog ( string msg )

inlinestaticprivate

    {
        int msg_lenght = msg.Length();
        int log_start = msg.IndexOf("'") + 1;
        
        if ( log_start == -1 )
        {
            return msg;
        }
        
        int log_lenght = msg_lenght - log_start - 2;
        
        return msg.Substring(log_start, log_lenght);
    }

Используется в AdjustDebugLog().

TrimStackTrace()

string TrimStackTrace ( string msg )

inlinestaticprivate

    {
        if ( msg.IndexOf("DebugPrint.c") != -1 )
        {
            return string.Empty;
        }
        
        return msg;
    }

Перекрестные ссылки string::Empty.

Используется в AdjustDebugLog().

Поля

MSG_COUNT

const int MSG_COUNT = 3

staticprivate

Используется в IsDebugLog().

MSG_ERROR

const int MSG_ERROR = 2

staticprivate

Используется в LogError(), LogErrorAndTrace() и OnInit().

MSG_LOG

const int MSG_LOG = 0

staticprivate

Используется в Log(), LogAndTrace() и OnInit().

MSG_WARNING

const int MSG_WARNING = 1

staticprivate

Используется в LogWarning(), LogWarningAndTrace() и OnInit().

s_MsgPrefix

string s_MsgPrefix[MSG_COUNT]

staticprivate

Используется в IsDebugLog(), LogMessage() и OnInit().

s_MsgStackMarked

bool s_MsgStackMarked

staticprivate

Используется в IsStackTrace() и OnInit().

s_MsgStackMarkEnd

string s_MsgStackMarkEnd

staticprivate

Используется в IsStackTrace() и OnInit().

s_MsgStackMarkStart

string s_MsgStackMarkStart

staticprivate

Используется в IsStackTrace() и OnInit().

s_TraceAllLogs

bool s_TraceAllLogs

staticprivate

Используется в EnableTracingLogs(), Log(), LogError(), LogWarning() и OnInit().

---

Объявления и описания членов класса находятся в файле:

• D:/Ishodniki/scripts/3_Game/tools/DebugPrint.c