module

package module
v8.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 11, 2026 License: MIT Imports: 3 Imported by: 5

Documentation

Overview

┌────────────────────────────────── WARNING ───────────────────────────────────┐ │ This "module_api.go" file was automatically generated using: │ │ https://github.com/craterdog/go-development-tools/wiki │ │ │ │ Updates to any part of this file—other than the Module Description │ │ and the Global Functions sections may be overwritten. │ └──────────────────────────────────────────────────────────────────────────────┘

Package "module" declares type aliases for the commonly used types declared in the packages contained in this module. It also provides constructors for each commonly used class that is exported by the module. Each constructor delegates the actual construction process to its corresponding concrete class declared in the corresponding package contained within this module.

For detailed documentation on this entire module refer to the wiki:

Index

Constants

View Source 
const (
	ErrorToken     = gra.ErrorToken
	AllcapsToken   = gra.AllcapsToken
	CommentToken   = gra.CommentToken
	DelimiterToken = gra.DelimiterToken
	GlyphToken     = gra.GlyphToken
	IntrinsicToken = gra.IntrinsicToken
	LiteralToken   = gra.LiteralToken
	LowercaseToken = gra.LowercaseToken
	NewlineToken   = gra.NewlineToken
	NoteToken      = gra.NoteToken
	NumberToken    = gra.NumberToken
	SpaceToken     = gra.SpaceToken
	UppercaseToken = gra.UppercaseToken
)

Variables

This section is empty.

Functions

func FormatSyntax 

func FormatSyntax(
	syntax SyntaxLike,
) string

func MatchesType 

func MatchesType(
	tokenValue string,
	tokenType TokenType,
) bool

func ValidateSyntax 

func ValidateSyntax(
	syntax SyntaxLike,
)

Types

type AlternativeSequenceClassLike 

type AlternativeSequenceClassLike = ast.AlternativeSequenceClassLike

func AlternativeSequenceClass 

func AlternativeSequenceClass() AlternativeSequenceClassLike

type AlternativeSequenceLike 

type AlternativeSequenceLike = ast.AlternativeSequenceLike

func AlternativeSequence 

func AlternativeSequence(
	delimiter string,
	sequence ast.SequenceLike,
) AlternativeSequenceLike

type AlternativesClassLike 

type AlternativesClassLike = ast.AlternativesClassLike

func AlternativesClass 

func AlternativesClass() AlternativesClassLike

type AlternativesLike 

type AlternativesLike = ast.AlternativesLike

func Alternatives 

func Alternatives(
	sequence ast.SequenceLike,
	alternativeSequences com.Sequential[ast.AlternativeSequenceLike],
) AlternativesLike

type CardinalityClassLike 

type CardinalityClassLike = ast.CardinalityClassLike

func CardinalityClass 

func CardinalityClass() CardinalityClassLike

type CardinalityLike 

type CardinalityLike = ast.CardinalityLike

func Cardinality 

func Cardinality(
	any_ any,
) CardinalityLike

type CharacterClassLike 

type CharacterClassLike = ast.CharacterClassLike

func CharacterClass 

func CharacterClass() CharacterClassLike

type CharacterLike 

type CharacterLike = ast.CharacterLike

func Character 

func Character(
	any_ any,
) CharacterLike

type ComponentClassLike 

type ComponentClassLike = ast.ComponentClassLike

func ComponentClass 

func ComponentClass() ComponentClassLike

type ComponentLike 

type ComponentLike = ast.ComponentLike

func Component 

func Component(
	any_ any,
) ComponentLike

type ConstrainedClassLike 

type ConstrainedClassLike = ast.ConstrainedClassLike

func ConstrainedClass 

func ConstrainedClass() ConstrainedClassLike

type ConstrainedLike 

type ConstrainedLike = ast.ConstrainedLike

func Constrained 

func Constrained(
	any_ any,
) ConstrainedLike

type DefinitionClassLike 

type DefinitionClassLike = ast.DefinitionClassLike

func DefinitionClass 

func DefinitionClass() DefinitionClassLike

type DefinitionLike 

type DefinitionLike = ast.DefinitionLike

func Definition 

func Definition(
	any_ any,
) DefinitionLike

type ElementClassLike 

