Module:Escape/උපදෙස්

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:

සැකිල්ල:Codett
esc:char(escape char (or sequence))
සැකිල්ල:Codett(string)
code that replaces or removes unescaped chars
සැකිල්ල:Codett

From a template:

සැකිල්ල:Mlx

In a template, the most useful function is

XML Example

kill

.

This module is primarily intended to be used by other modules. However all functions can be called in template space using |mode=the function you want to call followed by arguments.

All module functions (i.e. any func. other than

XML Example

main()

) should be called using a colon (සැකිල්ල:Char), e.g.

XML Example

esc:char('%')

or

XML Example

esc:kill{'{{example|\\}}}', '}'} == '{{example|}'

සැකිල්ල:TOC tab	This function takes only one argument: A string. All characters in this string which are preceded by the sequence set by XML Example escape:char() will be replaced with placeholders that can be converted back into that char by escape:undo()
සැකිල්ල:TOC tab	Takes two arguments: The string that may contain placeholders set by XML Example 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)
සැකිල්ල:TOC tab	This is basically equivalent to calling XML Example string.gsub() on the string returned by XML Example escape:text() and feeding that result into XML Example escape:undo() in a single step. Takes three arguments: A string A sequence of characters to be removed from that string. (May use a XML Example string.gsub() pattern) Optional, a char to be placed in front of any characters that have been de-escaped.
සැකිල්ල: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 XML Example \ char. To escape the XML Example { char instead, you can do XML Example require('Module:Escape'):char('{') (or XML Example esc:char('{') (presuming you stored the table returned by this module in the local variable XML Example esc ). When called without the second argument, char() will return a table containing the functions. This allows, for example, XML Example escape:char('*'):kill('1*23', '%d') which would return '2'. For the most part, there is very little reason to set |mode= in template space since the patterns it stores are not shared with other invokations of this module. Templates should instead use the |char= 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 XML Example text , XML Example undo , or XML Example kill and the value is a table containing the arguments that would have been passed to those functions. For example, XML Example escape:char('\\', {text = 'string'}) is equivalent to XML Example escape:char('\\'):text('string') . Note that if multiple key-value pairs are provided, only one may execute. XML Example kill is ignored if either XML Example text or XML Example undo are present. XML Example undo is ignored if XML Example text is present.

Caveats

• When using a multi-character escape sequence, this module only marks it using the byte value of the first character. Thus,
  XML Example

  escape:undo()
  

  will unescape, for example, all characters escaped with
  XML Example

  'e'
  

  and
  XML Example

  '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 (
  XML Example

  '\r'
  

  ) characters--chosen because they are seldom used at all, and virtually never used unpaired with
  XML Example

  '\n'
  

  ; moreover, it is distinct from the markers generated by <nowiki>...</nowiki> or
  XML Example

  mw.text.nowiki()
  

  (which use the delete char). To set a different separator char, include the key-value pair {safeChr = alternate character} 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

0.01764

when repeating the following line 500 times in a template:

XML Example

{{#invoke:Escape|main|mode=kill|{{#invoke:Escape/testcases|test_string2}}|test}}

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.

ආයාත කිරීමට පෙර ඉතිහාසය

oldid	date/time	username	edit summary
642652924	2015-01-15T20:45:13Z	Codehydro
642648556	2015-01-15T20:11:45Z	Codehydro	speed benchmark
642495498	2015-01-14T19:30:40Z	Codehydro
642491193	2015-01-14T18:54:04Z	Codehydro
642490918	2015-01-14T18:51:43Z	Codehydro
642490836	2015-01-14T18:51:04Z	Codehydro
642490541	2015-01-14T18:48:41Z	Codehydro	[[WP:AES|←]]Created page with '-- Example Unit tests for [[Module:Bananas]]. Click talk page to run tests. local p = require('Module:UnitTests') function p:test_string() return self:equal...'

Module

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

local escape = require('Module:Escape')
test = 'test, \\test, \\{,test\\\\ \\\\ \\\\\\\\'

test2 = escape:char('{'):text(test)
=test2

test, \test, \7b

044
7btest\\ \\ \\\\

test3 = escape:char('\\'):text(test2)
=test3

test, 5c

0116
5cest, 5c

055
5cb

044
7btest5c

092
5c 5c

092
5c 5c

092
5c5c

092
5c

test4 = escape:char('{', {undo = test3})
=test4

test, 5c

0116
5cest, 5c

055
5cb

044
7btest5c

092
5c 5c

092
5c 5c

092
5c5c

092
5c

test4 = escape:char('\\', {undo = test3})
=test4

test, test, 7b

044
7btest\ \ \\

test5 = escape:char('{', {undo = test4})
=test5 == test

true

=escape:undo(test3)--doesn't work because char is still set to '{' in current session

test, 5c

0116
5cest, 5c

055
5cb

044
7btest5c

092
5c 5c

092
5c 5c

092
5c5c

092
5c

=escape:undo(test4)

test, \test, \,test\\ \\ \\\\

=escape:char('\\'):undo(test3)

test, test, 7b

044
7btest\ \ \\

=escape:char('{', {undo = escape:char('\\'):undo(test3)})

test, test, {,test\ \ \\

=test == escape:char('{', {undo = escape:char('\\'):undo(test3)})

false

=test == escape:char('{', {undo = escape:char('\\'):undo(test3, '\\')})

true

local t = 'test { test {\\{ test, \\test, \\{,test\\ \\ \\ {\\'
=t

test { test {\{ test, \test, \{,test\ \ \ {\

local e = require('Module:Escape')
local t2 = escape:text(t)
local t3 = string.gsub(t2, '{', )
local t4 = escape:undo(t3)
=t4

test  test { test, test, {,test   \

local tk0 = escape:kill(t, '{')
=tk0 == t4

true