Módulo:String
Este módulo proporciona acceso a funciones básicas sobre cadenas (strings).
La mayoría de estas funciones se pueden invocar con parámetros con nombre, sin nombre o una mezcla. Si se usan parámetros con nombre hay que tener en cuenta que MediaWiki elimina los espacios en blanco iniciales y finales del valor del parámetro. Según el uso previsto puede ser conveniente tanto conservarlos como eliminarlos.
Algunas funciones admiten parámetros con patrones Lua que son una especie de expresiones regulares. Véase en el Manual de patrones Ustring.
Opciones globales
ignore_errors: Puesto a 'true' o 1, en caso de error retorno una cadena vacía en lugar del mensaje de error.
error_category: Si se detecta un error especifica el nombre de la categoría a incluir con el mensaje de error. Por defecto es Categoría:Wikipedia:Errores detectados por el módulo String.
no_category: puesto a 'true' o 1, no añade ninguna categoría si se genera un error.
Funciones
len
Devuelve la longitud de la cadena. Sintaxis:
{{#Invoke:String|len|cadena}}{{#Invoke:String|len|s=cadena}}
Parámetros:
s: La cadena a encontrar su longitud
sub
Devuelve una subcadena de la cadena indicada en los índices especificados. Sintaxis:
{{#Invoke:String|sub|cadena|índice inicial|índice final}}{{#Invoke:String|sub|s=cadena|i=índice inicial|j=índice final}}
Parámetros:
s: la cadena donde extraer la subcadenai: �ndice inicial de la subcadena, por defecto 1, el primer car�cter de la cadena.j: �ndice final de la subcadena, por defecto la longitud total, hasta el �ltimo car�cter.
Si cualquiera de los dos �ndices tienen valor negativo entonces contar� desde el final de la cadena. As�, -1 es el �ndice del �ltimo car�cter de la cadena. Si los �ndices son superiores a la longitud de la cadena entonces reportar� un error.
match
Devuelve una subcadena de la cadena indicada que coincida con un patr�n especificado. Sintaxis:
{{#Invoke:String|match|cadena|patr�n|�ndice inicial|n�mero coincidencia|indicador texto limpio|texto no coincidencia}}{{#Invoke:String|match|s=cadena|pattern = patr�n|start=�ndice inicial|match=n�mero coincidencia|plain=indicador texto limpio|nomatch=texto no coincidencia}}
Par�metros:
s: Cadena donde se hace la b�squedapattern: Patr�n o cadena a buscar.start: �ndice de la cadena d�nde empezar a buscar, por defecto 1, el primer car�cter.match: Si se encuentran m�ltiples coincidencias, especifica cu�l de ellas devolver. Por defecto es 1, la primera coincidencia encontrada. Un n�mero negativo cuenta desde el final, por lo tanto match = -1 es la �ltima coincidencia.plain: Indica si el patr�n debe interpretarse como texto limpio, por defecto 'false'.nomatch: En caso de no encontrar ninguna coincidencia, devuelve el valor de �nomatch� en lugar de un error.
Si el n�mero match o el �ndice start est�n fuera del rango de la cadena, entonces la funci�n genera un error. Tambi�n genera un error si no encuentra ninguna coincidencia. Con el par�metro global ignore_errors = true se suprime el error y devuelve una cadena vac�a.
pos
Devuelve el car�cter de la cadena que se encuentra en la posici�n indicada. Sintaxis:
{{#Invoke:String|pos|cadena|�ndice}}{{#Invoke:String|pos|target=cadena|pos=�ndice}}
Par�metros:
target: Cadena donde buscarpos: �ndice del car�cter a devolver
El primer car�cter tiene el �ndice 1. El �ltimo es -1, contando desde el final. Si est� fuera del rango de la cadena entonces devolver� un error.
find
Devuelve la posici�n donde se encuentra una cadena o patr�n buscando en otra cadena.
{{#Invoke:String|find|cadena|b�squeda|�ndice inicial|indicador texto limpio}}{{#Invoke:String|find|source=cadena|target=b�squeda|start=�ndice inicial|plain=indicador texto limpio}}
Par�metros:
source: Cadena donde buscartarget: Cadena a buscar o patr�n de b�squedastart: �ndice de la cadena fuente donde empezar a buscar, por defecto 1, el primer car�cter.plain: �ndica si la b�squeda debe interpretarse como texto limpio, de lo contrario como patr�n Lua. Por defecto es 'true'.
Devuelve el primer �ndice, mayor o igual que �start�, donde �target� se ha encontrado en �source�. Si no lo encuentra devuelve 0. Si �source� o �target� est�n vac�os o indefinidos tambi�n devuelve 0. Se supone que funciona bien con cadenas UTF-8.
replace
Permite reemplazar una cadena o patr�n en otra cadena. Sintaxis:
{{#Invoke:String|replace|cadena|patr�n|reemplazo|contador|indicador texto limpio}}
Par�metros:
source: Cadena donde buscarpattern: Cadena de b�squeda o patr�n a buscarreplace: Texto de reemplazocount: N�mero de ocurrencias a reemplazar, por defecto todas.plain: Indica si la b�squeda debe interpretarse como texto limpio, de lo contrario como patr�n Lua. Por defecto es 'true'.
--[[
Este m�dulo est� destinado a proporcionar acceso a las funciones de cadena (string) b�sicas.
]]
local str = {}
--[[
len
Parametros
s: La cadena a encontrar su longitud
]]
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
Parametros
s: La cadena donde extraer la subcadena
i: La cadena donde extraer la subcadena.
j: �ndice final de la subcadena, por defecto la longitud total, hasta el �ltimo car�cter.
]]
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 );
-- Convertir negativos para la comprobaci�n de rango
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( '�ndice fuera del rango de la cadena' );
end
if j < i then
return str._error( '�ndices de la cadena no ordenados' );
end
return mw.ustring.sub( s, i, j )
end
--[[
match
Parametros
s: cadena donde se hace la b�squeda
pattern: patr�n o cadena a buscar.
start: �ndice de la cadena d�nde empezar a buscar, por defecto 1, el primer car�cter.
match: si se encuentran m�ltiples coincidencias, especifica cu�l de ellas devolver. Por defecto es 1, l
la primera coincidencia encontrada. Un n�mero negativo cuenta desde el final, por lo tanto
match = -1 es la �ltima coincidencia.
plain: indica si el patr�n debe interpretarse como texto limpio, por defecto 'false'. nomatch: en caso de
no encontrar ninguna coincidencia, devuelve el valor de "nomatch" en lugar de un error.
Si el n�mero match o el �ndice start est�n fuera del rango de la cadena, entonces la funci�n genera un error.
Tambi�n genera un error si no encuentra ninguna coincidencia.
Con el par�metro global ignore_errors = true se suprime el
error y devuelve una cadena vac�a.
]]
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( 'La cadena donde buscar est� vac�a' );
end
if pattern == '' then
return str._error( 'La cadena de b�squeda est� vac�a ' );
end
if math.abs(start) < 1 or math.abs(start) > mw.ustring.len( s ) then
return str._error( '�ndice d\'inicio fuera del rango de la cadena ' );
end
if match_index == 0 then
return str._error( 'N�mero de coincidencias fuera de rango' );
end
if plain_flag then
pattern = str._escapePattern( pattern );
end
local result
if match_index == 1 then
-- Encontrar la primera coincidencia es un caso sencillo.
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
-- B�squeda hacia adelante
for w in iterator do
match_index = match_index - 1;
if match_index == 0 then
result = w;
break;
end
end
else
-- Invierte b�squeda
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( 'Ninguna coincidencia encontrada' );
else
return nomatch;
end
else
return result;
end
end
--[[
pos
Par�metros
target: Cadena donde buscar.
pos: �ndice del car�cter a devolver.
]]
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( '�ndice fuera del rango de la cadena' );
end
return mw.ustring.sub( target_str, pos, pos );
end
--[[
find
Parametros
source: Cadena donde buscar.
target: Cadena a buscar o patr�n de b�squeda.
start: �ndice de la cadena fuente donde empezar a buscar, por defecto 1, el primer car�cter.
plain: Indica si la b�squeda debe interpretarse como texto limpio, de lo contrario como patr�n Lua.
Por defecto es 'true'.
]]
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
Par�metros
source: Cadena donde buscar
pattern: Cadena de b�squeda o patr�n a buscar
replace: Texto de reemplazo
count: N�mero de ocurrencias a reemplazar, por defecto todas.
plain: Indica si la b�squeda debe interpretarse como texto limpio, de lo contrario como patr�n Lua. Por
defecto es '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, "%%", "%%%%" ); --S�lo es necesario secuencias de escape.
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
--[[
count
Esta funsci�n cuenta el n�mero de existencias de un car�cter o una cadena (no supuerpuestos) dentro de otra cadena.
]]
function str.count(frame)
local args = str._getParameters(frame.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 = mw.ustring.gsub(source, pattern, '')
return count
end
function str.mayuscula(frame) -- Convierte en may�sculas la primera letra que aparece en la edici�n de una cadena
local s = frame.args[1] or '';
if s ~= '' then
local cambio = {};
local modo = {};
if string.find(s, '|') ~= nil then -- Enlaces con etiqueta
modo = string.upper(string.match(s,'(|%a)'));
cambio = string.gsub(s,'|%a', modo,1);
elseif string.find(s, '[[]') ~= nil then -- Enlaces sin etiqueta
modo = string.upper(string.match(s,'^(..%a)'));
cambio = string.gsub(s,'^..%a', modo,1);
elseif string.match(s,'^%a') ~= nil then -- Sin enlace
modo = string.upper(string.match(s,'^(%a)'));
cambio = string.gsub(s,'^%a', modo, 1);
else
cambio = s;
end
return cambio;
end
end
--[[
Función de ayuda que rellena la lista de argumentos, para que el usuario pueda utilizar una combinación de
parámetros con nombre y sin nombre. Esto es importante porque los parámetros con nombre no funcionan igual
que los parámetros sin nombre cuando se encadenan recortes, y cuando se trata de cadenas
a veces se debe conservar o quitar espacios en blanco dependiendo de la aplicación.
]]
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
--[[
Función de ayuda para controlar los mensajes de error.
]]
function str._error( error_str )
local frame = mw.getCurrentFrame();
local error_category = frame.args.error_category or 'Errores detectados por el módulo 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">Error del módulo String: ' .. error_str .. '</strong>';
if error_category ~= '' and not str._getBoolean( no_category ) then
error_str = '[[Categoría:Wikipedia:' .. error_category .. ']]' .. error_str;
end
return error_str;
end
--[[
Función de ayuda para interpretar cadenas booleanas.
]]
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( 'Ningún valor booleano encontrado' );
end
return boolean_value
end
--[[
Función de ayuda que escapa a todos los caracteres de patrón para que puedan ser tratados
como texto sin formato.
]]
function str._escapePattern( pattern_str )
return mw.ustring.gsub( pattern_str, "([%(%)%.%%%+%-%*%?%[%^%$%]])", "%%%1" );
end
return str