Ver o código fonte de "Módulo:Coordenadas"

--[[
Este módulo serve para substituír a función dos modelos {{Coordenadas}}
e relacionados. Achega varios métodos, incluíndo

{{#chamar:Coordenadas | coord }} : Función xeral para dar formato e mostrar
os valores das coordenadas.

{{#chamar:Coordenadas | dec2dms }} : Función simple para converter os valores
en graos decimais no formato DMS.

{{#chamar:Coordenadas | dms2dec }} : Función simple para converter o formato DMS
no formato de graos decimais.

]]

math_mod = require( "Módulo:Math" );
globalFrame = nil

coordinates = {};

--[[ Función de axuda, subsitución para {{coord/display/title}} ]]
function displaytitle (s, notes)
    local l = '<span title="[[Coordenadas xeográficas|Coordenadas]]">Coord.:</span> ' .. s
    local co = '<span id="coordinates">' .. l .. notes .. '</span>';
	local frame = mw.getCurrentFrame()
    return frame:extensionTag( 'indicator', co, { name = 'coordinates-ind' } )
end

--[[ Función de axuda, subsitución para {{coord/display/inline}} ]]
function displayinline (s, notes)
    return s .. notes    
end

--[[ Función de axuda, usada na detección do formato 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 == "EN" or concatenated == "WN" or concatenated == "ES" or concatenated == "WS" or
		concatenated == "NL" or concatenated == "SL" or concatenated == "LN" or concatenated == "LS" or
        concatenated == "NO" or concatenated == "SO" or concatenated == "ON" or concatenated == "OS" then
        return true;
    end
    return false;
end

--[[
parseDec

Transforma as latitudes e lonxitudes en formato decimal
na estrutura que se vai usar para amosar as coordenadas
]]
function parseDec( lat, long, format )
    local coordinateSpec = {}
    local errors = {}
    
    if long == "" or long == nil then
        return nil, {{"parseDec", "Falta a lonxitude"}}
    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, "L", "O", mode)  -- {{coord/dec2dms|{{{2}}}|E|W|{{coord/prec dec|{{{1}}}|{{{2}}}}}}}    
    
    if format ~= "" then
        coordinateSpec.default = format
    else
        coordinateSpec.default = "dec"
    end

    return coordinateSpec, errors
end

--[[ Función de axuda, manexar argumentos opcionais]]
function optionalArg(arg, suplement)
    if arg ~= nil and arg ~= "" then
        return arg .. suplement
    end
    return ""
end

--[[
parseDMS

Transforma graos, minutos e segundos na estrutura 
que se vai usar para amosar as coordenadas
]]
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();
    
    -- Comprobar se está especificado ao revés
    if lat_f == 'E' or lat_f == 'W' or lat_f == "O" or lat_f == "L" 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 a lonxitude" })
    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 mostrar, agás con coordinateSpec["param"]
    end
	if long_f == "E" then
        long_f = "L"        -- dirección a mostrar, agás 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

Saída do formateador. Toma a estrutura xerada por calquera parseDec
ou parseDMS e dá o formato para a súa inclusión na Wikipedia.
]]
function specPrinter(args, coordinateSpec)
    local uriComponents = coordinateSpec["param"]
    if uriComponents == "" then
        -- Retorna erro, nunca debe estar baleiro ou nulo
        return "ERRO: O parémetro está baleiro"
    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="Mapas, fotos e outros datos de ' .. 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="Mapas, fotos e outros datos de ' .. 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=gl&pagename={{FULLPAGENAMEE}}&params=' ..
        uriComponents .. ' ' .. inner .. ']') .. '</span>'
end

--[[
Formatea calquera mensaxe de erro xerada
]]
function errorPrinter(errors)
    local result = ""
    for i,v in ipairs(errors) do
        local errorHTML = '<small><strong class="error">Coordenadas: ' .. v[2] .. '</strong></small>'
        result = result .. errorHTML .. "<br />"
    end
    return result
end

--[[
Determina a clase CSS requirirda para amosar as coordenadas

Habitualmente geo-nondefault agóchase por CSS, agás que un usuario o sobreescriba para si mesmo
o modo por defecto é o especificado na chamada do modelo {{coord}}
o modo é o modo de "display" (dec ou dms) necesario para determinar a clase css
]]
function displayDefault(default, mode)
    if default == "" then
        default = "dec"
    end
    
    if default == mode then
        return "geo-default"
    else
        return "geo-nondefault"
    end
end

--[[ 
Comproba os argumentos de entrada de coord para determinar o tipo de datos que se proporcionan
e despois facer o proceso necesario.
]]
function formatTest(args)
    local result, errors;
    local primary = false;
    
    if args[1] == "" then
        -- Sen lóxica lat
        return errorPrinter( {{"formatTest", "Falta a latitude"}} )
    elseif args[4] == "" and args[5] == "" and args[6] == "" then
        -- lóxica dec
        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
        -- lóxica dms
        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', 'Sobran parámetros' } );
        end        
    elseif dmsTest(args[3], args[6]) then
        -- lóxica dm
        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', 'Sobran parámetros' } );
        end        
    elseif dmsTest(args[2], args[4]) then
        -- lóxica d
        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', 'Sobran parámetros' } );
        end        
    else
        -- Erro
        return errorPrinter( {{"formatTest", "Formato non recoñecido"}} )
    end
    result.name = args["name"] or args["nom"]
    
    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', 'O parámetro: "' .. v .. '=" debería ser"' .. v .. ':"' } );
        end
    end
    
    if #errors == 0 then
        return specPrinter( args, result )    
    else
        return specPrinter( args, result ) .. " " .. errorPrinter(errors) .. '[[Categoría:Wikipedia:Mantemento do modelo coordenadas]]'; 
    end    
end
--[[ Función de axuda para converter a coma decimal en punto decimal ]]
function formatPunt(num)
    return mw.ustring.gsub(num, ",", ".")
end
--[[ Función de axuda para converter as lonxitudes "O" a "W" e "E" a "L"]]
function formatLongW(dir)
    if dir:upper() == "O" then
        return "W"
    end
	if dir:upper() == "L" then
        return "E"
    end
    return dir
end

--[[ 
Función de axuda para converter latitude ou lonxitudes decimais a graos,
minutos e segundos baseándose 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 de axuda, convirte decimal a graos]]
function convert_dec2dms_d(coordinate)
    local d = math_mod._round( coordinate, 0 ) .. "°"
    return d .. ""
end

--[[ Función de axuda, convirte decimal a graos e 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 de axuda, convirte decimal a graos, minutos e 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

--[[
Convirte o formato DMS a unha coordenada decimal N ou E
]]
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 no número onde se basea a cadea
end

--[[ 
Comproba os valores de entrada buscando erros de fóra de rango
]]
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, "graos de latitude < 0 coa bandeira hemisferio"})
        end
        if long_d < 0 then
            table.insert(errors, {source, "graos de lonxitude < 0 coa bandeira hemisferio"})
        end
        --[[ 
        #coordinates é inconsistente sobre se isto é un erro. De especificarse globe:
        non da erro nesta condición, pero si no resto de casos.
        
        Para simplificar inutilizar este control.
        
        if long_d > 180 then
            table.insert(errors, {source, "graos de lonxitude > 180 coa bandeira hemisferio"})
        end
        ]]
    end    
        
    if lat_d > 90 then
        table.insert(errors, {source, "graos de latitude > 90"})
    end
    if lat_d < -90 then
        table.insert(errors, {source, "graos de latitude < -90"})
    end
    if lat_m >= 60 then
        table.insert(errors, {source, "minutos de latitude >= 60"})
    end
    if lat_m < 0 then
        table.insert(errors, {source, "minutos de latitude < 0"})
    end
    if lat_s >= 60 then
        table.insert(errors, {source, "segundos de latitude >= 60"})
    end
    if lat_s < 0 then
        table.insert(errors, {source, "segundos de latitude < 0"})
    end
    if long_d >= 360 then
        table.insert(errors, {source, "graos de lonxitude >= 360"})
    end
    if long_d <= -360 then
        table.insert(errors, {source, "graos de lonxitude <= -360"})
    end
    if long_m >= 60 then
        table.insert(errors, {source, "minutos de lonxitude >= 60"})
    end
    if long_m < 0 then
        table.insert(errors, {source, "minutos de lonxitude < 0"})
    end
    if long_s >= 60 then
        table.insert(errors, {source, "segundos de lonxitude >= 60"})
    end
    if long_s < 0 then
        table.insert(errors, {source, "segundos de lonxitude < 0"})
    end
    
    return errors;
end

--[[
dec2dms

Encapsulado para permitir que os modelos chamen a dec2dms directamente

Uso:
    {{ Invoke:Coordinates | dec2dms | decimal_coordinate | positive_suffix | 
        negative_suffix | precision }}
    
decimal_coordinate convértese a formato DMS. Se é positivo o positive_suffix
engádese ao final (N or E), se é negativo, o sufixo negativo engádese.
A precisión especificada é 'D', 'DM', or 'DMS' para o nivel de detalle a usar.
]]
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 de axuda para determinar se usar formatos D, DM, ou DMS
dependendo da precisión da 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

Encapsulado para que os modelos poidan chamar a dms2dec directamente

Uso:
    {{ Invoke:Coordinates | dms2dec | direction_flag | degrees | 
        minutes | seconds }}
    
Converte os valores DMS especificados en graos, minutos e segundos a formato decimal.
direction_flag é un valor N, S, E, W e determina se a saída é positiva 
(p.e. N e E) ou negativa (p.e. S e W).
]]
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

Punto de entrada principal para {{coord}}

Uso:
    {{ Invoke:Coordinates | coord }}
    {{ Invoke:Coordinates | coord | lat | long }}
    {{ Invoke:Coordinates | coord | lat | lat_flag | long | long_flag }}
    ...
    
    Consulte a páxina de documentación de {{coord}} para ver parámetros
    adicionais e opcións de configuración.

Nota: Esta función proporciona os elementos de visualización de {{coord}}.
Para cargar coordenadas na base de datos, a función de análise {{#coordinates:}}
tamén debe chamarse, isto faise automaticamente na versión Lua de {{coord}}.
]]
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*$' );  --quitar espazo en branco
        end        
    end
    args['format'] = args['formato'] 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*$' );  --elimina espazos en branco
        end        
    end
    args['format'] = 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