Jump to content

Module:Jcon/sandbox

From Wikipedia, the free encyclopedia
This is an old revision of this page, as edited by BrandonXLF (talk | contribs) at 01:17, 21 July 2024 (Improve comments and handle MTO signs are road type). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.
require('strict')

local p = {}
local getArgs = require('Module:Arguments').getArgs
local yesno = require('Module:Yesno')
local data = mw.loadData('Module:Jcon/data')

-- Place types to remove from lowercase road type
local placeTypes = {
	'municipality',
	'municipal',
	'city',
	'township',
	'district',
	'county',
	'counties',
	'united counties',
	'region',
	'regional',
	'regional municipality',
	'road'
}

-- Normalize the given road type
local function normalizeType(roadType)
	roadType = (roadType or ''):lower() -- Make the road type lowercase

	for index, placeType in ipairs(placeTypes) do
		roadType = roadType -- Remove the place types from the road type
			:gsub('^' .. placeType .. ' of ', '')
			:gsub(' ' .. placeType .. '$', '')
			:gsub(' ' .. placeType .. ' road$', '')
	end

	return data.aliases[roadType] or roadType -- Transform alias into proper name
end

-- Generate the wikitext for the shield
local function shieldWikitext(route, roadInfo, args)
	local size = args.size or '20px' -- Image size
	local fileName = nil
	
	if roadInfo.imgExceptions and roadInfo.imgExceptions[route] then
		-- Handle exceptions
		fileName = roadInfo.imgExceptions[route][yesno(args.shield) and 'shield' or 'guide']
	elseif roadInfo.prefix == 'Ontario' and (tonumber(({route:gsub('%D', '')})[1]) or 0) >= 500 then
		-- Handle secondary and tertiary highways
		fileName = 'Ontario Highway ' .. route .. '.svg'
	elseif roadInfo.shield and yesno(args.shield) then
		-- Shield format (used as reassurance marker)
		fileName = roadInfo.shield:format(route)
	elseif roadInfo.guide then
		-- Guide format (used on guide signs)
		fileName = roadInfo.guide:format(route)
	else
		return '' -- Return nothing if no file format was found
	end
	
	local titleObj = mw.title.new('File:' .. fileName)

	if not titleObj or not titleObj.file.exists then
		return '' -- Return nothing if no existing file was found
	end
	
	return '[[File:' .. fileName .. '|alt=|link=|' .. size .. ']]' -- Return the file wikitext
end

-- Display a link, accounting for presentation arguments
local function displayLink(link, display, args)
	local titleObj = mw.title.new(link)
	local showLink = ((titleObj and titleObj.exists) or yesno(args.showred)) and not yesno(args.nolink)
	
	if showLink then
		return '[[' .. link .. '|' .. display .. ']]' -- Return the link
	else
		return display -- Fallback to returning the display text
	end
end

-- Generate the text part of the output
local function getText(route, roadInfo, args)
	local link = ''
	local display = ''
	
	if roadInfo.textExceptions and roadInfo.textExceptions[route] then
		-- Handle exceptions
		link = roadInfo.textExceptions[route].link
		display = roadInfo.textExceptions[route].display
	else
		-- Construct links and display from prefix, type, and route number
		link = roadInfo.prefix .. ' ' .. roadInfo.type .. ' ' .. route
		display = roadInfo.type .. ' ' .. route
	end
	
	if yesno(args.fulltext) then
		-- Display the full link title when requested
		display = link
	end
	
	return displayLink(link, display, args)
end

-- Gets the wikitext link for a place
local function getPlace(place, args)
	local placeArticle = place .. ', Ontario'
	local titleObj = mw.title.new(placeArticle)
	
	if (titleObj and titleObj.exists) or yesno(args.showred) then
		return '[[' .. placeArticle .. '|' .. place .. ']]'
	else
		return place
	end
end

