Module:String

🛑

Ipgelet: Ôog risico module!

Dit module wordt gebruukt in systeem-berichtn of ip vrêe vele bloadn. Een anpassienge an dees code kan d'n uutkyk van de gansche wiki direct verandern. Test anpassiengn êest in e zandbak of discuteer d'rover ip 't overlegblad vôoda je ze definitief bywerkt.

Moduleinfo: String

Wuk doet et?

Module:String is gemakt oem boasis-funcsjes vôor tekstverwerkienge (strings) an te biedn an andere patrôonn.

De mêeste funcsjes ier kunn angereoepn wordn mèi benoamde parameters, ounbenoamde (numerieke) parameters, of e mix van aolle twêe. A je benoamde parameters gebruukt (lik |source=), smyt MediaWiki otematisch aolle spaties an 't begin en 't einde weg. Ofankelik van wuk da je wilt doen, kan 't andig zyn oem die spaties te beoudn of zjuust weg te doen.

Globoale Opsjes

• ignore_errors: As dit ip true of 1 stoat, goat iddere foute d'rvoorn zorgn da 't script e lege tekst weregèeft in plekke van e rôod foutbericht.
• error_category: As d'r een error is, bepoalt dit in wukke categorie da 't blad terechtekomt.
• no_category: As dit ip true of 1 stoat, wordt er gèn categorie toegevoegd by een error.

---

Funcsjes

count

Telt oevele kêers dat e bepoalde tekst (pattern) vôornkomt in de brontekst (source). Et telt allêne overlappiende dêeln nie mee.

