File MIES_Debugging.ipf¶

Holds functions for handling debugging information.

Functions

static variable FindFirstOutsideCaller(string *func, string *line, string *file)¶: Return the first function from the stack trace not located in this file.

variable DEBUGPRINTv(variable var, string format = defaultValue)

Output debug information and return the parameter var.

Debug function especially designed for usage in return statements.

For example calling the following function

Function doStuff()
    variable var = 1 + 2
    return DEBUGPRINTv(var)
End

will output

DEBUG doStuff(...)#L5: return value 3

to the history.

Parameters:

var – numerical argument for debug output
format – optional format string to override the default of “%g”

wave DEBUGPRINTw(WaveOrNull wv, string format = defaultValue)¶

Output debug information and return the wave wv.

Debug function especially designed for usage in return statements.

For example calling the following function

Function/WAVE doStuff()
    Make/D/N=5 data = p
    return DEBUGPRINTw(data)
End

will output

DEBUG doStuff(...)#L5: return value {0, 1, 2, 3, 4}

to the history.

Parameters:

wv – wave argument for debug output
format – optional format string to override the default of “%g”

string DEBUGPRINTs(string str, string format = defaultValue)

Output debug information and return the parameter str.

Debug function especially designed for usage in return statements.

For example calling the following function

Function/s doStuff()
    variable str= "a" + "b"
    return DEBUGPRINTs(str)
End

will output

DEBUG doStuff(...)#L5: return value ab

to the history.

Parameters:

str – string argument for debug output
format – optional format string to override the default of “%s”

variable DEBUGPRINT(string msg, variable var = defaultValue, string str = defaultValue, WaveOrNull wv = defaultValue, string format = defaultValue)¶

Generic debug output function.

Outputs variables and strings with optional format argument.

Examples:

DEBUGPRINT("before a possible crash")
DEBUGPRINT("some variable", var=myVariable)
DEBUGPRINT("my string", str=myString)
DEBUGPRINT("Current state", var=state, format="%.5f")

Parameters:

msg – descriptive string for the debug message
var – variable
str – string
wv – wave (can be null)
format – format string overrides the default of “%g” for variables and “%s” for strings

variable DEBUGPRINT_TS(string msg, variable var = defaultValue, string str = defaultValue, string format = defaultValue)¶

Generic debug output function (threadsafe variant)

Outputs variables and strings with optional format argument.

Examples:

DEBUGPRINT("before a possible crash")
DEBUGPRINT("some variable", var=myVariable)
DEBUGPRINT("my string", str=myString)
DEBUGPRINT("Current state", var=state, format="%.5f")

Parameters:

msg – descriptive string for the debug message
var – variable
str – string
format – format string overrides the default of “%g” for variables and “%s” for strings

variable DEBUGPRINTSTACKINFO()¶: Print a nicely formatted stack trace to the history.

static variable CreateHistoryLog()¶: Creates a notebook with the special name “HistoryCarbonCopy” which will hold a copy of the history

static variable SaveHistoryLog()¶: Save the contents of the history notebook on disk in the same folder as this experiment as timestamped file “run_*_*.log”

variable DEBUGPRINT_OR_ABORT(string msg)¶: Prints a message to the command history in debug mode, aborts with dialog in release mode.

variable DEBUG_TIMER_START()

Start a timer for performance measurements.

Usage:

variable referenceTime = DEBUG_TIMER_START()
// part one to benchmark
DEBUGPRINT_ELAPSED(referenceTime)
// part two to benchmark
DEBUGPRINT_ELAPSED(referenceTime)

variable DEBUGPRINT_ELAPSED(variable referenceTime)

Print the elapsed time for performance measurements in seconds.

File MIES_Debugging.ipf¶

Table of Contents

Previous topic

Next topic