cpg-language-ini/de.fraunhofer.aisec.cpg.frontends.ini/IniFileFrontend

IniFileFrontend

class IniFileFrontend(language: Language<IniFileFrontend>, ctx: TranslationContext) : LanguageFrontend<Any, Any?>

The INI file frontend. This frontend utilizes the ini4j library to parse the config file. The result consists of

a TranslationUnitDeclaration wrapping the entire result
a NamespaceDeclaration wrapping the INI file and thus preventing collisions with other symbols which might have the same name
a RecordDeclaration per Section (a section refers to a block of INI values marked with a line [SectionName])
a FieldDeclaration per entry in a section. The FieldDeclaration.name matches the entrys name field and the FieldDeclaration.initializer is set to a Literal with the corresponding entrys value.

Note:

the "ini4j" library does not provide any super type for all nodes. Thus, the frontend accepts Any
typeOf has to be implemented, but as there are no types always returns the builtin string type
codeOf has to accept Any (because of the limitations stated above) and simply returns .toString()
locationOf always returns null as the "ini4j" library does not provide any means of getting a location given a node
setComment not implemented as this is not used (no Handler pattern implemented)
Comments in general are not supported.

Constructors

IniFileFrontend

constructor(language: Language<IniFileFrontend>, ctx: TranslationContext)

Properties

config

val config: TranslationConfiguration

ctx

override var ctx: TranslationContext

currentTU

var currentTU: TranslationUnitDeclaration?

language

open override val language: Language<out LanguageFrontend<Any, Any?>>

namespace

open override val namespace: Name?

scope

open override val scope: Scope?

scopeManager

val scopeManager: ScopeManager

typeManager

val typeManager: TypeManager

Functions

build

fun build(init: LanguageFrontend<*, *>.() -> TranslationResult): TranslationResult

cleanup

open fun cleanup()

clearProcessed

fun clearProcessed()

codeOf

open override fun codeOf(astNode: Any): String?

Returns an approximation of the original code by re-creating (parts of) the INI file given the parsed results provided by ini4j. This is not a perfect representation of the original code (comments, order, ...), however re-parsing it should result in the same CPG-representation.

locationOf

open override fun locationOf(astNode: Any): PhysicalLocation?

Return the entire file as the location of any node. The parsing library in use does not provide more fine granular access to a node's location.

parse

open override fun parse(file: File): TranslationUnitDeclaration

parseAll

fun parseAll(): List<TranslationUnitDeclaration>

process

open fun process(from: Any, to: Node)

registerObjectListener

open fun registerObjectListener(from: Any, biConsumer: BiConsumer<Any, Node>)

registerPredicateListener

open fun registerPredicateListener(predicate: BiPredicate<Any, Node>, biConsumer: BiConsumer<Any, Node>)

setComment

open override fun setComment(node: Node, astNode: Any)

typeOf

open override fun typeOf(type: Any?): Type