DebugPrint Class Reference

Collaboration diagram for DebugPrint:

Static Private Member Functions
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)

Static Private Attributes
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

Detailed Description

Definition at line 1 of file DebugPrint.c.

Member Function Documentation

AdjustDebugLog()

static string DebugPrint::AdjustDebugLog ( string msg )

inlinestaticprivate

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

Parameters

msg	string Message for adjust

Returns

string Adjusted Message

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

Definition at line 141 of file DebugPrint.c.

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

References IsDebugLog(), IsStackTrace(), TrimDebugLog(), and TrimStackTrace().

EnableTracingLogs()

static void DebugPrint::EnableTracingLogs ( bool enable )

inlinestaticprivate

Definition at line 152 of file DebugPrint.c.

  {
    s_TraceAllLogs = enable;
  }

References s_TraceAllLogs.

IsDebugLog()

bool DebugPrint::IsDebugLog ( string msg )

inlinestaticprivate

Definition at line 157 of file DebugPrint.c.

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

References MSG_COUNT, and s_MsgPrefix.

Referenced by AdjustDebugLog().

IsStackTrace()

bool DebugPrint::IsStackTrace ( string msg )

inlinestaticprivate

Definition at line 179 of file DebugPrint.c.

  {
    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;
  }

References s_MsgStackMarked, s_MsgStackMarkEnd, and s_MsgStackMarkStart.

Referenced by AdjustDebugLog().

Log()

static void DebugPrint::Log ( string msg )

inlinestaticprivate

Prints debug message with normal prio.

Parameters

msg	string Debug message for print

Returns

void None

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

Definition at line 37 of file DebugPrint.c.

  {
    LogMessage(msg, MSG_LOG, s_TraceAllLogs);
  }

References LogMessage(), MSG_LOG, and s_TraceAllLogs.

LogAndTrace()

static void DebugPrint::LogAndTrace ( string msg )

inlinestaticprivate

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

Parameters

msg	string Debug message for print

Returns

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
>>    -----------------

Definition at line 56 of file DebugPrint.c.

  {
    LogMessage(msg, MSG_LOG, true);
  }

References LogMessage(), and MSG_LOG.

LogError()

static void DebugPrint::LogError ( string msg )

inlinestaticprivate

Prints debug message as error message.

Parameters

msg	string Debug message for error print

Returns

void None

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

Definition at line 105 of file DebugPrint.c.

  {
    LogMessage(msg, MSG_ERROR, s_TraceAllLogs);
  }

References LogMessage(), MSG_ERROR, and s_TraceAllLogs.

LogErrorAndTrace()

static void DebugPrint::LogErrorAndTrace ( string msg )

inlinestaticprivate

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

Parameters

msg	string Debug message for error print

Returns

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
>>    -----------------

Definition at line 124 of file DebugPrint.c.

  {
    LogMessage(msg, MSG_ERROR, true);
  }

References LogMessage(), and MSG_ERROR.

Referenced by OnlineServices::ErrorCaught(), OnlineServices::LoadFriends(), OnlineServices::LoadMPPrivilege(), OnlineServices::LoadPermissions(), OnlineServices::LoadServers(), OnlineServices::LoadVoicePrivilege(), OnlineServices::SetServerFavorited(), OnlineServices::ShowInviteScreen(), and OnlineServices::ShowUserProfile().

LogMessage()

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

inlinestaticprivate

Definition at line 206 of file DebugPrint.c.

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

References DumpStack(), Print(), and s_MsgPrefix.

Referenced by Log(), LogAndTrace(), LogError(), LogErrorAndTrace(), LogWarning(), and LogWarningAndTrace().

LogWarning()

static void DebugPrint::LogWarning ( string msg )

inlinestaticprivate

Prints debug message as warning message.

Parameters

msg	string Debug message for warning print

Returns

void None

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

Definition at line 71 of file DebugPrint.c.

  {
    LogMessage(msg, MSG_WARNING, s_TraceAllLogs);
  }

References LogMessage(), MSG_WARNING, and s_TraceAllLogs.

LogWarningAndTrace()

static void DebugPrint::LogWarningAndTrace ( string msg )

inlinestaticprivate

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

Parameters

msg	string Debug message for warning print

Returns

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
>>    -----------------

Definition at line 90 of file DebugPrint.c.

  {
    LogMessage(msg, MSG_WARNING, true);
  }

References LogMessage(), and MSG_WARNING.

OnInit()

static void DebugPrint::OnInit ( )

inlinestaticprivate

Definition at line 14 of file DebugPrint.c.

  {
    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;
  }

References MSG_ERROR, MSG_LOG, MSG_WARNING, s_MsgPrefix, s_MsgStackMarked, s_MsgStackMarkEnd, s_MsgStackMarkStart, and s_TraceAllLogs.

TrimDebugLog()

string DebugPrint::TrimDebugLog ( string msg )

inlinestaticprivate

Definition at line 167 of file DebugPrint.c.

  {
    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);
  }

Referenced by AdjustDebugLog().

TrimStackTrace()

string DebugPrint::TrimStackTrace ( string msg )

inlinestaticprivate

Definition at line 198 of file DebugPrint.c.

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

References string::Empty.

Referenced by AdjustDebugLog().

Member Data Documentation

MSG_COUNT

const int DebugPrint::MSG_COUNT = 3

staticprivate

Definition at line 6 of file DebugPrint.c.

Referenced by IsDebugLog().

MSG_ERROR

const int DebugPrint::MSG_ERROR = 2

staticprivate

Definition at line 5 of file DebugPrint.c.

Referenced by LogError(), LogErrorAndTrace(), and OnInit().

MSG_LOG

const int DebugPrint::MSG_LOG = 0

staticprivate

Definition at line 3 of file DebugPrint.c.

Referenced by Log(), LogAndTrace(), and OnInit().

MSG_WARNING

const int DebugPrint::MSG_WARNING = 1

staticprivate

Definition at line 4 of file DebugPrint.c.

Referenced by LogWarning(), LogWarningAndTrace(), and OnInit().

s_MsgPrefix

string DebugPrint::s_MsgPrefix[MSG_COUNT]

staticprivate

Definition at line 8 of file DebugPrint.c.

Referenced by IsDebugLog(), LogMessage(), and OnInit().

s_MsgStackMarked

bool DebugPrint::s_MsgStackMarked

staticprivate

Definition at line 11 of file DebugPrint.c.

Referenced by IsStackTrace(), and OnInit().

s_MsgStackMarkEnd

string DebugPrint::s_MsgStackMarkEnd

staticprivate

Definition at line 10 of file DebugPrint.c.

Referenced by IsStackTrace(), and OnInit().

s_MsgStackMarkStart

string DebugPrint::s_MsgStackMarkStart

staticprivate

Definition at line 9 of file DebugPrint.c.

Referenced by IsStackTrace(), and OnInit().

s_TraceAllLogs

bool DebugPrint::s_TraceAllLogs

staticprivate

Definition at line 12 of file DebugPrint.c.

Referenced by EnableTracingLogs(), Log(), LogError(), LogWarning(), and OnInit().

---

The documentation for this class was generated from the following file:

• scripts/3_Game/tools/DebugPrint.c