Módulo:SimpleDebug/doc

Esta es la página de documentación de Módulo:SimpleDebug

Contiene funciones para ayudar a depurar los módulos lua: Permite recoger y visualizar los valores de varias variables y/o puntos de su programa lua, desde un módulo (lo habitual) o en varios módulos (que son requeridos desde el módulo principal).

Está diseñado para que sus funciones sean llamadas desde dentro del módulo que se quiere depurar, llamadas que deberán formar parte del código (del módulo que ha diseñado, o que quiere mejorar o adaptar) hasta que decida eliminarlas (cuando ya haya determinado el error). Así, no se ha de llamar ninguna de sus funciones con un invoke.

Atención: el uso de este módulo debería limitarse a la creación y depuración de otros módulos en zonas de pruebas.

Usos

Uno o diversos puntos a ver
Abreviaciones de las funciones: w: where (donde). n: names (nombres). v: variables. s: string (cadena).
Variables
Nombre	Por defecto
`tab.oneline`	true	Si es false o es true y contiene tablas anidadas, mostrará una línea por cada elemento de la tabla y con un sangrado para cada tabla anidada. Si es true y no contiene tablas anidadas, muestra la tabla en una línea.
`tab.allidx`	false	Si es true, también muestra los índices numéricos de una tabla.
`dec`	-1	Espacios para los decimales: -1: muestra todos los decimales necesarios. 0: sin decimales. n: 1: un decimal, 2: dos decimales, etc,
`enabled`	true	Si es false, todas las llamadas a las funciones siguientes no hacen nada.
`nohtml`	false	Sustituye < por ⪡ y > por ⪢ en las cadenas.
`plaintext`	false	Elimina el formato html.
Un punto a ver
Funciones
`w (where)`		where: etiqueta del punto.
`v (...)`		...: un seguido de variables => var1, var2...
`wv (where, ...)`		where: etiqueta del punto. ...: un seguido de variables => var1, var2...
`nv (...)`		...: un seguido de parejas de nombre-variable = name1, var1, name2, var2....
`wnv (where, ...)`		where: etiqueta del punto. ...: un seguido de parejas de nombre-variable = name1, var1, name2, var2....
Diversos puntos a ver
Variables
Nombre	Por defecto
`s`		La variable de cadena que contiene los valores devueltos de las funciones.
`maxlines.num`	100	Número máximo de líneas (al llamar a las funciones siguientes).
`maxlines.doerror`	true	Si es true y se alcanza `maxlines.num`, entonces se llama `error(s).`
`counter`	false	Añade un número autoincremental al principio de cada utilización de una función.
Funciones
`breakline ()`		Añade un retorno de línea a `s`.
`wtos (where)`		Igual a `w`, pero la cadena devuelta se guarda en `s`.
`vtos (...)`		Igual a `v`, pero la cadena devuelta se guarda en `s`.
`wvtos (where, ...)`		Igual a `wv`, pero la cadena devuelta se guarda en `s`.
`nvtos (...)`		Igual a `nv`, pero la cadena devuelta se guarda en `s`.
`wnvtos (where, ...)`		Igual a `wnv`, pero la cadena devuelta se guarda en `s`.

Ejemplos

Un punto a ver

Siguiendo el flujo

local SD = require "Module:SimpleDebug"
return SD.w ("Se ha pasado por aquí")

devuelve:

Se ha pasado por aquí

Número de decimales y valor de una variable

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

devuelve:

0.33

Nohtml

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

devuelve:

"⪡b⪢bold⪡/b⪢"

Plaintext

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

devuelve:

"bold"

El valor de varias variables

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

devuelve:

12 • "Hola"

Detección de variable no assignada

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

devuelve:

true • nil

El valor de una tabla

local SD = require "Module:SimpleDebug"
local a = {1, tab='a', 'b'}
return SD.v (a)

devuelve: { 1, "b", [tab]="a", }

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

devuelve:

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

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

devuelve:

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

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

devuelve:

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

Normalmente, implementará estas funciones con la función de error:

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

muestra:

Error de Lua: Módulo:SuMódulo:Linea: {

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

Todos los valorrd de una tabla en multinlinea

local SD = require "Module:SimpleDebug"
SD.tab.oneline = false
local a = {{Primero=1,2,3},'En medio',{4,Segundo=5,6}}
return SD.v (a)

devuelve:

{
 [1] = {
     [1] = 2,
     [2] = 3,
     ["Primero"] = 1,
   },
 [2] = "En medio",
 [3] = {
     [1] = 4,
     [2] = 6,
     ["Segundo"] = 5,
   },
}

El valor de varias variables con su nombre en un punto

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

devuelve:

a: 12 • b: "Hola"

Diversos puntos a ver

Siguiendo el flujo

local SD = require "Module:SimpleDebug" 
local tab = {1,12,7}
function p.CheckValues ()
  local function LittleNum()
    SD.wtos ('número pequeño')
  end
  local function BigNum(num)
    SD.wtos ('grande='..num)
  end
  for i, num in ipairs(tab) do
    if num > 9 then
      BigNum(num)
    else
      LittleNum()
    end  
  end  
  error (SD.s)
end

devuelve:

Error de Lua:SuMódulo:Linea:

número pequeño

grande=12

número pequeño.

Con contador

local SD = require "Module:SimpleDebug" 
function Increm()
  local n = 0
  for i = 1, 3 do
    n = n + 2
    SD.vtos (n)
  end
end
SD.counter = true
Increm()
return SD.s

devuelve:

1 • 2

2 • 4

3 • 6

Seguimiento de varias variables

local SD = require "Module:SimpleDebug"
a = 12
b = 'Hola'
SD.vtos (1,a,b)
a = a + a
b = b..' mundo!'
SD.vtos ('Finalmente',a,b)
return SD.s

devuelve:

1 => 12 • "Hola"

Finalmente => 24 • "Hola mundo!"

local SD = require "Module:SimpleDebug"
SD.breakline ()
a = 12
b = 'Hola'
c = false
SD.nvtos (1, 'a',a,'b',b,'c',c)
a = a + a
b = b..' mundo!'
SD.nvtos ('Finalmente', 'a',a,'b',b)
error (SD.s)

muestra:

Error de Lua: Módulo:SuMódulo:Linea:

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

Finalmente => a: 24 • b: "Hola mundo!"

Variables y su presentación con condiciones

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.wvtos (i, string.len(a), a)
end

muestra:

Error de Lua: Módulo:SuMódulo:Linea:

3 => 8 • "AAAAAAAA"

4 => 10 • "AAAAAAAAAA"

5 => 12 • "AAAAAAAAAAAA".