• Gebruuk: {{#invoke:String|count|brontekst|zoektekst|plain_flag}}
• Parameters:
  • source: De tekst woarin gezocht wordt.
  • pattern: De tekst of 't patrôon da je wilt telln.
  • plain: E "booleoansche" woarde (true/false) die angèeft of da 't patrôon as geweune tekst (true) of as e Lua-regex patrôon (false) moe wordn ezien. Standoard is true.

endswith

Gèeft "yes" were as de brontekst eindigt mèi de zoektekst. De zoektekst is assan letterlik (gèn Lua-patrôon).

• Gebruuk: {{#invoke:String|endswith|brontekst|zoektekst}}
• Vôorbeeld: {{#invoke:String|endswith|xxxyyy|y}} → yes

escapePattern

Verandert e "klasse-karakter" uut e Lua-patrôon noar e "letterlik karakter". Byvôorbeeld: 't têekn . zoekt normoal achter eender wukke letter. Mèi escapePattern wordt da %., zoda 't script uutslutend achter e letterlik puntje zoekt.

• Gebruuk: {{#invoke:String|escapePattern|patrôon_tekst}}
• Vôorbeeld: {{#invoke:String|escapePattern|10%}} → 10%%

find

Zoekt e doeltekst (target) binn'n in een andre tekst (source). Gèeft de posiesje (et index-nummer) were woa da de tekst begunt. As 't nie g'voundn is, gèeft et 0 were.

• Gebruuk: {{#invoke:String|find|brontekst|doeltekst|start_posiesje|plain_flag}}
• Parameters:
  • source: De tekst oem in te zoekn.
  • target: De tekst oem te viendn.
  • start: Vanaf wukke letter 't zoekn moe begunn (standoard 1).
  • plain: Of et target as geweune tekst anezien moe wordn (standoard true).
• Vôorbeeld: {{#invoke:String|find|abc123def|12}} → 4

findpagetext

Zoekt noar e stik tekst in de wikitext (broncode) van e blad zelve.

• Gebruuk: {{#invoke:String|findpagetext|text=zoektekst}}
• Parameters:
  • text: (of parameter 1) De tekst om te zoekn.
  • title: (optioneel) 't Blad om te zoekn, standoard 't hudige blad.
  • plain: (optioneel) true vo geweune tekst, false vo e Lua-patrôon.
  • nomatch: (optioneel) Tekst oem te tôgen as er niks g'voundn is.

join

Plakt aolle tekst-parameters an mekoar, en gebruukt d'n êerste parameter as scheidiengstêekn.

• Gebruuk: {{#invoke:String|join|scheidiengstêekn|tekst1|tekst2|...}}
• Vôorbeeld: {{#invoke:String|join|-|a|b|c}} → a-b-c

len

Gèeft de lengte (et antol letters/karakters) van de tekst were.

• Gebruuk: {{#invoke:String|len|tekst}}
• Vôorbeeld: {{#invoke:String|len|abcdef}} → 6

match

Gèeft e stikske tekst (substring) were dat overêenkomt mèi e specifieke Lua-zoekopdracht (patrôon).

• Gebruuk: {{#invoke:String|match|brontekst|patrôon|start_posiesje|match_nummer|plain_flag|nomatch_output}}
• Parameters:
  • s: De tekst om in te zoekn.
  • pattern: Et patrôon om te viendn.
  • start: Vanaf woa da 't zoekn moe begunn (standoard 1).
  • match: As 't patrôon mêerdere kêers vôornkomt, wukken dat er getoogd moe wordn (1 vo d'n êersten, -1 vo d'n latstn).
  • nomatch: Tekst om te tôgen as er niks g'voundn is.
• Vôorbeeld: {{#invoke:String|match|abc123def456|%d+}} → 123

pos

Gèeft exact êen letter (karakter) were uut de tekst, ip e bepoalde posiesje.

• Gebruuk: {{#invoke:String|pos|tekst|index_nummer}}
• Vôorbeeld: {{#invoke:String|pos|abcdef|3}} → c

rep

Herhoalt e tekst n antol kêers.

• Gebruuk: {{#invoke:String|rep|tekst|antol}}
• Vôorbeeld: {{#invoke:String|rep|hello|3}} → hellohellohello

replace (gsub)

Vervangt e doeltekst in de brontekst deur een andre tekst. (Standoard is de zoekopdracht 'plain text', a je Lua-patrôonn wilt gebruukn, zet plain toun ip false).

• Gebruuk: {{#invoke:String|replace|brontekst|zoektekst|vervangtekst|antol_kêers|plain_flag}}
• Vôorbeeld: {{#invoke:String|replace|abc123def456|123|XYZ}} → abcXYZdef456

str_find

Dit is e kopie van 't oude patrôon Patrôon:Str find. 't Werkt bykan lyk find, moa is eignlik g'outdeerd. Niet angeroadn vôor nieuwe patrôonn. Gebruukt assan find in de plekke.

sub

Gèeft e dêel van de tekst (substring) were, uutgesneen tussn e begin- en eindposiesje (d' êerste letter is posiesje 1).

• Gebruuk: {{#invoke:String|sub|tekst|begin|einde}}
• Vôorbeeld: {{#invoke:String|sub|abcdefghi|3|5}} → cde

sublength

Gelykoardig an sub, moa in plekke van een eindposiesje mee te geevn, gèef je de lengte (et antol letters) mee da je wilt uutsnyen. D' êerste letter is ier posiesje 0 (nie 1).

• Gebruuk: {{#invoke:String|sublength|s=tekst|i=begin_index|len=lengte}}
• Vôorbeeld: {{#invoke:String|sublength|s=abcdefghi|i=3|len=4}} → defg

---

--[[

This module is intended to provide access to basic string functions.

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.

Unit tests for this module are available at Module:String/tests.
]]

local str = {}

--[[
len

This function returns the length of the target string.

Usage:
{{#invoke:String|len|target_string|}}
OR
{{#invoke:String|len|s=target_string}}

Parameters
	s: The string whose length to report

If invoked using named parameters, Mediawiki will automatically remove any leading or
trailing whitespace from the target string.
]]
function str.len( frame )
	local new_args = str._getParameters( frame.args, {'s'} );
	local s = new_args['s'] or '';
	return mw.ustring.len( s )
end

--[[
sub

This function returns a substring of the target string at specified indices.

Usage:
{{#invoke:String|sub|target_string|start_index|end_index}}
OR
{{#invoke:String|sub|s=target_string|i=start_index|j=end_index}}

Parameters
	s: The string to return a subset of
	i: The fist index of the substring to return, defaults to 1.
	j: The last index of the string to return, defaults to the last character.

The first character of the string is assigned an index of 1. If either i or j
is a negative value, it is interpreted the same as selecting a character by
counting from the end of the string. Hence, a value of -1 is the same as
selecting the last character of the string.

If the requested indices are out of range for the given string, an error is
reported.
]]
function str.sub( frame )
	local new_args = str._getParameters( frame.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 = mw.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 mw.ustring.sub( s, i, j )
end

--[[
This function implements that features of {{str sub old}} and is kept in order
to maintain these older templates.
]]
function str.sublength( frame )
	local i = tonumber( frame.args.i ) or 0
	local len = tonumber( frame.args.len )
	return mw.ustring.sub( frame.args.s, i + 1, len and ( i + len ) )
end

--[[
match

This function returns a substring from the source string that matches a
specified pattern.

Usage:
{{#invoke:String|match|source_string|pattern_string|start_index|match_number|plain_flag|nomatch_output}}
OR
{{#invoke:String|pos|s=source_string|pattern=pattern_string|start=start_index
	|match=match_number|plain=plain_flag|nomatch=nomatch_output}}

Parameters
	s: The string to search
	pattern: The pattern or string to find within the string
	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.

If invoked using named parameters, 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

]]
function str.match( frame )
	local new_args = str._getParameters( frame.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'];

	if s == '' then
		return str._error( 'Target string is empty' );
	end
	if pattern == '' then
		return str._error( 'Pattern string is empty' );
	end
	if math.abs(start) < 1 or math.abs(start) > mw.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 = mw.ustring.match( s, pattern, start )
	else
		if start > 1 then
			s = mw.ustring.sub( s, start );
		end

		local iterator = mw.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

--[[
pos

This function returns a single character from the target string at position pos.

Usage:
{{#invoke:String|pos|target_string|index_value}}
OR
{{#invoke:String|pos|target=target_string|pos=index_value}}

Parameters
	target: The string to search
	pos: The index for the character to return

If invoked using named parameters, 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.
]]
function str.pos( frame )
	local new_args = str._getParameters( frame.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) > mw.ustring.len( target_str ) then
		return str._error( 'String index out of range' );
	end

	return mw.ustring.sub( target_str, pos, pos );
end

--[[
find

This function allows one to search for a target string or pattern within another
string.

Usage:
{{#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}}

Parameters
	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 parameters, 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.
]]
function str.find( frame )
	local new_args = str._getParameters( frame.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 = mw.ustring.find( source_str, pattern, start_pos, plain )
	if start == nil then
		start = 0
	end

	return start
end

--[[
replace

This function allows one to replace a target string or pattern within another
string.

Usage:
{{#invoke:String|replace|source_str|pattern_string|replace_string|replacement_count|plain_flag}}
OR
{{#invoke:String|replace|source=source_string|pattern=pattern_string|replace=replace_string|
  count=replacement_count|plain=plain_flag}}

Parameters
	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
]]
function str.replace( 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 = mw.ustring.gsub( replace, "%%", "%%%%" ); --Only need to escape replacement sequences.
	end

	local result;

	if count ~= nil then
		result = mw.ustring.gsub( source_str, pattern, replace, count );
	else
		result = mw.ustring.gsub( source_str, pattern, replace );
	end

	return result;
end

--[[
	simple function to pipe string.rep to templates.
]]

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 string.rep( frame.args[1] or '', repetitions )
end

--[[
Helper function that populates the argument list given that user may need to use a mix of
named and unnamed parameters. This is relevant because named parameters are not
identical to unnamed parameters 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 i,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 'Errors reported by Module 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 mw.ustring.gsub( pattern_str, "([%(%)%.%%%+%-%*%?%[%^%$%]])", "%%%1" );
end

return str