type ElementClassLike = ast.ElementClassLike

func ElementClass 

func ElementClass() ElementClassLike

type ElementLike 

type ElementLike = ast.ElementLike

func Element 

func Element(
	any_ any,
) ElementLike

type ExplicitClassLike 

type ExplicitClassLike = ast.ExplicitClassLike

func ExplicitClass 

func ExplicitClass() ExplicitClassLike

type ExplicitLike 

type ExplicitLike = ast.ExplicitLike

func Explicit 

func Explicit(
	glyph string,
	optionalExtent ast.ExtentLike,
) ExplicitLike

type ExpressionAlternativesClassLike 

type ExpressionAlternativesClassLike = ast.ExpressionAlternativesClassLike

func ExpressionAlternativesClass 

func ExpressionAlternativesClass() ExpressionAlternativesClassLike

type ExpressionAlternativesLike 

type ExpressionAlternativesLike = ast.ExpressionAlternativesLike

func ExpressionAlternatives 

func ExpressionAlternatives(
	expressionNames com.Sequential[ast.ExpressionNameLike],
) ExpressionAlternativesLike

type ExpressionClassLike 

type ExpressionClassLike = ast.ExpressionClassLike

func ExpressionClass 

func ExpressionClass() ExpressionClassLike

type ExpressionLike 

type ExpressionLike = ast.ExpressionLike

func Expression 

func Expression(
	delimiter1 string,
	lowercase string,
	delimiter2 string,
	pattern ast.PatternLike,
) ExpressionLike

type ExpressionNameClassLike 

type ExpressionNameClassLike = ast.ExpressionNameClassLike

func ExpressionNameClass 

func ExpressionNameClass() ExpressionNameClassLike

type ExpressionNameLike 

type ExpressionNameLike = ast.ExpressionNameLike

func ExpressionName 

func ExpressionName(
	newline string,
	lowercase string,
	optionalNote string,
) ExpressionNameLike

type ExtentClassLike 

type ExtentClassLike = ast.ExtentClassLike

func ExtentClass 

func ExtentClass() ExtentClassLike

type ExtentLike 

type ExtentLike = ast.ExtentLike

func Extent 

func Extent(
	delimiter string,
	glyph string,
) ExtentLike

type FilterClassLike 

type FilterClassLike = ast.FilterClassLike

func FilterClass 

func FilterClass() FilterClassLike

type FilterLike 

type FilterLike = ast.FilterLike

func Filter 

func Filter(
	optionalDelimiter string,
	delimiter1 string,
	characters com.Sequential[ast.CharacterLike],
	delimiter2 string,
) FilterLike

type FormatterClassLike 

type FormatterClassLike = gra.FormatterClassLike

func FormatterClass 

func FormatterClass() FormatterClassLike

type FormatterLike 

type FormatterLike = gra.FormatterLike

func Formatter 

func Formatter() FormatterLike

type FragmentClassLike 

type FragmentClassLike = ast.FragmentClassLike

func FragmentClass 

func FragmentClass() FragmentClassLike

type FragmentLike 

type FragmentLike = ast.FragmentLike

func Fragment 

func Fragment(
	delimiter1 string,
	allcaps string,
	delimiter2 string,
	pattern ast.PatternLike,
) FragmentLike

type GroupClassLike 

type GroupClassLike = ast.GroupClassLike

func GroupClass 

func GroupClass() GroupClassLike

type GroupLike 

type GroupLike = ast.GroupLike

func Group 

func Group(
	delimiter1 string,
	alternatives ast.AlternativesLike,
	delimiter2 string,
) GroupLike

type ImplicitClassLike 

type ImplicitClassLike = ast.ImplicitClassLike

func ImplicitClass 

func ImplicitClass() ImplicitClassLike

type ImplicitLike 

type ImplicitLike = ast.ImplicitLike

func Implicit 

func Implicit(
	intrinsic string,
) ImplicitLike

type LegalNoticeClassLike 

type LegalNoticeClassLike = ast.LegalNoticeClassLike

func LegalNoticeClass 

func LegalNoticeClass() LegalNoticeClassLike

type LegalNoticeLike 

type LegalNoticeLike = ast.LegalNoticeLike

func LegalNotice 

