Ir al contenido

Módulo:String

Editar enlaces
De Wikipedia, la enciclopedia libre

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 deexpresiones regulares.Véase en elManual 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.
  • 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 subcadena
  • i:í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ú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, 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 buscar
  • pos:Í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 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:Í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 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'.
--[[
Este módulo está destinado a proporcionar acceso a las funciones de cadena (string) básicas.
]]

localstr={}

--[[
len

Parametros
s: La cadena a encontrar su longitud

]]
functionstr.len(frame)
localnew_args=str._getParameters(frame.args,{'s'});
locals=new_args['s']or'';
returnmw.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.

]]
functionstr.sub(frame)
localnew_args=str._getParameters(frame.args,{'s','i','j'});
locals=new_args['s']or'';
locali=tonumber(new_args['i'])or1;
localj=tonumber(new_args['j'])or-1;

locallen=mw.ustring.len(s);

-- Convertir negativos para la comprobación de rango
ifi<0then
i=len+i+1;
end
ifj<0then
j=len+j+1;
end

ifi>lenorj>lenori<1orj<1then
returnstr._error('Índice fuera del rango de la cadena');
end
ifj<ithen
returnstr._error('Índices de la cadena no ordenados');
end

returnmw.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.
]]
functionstr.match(frame)
localnew_args=str._getParameters(frame.args,{'s','pattern','start','match','plain','nomatch'});
locals=new_args['s']or'';
localstart=tonumber(new_args['start'])or1;
localplain_flag=str._getBoolean(new_args['plain']orfalse);
localpattern=new_args['pattern']or'';
localmatch_index=math.floor(tonumber(new_args['match'])or1);
localnomatch=new_args['nomatch'];

ifs==''then
returnstr._error('La cadena donde buscar está vacía');
end
ifpattern==''then
returnstr._error('La cadena de búsqueda está vacía ');
end
ifmath.abs(start)<1ormath.abs(start)>mw.ustring.len(s)then
returnstr._error('Índice d\'inicio fuera del rango de la cadena ');
end
ifmatch_index==0then
returnstr._error('Número de coincidencias fuera de rango');
end
ifplain_flagthen
pattern=str._escapePattern(pattern);
end

localresult
ifmatch_index==1then
-- Encontrar la primera coincidencia es un caso sencillo.
result=mw.ustring.match(s,pattern,start)
else
ifstart>1then
s=mw.ustring.sub(s,start);
end

localiterator=mw.ustring.gmatch(s,pattern);
ifmatch_index>0then
-- Búsqueda hacia adelante
forwiniteratordo
match_index=match_index-1;
ifmatch_index==0then
result=w;
break;
end
end
else
-- Invierte búsqueda
localresult_table={};
localcount=1;
forwiniteratordo
result_table[count]=w;
count=count+1;
end

result=result_table[count+match_index];
end
end

ifresult==nilthen
ifnomatch==nilthen
returnstr._error('Ninguna coincidencia encontrada');
else
returnnomatch;
end
else
returnresult;
end
end

--[[
pos

Parámetros
target: Cadena donde buscar.
pos: Índice del carácter a devolver.
]]
functionstr.pos(frame)
localnew_args=str._getParameters(frame.args,{'target','pos'});
localtarget_str=new_args['target']or'';
localpos=tonumber(new_args['pos'])or0;

ifpos==0ormath.abs(pos)>mw.ustring.len(target_str)then
returnstr._error('Índice fuera del rango de la cadena');
end

returnmw.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'.
]]
functionstr.find(frame)
localnew_args=str._getParameters(frame.args,{'source','target','start','plain'});
localsource_str=new_args['source']or'';
localpattern=new_args['target']or'';
localstart_pos=tonumber(new_args['start'])or1;
localplain=new_args['plain']ortrue;

ifsource_str==''orpattern==''then
return0;
end

plain=str._getBoolean(plain);

localstart=mw.ustring.find(source_str,pattern,start_pos,plain)
ifstart==nilthen
start=0
end

