Module:SimpleDebug/doc

Jump to navigation Jump to search

This is the documentation page for Module:SimpleDebug

Contains a functions to help debug the lua modules. It allows to collect and view the values of several variables and/or points in your lua program, from a module (which is usual) or in several modules (which are required from the main module).

Uses[edit source]

One or several points to watch
Function abbreviations: w: where. n: names. v: variables. s: string.
Variables
Name Default
tab.oneline true

If true, it shows the table in a line; Alternatively with a line for each element of the table and with an indent for each nested table.

tab.allidx false

If it is true then also displays the numerical indexes of a table.

dec -1

Spaces for the decimals:

  • -1: It displays all required decimals.
  • 0: No decimals.
  • n: 1: one decimal, 2: two decimals, etc.
enabled true

If it is false all calls to the below functions do nothing.

nowiki false

Adds <nowiki> and </nowiki> to strings.

One point to watch
Functions
w (where)
  • where: point label.
v (...)
  • ...: a number of variables = var1, var2...
wv (where, ...)
  • where: point label.
  • ...: a number of variables = var1, var2...
nv (...)
  • ...: a number of pairs of name-variable = name1, var1, name2, var2....
wnv (where, ...)
  • where: point label.
  • ...: a number of pairs of name-variable = name1, var1, name2, var2....
Several points to watch
Variables
Name Default
s

The string variable that holds the returned values from the next functions.

maxlines.num 100

The maxim number of lines (on calling the next functions).

maxlines.doerror true

If it is true and maxlines.num is reached, error(s) is called.

Functions
breakline ()

Adds a break line in s.

wtos (where)

Equal to w, but the return string is stored in s.

vtos (...)

Equal to v, but the return string is stored in s.

wvtos (where, ...)

Equal to wv, but the return string is stored in s.

nvtos (...)

Equal to nv, but the return string is stored in s.

wnvtos (where, ...)

Igual a wnv, but the return string is stored in s.

Examples[edit source]

One point to watch[edit source]

Following the flow[edit source]

local sd = require "Module:SimpleDebug"
return sd.v ('Here is reached')

returns:

Here is reached


Number of decimal places and value of a variable[edit source]

local sd = require "Module:SimpleDebug"
sd.dec = 2
return sd.v (1/3)

returns:

0.33


Nowiki[edit source]

local sd = require "Module:SimpleDebug"
sd.nowiki = true
return sd.v ("<b>bold</b>")

returns:

<b>bold</b>


The value of several variables[edit source]

local sd = require "Module:SimpleDebug"
local a = 12
local b = 'Hello'
return sd.v (a,b)

returns:

12  •  "Hello"


Non-assigned variable detection[edit source]

local sd = require "Module:SimpleDebug"
local a = true
return sd.v (a,b)

returns:

true  •  nil


The value of a table[edit source]

local sd = require "Module:SimpleDebug"
local a = {{1,2,3},{4,5,6},{7,8,9}}
return sd.v (a)

returns:

{ { 1, 2, 3, } , { 4, 5, 6, } , { 7, 8, 9, } , }


local sd = require "Module:SimpleDebug"
local a = {{First=1,2,3},{4,Second=5,6},{7,8,9}}
return sd.v (a)

returns:

{ { 2, 3, [First]=1, } , { 4, 6, [Second]=5, } , { 7, 8, 9, } , }


local sd = require "Module:SimpleDebug"
SD.allidx = true
local a = {{1,2,3},{4,5,6},{7,8,9}}
return sd.v (a)

returns:

{ [1]={ [1]=1, [2]=2, [3]=3, } , [2]={ [1]=4, [2]=5, [3]=6, } , [3]={ [1]=7, [2]=8, [3]=9, } , }


Usually, you implement these functions with error function:

local sd = require "Module:SimpleDebug"
local a = {{1,2,3},{4,5,6},{7,8,9}}
error (sd.v (a))

displays:

Lua error:Module:YourModule:Line:{ { 1, 2, 3, } , { 4, 5, 6, } , { 7, 8, 9, } , }


The value of a table in multiline[edit source]

local sd = require "Module:SimpleDebug"
SD.tab.oneline = false
local a = {{First=1,2,3},'Middle',{4,Second=5,6}}
return sd.v (a)

retorna:

table#1 {
 table#2 {
   2,
   3,
   ["First"] = 1,
 },
 "Middle",
 table#3 {
   4,
   6,
   ["Second"] = 5,
 },
} 


The value of several variables with their name in a point[edit source]

local sd = require "Module:SimpleDebug"
local a = 12
local b = 'Hello'
return sd.nv ('a',a,'b',b)

returns:

a: 12  •  b: "Hello"


Several points to watch[edit source]

Following the flow[edit source]

local sd = require "Module:SimpleDebug" 
local tab = {1,12,7}
function p.CheckValues ()
  local function LittleNum()
    sd.wtos ('little number')
  end
  local function BigNum(num)
    sd.wtos ('big='..num)
  end
  for i, num in ipairs(tab) do
    if num > 9 then
      BigNum(num)
    else
      LittleNum()
    end  
  end  
  error (sd.s)
end

returns:

Error de Lua:Mòdul:VostreMòdul:Línia: little number

big=12

little number.


Monitoring of several variables[edit source]

local sd = require "Module:SimpleDebug"
a = 12
b = 'Hello'
sd.vtos (1,a,b)
a = a + a
b = b..' world!'
sd.vtos ('Finally',a,b)
return sd.s

returns:

1 => 12  •  "Hello"

Finally => 24  •  "Hello world!"


local sd = require "Module:SimpleDebug"
sd.breakline ()
a = 12
b = 'Hello'
c = false
sd.nvtos (1,'a',a,'b',b,'c',c)
a = a + a
b = b..' world!'
sd.nvtos ('Finally','a',a,'b',b)
error (sd.s)

displays:

Lua error:Module:YourModule:Line:

1 => a: 12  •  b: "Hello"  •  c: false

Finally => a: 24  •  b: "Hello world!"

Variables and their presentation with conditions[edit source]

local sd = require "Module:SimpleDebug"
sd.breakline()
sd.enabled = false
sd.maxlines.num = 3
local a = 'AA'
for i = 1, 10 do
  a = a + 'AA'
  if i == 3 then
    sd.enabled = true
  end
  sd.nvtos (i, string.len(a), a)
end

displays:

Lua error:Module:YourModule:Line:

3 => 8  •  "AAAAAAAA"

4 => 10  •  "AAAAAAAAAA"

5 => 12  •  "AAAAAAAAAAAA".

External links[edit source]