Módulu:Coordenaes

UsuEditar

Esti módulu proporciona les funciones de la plantía {{coord}} y rellacionaes. Necesita'l Módulu:Math pa les funciones matemátiques. Los métodos esportables son:

coord

Sustituye les funciones de la plantía coord. Sintaxis:

{{#Invoke:coordinates | coord | lat | long }}
{{#Invoke:coordinates | coord | lat | dir | long | dir | opciones de mapa | opciones de formatu }}

...

Ver la documentación de la plantía {{coord}} para toles opciones de parámetros y configuración. Esta función xenera'l formatu de coordenaes a amosar según la configuración, incluyendo'l microformatu geo. Pa cargar les coordenaes d'una base de datos, tien de llamar tamién a la función d'análisis {{#coordinates:}}.

dec2dms

Función pa convertir direutamente una coordenada de formatu decimal a formatu graos-minutos-segundos. Sintaxis:

{{#Invoke:coordinates | dec2dms | coordenada_decimal | sufixu_positivu | sufixu_negativu | precisión }}

Si la coordenada_decimal ye positiva, añadirá'l sufixu_positivu (normalmente N o E). Si ye negativa añadirá'l sufixu_negativu (normalmente S o O). Los valores de precisión pueden ser: de, dm, dms, según si se quier redondiar en graos, graos-minutos o graos-minutos-segundos. Pal valor de coordenada_decimal hai qu'usar el formatu de puntu decimal.

dms2dec

Función pa convertir direutamente una coordenada del formatu graos-minutos-segundos al formatu decimal. Sintaxis:

{{#Invoke:coordinates | dms2dec | dirección | graos | minutos | segundos }}

Si la dirección ye N o E, el resultáu será positivu; sinón será negativu (suponse S o O).


--[[
Esti módulu tien l'envís de reemplazar la funcionalidá de la plantía {{Coord}} y
les rellacionaes. Ufre dellos métodos, incluyendo:

{{#Invoke:Coordenaes | coord }} : Función xeneral de formatu y visualización
de valores de coordenaes.

{{#Invoke:Coordenaes | dec2dms }} : Función cenciella pa convertir coordenaes en formatu de
 graos con decimales (deg) al formatu DMS (graos minutos y segundos).

{{#Invoke:Coordenaes | dms2dec }} : Función cenciella pa convertir coordenaes en formatu de
 DMS (graos, minutos y segundos) al formatu de graos con decimales (deg).

]]

math_mod = require( "Module:Math" );
globalFrame = nil

coordinates = {};
 
--[[ Función auxiliar, sustituye a {{coord/display/title}} ]]
function displaytitle (s, notes)
	local l = "[[Coordenaes xeográfiques|Coordenaes]]: " .. s
    --'<span title="Coordenaes xeográfiques WGS84">Coordenaes:</span> ' .. s
	local co = '<span id="coordinates">' .. l .. notes .. '</span>';
	return '<span style="font-size: small;">' .. co .. '</span>';
end
 
--[[ Función auxiliar, sustituye a {{coord/display/inline}} ]]
function displayinline (s, notes)
	return s .. notes	
end
 
--[[ Función auxiliar, usada pa detectar el formatu DMS ]]
local dmsTest = function(first, second)
	local concatenated = first:upper() .. second:upper();
	
	if concatenated == "NE" or concatenated == "NW" or concatenated == "SE" or concatenated == "SW" or
		concatenated == "NO" or concatenated == "SO" or concatenated == "ON" or concatenated == "OS" or
		concatenated == "EN" or concatenated == "WN" or concatenated == "ES" or concatenated == "WS" then
		return true;
	end
	return false;
end

--[[
parseDec

Transforma al formatu decimal la llatitú y la llonxitú na estructura qu'utiliza
el visor de coordenaes
]]
function parseDec( lat, long, format )
    local coordinateSpec = {}
    local errors = {}
    
    if long == "" or long == nil then
        return nil, {{"parseDec", "falta la llonxitú"}}
    end
    
    errors = validate( lat, nil, nil, long, nil, nil, 'parseDec', false );    
    coordinateSpec["dec-lat"]  = lat;
    coordinateSpec["dec-long"] = long;

    local mode = coordinates.determineMode( lat, long );
    coordinateSpec["dms-lat"]  = convert_dec2dms( lat, "N", "S", mode)  -- {{coord/dec2dms|{{{1}}}|N|S|{{coord/prec dec|{{{1}}}|{{{2}}}}}}}
    coordinateSpec["dms-long"] = convert_dec2dms( long, "E", "O", mode)  -- {{coord/dec2dms|{{{2}}}|E|W|{{coord/prec dec|{{{1}}}|{{{2}}}}}}}    
    
    if format ~= "" then
        coordinateSpec.default = format
    else
        coordinateSpec.default = "dms"  -- por defectu el formatu dau
    end

    return coordinateSpec, errors
end

--[[ Función auxiliar, xestiona los argumentos opcionales. ]]
function optionalArg(arg, suplement)
	if arg ~= nil and arg ~= "" then
		return arg .. suplement
	end
	return ""
end

--[[
parseDMS

Transforma el formatu de graos, minutos y segundos de la llatitú y llonxitú 
na estructura pa utilizar na vista de coordenaes
]]
function parseDMS( lat_d, lat_m, lat_s, lat_f, long_d, long_m, long_s, long_f, format )
    local coordinateSpec = {}
    local errors = {}
    
    lat_f = lat_f:upper();
    long_f = long_f:upper();
    
    -- Comprueba si se dio haza atrás la posición E, O 
    if lat_f == 'E' or lat_f == 'W' or lat_f == "O" then
        local t_d, t_m, t_s, t_f;
        t_d = lat_d;
        t_m = lat_m;
        t_s = lat_s;
        t_f = lat_f;
        lat_d = long_d;
        lat_m = long_m;
        lat_s = long_s;
        lat_f = long_f;
        long_d = t_d;
        long_m = t_m;
        long_s = t_s;
        long_f = t_f;
    end    
    
    errors = validate( lat_d, lat_m, lat_s, long_d, long_m, long_s, 'parseDMS', true );
    if long_d == nil or long_d == "" then
        table.insert(errors, {"parseDMS", "falta la llonxitú" })
    end
    
    if lat_m == nil and lat_s == nil and long_m == nil and long_s == nil and #errors == 0 then 
        if math_mod._precision( lat_d ) > 0 or math_mod._precision( long_d ) > 0 then
            if lat_f:upper() == 'S' then 
                lat_d = '-' .. lat_d;
            end
            if long_f:upper() == 'W' or long_f:upper() == 'O' then 
                long_d = '-' .. long_d;
            end     
            
            return parseDec( lat_d, long_d, format );
        end        
    end   
    
    if long_f == "W" then
        long_f = "O"        -- dirección a amosar, excepto con coordinateSpec["param"]
    end
    coordinateSpec["dms-lat"]  = lat_d.."°"..optionalArg(lat_m,"′") .. optionalArg(lat_s,"″") .. lat_f
    coordinateSpec["dms-long"] = long_d.."°"..optionalArg(long_m,"′") .. optionalArg(long_s,"″") .. long_f
    coordinateSpec["dec-lat"]  = convert_dms2dec(lat_f, lat_d, lat_m, lat_s) -- {{coord/dms2dec|{{{4}}}|{{{1}}}|0{{{2}}}|0{{{3}}}}}
    coordinateSpec["dec-long"] = convert_dms2dec(long_f, long_d, long_m, long_s) -- {{coord/dms2dec|{{{8}}}|{{{5}}}|0{{{6}}}|0{{{7}}}}}

    if format ~= "" then
        coordinateSpec.default = format
    else
        coordinateSpec.default = "dms"
    end   

    return coordinateSpec, errors
end

--[[
specPrinter

Formateador de la salida.  Toma la estructura xenerada por parseDec
o por parseDMS y da-y formatu pa incluila en Wikipedia.
]]
function specPrinter(args, coordinateSpec)
	local uriComponents = coordinateSpec["param"]
	if uriComponents == "" then
		-- Devuelve error, nunca habría tar vacíu o ser nulu
		return "ERROR el parámetru ta vacíu"
	end
	if coordinateSpec["name"] ~= "" and coordinateSpec["name"] ~= nil then
		uriComponents = uriComponents .. "&title=" .. mw.uri.encode(coordinateSpec["name"])
	end
	
	local geodmshtml = '<span class="geo-dms" title="Mapes, fotos aérees, y otros datos pa ' .. coordinateSpec["dms-lat"] .. ' ' ..  coordinateSpec["dms-long"] .. '">'
			 .. '<span class="latitude">' .. coordinateSpec["dms-lat"] .. '</span> '
			 .. '<span class="longitude">' ..coordinateSpec["dms-long"] .. '</span>'
			 .. '</span>'
			 
	local geodechtml = '<span class="geo-dec" title="Mapes, fotos aérees, y otros datos pa ' .. coordinateSpec["dec-lat"] .. ' ' ..  coordinateSpec["dec-long"] .. '">'
             .. '<span class="geo">'
             .. '<span class="latitude">' .. coordinateSpec["dec-lat"] .. ', </span>'
             .. '<span class="longitude">' .. coordinateSpec["dec-long"] .. '</span>'
             .. '</span></span>'

    local inner;
    inner = '<span class="' .. displayDefault(coordinateSpec["default"], "dms" ) .. '">' .. geodmshtml .. '</span>'
                .. '<span class="geo-multi-punct">&#xfeff; / &#xfeff;</span>'
                .. '<span class="' .. displayDefault(coordinateSpec["default"], "dec" ) .. '">';

    if coordinateSpec["name"] == "" or coordinateSpec["name"] == nil then
        inner = inner .. geodechtml .. '</span>'
    else
        inner = inner .. '<span class="vcard">' .. geodechtml 
                .. '<span style="display:none">&#xfeff; (<span class="fn org">'
                .. coordinateSpec["name"] .. '</span>)</span></span></span>'
    end

    --return '<span class="plainlinksneverexpand">' 
    return '<span class="plainlinks nourlexpansion">'.. globalFrame:preprocess( 
        '[http://tools.wmflabs.org/geohack/geohack.php?language=ast&pagename={{FULLPAGENAMEE}}&params=' ..
        uriComponents .. ' ' .. inner .. ']') .. '</span>'
end
--http://tools.wmflabs.org/geohack/geohack.php?language=fr&pagename=Communaut%C3%A9_forale_de_Navarre&params=42.816666666667_N_1.65_W_type:city_globe:earth&title=
--[[
Formatos de los mensaxes d'error autoxeneraos 
]]
function errorPrinter(errors)
    local result = ""
    for i,v in ipairs(errors) do
        local errorHTML = '<small><strong class="error">Coordenaes: ' .. v[2] .. '</strong></small>'
        result = result .. errorHTML .. "<br />"
    end
    return result
end

--[[
Determina la clase CSS riquía p'amosar les coordenaes

De vezu, "geo-nodefault" ta tapecío por CSS, menos si un usuariu omitió esto
"default" ye'l mou predetermináu qu'apaez, anque l'usuariu puede especificalo al llamar a la plantía {{coord}}
mou ye'l mou de visualización (dec o DMS) que vamos necesitar pa determinar la clase css

]]
function displayDefault(default, mode)
    if default == "" then
        default = "dms"
    end
    
    if default == mode then
        return "geo-default"
    else
        return "geo-nondefault"
    end
end

--[[ 
Comprueba los argumentos d'entrada de coord pa determinar el tipu de datos que se dan
y llueu facer el procesu necesariu.
]]
function formatTest(args)
    local result, errors;
    local primary = false;
    
    if args[1] == "" then
        -- Nenguna lat llóxica
        return errorPrinter( {{"formatTest", "Falta la llatitú"}} )
    elseif args[4] == "" and args[5] == "" and args[6] == "" then
        -- dec lógico
        result, errors = parseDec( formatPunt(args[1]), formatPunt(args[2]), args['format'] )
        if result == nil then
            return errorPrinter( errors );
        end              
        result.param    = table.concat( {formatPunt(args[1]), "_N_", formatPunt(args[2]), "_E_", args[3] } );
    elseif dmsTest(args[4], args[8]) then
        -- dms llóxicu
        result, errors = parseDMS( args[1], args[2], formatPunt(args[3]), args[4], 
            args[5], args[6], formatPunt(args[7]), args[8], args['format'] )
        result.param = table.concat( { args[1], args[2], formatPunt(args[3]), args[4], args[5],
            args[6], formatPunt(args[7]), formatLongW(args[8]), args[9] } , '_' );
        if args[10] ~= '' then
            table.insert( errors, { 'formatTest', 'sobren parámetros' } );
        end        
    elseif dmsTest(args[3], args[6]) then
        -- dm lógico
        result, errors = parseDMS( args[1], formatPunt(args[2]), nil, args[3], 
            args[4], formatPunt(args[5]), nil, args[6], args['format'] )
        result.param = table.concat( { args[1], formatPunt(args[2]), args[3], args[4], formatPunt(args[5]),
            formatLongW(args[6]), args[7] } , '_' );
        if args[8] ~= '' then
            table.insert( errors, { 'formatTest', 'sobren paràmetros' } );
        end        
    elseif dmsTest(args[2], args[4]) then
        -- d lógico
        result, errors = parseDMS( formatPunt(args[1]), nil, nil, args[2], 
            formatPunt(args[3]), nil, nil, args[4], args['format'] )
        result.param = table.concat( { formatPunt(args[1]), args[2], formatPunt(args[3]), formatLongW(args[4]), args[5] } , '_' );
        if args[6] ~= '' then
            table.insert( errors, { 'formatTest', 'sobren parámetros' } );
        end        
    else
        -- Error
        return errorPrinter( {{"formatTest", "Formatu non reconocíu"}} )
    end
    result.name = args["name"] or args["nome"]
    
    local extra_param = {'dim', 'globe', 'scale', 'region', 'source', 'type'}
    for _, v in ipairs( extra_param ) do
        if (args[v] or '') ~= '' then 
            table.insert( errors, {'formatTest', 'Parámetru: "' .. v .. '=" tendría de ser"' .. v .. ':"' } );
        end
    end
    
    if #errors == 0 then
        return specPrinter( args, result )    
    else
        return specPrinter( args, result ) .. " " .. errorPrinter(errors) .. '[[Categoría:Wikipedia:Mantenimentu de la plantía coord]]'; 
    end    
end
--[[ Función auxiliar pa convertir la coma decimal en puntu decimal ]]
function formatPunt(num)
    return mw.ustring.gsub(num, ",", ".")
end
--[[ Función auxilar pa convertir llonxitú O a W ]]
function formatLongW(dir)
    if dir:upper() == "O" then
        return "W"
    end
    return dir
end

--[[ 
Función auxiliar, convierte la llatitú o llonxitú al formatu decimal
graos, minutos y segundos en formatu basáu na precisión especificada.  
]]
function convert_dec2dms(coordinate, firstPostfix, secondPostfix, precision)
    local coord = tonumber(coordinate) or 0
    local postfix
    if coord >= 0 then
        postfix = firstPostfix
    else
        postfix = secondPostfix
    end

    precision = precision:lower();
    if precision == "dms" then
        return convert_dec2dms_dms( math.abs( coord ) ) .. postfix;
    elseif precision == "dm" then
        return convert_dec2dms_dm( math.abs( coord ) ) .. postfix;
    elseif precision == "d" then
        return convert_dec2dms_d( math.abs( coord ) ) .. postfix;
    end
end

--[[ Función auxiliar, convierte decimales a graos ]]
function convert_dec2dms_d(coordinate)
    local d = math_mod._round( coordinate, 0 ) .. "°"
    return d .. ""
end

--[[ Función auxiliar, convierte decimales a graos y minutos ]]
function convert_dec2dms_dm(coordinate)    
    coordinate = math_mod._round( coordinate * 60, 0 );
    local m = coordinate % 60;
    coordinate = math.floor( (coordinate - m) / 60 );
    local d = coordinate % 360 .."°"
    
    return d .. string.format( "%02d′", m )
end

--[[ Función auxiliar, convierte decimales a graos, minutos y segundos ]]
function convert_dec2dms_dms(coordinate)
    coordinate = math_mod._round( coordinate * 60 * 60, 0 );
    local s = coordinate % 60
    coordinate = math.floor( (coordinate - s) / 60 );
    local m = coordinate % 60
    coordinate = math.floor( (coordinate - m) / 60 );
    local d = coordinate % 360 .."°"

    return d .. string.format( "%02d′", m ) .. string.format( "%02d″", s )
end

--[[
Convierte el formatu DMS con un N o E en coordenaes decimales
]]
function convert_dms2dec(direction, degrees_str, minutes_str, seconds_str)
    local degrees = tonumber(degrees_str) or 0
    local minutes = tonumber(minutes_str) or 0
    local seconds = tonumber(seconds_str) or 0
    
    local factor
    direction = mw.ustring.gsub(direction, '^[ ]*(.-)[ ]*$', '%1');
    if direction == "N" or direction == "E" then
        factor = 1
    else
        factor = -1
    end
    
    local precision = 0
    if seconds_str ~= nil and seconds_str ~= '' then
        precision = 5 + math.max( math_mod._precision(seconds_str), 0 );
    elseif minutes_str ~= nil and minutes_str ~= '' then
        precision = 3 + math.max( math_mod._precision(minutes_str), 0 );
    else
        precision = math.max( math_mod._precision(degrees_str), 0 );
    end
    
    local decimal = factor * (degrees+(minutes+seconds/60)/60) 
    return string.format( "%." .. precision .. "f", decimal ) -- non nel númberu onde se basa la cadena.
end

--[[ 
Comprueba los valores d'entrada y los errores fuera de rangu.
]]
function validate( lat_d, lat_m, lat_s, long_d, long_m, long_s, source, strong )
    local errors = {};
    lat_d = tonumber( lat_d ) or 0;
    lat_m = tonumber( lat_m ) or 0;
    lat_s = tonumber( lat_s ) or 0;
    long_d = tonumber( long_d ) or 0;
    long_m = tonumber( long_m ) or 0;
    long_s = tonumber( long_s ) or 0;

    if strong then
        if lat_d < 0 then
            table.insert(errors, {source, "Llatitú negativa y con dirección N"})
        end
        if long_d < 0 then
            table.insert(errors, {source, "Llonxitú negativa y con dirección E"})
        end
        --[[ 
        #coordinates ye contradictoria sobre si esto ye un error. Si "globe" ta
         especificáu, nun sedrá error nesta condición; de lo contrario si lo sedrá.
        
        solo por nun desactivar esta comprobación.
        
        if long_d > 180 then
            table.insert(errors, {source, "longitude degrees > 180 with hemisphere flag"})
        end
        ]]
    end    
        
    if lat_d > 90 then
        table.insert(errors, {source, "graos de llatitú > 90"})
    end
    if lat_d < -90 then
        table.insert(errors, {source, "graos de llatitú < -90"})
    end
    if lat_m >= 60 then
        table.insert(errors, {source, "minutos de llatitú >= 60"})
    end
    if lat_m < 0 then
        table.insert(errors, {source, "minutos de llatitú < 0"})
    end
    if lat_s >= 60 then
        table.insert(errors, {source, "segundos de llatitú >= 60"})
    end
    if lat_s < 0 then
        table.insert(errors, {source, "segundos de llatitú < 0"})
    end
    if long_d >= 360 then
        table.insert(errors, {source, "graos de llonxitú >= 360"})
    end
    if long_d <= -360 then
        table.insert(errors, {source, "graos de llonxitú <= -360"})
    end
    if long_m >= 60 then
        table.insert(errors, {source, "minutos de llonxitú >= 60"})
    end
    if long_m < 0 then
        table.insert(errors, {source, "minutos de llonxitú < 0"})
    end
    if long_s >= 60 then
        table.insert(errors, {source, "segundos de llonxitú >= 60"})
    end
    if long_s < 0 then
        table.insert(errors, {source, "segundos de llonxitú < 0"})
    end
    
    return errors;
end

--[[
dec2dms

Función pa permitir que les plantíes llamen directamente a dec2dms.

Usu:
    {{ #Invoke:Coordenaes | dec2dms | <coordenaes_decimales> | <sufixu_positivu> | 
        <sufixu_negativu> | <precision> }}
    
Les <coordenaes_decimales> se convierten al formatu DMS. Si ye positivo, el <sufixu_positivu>
añádese (N o E), si ye negativo, el <sufixu_negativu> añádese si la
<precision> especificada puede ser 'D', 'DM' o 'DMS' pa especificar el nivel de detalle
a utilizar.
]]
function coordinates.dec2dms(frame)
    globalFrame = frame
    local coordinate = frame.args[1]
    local firstPostfix = frame.args[2]
    local secondPostfix = frame.args[3]
    local precision = frame.args[4]

    return convert_dec2dms(coordinate, firstPostfix, secondPostfix, precision)
end

--[[
Función auxiliar pa determinar tien d'utilizase el formato D, DM, o DMS
na función "precision" de la entrada decimal
.
]]
function coordinates.determineMode( value1, value2 )
    local precision = math.max( math_mod._precision( value1 ), math_mod._precision( value2 ) );
    if precision <= 0 then
        return 'd'
    elseif precision <= 2 then
        return 'dm';
    else
        return 'dms';
    end
end        

--[[
dms2dec

Wrapper pa permitir que les plantíes llamen directamente a dms2dec.

Usu:
    {{ #Invoke:Coordenaes | dms2dec | <indicador de dirección> | graos | 
        minutos | segundos }}
    
Convierte los valores de formatu DMS  especificaos en graos, minutos y segundos en graos decimales.
L'indicador de dirección puede ser N, S, E, O , y determina si la salida ye
positiva (esto ye, N o E) o negativa (esto ye, S o O).
]]
function coordinates.dms2dec(frame)
    globalFrame = frame
    local direction = frame.args[1]
    local degrees = frame.args[2]
    local minutes = frame.args[3]
    local seconds = frame.args[4]

    return convert_dms2dec(direction, degrees, minutes, seconds)
end

--[[
coord

Principal puntu d'entrada pa la función Lua pa reemplazar {{coord}}

Usu:
    {{ #Invoke:Coordenaes | coord }}
    {{ #Invoke:Coordenaes | coord | lat | long }}
    {{ #Invoke:Coordenaes | coord | lat | <lat_dirección> | <long> | <long_dirección> }}
    ...
    
    Consulte la páxina de documentación {{coord}} pa munchos parámetros adicionales y
    opciones de configuración.
    
Nota: Esta función proporciona los elementos de presentación visual de {{coord}}. 
Pa poder cargar coordenaes na base de datos, el parser function (analizador de función) {{#coordinates:}} también tien de llamase, esto faise automáticamente na versión de {{Coord}} en módulu Lua.
]]
function coordinates.coord(frame)
    globalFrame = frame
    local args = frame.args
    if args[1] == nil then
        local pFrame = frame:getParent();
        args = pFrame.args;

        for k,v in pairs( frame.args ) do
            args[k] = v;
        end
    end
    
    for i=1,10 do 
        if args[i] == nil then 
            args[i] = ""
        else
            args[i] = args[i]:match( '^%s*(.-)%s*$' );  --quita espacios en blanco
        end        
    end
    args['format'] = args['formatu'] or args['formato'] or args['format'] or '';
    
    local contents = formatTest(args)
    local Notes = args.notes or ""
    local Display = string.lower(args.display or "inline")
    if Display == '' then
        Display = 'inline';
    end
    
    local text = ''
    if string.find( Display, 'inline' ) ~= nil or Display == 'i' or 
            Display == 'it' or Display == 'ti' then
        text = displayinline(contents, Notes)
    end
    if string.find( Display, 'title' ) ~= nil or Display == 't' or 
            Display == 'it' or Display == 'ti' then
        text = text .. displaytitle(contents, Notes)
    end
    return text
    end
function coordinates.coord2(frame)
        globalFrame = frame.args.gf 
        local origArgs = {}
 
             if frame == mw.getCurrentFrame() then
                 origArgs = frame:getParent().args
             else        
                 origArgs = frame.args
             end
 
         args = {}
            for k, v in pairs(origArgs) do                 
                     args[k] = v                    
            end
    for i=1,10 do 
        if args[i] == nil then 
            args[i] = ""
        else
            args[i] = args[i]:match( '^%s*(.-)%s*$' );  --quita espacios en blanco
        end        
    end
    args['format'] = args['formatu'] or args['formato'] or args['format'] or '';
    
    local contents = formatTest(args)
    local Notes = args.notes or ""
    local Display = string.lower(args.display or "inline")
    if Display == '' then
        Display = 'inline';
    end
    
    local text = ''
    if string.find( Display, 'inline' ) ~= nil or Display == 'i' or 
            Display == 'it' or Display == 'ti' then
        text = displayinline(contents, Notes)
    end
    if string.find( Display, 'title' ) ~= nil or Display == 't' or 
            Display == 'it' or Display == 'ti' then
        text = text .. displaytitle(contents, Notes)
    end
    return text
end

return coordinates