Skins: |

NWN SCRIPTS

- Jump to comments -

Title

Trace Debugging Technique

Author

Frank Perez

Submitted / Updated

06-05-2005 / 11-22-2006

Category

Scripting routines

Expansions

Works on all versions

View Code

//::///////////////////////////////////////////////
//:: TRACE_DEBUG_INC
//:://////////////////////////////////////////////
/*
    This is a small library of trace debugging
    functions.
*/
//:://////////////////////////////////////////////
//:: Created By: Frank Perez
//:: Created On: 05 June 2005
//:://////////////////////////////////////////////

void DebugBegin(string sDebugFunction);

void DebugEnd(string sDebugFunction);

void DebugPrint(string sDebugString);


string SpaceIndent(int nIndents)
{
    string sTraceSpace = "";
    int nNumTraceIndents;
    for (nNumTraceIndents = 0; nNumTraceIndents < nIndents; nNumTraceIndents++)
        sTraceSpace += "    ";
    return sTraceSpace;
}

void DebugBegin(string sDebugFunction)
{
    int nTraceIndent = GetLocalInt(OBJECT_SELF, "TRACE_INDENT");
    SetLocalInt(OBJECT_SELF, "TRACE_INDENT", nTraceIndent + 1);
    if (nTraceIndent == 0)
        sDebugFunction += "::" + GetName(OBJECT_SELF) + " (" + ObjectToString(OBJECT_SELF) + ")";
    string sTraceSpace = SpaceIndent(nTraceIndent);
    SendMessageToPC(GetFirstPC(), sTraceSpace + sDebugFunction + " {");
    PrintString(sTraceSpace + sDebugFunction + " {");
}

void DebugEnd(string sDebugFunction)
{
    int nTraceIndent = GetLocalInt(OBJECT_SELF, "TRACE_INDENT") - 1;
    SetLocalInt(OBJECT_SELF, "TRACE_INDENT", nTraceIndent);
    if (nTraceIndent == 0)
        sDebugFunction += "::" + GetName(OBJECT_SELF) + " (" + ObjectToString(OBJECT_SELF) + ")";
    string sTraceSpace = SpaceIndent(nTraceIndent);
    SendMessageToPC(GetFirstPC(), sTraceSpace + "} // End of " + sDebugFunction);
    PrintString(sTraceSpace + "} // End of " + sDebugFunction);
    if (nTraceIndent == 0)
    {
        SendMessageToPC(GetFirstPC(), " ");
        PrintString(" ");
    }
}

void DebugPrint(string sDebugString)
{
    string sTraceSpace = SpaceIndent(GetLocalInt(OBJECT_SELF, "TRACE_INDENT"));
    SendMessageToPC(GetFirstPC(), sTraceSpace + sDebugString);
    PrintString(sTraceSpace + sDebugString);
}

Select All Text | View Code in separate window

Format

Module and Code

Type

Type - Other

Description

The Trace Debugging Technique is a simple way to trace through the function calls of your modules. It outputs the names of functions with a system of indentation and carriage returns that makes it easy to tell which functions call which. I have personally found it useful in finding and eliminating show-stopping bugs that I had not been able to find prior to creating this technique.

The attached zip file contains the following:
* A PDF document on using the Trace Debugging Technique.
* An ERF file containing an include file implementing the trace debugging code.
* A short demo module where you get to referee Lord Nasher and company in a gruesome game of musical chairs.

NOW UPDATED TO VERSION 1.1!
The Trace Debugging Technique has just gotten easier to use. You no longer need to copy and paste at least nineteen lines of trace debugging code into each function that you want to trace through. With the include file provided, all you need to add are at least two lines of code per function. Instructions on how to use the technique are provided in the revised manual.