This module provides methods for quickly printing messages to the display at run-time when the -d option is used.

dfh is short for Debug Function Header. It returns a string combining the following:

• name of the thread if Thread[‘name’] has been defined
• name of the Class/Module
• name of the object if name() is defined for self or the object
• name of the method or caller[0]
• (args.join("’"))

For example:

 def name()  # this object has a name method
    return 'MyName'
 end
 def MyClass.method_name(param1, param2)
    debug 2, dfh(param1, param2) =>  MyClass'MyName'.method_name(param1, param2)
 end

This can be used to start each debug and raise to keep the messages consistent and easier to manage. I use this to add the things I like to see in debug statements.

Set the level of debug (sets @@debug_level). The higher the number, the more debug. Debug_level is a number relating to the debug_level of each debug.

This works exactly like a print statement with the following exceptions:

• one leading space is automatically added for each nested function call to provide a nice terraced look
• the debug message is surrounded with <<…>> to help them stand out
• automatically adds a trailing "\n"

This example prints when $DEBUG is true and @@debug_level is >= 5:

   debug 5, 'test ', 2400, ' message'  if ($DEBUG)
   =>  <<05|test 2400 message>>

This example prints when $DEBUG is true and @@debug_level is >= 6, assume this is called inside instance method ‘save()’ of class Locana and the object has a name of test_object:

 def name()
    'test_object'
 end
 def save(param1, param2)    # where param1 == 2400 and param2 == "message"
   debug 6, dfh(param1, param2) if ($DEBUG)
   =>  <<06|Locana'test_object'.save(2400, "message")>>
 end

This example prints when $DEBUG is true and @@debug_level is >= 10, assume this is called inside class method "save(2400, ‘p2’)" of class Locana:

   debug 10, dfh(param.inspect, param2.inpect), " - what ever you want to reveal goes here" if ($DEBUG)
    =>  <<10|Locana.save(2400, "p2") - what ever you want to reveal goes here>>