func LegalNotice(
	comment string,
) LegalNoticeLike

type LimitClassLike 

type LimitClassLike = ast.LimitClassLike

func LimitClass 

func LimitClass() LimitClassLike

type LimitLike 

type LimitLike = ast.LimitLike

func Limit 

func Limit(
	delimiter string,
	optionalNumber string,
) LimitLike

type LiteralAlternativesClassLike 

type LiteralAlternativesClassLike = ast.LiteralAlternativesClassLike

func LiteralAlternativesClass 

func LiteralAlternativesClass() LiteralAlternativesClassLike

type LiteralAlternativesLike 

type LiteralAlternativesLike = ast.LiteralAlternativesLike

func LiteralAlternatives 

func LiteralAlternatives(
	literalValues com.Sequential[ast.LiteralValueLike],
) LiteralAlternativesLike

type LiteralValueClassLike 

type LiteralValueClassLike = ast.LiteralValueClassLike

func LiteralValueClass 

func LiteralValueClass() LiteralValueClassLike

type LiteralValueLike 

type LiteralValueLike = ast.LiteralValueLike

func LiteralValue 

func LiteralValue(
	newline string,
	literal string,
	optionalNote string,
) LiteralValueLike

type Methodical 

type Methodical = gra.Methodical

type ParserClassLike 

type ParserClassLike = gra.ParserClassLike

func ParserClass 

func ParserClass() ParserClassLike

type ParserLike 

type ParserLike = gra.ParserLike

func Parser 

func Parser() ParserLike

type PatternClassLike 

type PatternClassLike = ast.PatternClassLike

func PatternClass 

func PatternClass() PatternClassLike

type PatternLike 

type PatternLike = ast.PatternLike

func Pattern 

func Pattern(
	alternatives ast.AlternativesLike,
	optionalNote string,
) PatternLike

type ProcessorClassLike 

type ProcessorClassLike = gra.ProcessorClassLike

func ProcessorClass 

func ProcessorClass() ProcessorClassLike

type ProcessorLike 

type ProcessorLike = gra.ProcessorLike

func Processor 

func Processor() ProcessorLike

type QuantifiedClassLike 

type QuantifiedClassLike = ast.QuantifiedClassLike

func QuantifiedClass 

func QuantifiedClass() QuantifiedClassLike

type QuantifiedLike 

type QuantifiedLike = ast.QuantifiedLike

func Quantified 

func Quantified(
	delimiter1 string,
	number string,
	optionalLimit ast.LimitLike,
	delimiter2 string,
) QuantifiedLike

type RepetitionClassLike 

type RepetitionClassLike = ast.RepetitionClassLike

func RepetitionClass 

func RepetitionClass() RepetitionClassLike

type RepetitionLike 

type RepetitionLike = ast.RepetitionLike

func Repetition 

func Repetition(
	element ast.ElementLike,
	optionalCardinality ast.CardinalityLike,
) RepetitionLike

type RuleAlternativesClassLike 

type RuleAlternativesClassLike = ast.RuleAlternativesClassLike

func RuleAlternativesClass 

func RuleAlternativesClass() RuleAlternativesClassLike

type RuleAlternativesLike 

type RuleAlternativesLike = ast.RuleAlternativesLike

func RuleAlternatives 

func RuleAlternatives(
	ruleNames com.Sequential[ast.RuleNameLike],
) RuleAlternativesLike

type RuleClassLike 

type RuleClassLike = ast.RuleClassLike

func RuleClass 

func RuleClass() RuleClassLike

type RuleLike 

type RuleLike = ast.RuleLike

func Rule 

func Rule(
	delimiter1 string,
	uppercase string,
	delimiter2 string,
	definition ast.DefinitionLike,
) RuleLike

type RuleNameClassLike 

type RuleNameClassLike = ast.RuleNameClassLike

func RuleNameClass 

func RuleNameClass() RuleNameClassLike

type RuleNameLike 

type RuleNameLike = ast.RuleNameLike

func RuleName 

func RuleName(
	newline string,
	uppercase string,
	optionalNote string,
) RuleNameLike

type RuleTermClassLike 

type RuleTermClassLike = ast.RuleTermClassLike

func RuleTermClass 

