avail/avail.stacks.module/StacksImportModule

StacksImportModule

abstract class StacksImportModule( val moduleName: String, val commentGroups: MutableMap<A_String, CommentGroup>, val moduleNameToExtendsList: MutableMap<String, StacksExtendsModule>, val extendsMethodLeafNameToModuleName: MutableMap<A_String, MutableMap<String, CommentGroup>>, val moduleNameToUsesList: MutableMap<String, StacksUsesModule>, val usesMethodLeafNameToModuleName: MutableMap<A_String, MutableMap<String, CommentGroup>>)

A grouping of all implementationGroups originating from the names section of this module that this is being imported by another module.

Author

Richard Arriaga

Parameters

moduleName

The name of the module

commentGroups

The a map of implementationGroups keyed by the implementation name.

moduleNameToExtendsList

A map of module names to other modules extended by this module.

extendsMethodLeafNameToModuleName

A map keyed by exported method names with no path to the qualified module path it is originally named from.

moduleNameToUsesList

A map of module names to other modules used by this module.

usesMethodLeafNameToModuleName

A map keyed by visible (uses) method names with no path to the qualified module path it is originally named from.

Constructors

StacksImportModule

fun StacksImportModule( moduleName: String, commentGroups: MutableMap<A_String, CommentGroup>, moduleNameToExtendsList: MutableMap<String, StacksExtendsModule>, extendsMethodLeafNameToModuleName: MutableMap<A_String, MutableMap<String, CommentGroup>>, moduleNameToUsesList: MutableMap<String, StacksUsesModule>, usesMethodLeafNameToModuleName: MutableMap<A_String, MutableMap<String, CommentGroup>>)

Construct a new StacksImportModule.

Functions

addClassImplementationGroup

abstract fun addClassImplementationGroup(key: A_String, classCommentGroup: CommentGroup)

addGlobalImplementationGroup

abstract fun addGlobalImplementationGroup(key: A_String, globalCommentGroup: CommentGroup)

addGrammaticalImplementation

abstract fun addGrammaticalImplementation(key: A_String, implementation: GrammaticalRestrictionComment)

addMacroImplementation

abstract fun addMacroImplementation(key: A_String, implementation: MacroComment)

addMethodImplementation

abstract fun addMethodImplementation(key: A_String, implementation: MethodComment)

addSemanticImplementation

abstract fun addSemanticImplementation(key: A_String, implementation: SemanticRestrictionComment)

flattenImplementationGroups

fun flattenImplementationGroups(): Pair<MutableMap<String, Pair<String, CommentGroup>>, MutableMap<String, String>>

Flatten out moduleNameToExtendsList map so that all modules in tree are in one flat map keyed by the qualified method name to the implementation. Pair this with a map of method name to html link.

qualifiedImplementationNameToImplementation

fun qualifiedImplementationNameToImplementation(): Pair<MutableMap<String, Pair<String, CommentGroup>>, MutableMap<String, String>>

Create a new map from implementationGroups with new keys using the method qualified name

renameImplementation

abstract fun renameImplementation( key: A_String, newName: A_String, newlyDefinedModule: CommentsModule, newFileName: StacksFilename, deleteOriginal: Boolean)

Rename an implementation in this Module.