이 모듈은 Lua의 기본 문자열 함수를 위키 문서에서 사용할 수 있도록 하는 모듈입니다.
Most of the functions provided here can be invoked with named parameters, unnamed parameters, or a mixture. If named parameters are used, Mediawiki will automatically remove any leading or trailing whitespace from the parameter. Depending on the intended use, it may be advantageous to either preserve or remove such whitespace.
Global options
ignore_errors: If set to 'true' or 1, any error condition will result in
an empty string being returned rather than an error message.
error_category: If an error occurs, specifies the name of a category to
include with the error message. The default category is
[Category:Errors reported by Module String].
no_category: If set to 'true' or 1, no category will be added if an error
is generated.
모듈:String/연습장에서 모듈을 테스트 해볼 수 있습니다.
len
대상 문자열의 길이를 출력합니다. 사용법:
{{#invoke:String|len|target_string}}
또는
{{#invoke:String|len|s=target_string}}
{{#invoke:String|len|asdfghjkl}}
9
이름 있는 변수 s 를 사용하여 함수를 불러올 경우 대상 문자열에서 선행 또는 후행 공백이 자동 삭제됩니다.
sub
이 함수는 원본 문자열에서 지정된 범위의 문자열을 반환합니다.
사용법:
{{#invoke:String|sub|원본 문자열|시작점|끝점}}
{{#invoke:String|sub|s=원본 문자열|i=시작점|j=끝점}}
{{#invoke:String|sub|asdfghjkl|4|6}}
fgh
변수
s: 원본 문자열 i: 반환할 문자열의 시작점, 기본값은 1 j: 반환할 문자열의 끝점, 기본값은 문자열 끝까지
문자열의 첫 번째 문자의 인덱스는 1입니다. i나 j가 음수이면 문자열의 맨 뒤에서부터 위치가 계산됩니다. 예를 들어 abcd의 인덱스 1은 a, 인덱스 -1은 d입니다.
인덱스가 문자열의 범위를 벗어나면 오류를 반환합니다.
_match
사용법 : require("Module:String")._match strmatch = require("Module:String")._match sresult = strmatch( s, pattern, start, match, plain, nomatch )
다른 모듈에 포함해서 사용하는 함수입니다.
변수
s: 대상 문자열
pattern: 대상 문자열에서 찾을 문자열이나 정규식(패턴)을 입력합니다.
start: The index within the source string to start the search. The first
character of the string has index 1. Defaults to 1.
match: In some cases it may be possible to make multiple matches on a single
string. This specifies which match to return, where the first match is
match= 1. If a negative number is specified then a match is returned
counting from the last match. Hence match = -1 is the same as requesting
the last match. Defaults to 1.
plain: A flag indicating that the pattern should be understood as plain
text. Defaults to false.
nomatch: If no match is found, output the "nomatch" value rather than an error.
For information on constructing Lua patterns, a form of [regular expression], see:
- http://www.lua.org/manual/5.1/manual.html#5.4.1
- http://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#Patterns
- http://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#Ustring_patterns
match
원본 문자열에서 정규식(패턴)과 일치하는 문자열을 찾아 반환합니다.
사용법:
{{#invoke:String|match|원본 문자열|패턴(정규식)|start_index|match_number|plain_flag|nomatch_output}}
or
{{#invoke:String|match|s=원본 문자열|pattern=패턴(정규식)|start=start_index
|match=match_number|plain=plain_flag|nomatch=nomatch_output}}
변수
s: 원본 문자열
pattern: 원본 문자열에서 찾을 문자열/패턴
start: 검색을 시작할 위치. 첫 번째 문자의 인덱스는 1입니다. 기본값은 1.
match: In some cases it may be possible to make multiple matches on a single
string. This specifies which match to return, where the first match is
match= 1. If a negative number is specified then a match is returned
counting from the last match. Hence match = -1 is the same as requesting
the last match. Defaults to 1.
plain: A flag indicating that the pattern should be understood as plain
text. Defaults to false.
nomatch: If no match is found, output the "nomatch" value rather than an error.
If invoked using named 변수, Mediawiki will automatically remove any leading or trailing whitespace from each string. In some circumstances this is desirable, in other cases one may want to preserve the whitespace.
If the match_number or start_index are out of range for the string being queried, then this function generates an error. An error is also generated if no match is found. If one adds the parameter ignore_errors=true, then the error will be suppressed and an empty string will be returned on any failure.
For information on constructing Lua patterns, a form of [regular expression], see:
- http://www.lua.org/manual/5.1/manual.html#5.4.1
- http://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#Patterns
- http://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#Ustring_patterns
pos
This function returns a single character from the target string at position pos.
사용법:
{{#invoke:String|pos|target_string|index_value}}
or
{{#invoke:String|pos|target=target_string|pos=index_value}}
{{#invoke:String|pos|asdfghjkl|3}}
d
변수
target: The string to search pos: The index for the character to return
If invoked using named 변수, Mediawiki will automatically remove any leading or trailing whitespace from the target string. In some circumstances this is desirable, in other cases one may want to preserve the whitespace.
The first character has an index value of 1.
If one requests a negative value, this function will select a character by counting backwards from the end of the string. In other words pos = -1 is the same as asking for the last character.
A requested value of zero, or a value greater than the length of the string returns an error.
find
This function allows one to search for a target string or pattern within another string.
사용법:
{{#invoke:String|find|source_str|target_string|start_index|plain_flag}}
or
{{#invoke:String|find|source=source_str|target=target_str|start=start_index|plain=plain_flag}}
{{#invoke:String|find|asdfghjkl|asdf}}
1
변수
source: The string to search
target: The string or pattern to find within source
start: The index within the source string to start the search, defaults to 1
plain: Boolean flag indicating that target should be understood as plain
text and not as a Lua style regular expression, defaults to true
If invoked using named 변수, Mediawiki will automatically remove any leading or trailing whitespace from the parameter. In some circumstances this is desirable, in other cases one may want to preserve the whitespace.
This function returns the first index >= "start" where "target" can be found within "source". Indices are 1-based. If "target" is not found, then this function returns 0. If either "source" or "target" are missing / empty, this function also returns 0.
This function should be safe for UTF-8 strings.
gsub
This function allows one to replace a target string or pattern within another string.
사용법:
{{#invoke:String|gsub|source_str|pattern_string|replace_string|replacement_count|plain_flag}}
or
{{#invoke:String|gsub|source=source_string|pattern=pattern_string|replace=replace_string|count=replacement_count|plain=plain_flag}}
{{#invoke:String|gsub|asdfghjkl|asdf|qwer}}
qwerghjkl
변수
source: The string to search
pattern: The string or pattern to find within source
replace: The replacement text
count: The number of occurences to replace, defaults to all.
plain: Boolean flag indicating that pattern should be understood as plain
text and not as a Lua style regular expression, defaults to true
rep
Repeat
escapePattern
This function escapes special characters from a Lua string pattern. See [1] for details on how patterns work.
[1] https://www.mediawiki.org/wiki/Extension:Scribunto/Lua_reference_manual#Patterns
사용법:
{{#invoke:String|escapePattern|pattern_string}}
변수
pattern_string: The pattern string to escape.
count
join
Join all non empty arguments together; the first argument is the separator. 사용법:
{{#invoke:String|join|sep|one|two|three}}
one|two|three
local getArgs = require('Module:Arguments').getArgs
local ustring = mw.ustring
local str = {}
-- string.find
function str.len( frame )
local new_args = str._getParameters( frame.args, {'s'} )
local s = new_args['s'] or ''
return ustring.len( s )
end
-- string.sub
function str.sub( frame )
local args = getArgs(frame)
local new_args = str._getParameters( args, { 's', 'i', 'j' } )
local s = new_args['s'] or ''
local i = tonumber( new_args['i'] ) or 1
local j = tonumber( new_args['j'] ) or -1
local len = ustring.len( s )
-- Convert negatives for range checking
if i < 0 then
i = len + i + 1
end
if j < 0 then
j = len + j + 1
end
if i > len or j > len or i < 1 or j < 1 then
return str._error( 'String subset index out of range' )
end
if j < i then
return str._error( 'String subset indices out of order' )
end
return ustring.sub( s, i, j )
end
-- 다른 모듈에서 require 되는 함수
function str._match( s, pattern, start, match_index, plain_flag, nomatch )
if s == '' then
return str._error( 'Target string is empty' )
end
if pattern == '' then
return str._error( 'Pattern string is empty' )
end
start = tonumber(start) or 1
if math.abs(start) < 1 or math.abs(start) > ustring.len( s ) then
return str._error( 'Requested start is out of range' )
end
if match_index == 0 then
return str._error( 'Match index is out of range' )
end
if plain_flag then
pattern = str._escapePattern( pattern )
end
local result
if match_index == 1 then
-- Find first match is simple case
result = ustring.match( s, pattern, start )
else
if start > 1 then
s = ustring.sub( s, start )
end
local iterator = ustring.gmatch(s, pattern)
if match_index > 0 then
-- Forward search
for w in iterator do
match_index = match_index - 1
if match_index == 0 then
result = w
break
end
end
else
-- Reverse search
local result_table = {}
local count = 1
for w in iterator do
result_table[count] = w
count = count + 1
end
result = result_table[ count + match_index ]
end
end
if result == nil then
if nomatch == nil then
return str._error( 'Match not found' )
else
return nomatch
end
else
return result
end
end
-- string.match
function str.match( frame )
local args = getArgs(frame)
local new_args = str._getParameters( args, {'s', 'pattern', 'start', 'match', 'plain', 'nomatch'} )
local s = new_args['s'] or ''
local start = tonumber( new_args['start'] ) or 1
local plain_flag = str._getBoolean( new_args['plain'] or false )
local pattern = new_args['pattern'] or ''
local match_index = math.floor( tonumber(new_args['match']) or 1 )
local nomatch = new_args['nomatch']
return str._match( s, pattern, start, match_index, plain_flag, nomatch )
end
--
function str.pos( frame )
local args = getArgs(frame)
local new_args = str._getParameters( args, {'target', 'pos'} )
local target_str = new_args['target'] or ''
local pos = tonumber( new_args['pos'] ) or 0
if pos == 0 or math.abs(pos) > ustring.len( target_str ) then
return str._error( 'String index out of range' )
end
return ustring.sub( target_str, pos, pos )
end
-- string.find
function str.find( frame )
local args = getArgs(frame)
local new_args = str._getParameters( args, {'source', 'target', 'start', 'plain' } )
local source_str = new_args['source'] or ''
local pattern = new_args['target'] or ''
local start_pos = tonumber(new_args['start']) or 1
local plain = new_args['plain'] or true
if source_str == '' or pattern == '' then
return 0
end
plain = str._getBoolean( plain )
local start = ustring.find( source_str, pattern, start_pos, plain )
if start == nil then
start = 0
end
return start
end
-- string.gsub
function str.gsub( frame )
local new_args = str._getParameters( frame.args, {'source', 'pattern', 'replace', 'count', 'plain' } )
local source_str = new_args['source'] or ''
local pattern = new_args['pattern'] or ''
local replace = new_args['replace'] or ''
local count = tonumber( new_args['count'] )
local plain = new_args['plain'] or true
if source_str == '' or pattern == '' then
return source_str
end
plain = str._getBoolean( plain )
if plain then
pattern = str._escapePattern( pattern )
replace = ustring.gsub( replace, "%%", "%%%%" ) --Only need to escape replacement sequences.
end
local result
if count ~= nil then
if replace == '제거' or replace == nil then
result = ustring.gsub( source_str, pattern, '', count)
else
result = ustring.gsub( source_str, pattern, replace, count )
end
else
if replace == '제거' or replace == nil then
result = ustring.gsub( source_str, pattern, '')
else
result = ustring.gsub( source_str, pattern, replace )
end
end
return result
end
-- string.rep
function str.rep( frame )
local repetitions = tonumber( frame.args[2] )
if not repetitions then
return str._error( 'function rep expects a number as second parameter, received "' .. ( frame.args[2] or '' ) .. '"' )
end
return ustring.rep( frame.args[1] or '', repetitions )
end
-- string.upper
function str.upper( frame )
local new_args = str._getParameters( frame.args, { 's' } )
local s = new_args['s'] or ''
return ustring.upper( s )
end
-- string.lower
function str.lower( frame )
local new_args = str._getParameters( frame.args, { 's' } )
local s = new_args['s'] or ''
return ustring.lower( s )
end
function str.reverse( frame )
local new_args = str._getParameters( frame.args, { 's' } )
local s = new_args['s'] or ''
local str = ""
for token in ustring.gmatch(s, ".") do
str = token..str
end
return str
end
-- string.byte의 유니코드 호환 버전
function str.tounicode( frame )
local args = getArgs(frame)
local new_args = str._getParameters( args, { 's', 'i', 'j' } )
local s = new_args['s'] or ''
local i = tonumber( new_args['i'] ) or 1
local j = tonumber( new_args['j'] ) or -1
return ustring.codepoint( frame.args[1], i, j )
end
-- string.char
function str.char( frame )
local args = getArgs(frame)
local new_args = str._getParameters( args, { 'c' } )
local c = tonumber(new_args['c'])
return ustring.char( c )
end
function str.escapePattern( frame )
local args = getArgs(frame)
local pattern_str = args[1]
if not pattern_str then
return str._error( 'No pattern string specified' )
end
local result = str._escapePattern( pattern_str )
return result
end
function str.count(frame)
local args_ = getArgs(frame)
local args = str._getParameters(args_, {'source', 'pattern', 'plain'})
local source = args.source or ''
local pattern = args.pattern or ''
local plain = str._getBoolean(args.plain or true)
if plain then
pattern = str._escapePattern(pattern)
end
local _, count = ustring.gsub(source, pattern, '')
return count
end
--[[
endswith
This function determines whether a string ends with another string.
]]
function str.endswith(frame)
local args_ = getArgs(frame)
local args = str._getParameters(args_, {'source', 'pattern'})
local source = args.source or ''
local pattern = args.pattern or ''
if pattern == '' then
-- All strings end with the empty string.
return "yes"
end
if ustring.sub(source, -ustring.len(pattern), -1) == pattern then
return "yes"
else
return ""
end
end
function str.join(frame)
local args = getArgs(frame)
local table_ = {}
local sep = args[1]
local i, j = 2, 1
-- args,table
while args[i] ~= nil do
table_[j] = args[i]
i = i + 1
j = j + 1
end
return table.concat(table_, sep)
end
--[[
Helper function that populates the argument list given that user may need to use a mix of
named and unnamed 변수. This is relevant because named 변수 are not
identical to unnamed 변수 due to string trimming, and when dealing with strings
we sometimes want to either preserve or remove that whitespace depending on the application.
]]
function str._getParameters( frame_args, arg_list )
local new_args = {}
local index = 1
local value
for _, arg in ipairs( arg_list ) do
value = frame_args[arg]
if value == nil then
value = frame_args[index]
index = index + 1
end
new_args[arg] = value
end
return new_args
end
--[[
Helper function to handle error messages.
]]
function str._error( error_str )
local frame = mw.getCurrentFrame()
local error_category = frame.args.error_category or 'String 모듈에 의해 보고된 오류'
local ignore_errors = frame.args.ignore_errors or false
local no_category = frame.args.no_category or false
if str._getBoolean(ignore_errors) then
return ''
end
local error_str = '<strong class="error">String Module Error: ' .. error_str .. '</strong>'
if error_category ~= '' and not str._getBoolean( no_category ) then
error_str = '[[Category:' .. error_category .. ']]' .. error_str
end
return error_str
end
--[[
Helper Function to interpret boolean strings
]]
function str._getBoolean( boolean_str )
local boolean_value
if type( boolean_str ) == 'string' then
boolean_str = boolean_str:lower()
if boolean_str == 'false' or boolean_str == 'no' or boolean_str == '0'
or boolean_str == '' then
boolean_value = false
else
boolean_value = true
end
elseif type( boolean_str ) == 'boolean' then
boolean_value = boolean_str
else
error( 'No boolean value found' )
end
return boolean_value
end
--[[
Helper function that escapes all pattern characters so that they will be treated
as plain text.
]]
function str._escapePattern( pattern_str )
return ustring.gsub( pattern_str, "([%(%)%.%%%+%-%*%?%[%^%$%]])", "%%%1" )
end
return str