Module:Escape/doc

Usage

This module is designed as an way to escape strings in a customized and efficient manner. It works by replacing characters that are preceded by your escape char (or phrase) There are two ways to call this module:

From another module:

local esc = require('Module:Escape')
esc:char(Template:Green)
local to_escape = esc:text(Template:Green)
Template:Green
local result = esc:undo(to_escape)

From a template:

{{invoke:Escape|main|mode=Template:Green|char=Template:Green|Template:Green}}

In a template, the most useful function is Template:Code.

This module is primarily intended to be used by other modules. However all functions can be called in template space using Template:Para followed by arguments.

All module functions (i.e. any func. other than main()) should be called using a colon (:), e.g. Template:Code or esc:kill{'{{example|\\}}}', '}'} == '{{example|}'

Template:TOC tab	This function takes only one argument: A string. All characters in this string which are preceded by the sequence set by escape:char() will be replaced with placeholders that can be converted back into that char by escape:undo()
Template:TOC tab	Takes two arguments: The string that may contain placeholders set by escape:text() Optional, a char to be placed in front of any characters that have been de-escaped. (i.e. if you need to re-escape those string with a different char)
Template:TOC tab	This is basically equivalent to calling string.gsub() on the string returned by escape:text() and feeding that result into escape:undo() in a single step. Takes three arguments: A string A sequence of characters to be removed from that string. (May use a string.gsub pattern) Optional, a char to be placed in front of any characters that have been de-escaped.
Template:TOC tab	This function's primary use is to initialize the patterns to scan a string for an escape/escaped sequence. It takes two arguments, the first being the escape character and the second being a table of arguments (optional). By default, this module will escape the Template:Code char. To escape the Template:Code char instead, you can do Template:Code (or Template:Code (presuming you stored the table returned by this module in the local variable Template:Code). When called without the second argument, char() will return a table containing the functions. This allows, for example, escape:char('*'):kill('1*23', '%d') which would return '2' For the most part, there is very little reason to set Template:Para in template space since the patterns it stores are not shared with other invokations of this module. Templates should instead use the Template:Para if a new escape sequence is desired. Shortcut If provided a second argument that is a table containing a {key = value} pair, such that the key is Template:Code, Template:Code, or Template:Code and the value is a table containing the arguments that would have been passed to those functions. For escape:undo(), will cause the escaescape:text() and escape:kill()

Caveats

• When using a multi-character escape sequence, this module only marks it using the byte value of the first character. Thus, escape:undo() will unescape, for example, all characters escaped with 'e' and 'esc' if both were used. In practice however this shouldn't be a problem as multiple escape sequences are pretty rare unless you're transitioning between multiple code languages. (Multiple multi-char escape sequences beginning with the same character are simply bad practice anyhow.)
• Since byte values are stored as numbers, it is not recommended for you to use a number as an escape sequence (though it may work just fine).
• Placeholder byte values separated with return ('\r') characters--chosen because they are seldom used at all, and virtually never used unpaired with '\n'; moreover, it is distinct from the markers generated by <nowiki>...</nowiki> or Template:Code (which use the delete char). To set a different separator char, include the key-value pair {safeChr = Template:Green} in the table that you pass to escape:char().

Speed

The following are benchmarks...

when executing the following module function:

function p.test_kill500(frame)
 local esc = require('Module:Escape')
 for k = 1, 500 do
  local v = esc:kill(p.test_string2(), 'test')
 end
 return os.clock(esc)
end

when repeating the following line 500 times in a template:

0.767

All times in seconds. The module time x500 was calculated when you loaded this doc page (normally between 0.02 and 0.07). The template time x500 was recorded on Jan 15, 2015.

Examples

Module

Here's some sample output from the debug consol below the module editor:

Template:Blue Template:Blue Template:Blue Template:Blue Template:Blue true Template:BlueTemplate:Green Template:Blue Template:Blue Template:Blue Template:Blue false Template:Blue true Template:Blue Template:Blue test test { test, test, {,test \ Template:Blue true