-- Process routes present in the provided arguments
local function processRoutes(roadType, showShield, showText, args)
	local roadInfo = data.types[roadType]
	
	local shield = '' -- Generated shield wikitext
	local text = '' -- Generated text/link wikitext
	
	local conNumber = 0 -- The number of the concurrency being processed
	local paramName = 2 -- Route number parameter name
	local typeParamName = nil -- Road type override parameter name
	local dirParamName = 'dir' -- Direction parameter name

	repeat
		local routeRoadInfo = roadInfo -- Local copy of the road info
		
		if typeParamName and args[typeParamName] then
			-- Override the road info if one is provided
			local overrideRoadType = normalizeType(args[typeParamName])
			routeRoadInfo = data.types[overrideRoadType]
		end
		
		if showShield then
			if shield ~= '' then shield = shield .. ' ' end -- Add space after existing shields
			shield = shield .. shieldWikitext(args[paramName], routeRoadInfo, args) -- Add the shield
		end
		
		if showText then
			if text ~= '' then text = text .. ' / ' end -- Add " / " after existing text
			text = text .. getText(args[paramName], routeRoadInfo, args) -- Add route text
		end
		
		if args[dirParamName] then
			text = text .. ' ' .. args[dirParamName] -- Add the direction
		end
		
		conNumber = conNumber + 1 -- Move on to the next concurrency

		-- Update the parameter names
		local paramPrefix = conNumber == 1 and '' or conNumber
		paramName = 'con' .. paramPrefix
		typeParamName = 'contype' .. paramPrefix
		dirParamName = 'condir' .. paramPrefix
	until not args[paramName]
	
	return shield, text -- Return generated shield and text wikitext
end

-- Entry function
function p.jcon(frame)
	local args = getArgs(frame)

	if yesno(args.ot) then
		-- Set correct arguments if output should be only text
		args.nosh = 'yes'
		args.nolink = 'yes'
	end

	local roadType = normalizeType(args[1]) -- The first road type
	local showShield = not yesno(args.nosh)
	local showText = not yesno(args.notext)
	local shieldAfter = yesno(args.picaft or args['pic aft'])
	
	local shield = nil -- Generated shield wikitext
	local text = nil -- Generated text/name wikitext
	
	if data.signs[roadType] then
		-- Handle MTO signs
		shield = data.signs[roadType]
		text = args[2] or ''
	else
		-- Handle numbered roads
		shield, text = processRoutes(roadType, showShield, showText, args)
	end
	
	if args.sign and showShield then
		-- Add the MTO sign if provided
		shield = shield .. ' ' .. data.signs[normalizeType]
	end
	
	if yesno(args.tch) then
		if showShield then shield = shield .. ' [[File:TCH-blank.svg|x20px]]' end -- Add the TCH shield
		if showText then text = text .. ' / [[Trans-Canada Highway|TCH]]' end -- Add the TCH text
	end
	
	local output = '' -- The returned output
	
	if not shieldAfter then
		-- Add the shield if it goes first
		output = output .. shield
	end
	
	if text ~= '' then
		if output ~= '' then output = output .. ' ' end -- Add a NBSP after the shield if it exists
		output = output .. text -- Add the generated text to the output
	end

	if args[3] then
		output = output .. ' (' .. args[3] .. ')' -- Add the name to the output
	end
	
	-- Process control cities
	if args.city or args.town then
		output = output .. ' – ' .. getPlace(args.city or args.town, args) -- Add the first city
		
		local extraCityNum = 2 -- The number of the additional city being processed
		
		while args['city' .. extraCityNum] or args['town' .. extraCityNum] do
			local val = args['city' .. extraCityNum] or args['town' .. extraCityNum]
			output = output .. ', ' .. getPlace(val, args) -- Add extra cities
			extraCityNum = extraCityNum + 1
		end
	end

	if shieldAfter and shield then
		if output ~= '' then output = output .. ' ' end -- Add a space if output already has text
		output = output .. shield -- Add the shield if it goes last
	end

	return output
end

return p