avail/avail.stacks/CommentGroup

CommentGroup

class CommentGroup

A grouping of AvailComments from an Avail module.

Author

Richard Arriaga

Constructors

constructor(name: A_String, namingModule: String, filename: StacksFilename, isPrivate: Boolean)

Construct a new CommentGroup.

constructor(group: CommentGroup, fileName: StacksFilename, namingModule: String, name: A_String)

Construct a new CommentGroup.

Properties

val aliases: MutableSet<String>

The set of all names referring to this implementation

val categories: MutableSet<String>

All the categories this group belongs to.

classImplementation

var classImplementation: ClassComment?

A class comment

var filepath: StacksFilename?

The relative file path and file name first, fileName second.

var global: GlobalComment?

A module global.

grammaticalRestrictions

val grammaticalRestrictions: MutableMap<String, GrammaticalRestrictionComment>

A list of grammatical restrictions

hasStickyComment

var hasStickyComment: Boolean

Indicates the implementation group has the sticky trait

val isPopulated: Boolean

Determine if the implementation is populated.

val isPrivate: Boolean

val macros: MutableMap<String, MacroComment>

A map keyed by a unique identifier to MacroComment.

val methods: MutableMap<String, MethodComment>

A map keyed by a unique identifier to MethodComment.

val name: A_String

The name of the implementation. It is not final because it can be renamed.

val namingModule: String

The name of the module where this implementation is named and exported from.

semanticRestrictions

val semanticRestrictions: MutableMap<String, SemanticRestrictionComment>

A list of semantic restrictions

Functions

addGrammaticalRestriction

fun addGrammaticalRestriction(newGrammaticalRestriction: GrammaticalRestrictionComment)

fun addMacro(newMacro: MacroComment)

fun addMethod(newMethod: MethodComment)

addSemanticRestriction

fun addSemanticRestriction(newSemanticRestriction: SemanticRestrictionComment)

fun categories(): MutableSet<String>

classImplementation

fun classImplementation(aClassImplementation: ClassComment)

fun global(aGlobal: GlobalComment)

hasStickyComment

fun hasStickyComment(aSwitch: Boolean)

set the boolean, hasStickyComment, presumably to true as the default is false.

fun mergeWith(group: CommentGroup)

Merge the input group with this group

fun toJSON(outputPath: Path, synchronizer: StacksSynchronizer, runtime: AvailRuntime, linkingFileMap: LinkingFileMap, nameOfGroup: String, errorLog: StacksErrorLog)

Create JSON file from implementation.