1 = APIs = 2 3 The principal application programming interfaces (APIs) within Lichen are described below. 4 5 == Modules == 6 7 When [[../Inspection|inspecting]] and [[../Translation|translating]] modules, common abstractions are used so that elements of the program are handled in similar ways. Various useful attributes and methods are provided by the `CommonModule` abstraction for use within `InspectedModule` and `TranslatedModule` methods: 8 9 {{{#!table 10 '''Attribute or Method''' || '''Purpose''' 11 == 12 `name` || 13 An attribute providing the module name. 14 == 15 `get_global_path(name)` || 16 A method returning the qualified name of the given global name within the module being processed. 17 == 18 `get_namespace_path()` || 19 A method returning the qualified name of the namespace being processed. 20 * For modules, this is the module name 21 * For classes, functions and methods, the path incorporates the module name and namespaces leading to the current namespace itself 22 == 23 `get_object_path(name)` || 24 A method returning the qualified name of the given local name within the namespace being processed. 25 }}}