Modul:SternensystemStruktur

Modul Dokumentation[view][edit][history][purge]
Diese Dokumentation wird von Modul:SternensystemStruktur/doc aus übernommen. Änderungen können auf der Diskussionsseite vorgeschlagen werden.
Function list
L 14 — spairs L 38 — methodtable.getStarsystemData L 67 — methodtable.getCelestialObjects L 101 — methodtable.filterCelestialObjects L 125 — methodtable.createDataStructure L 137 — continue L 178 — stratify L 196 — methodtable.makeEntry L 256 — methodtable.makeHtml L 320 — SternensystemStruktur.output L 343 — SternensystemStruktur.new
Dieses Modul setzt die Vorlage:Sternensystem/Struktur um. Anweisungen zur Verwendung findest du auf der Vorlagenseite.
local SternensystemStruktur = {}

local metatable = {}
local methodtable = {}

metatable.__index = methodtable

local starsystem = require( 'Module:Sternensystem' )
local celestialObject = require( 'Module:CelestialObject' )
local localized = require( 'Module:Localized' )


--- Walks a table in order
local function spairs( t, order )
    -- collect the keys
    local keys = {}
    for k in pairs(t) do keys[#keys+1] = k end

    -- if order function given, sort by it by passing the table and keys a, b,
    -- otherwise just sort the keys
    if order then
        table.sort(keys, function(a,b) return order(t, a, b) end)
    else
        table.sort(keys)
    end

    -- return the iterator function
    local i = 0
    return function()
        i = i + 1
        if keys[i] then
            return keys[i], t[keys[i]]
        end
    end
end

--- Queries the SMW store for data of the current page name
function methodtable.getStarsystemData( t )
    if t.system ~= nil then
        return
    end

    local selector = t.pageName

    if mw.getCurrentFrame():getParent().args.code then
        selector = 'Starmap Code::' .. mw.getCurrentFrame():getParent().args.code
    end

    local askData = celestialObject.getSmwBaseAskData()
    table.insert( askData, 1, '[[' .. selector .. ']]' )

    askData.mainlabel = '-'
    askData.limit = 1

    local data = mw.smw.ask( askData )

    if data ~= nil and data[ 1 ] ~= nil then
        t.system = data[ 1 ]

        return
    end

    error( 'Could not get Starsystem data' )
end

--- Queries the SMW store for the objects of the system
function methodtable.getCelestialObjects( t )
    local selector = ''

    if mw.getCurrentFrame():getParent().args.code == nil then
        selector = '[[-Has subobject::' .. t.pageName .. ']]'

        if t.system.id ~= nil then
            selector = '<q>' .. selector .. '||[[Sternensystemid::' .. t.system.id .. ']]</q>'
        end
    elseif t.system.system_id ~= nil then
        selector = '[[Sternensystemid::' .. t.system.system_id .. ']]'
    end

    local askData = celestialObject.getSmwBaseAskData()
    table.insert( askData, 1, selector .. '[[Starmap Code::+]]' )
    table.insert( askData, 'sort=Typ,Bezeichnung' )
    table.insert( askData, 'order=desc,asc' )

    askData.mainlabel = '-'

    local data = mw.smw.ask( askData )

    if data ~= nil and data[ 1 ] ~= nil then
        t.celestialObjects = data

        return
    end

    error( 'Could not get Celestial Objects' )
end

--- Filters from all celestial objects
--- those that have the upper most parent of 'system.id'
--- @return table
function methodtable.filterCelestialObjects( t )
    local filtered = {}

    local parentIds = {
        [ t.system.id ] = '',
    }

    for _, object in spairs( t.celestialObjects ) do
        if parentIds[ object.parent_id ] ~= nil then
            parentIds[ object.id ] = ''
        end
    end

    for _, object in spairs( t.celestialObjects ) do
        if parentIds[ object.parent_id ] ~= nil then
            filtered[ object.id ] = object
        end
    end

    return filtered
end

--- Generates the data structure
--- A "tree" that has the system as its root
function methodtable.createDataStructure( t )
    -- Maps object id to key in array
    local idMapping = {}

	local ignoredTypes = {
		'STATE',
		'TOWN',
		'LANDINGZONE',
		'STRUCTURE',
		'SETTLEMENT',
	}

	local function continue( objectType )
		if mw.getCurrentFrame():getParent().args.code ~= nil then
			return true
		end

		for _, ignored in pairs( ignoredTypes ) do
			if objectType == ignored then
				return false
			end
		end

		return true
	end

    t.structure = {
        [ t.system.id ] = t.system
    }

    t.types[ t.system.type ] = ''

    t.structure[ t.system.id ].children = {}

    for key, object in spairs( t.celestialObjects ) do
        idMapping[ tonumber(object.id) ] = key
        object.children = {}

        if object.type ~= nil and continue( object.type ) then
            if t.types[ object.type ] == nil then
                t.types[ object.type ] = ''
            end

            if object.id ~= nil and object.parent_id == nil or object.parent_id == t.system.id then
                if object.type == 'JUMPPOINT' then
                    object.id = object.id + 10000 --hack
                end

                table.insert( t.structure[ t.system.id ].children, tonumber(object.id), object )
            end
        end
    end

    local function stratify( data )
        for _, object in pairs( data ) do
            if object.parent_id ~= nil then
                local parentEl = data[ idMapping[ tonumber(object.parent_id or object.system_id) ] ]

                if parentEl ~= nil then
                    table.insert( parentEl.children, object.id, object )
                end
            end
        end
    end

    stratify( t.celestialObjects )
end

--- Makes a html entry
--- @param object table The current object from the list of smw entries
--- @param infoTable table The html table object
function methodtable.makeEntry( t, object, infoTable )
    local icon = ''
    if celestialObject.getIcon( object.type ) ~= nil then
        icon = string.format(
                '<span title="%s">%s</span>',
                celestialObject.reverseMapType( object.type ),
                celestialObject.getIcon( object.type )
        )
    end

    local text = celestialObject.getName( object.designation, true )

    if object.name ~= nil and text ~= object.name then
        text = text .. '|' .. text .. ': ' .. object.name
    end

    if object.type == 'STAR' or object.type == 'BLACKHOLE' then
        local starPage = mw.title.new( object.designation, 0 )

        if starPage.exists then
            if object.type == 'STAR' then
                text = object.designation .. ' (Stern)'
            else
                text = object.designation .. ' (Schwarzes Loch)'
            end
        end
    end

    text = '[[' .. text .. ']]'

    if object.type == 'ASTEROID_BELT' or object.type == 'ASTERPOD_FIELD' then
        text = object.designation
    end

    if object.type == 'JUMPPOINT' then
        local split = mw.text.split( object.designation, ' - ', true )

        text = '[[' .. starsystem.cleanJumppointDestination( split[ 2 ] ) .. ']]'
    end

    infoTable = infoTable
            :tag( 'div', {parent = infoTable} )
            :addClass( 'system-entry' )
            :addClass( 'system-entry-' .. object.type )
            :tag( 'span' )
            :addClass( 'system-entry-label' )
            :wikitext( icon .. ' ' .. text )
            :done()

    if type( object.children ) == 'table' then
        for _, child in spairs( object.children ) do
            infoTable = t:makeEntry( child, infoTable )
        end
    end

    return infoTable:done()
end

--- Generates the html
--- @return string
function methodtable.makeHtml( t )
    local headText = t.pageName

    if mw.getCurrentFrame():getParent().args.code then
        headText = t.system.designation or t.pageName
    end

    local icon = string.format(
            '<span title="%s">%s</span>',
            celestialObject.reverseMapType( t.system.type ),
            celestialObject.getIcon( t.system.type )
    )

    local infoTable = mw.html.create( 'div' )
                        :addClass( 'system-wrapper' )
                        :addClass( 'mw-collapsible mw-collapsed' )
                        :tag( 'span' )
                        :addClass( 'system-label' )
                        :wikitext( icon .. ' [[' .. headText .. ']]' )
                        :done()
                        :tag( 'div' )
                        :addClass( 'mw-collapsible-content' )
                        :addClass( 'system-content' )

    for _, object in spairs( t.structure[ t.system.id ].children ) do
        infoTable = t:makeEntry( object, infoTable )
    end

    infoTable = infoTable
            :tag( 'div', {parent = infoTable} )
            :addClass( 'system-entry' )
            :addClass( 'system-entry-INFO' )
            :tag( 'span' )
            :addClass( 'system-entry-label' )
            :addClass( 'mw-customtoggle-legend' )
            :wikitext( 'Legende' )
            :done()
            :tag( 'div' )
            :attr( 'id', 'mw-customcollapsible-legend' )
            :addClass( 'mw-collapsible mw-collapsed' )

    for key, _ in pairs( t.types ) do
        local icon = ''
        local typeTranslation = key

        if celestialObject.getIcon( key ) ~= nil then
            icon = celestialObject.getIcon( key )
        end

        if celestialObject.reverseMapType( key ) ~= nil then
            typeTranslation = celestialObject.reverseMapType( key )
        end

        infoTable = infoTable
                :tag( 'span' )
                :addClass( 'system-entry-label' )
                :wikitext( icon .. ' ' .. typeTranslation )
                :done()
    end

    return infoTable:allDone()
end

--- Template call entry
function SternensystemStruktur.output()
    local instance = SternensystemStruktur:new()

    if mw.getCurrentFrame():getParent().args.name ~= nil then
        instance.pageName = mw.getCurrentFrame():getParent().args.name
    else
        instance.pageName = localized.getMainTitle()
    end

    instance:getStarsystemData()
    instance:getCelestialObjects()

    if mw.getCurrentFrame():getParent().args.code then
        instance.celestialObjects = instance:filterCelestialObjects( instance )
    end

    instance:createDataStructure()

    return tostring( instance:makeHtml() )
end

--- New Instance
--- @return table CelestialObject
function SternensystemStruktur.new( self )
    local instance = {
        pageName = nil,
        system = nil,
        celestialObject = nil,
        structure = nil,
        types = {}
    }

    setmetatable( instance, metatable )

    return instance
end

return SternensystemStruktur