func RuleTermClass() RuleTermClassLike

type RuleTermLike 

type RuleTermLike = ast.RuleTermLike

func RuleTerm 

func RuleTerm(
	component ast.ComponentLike,
	optionalCardinality ast.CardinalityLike,
) RuleTermLike

type ScannerClassLike 

type ScannerClassLike = gra.ScannerClassLike

func ScannerClass 

func ScannerClass() ScannerClassLike

type ScannerLike 

type ScannerLike = gra.ScannerLike

func Scanner 

func Scanner(
	source string,
	tokens com.QueueLike[gra.TokenLike],
) ScannerLike

type SequenceClassLike 

type SequenceClassLike = ast.SequenceClassLike

func SequenceClass 

func SequenceClass() SequenceClassLike

type SequenceLike 

type SequenceLike = ast.SequenceLike

func Sequence 

func Sequence(
	repetitions com.Sequential[ast.RepetitionLike],
) SequenceLike

type SyntaxClassLike 

type SyntaxClassLike = ast.SyntaxClassLike

func SyntaxClass 

func SyntaxClass() SyntaxClassLike

type SyntaxLike 

type SyntaxLike = ast.SyntaxLike

func ParseSource 

func ParseSource(
	source string,
) SyntaxLike

func Syntax 

func Syntax(
	legalNotice ast.LegalNoticeLike,
	comment1 string,
	rules com.Sequential[ast.RuleLike],
	comment2 string,
	expressions com.Sequential[ast.ExpressionLike],
	comment3 string,
	fragments com.Sequential[ast.FragmentLike],
) SyntaxLike

type TermSequenceClassLike 

type TermSequenceClassLike = ast.TermSequenceClassLike

func TermSequenceClass 

func TermSequenceClass() TermSequenceClassLike

type TermSequenceLike 

type TermSequenceLike = ast.TermSequenceLike

func TermSequence 

func TermSequence(
	ruleTerms com.Sequential[ast.RuleTermLike],
	optionalNote string,
) TermSequenceLike

type TextClassLike 

type TextClassLike = ast.TextClassLike

func TextClass 

func TextClass() TextClassLike

type TextLike 

type TextLike = ast.TextLike

func Text 

func Text(
	any_ any,
) TextLike

type TokenClassLike 

type TokenClassLike = gra.TokenClassLike

func TokenClass 

func TokenClass() TokenClassLike

type TokenLike 

type TokenLike = gra.TokenLike

func Token 

func Token(
	line uint,
	position uint,
	type_ gra.TokenType,
	value string,
) TokenLike

type TokenType 

type TokenType = gra.TokenType

type ValidatorClassLike 

type ValidatorClassLike = gra.ValidatorClassLike

func ValidatorClass 

func ValidatorClass() ValidatorClassLike

type ValidatorLike 

type ValidatorLike = gra.ValidatorLike

func Validator 

func Validator() ValidatorLike

type VisitorClassLike 

type VisitorClassLike = gra.VisitorClassLike

func VisitorClass 

func VisitorClass() VisitorClassLike

type VisitorLike 

type VisitorLike = gra.VisitorLike

func Visitor 

func Visitor(
	processor gra.Methodical,
) VisitorLike

Source Files

View all Source files

Directories

Path Synopsis
┌────────────────────────────────── WARNING ───────────────────────────────────┐ │ This "package_api.go" file was automatically generated using: │ │ https://github.com/craterdog/go-development-tools/wiki │ │ │ │ Any updates to it may be overwritten.
 ┌────────────────────────────────── WARNING ───────────────────────────────────┐ │ This "package_api.go" file was automatically generated using: │ │ https://github.com/craterdog/go-development-tools/wiki │ │ │ │ Any updates to it may be overwritten.
┌────────────────────────────────── WARNING ───────────────────────────────────┐ │ This "package_api.go" file was automatically generated using: │ │ https://github.com/craterdog/go-development-tools/wiki │ │ │ │ Any updates to it may be overwritten.
 ┌────────────────────────────────── WARNING ───────────────────────────────────┐ │ This "package_api.go" file was automatically generated using: │ │ https://github.com/craterdog/go-development-tools/wiki │ │ │ │ Any updates to it may be overwritten.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.