Module:SimpleDebug/doc: Difference between revisions
Latest revision as of 13:29, 17 October 2021
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).
It is designed so that its functions are called from within the module that is to be debugged, calls that will have to be part of the code (of the module that you have designed, or that you want to improve or adapt) until you decide to delete them (when you already have determined the bug). Thus, you do not have to call any of its functions from an invoke.
Uses
[edit ]| One or several points to watch | ||
|---|---|---|
Function abbreviations: w: where. n: names. v: variables. s: string.
| ||
| Variables | ||
| Name | Default | |
tab.oneline |
true |
|
tab.allidx |
false |
If it is true then also displays the numerical indexes of a table. |
dec |
-1 |
Spaces for the decimals:
|
enabled |
true |
If it is false all calls to the below functions do nothing. |
nohtml |
false |
In strings, it replaces < for ⪡ and > for ⪢. |
plaintext |
false |
Deletes html format. |
| One point to watch | ||
| Functions | ||
w (where) |
| |
v (...) |
| |
wv (where, ...) |
| |
nv (...) |
| |
wnv (where, ...) |
| |
| 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 |
counter |
false |
Adds an autoincremental number at the beginning of each call of a function. |
| Functions | ||
breakline () |
Adds a break line in | |
wtos (where) |
Equal to | |
vtos (...) |
Equal to | |
wvtos (where, ...) |
Equal to | |
nvtos (...) |
Equal to | |
wnvtos (where, ...) |
Igual a | |
Examples
[edit ]One point to watch
[edit ]Following the flow
[edit ]localSD=require"Module:SimpleDebug" returnSD.v('Here is reached')
returns:
Here is reached
Number of decimal places and value of a variable
[edit ]localSD=require"Module:SimpleDebug" SD.dec=2 returnSD.v(1/3)
returns:
0.33
Nohtml
[edit ]localSD=require"Module:SimpleDebug" SD.nohtml=true returnSD.v("<b>bold</b>")
returns:
"⪡b⪢bold⪡/b⪢"
Plaintext
[edit ]localSD=require"Module:SimpleDebug" SD.plaintext=true returnSD.v("<b>bold</b>")
returns:
"bold"
The value of several variables
[edit ]localSD=require"Module:SimpleDebug" locala=12 localb='Hello' returnSD.v(a,b)
returns:
12 • "Hello"
Non-assigned variable detection
[edit ]localSD=require"Module:SimpleDebug" locala=true returnSD.v(a,b)
returns:
true • nil
The value of a table
[edit ]localSD=require"Module:SimpleDebug" locala={1,tab='a','b'} returnSD.v(a)
returns: { 1, "b", [tab]="a", }
localSD=require"Module:SimpleDebug" locala={{1,2,3},{4,5,6},{7,8,9}} returnSD.v(a)
returns:
{
[1] = {1, 2, 3, },
[2] = {4, 5, 6, },
[3] = {7, 8, 9, },
}
localSD=require"Module:SimpleDebug" locala={{First=1,2,3},{4,Second=5,6},{7,8,9}} returnSD.v(a)
returns:
{
[1] = {2, 3, [First]=1, },
[2] = {4, 6, [Second]=5, },
[3] = {7, 8, 9, },
}
localSD=require"Module:SimpleDebug" SD.tab.allidx=true locala={{1,2,3},{4,nil,6},{7,8,9}} returnSD.v(a)
returns:
{
[1]={[1]=1, [2]=2, [3]=3, },
[2]={[1]=4, [3]=6, },
[3]={[1]=7, [2]=8, [3]=9, },
}
Usually, you implement these functions with error function:
localSD=require"Module:SimpleDebug" locala={{1,2,3},{4,5,6},{7,8,9}} error(SD.v(a))
displays:
Lua error:Module:YourModule:Line:{
[1] = {1, 2, 3, },
[2] = {4, 5, 6, },
[3] = {7, 8, 9, },
}
All values of a table in multiline
[edit ]localSD=require"Module:SimpleDebug" SD.tab.oneline=false locala={{First=1,2,3},'Middle',{4,Second=5,6}} returnSD.v(a)
retorna:
{
[1] = {
[1] = 2,
[2] = 3,
["First"] = 1,
},
[2] = "Middle",
[3] = {
[1] = 4,
[2] = 6,
["Second"] = 5,
},
}
The value of several variables with their name in a point
[edit ]localSD=require"Module:SimpleDebug" locala=12 localb='Hello' returnSD.nv('a',a,'b',b)
returns:
a: 12 • b: "Hello"
Several points to watch
[edit ]Following the flow
[edit ]localSD=require"Module:SimpleDebug" localtab={1,12,7} functionp.CheckValues() localfunctionLittleNum() SD.wtos('little number') end localfunctionBigNum(num) SD.wtos('big='..num) end fori,numinipairs(tab)do ifnum>9then BigNum(num) else LittleNum() end end error(SD.s) end
returns:
Lua Error:Module:Your module:Line:
little number
big=12
little number.
With counter
[edit ]localSD=require"Module:SimpleDebug" functionIncrem() localn=0 fori=1,3do n=n+2 SD.vtos(n) end end SD.counter=true Increm() returnSD.s
returns:
1 • 2
2 • 4
3 • 6
Monitoring of several variables
[edit ]localSD=require"Module:SimpleDebug" a=12 b='Hello' SD.vtos(1,a,b) a=a+a b=b..' world!' SD.vtos('Finally',a,b) returnSD.s
returns:
1 => 12 • "Hello"
Finally => 24 • "Hello world!"
localSD=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 ]localSD=require"Module:SimpleDebug" SD.breakline() SD.enabled=false SD.maxlines.num=3 locala='AA' fori=1,10do a=a+'AA' ifi==3then 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".