+---
+-- Basic debug output
-- initialization {{{
local base = _G
local io = require 'io'
-- }}}
+---
+-- This module implements a few useful debug functions for use throughout the
+-- rest of the code.
module 'irc.debug'
-- defaults {{{
-- public functions {{{
-- enable {{{
+---
+-- Turns on debug output.
function enable()
ON = true
end
-- }}}
-- disable {{{
+---
+-- Turns off debug output.
function disable()
ON = false
end
-- }}}
-- set_output {{{
+---
+-- Redirects output to a file rather than stdout.
+-- @param file File to write debug output to
function set_output(file)
outfile = base.assert(io.open(file))
end
-- }}}
-- message {{{
+--
+-- Output a debug message.
+-- @param msg_type Arbitrary string corresponding to the type of message
+-- @param msg Message text
+-- @param color Which terminal code to use for color output (defaults to
+-- dark gray)
function message(msg_type, msg, color)
if ON then
local endcolor = ""
-- }}}
-- err {{{
+--
+-- Signal an error. Writes the error message to the screen in red and calls
+-- error().
+-- @param msg Error message
+-- @see error
function err(msg)
message("ERR", msg, "\027[0;31m")
base.error(msg, 2)
-- }}}
-- warn {{{
+--
+-- Signal a warning. Writes the warning message to the screen in yellow.
+-- @param msg Warning message
function warn(msg)
message("WARN", msg, "\027[0;33m")
end