Module:Color2dec

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search
Lua
CodeDiscussionEditHistoryLinksLink countNo test API Subpages:DocumentationTestsResultsSandboxLive code All modules

Written a bit complicated, due to my poor LUA knowledge.

This module contains a global function, two functions which can be used either global or local, and local functions.

Global function "tbcgen"[edit]

accepts & needs two parameters, a color code and a descriptive text.

  • the color code may be a valid hexadecimal color triplet, as "#ABCDEF" or "#80c";
    otherwise it is treated with the local/global function "tincture";
it may also be a valid tincture name, e.g. "céleste" (see examples)
from the many other color names just the set of CSS colors is valid for conversion;
when a string not starting with "#" cannot find its hexadecimal representation, an error is raised.
  • when the descriptive text starts with e.g. "#" that becomes replaced by its decimal numeric character reference
    by the local/global function "decode".

"tbcgen" calls the template Tbc with the 5 parameters needed by this template.

Function "tincture"[edit]

Used also global by template Igen/cbox
Converts tincture names to their hexadecimal color codes;
Color codes of six hexadecimal numbers #aabbcc are shortened to #ABC when possible.

if not successful the convertion of CSS names is tried;
other values are passed without check as-they-are, which may cause an error

Function "decode"[edit]

Used also global by template Igen/cbox and by other templates (same code as in module Char)
Avoids the problem with # * : ; at the first position

Code

--The function "tincture" converts valid tincture names to hexadecimal colorcodes
--  e.g. 'argent' will give '#FFF'; when not found it tries afterwards with module:convCSS
--The function "convert" converts a valid hexadecimal colorcode into three decimal numbers: 
--	#bbccdd gives 187|187|204,  while #FF0 will give 255|255|0 
--The function "tbcgen" generates a complete 5-parameter string 
--Invalid color codes will give invalid or unpredictable results, or LUA errors.

local p = {}
--
local function hexdec ( arg )
	local dig  =  ( string.upper ( string.char ( arg ) ) );
	local dec  =  0;
	if     dig == 'F' then  dec = 0xF
	elseif dig == 'E' then  dec = 0xE
	elseif dig == 'D' then  dec = 0xD
	elseif dig == 'C' then  dec = 0xC
	elseif dig == 'B' then  dec = 0xB
	elseif dig == 'A' then  dec = 0xA
	else   dec = tonumber (dig)
	end
	return dec;
end  

-- 
local function convert ( arg )
	local hex  =  arg or '#000';
    if  mw.ustring.sub ( hex, 1,  1) ~= '#' then 
        error ('value "' .. hex .. '" cannot be converted to decimal')
	end  
	local dec  =  {};
	if #hex == 7 then
		dec [1] = hexdec ( string.byte (hex, 2)) * 16 + hexdec (string.byte (hex, 3))
		dec [2] = hexdec ( string.byte (hex, 4)) * 16 + hexdec (string.byte (hex, 5))
		dec [3] = hexdec ( string.byte (hex, 6)) * 16 + hexdec (string.byte (hex, 7))
	else
		dec [1] = hexdec ( string.byte (hex, 2)) * 16 + hexdec (string.byte (hex, 2))
		dec [2] = hexdec ( string.byte (hex, 3)) * 16 + hexdec (string.byte (hex, 3))
		dec [3] = hexdec ( string.byte (hex, 4)) * 16 + hexdec (string.byte (hex, 4))
	end  
	return dec;
end

-- global=args[1], local=frame
function p.tincture ( frame )
	local args = frame.args
	local inp = ''
	if  args then
        inp   =  args[1] or 'glo'
	elseif  frame then
         inp  =  frame   or 'loc'
--	else inp  = 'Tinct wo'
	end
	local low  =  ( string.lower ( inp ) );
	if  mw.ustring.sub ( inp, 1, 1 ) == '#' then
		if  #low ==  4  then
			return inp;
		elseif   mw.ustring.sub ( low, 2, 2 ) ==  mw.ustring.sub ( low, 3, 3 )
			and  mw.ustring.sub ( low, 4, 4 ) ==  mw.ustring.sub ( low, 5, 5 )
			and  mw.ustring.sub ( low, 6, 6 ) ==  mw.ustring.sub ( low, 7, 7 )  then
			local  low  =  ( string.upper ( inp ) );
			return '#'  .. mw.ustring.sub ( low, 2, 2 ) 
						.. mw.ustring.sub ( low, 4, 4 ) 
						.. mw.ustring.sub ( low, 6, 6 );
		else			
			return inp;
		end	
	end
	local out  =  '';
	if     low == 'argent'    then  out = '#FFF'
	elseif low == 'argent-d'  then  out = '#E7E7E7'
	elseif low == 'azure'     then  out = '#0F47AF'
	elseif low == 'carnation' then  out = '#F2A772'
	elseif low == 'céleste'   then  out = '#89C5E3'
	elseif low == 'celeste'   then  out = '#89C5E3'
	elseif low == 'cendrée'   then  out = '#999'
	elseif low == 'gules'     then  out = '#DA121A'
	elseif low == 'or'        then  out = '#FCDD09'
	elseif low == 'purpure'   then  out = '#9116A1'
	elseif low == 'sable'     then  out = '#000'
	elseif low == 'tawny'     then  out = '#9D5333'
	elseif low == 'vert'      then  out = '#078930'
-- colours less common:	
	elseif low == 'brunâtre'  then  out = '#3F1FFF'
	elseif low == 'sanguine'  then  out = '#BC3F4A'
	elseif low == 'murrey'    then  out = '#C54B8C'
	elseif low == 'orange_t'  then  out = '#FC7A11'
	else   
		local convc = require( "Module:convCSS" )
		out  =  convc.main ( inp )
	end
	return out;
end

-- global=args[1], local=frame
function p.decode ( frame )
	local args = frame.args
	local str = ''
	if  args then
       str   =  mw.text.trim ( args [1], charset ) 
	elseif  frame then
       str   =  mw.text.trim ( frame, charset ) 
	end
    if  mw.ustring.sub ( str, 1, 1 ) == '#' then 
         return '#' .. mw.ustring.sub( str, 2, #str );
    elseif mw.ustring.sub ( str, 1, 1 ) == '*' then 
         return '*' .. mw.ustring.sub( str, 2, #str );
    elseif mw.ustring.sub ( str, 1, 1 ) == ':' then 
         return ':' .. mw.ustring.sub( str, 2, #str );
    elseif mw.ustring.sub ( str, 1, 1 ) == ';' then 
         return '&#59;' .. mw.ustring.sub( str, 2, #str );
    else
         return str;
    end
end


-- global with 1 parm
function p.tindec ( frame )
	local args = frame.args;
	local hcod = p.tincture ( args[1] );
	return p.decode ( hcod );
end


-- global with 2 parms
function p.tbcgen ( frame )
    local args = frame.args;
    local arg1 = args[1] or '#000000';
	local tbctab = {};
	local hexcod = '';
	hexcod = p.tincture ( arg1 );
	decval = convert ( hexcod ); 
	tbctab [1]   = '0';
	tbctab [2]   = decval [1];
	tbctab [3]   = decval [2];
	tbctab [4]   = decval [3];
	tbctab [5]   = p.decode ( args[2] or 'couleur' );
	return mw.getCurrentFrame():expandTemplate{ title = 'Tbc', args =  tbctab };
end
	
return p;