returnstart
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'
]]
functionstr.replace(frame)
localnew_args=str._getParameters(frame.args,{'source','pattern','replace','count','plain'});
localsource_str=new_args['source']or'';
localpattern=new_args['pattern']or'';
localreplace=new_args['replace']or'';
localcount=tonumber(new_args['count']);
localplain=new_args['plain']ortrue;

ifsource_str==''orpattern==''then
returnsource_str;
end
plain=str._getBoolean(plain);

ifplainthen
pattern=str._escapePattern(pattern);
replace=mw.ustring.gsub(replace,"%%","%%%%");--Sólo es necesario secuencias de escape.
end

localresult;

ifcount~=nilthen
result=mw.ustring.gsub(source_str,pattern,replace,count);
else
result=mw.ustring.gsub(source_str,pattern,replace);
end

returnresult;
end

--[[
count

Esta funsción cuenta el número de existencias de un carácter o una cadena (no supuerpuestos) dentro de otra cadena.
]]
functionstr.count(frame)
localargs=str._getParameters(frame.args,{'source','pattern','plain'})
localsource=args.sourceor''
localpattern=args.patternor''
localplain=str._getBoolean(args.plainortrue)
ifplainthen
pattern=str._escapePattern(pattern)
end
local_,count=mw.ustring.gsub(source,pattern,'')
returncount
end

functionstr.mayuscula(frame)-- Convierte en mayúsculas la primera letra que aparece en la edición de una cadena
locals=frame.args[1]or'';
ifs~=''then
localcambio={};
localmodo={};
ifstring.find(s,'|')~=nilthen-- Enlaces con etiqueta
modo=string.upper(string.match(s,'(|%a)'));
cambio=string.gsub(s,'|%a',modo,1);
elseifstring.find(s,'[[]')~=nilthen-- Enlaces sin etiqueta
modo=string.upper(string.match(s,'^(..%a)'));
cambio=string.gsub(s,'^..%a',modo,1);
elseifstring.match(s,'^%a')~=nilthen-- Sin enlace
modo=string.upper(string.match(s,'^(%a)'));
cambio=string.gsub(s,'^%a',modo,1);
else
cambio=s;
end
returncambio;
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.
]]
functionstr._getParameters(frame_args,arg_list)
localnew_args={};
localindex=1;
localvalue;

fori,arginipairs(arg_list)do
value=frame_args[arg]
ifvalue==nilthen
value=frame_args[index];
index=index+1;
end
new_args[arg]=value;
end

returnnew_args;
end

--[[
Función de ayuda para controlar los mensajes de error.
]]
functionstr._error(error_str)
localframe=mw.getCurrentFrame();
localerror_category=frame.args.error_categoryor'Errores detectados por el módulo String';
localignore_errors=frame.args.ignore_errorsorfalse;
localno_category=frame.args.no_categoryorfalse;

ifstr._getBoolean(ignore_errors)then
return'';
end

localerror_str='<strong class= "error" >Error del módulo String: '..error_str..'</strong>';
iferror_category~=''andnotstr._getBoolean(no_category)then
error_str='[[Categoría:Wikipedia:'..error_category..']]'..error_str;
end

returnerror_str;
end

--[[
Función de ayuda para interpretar cadenas booleanas.
]]
functionstr._getBoolean(boolean_str)
localboolean_value;

iftype(boolean_str)=='string'then
boolean_str=boolean_str:lower();
ifboolean_str=='false'orboolean_str=='no'orboolean_str=='0'
orboolean_str==''then
boolean_value=false;
else
boolean_value=true;
end
elseiftype(boolean_str)=='boolean'then
boolean_value=boolean_str;
else
error('Ningún valor booleano encontrado');
end
returnboolean_value
end

--[[
Función de ayuda que escapa a todos los caracteres de patrón para que puedan ser tratados
como texto sin formato.
]]
functionstr._escapePattern(pattern_str)
returnmw.ustring.gsub(pattern_str,"([%(%)%.%%%+%-%*%?%[%^%$%]])","%%%1");
end

returnstr
Obtenido de «https://es.wikipedia.org/w/index.php?title=Módulo:String&oldid=157427547»