package mml

Import Path
	github.com/d2lang/mathjax-go/internal/mml (on go.dev)

Dependency Relation
	imports 7 packages, and imported by 3 packages

Involved Source Files

	    attributes.go
	    definitions.go
	    factory.go
	    maction_selection.go
	    mfenced.go
	  d node.go
		Package mml defines MathJax's internal MathML tree representation.
Package-Level Type Names (total 8)

	/* sort by: alphabet | popularity */
	 type Attributes (struct)
		Attributes preserves MathJax's four attribute layers: explicit, inherited,
		per-node defaults, and global math attributes.

		Methods (total 18)
			(*Attributes) Clone() *Attributes
				Clone returns an independent shallow copy.

			(*Attributes) DefaultNames() []string
			(*Attributes) Defaults() *ordered.Map[Property]
				Defaults returns the per-kind default map.

			(*Attributes) Explicit() *ordered.Map[Property]
				Explicit returns the mutable explicit-attribute map.

			(*Attributes) ExplicitNames() []string
			(*Attributes) Get(name string) (Property, bool)
				Get resolves explicit, inherited, default, and global layers in that order.

			(*Attributes) GetDefault(name string) (Property, bool)
				GetDefault resolves the per-kind default and global layers.

			(*Attributes) GetExplicit(name string) (Property, bool)
				GetExplicit returns only an explicitly set value.

			(*Attributes) GetInherited(name string) (Property, bool)
				GetInherited resolves the inherited layer and its default/global prototypes.

			(*Attributes) GlobalNames() []string
			(*Attributes) Globals() *ordered.Map[Property]
				Globals returns the global math-attribute map.

			(*Attributes) HasDefault(name string) bool
				HasDefault reports whether name has a kind or global default.

			(*Attributes) Inherited() *ordered.Map[Property]
				Inherited returns the mutable inherited-attribute map.

			(*Attributes) InheritedNames() []string
			(*Attributes) IsSet(name string) bool
				IsSet reports whether name is explicit or directly inherited.

			(*Attributes) Set(name string, value Property)
				Set sets an explicit attribute.

			(*Attributes) SetInherited(name string, value Property)
				SetInherited sets an inherited value.

			(*Attributes) SetList(list *ordered.Map[Property])
				SetList sets explicit attributes in the source map's insertion order.

		As Outputs Of (at least 2)
			func NewAttributes(defaults, global *ordered.Map[Property]) *Attributes
			func (*Attributes).Clone() *Attributes

	 type Definition (struct)
		Definition describes behavior shared by all nodes of one kind.

		Fields (total 2)
			Defaults *ordered.Map[Property]
			Flags Flags
		As Outputs Of (at least one exported)
			func (*Factory).Definition(kind string) (Definition, bool)
		As Inputs Of (at least one exported)
			func (*Factory).Register(kind string, definition Definition)

	 type Factory (struct)
		Factory constructs nodes with registered kind definitions and shared global
		math attributes. It is intentionally small so parser and layout packages can
		evolve independently.

		Methods (total 6)
			(*Factory) Create(kind string, children ...*Node) *Node
				Create constructs kind and links children.

			(*Factory) CreateFencedNodes(node *Node)
				CreateFencedNodes ports MmlMfenced.addFakeNodes/fakeNode. Its caller must
				apply the original incoming inheritance context to the returned operators,
				rather than copying the resolved attributes of their mfenced parent.

			(*Factory) Definition(kind string) (Definition, bool)
				Definition returns a registered definition.

			(*Factory) Globals() *ordered.Map[Property]
				Globals returns the shared global math-attribute map.

			(*Factory) Register(kind string, definition Definition)
				Register registers or replaces a node definition.

			(*Factory) Text(text string) *Node
				Text constructs an internal text node.

		As Outputs Of (at least 2)
			func NewFactory() *Factory
			func NewMathJaxFactory() *Factory

	 type FencedNodes (struct)
		FencedNodes are MmlMfenced's non-authored operator nodes. A non-nil value
		distinguishes an initialized fence with no operators from one whose MML
		inheritance pass has not run. These nodes do not participate in Walk/Find.

		Fields (total 3)
			Close *Node
			Open *Node
			Separators []*Node

	 type Flags (struct)
		Flags contains node-kind behavior that MathJax expresses through its MML
		node subclasses.

		Fields (total 9)
			Arity int
			CoreIndex int
			Embellished bool
			HasNewline bool
			Inferred bool
			LinebreakContainer bool
			NotParent bool
			Spacelike bool
			Token bool

	 type Node (struct)
		Node is one node in MathJax's internal MathML tree. Kind-specific state that
		is not an attribute lives in Properties.

		Fields (total 13)
			Attributes *Attributes
			Children []*Node
			Fenced *FencedNodes
			Flags Flags
			Kind string
			OperatorLspace float64
				OperatorLspace/OperatorRspace are MmlMo's dictionary-derived defaults,
				distinct from explicit/inherited lspace/rspace attributes (in ems).

			OperatorRspace float64
				OperatorLspace/OperatorRspace are MmlMo's dictionary-derived defaults,
				distinct from explicit/inherited lspace/rspace attributes (in ems).

			Parent *Node
			PrevClass TeXClass
			PrevLevel int
			Properties *ordered.Map[Property]
			TeXClass TeXClass
			Text string
		Methods (total 15)
			(*Node) AppendChild(child *Node) *Node
				AppendChild appends child and returns it.

			(*Node) ChildIndex(child *Node) int
				ChildIndex returns child's index, or -1 if child is absent.

			(*Node) Clone() *Node
				Clone deep-copies n without retaining a parent pointer.

			(*Node) Core() *Node
				Core returns the child containing an embellished operator, or n.

			(*Node) CoreMO() *Node
				CoreMO follows embellished children to their core mo node.

			(*Node) Find(kind string) []*Node
				Find returns all descendants, including n, whose kind matches.

			(*Node) IsKind(kind string) bool
				IsKind reports whether n has kind.

			(*Node) ParentNode() *Node
				ParentNode returns the semantic parent, skipping inferred/not-parent nodes.

			(*Node) Property(name string) (Property, bool)
				Property returns internal node state.

			(*Node) RemoveChild(child *Node) error
				RemoveChild removes child and returns an error when it is absent.

			(*Node) RemoveProperty(name string) bool
				RemoveProperty removes internal node state.

			(*Node) ReplaceChild(newChild, oldChild *Node) error
				ReplaceChild replaces oldChild and returns an error when it is absent.

			(*Node) SetChildren(children []*Node)
				SetChildren replaces n's children and maintains parent pointers.

			(*Node) SetProperty(name string, value Property)
				SetProperty sets internal node state.

			(*Node) Walk(visit func(*Node) bool)
				Walk visits n and its descendants in pre-order.

		As Outputs Of (at least 12)
			func NewNode(kind string, defaults, global *ordered.Map[Property], children ...*Node) *Node
			func NewText(text string) *Node
			func (*Factory).Create(kind string, children ...*Node) *Node
			func (*Factory).Text(text string) *Node
			func (*Node).AppendChild(child *Node) *Node
			func (*Node).Clone() *Node
			func (*Node).Core() *Node
			func (*Node).CoreMO() *Node
			func (*Node).Find(kind string) []*Node
			func (*Node).ParentNode() *Node
			func github.com/d2lang/mathjax-go/internal/pipeline.Compiler.Compile(tex string, display bool) (*Node, error)
			func github.com/d2lang/mathjax-go/internal/tex.(*Compiler).Compile(source string, display bool) (*Node, error)
		As Inputs Of (at least 10)
			func NewNode(kind string, defaults, global *ordered.Map[Property], children ...*Node) *Node
			func (*Factory).Create(kind string, children ...*Node) *Node
			func (*Factory).CreateFencedNodes(node *Node)
			func (*Node).AppendChild(child *Node) *Node
			func (*Node).ChildIndex(child *Node) int
			func (*Node).RemoveChild(child *Node) error
			func (*Node).ReplaceChild(newChild, oldChild *Node) error
			func (*Node).SetChildren(children []*Node)
			func github.com/d2lang/mathjax-go/internal/pipeline.Typesetter.Typeset(root *Node, options pipeline.Options) (string, error)
			func github.com/d2lang/mathjax-go/internal/svg.(*Typesetter).Typeset(root *Node, options pipeline.Options) (string, error)

	 type Property = any (interface)
		Property is a MathML attribute or internal-property value.

	 type TeXClass int8 (basic type)
		TeXClass is a TeX atom class used by MathJax's spacing rules.

		As Inputs Of (at least one exported)
			func TeXSpacing(left, right TeXClass, script bool) string
		As Types Of (total 10)
			const TeXClassBin
			const TeXClassClose
			const TeXClassInner
			const TeXClassNone
			const TeXClassOp
			const TeXClassOpen
			const TeXClassOrd
			const TeXClassPunct
			const TeXClassRel
			const TeXClassVCenter


Package-Level Functions (total 8)

	 func IsInherit(value Property) bool
		IsInherit reports whether value is the Inherit sentinel.

	 func MactionSelectionNumber(value any, exists bool) float64
		MactionSelectionNumber applies the numeric coercions used by the source
		maction selected getter to supported scalar attribute values.

	 func NewAttributes(defaults, global *ordered.Map[Property]) *Attributes
		NewAttributes constructs an attribute set. Inputs are cloned; nil inputs are
		treated as empty maps.

	 func NewFactory() *Factory
		NewFactory returns an empty factory.

	 func NewMathJaxFactory() *Factory
		NewMathJaxFactory returns the complete pinned MathJax 3.2.2 registry.
		Each factory owns immutable definitions; Create clones their attribute maps.

	 func NewNode(kind string, defaults, global *ordered.Map[Property], children ...*Node) *Node
		NewNode creates a node with empty attribute and property maps.

	 func NewText(text string) *Node
		NewText creates an internal text node.

	 func TeXSpacing(left, right TeXClass, script bool) string
		TeXSpacing returns MathJax's named space between two TeX atom classes.
		script suppresses entries marked as display/text-style-only. Negative table
		entries are the ones retained in scripts in MathJax's TEXSPACE encoding.


Package-Level Variables (total 2)

	  var Inherit Property
		Inherit marks a default that resolves directly from the math node's global
		attributes, matching MathJax's _inherit_ sentinel.

	  var TeXClassNames [9]string
Package-Level Constants (total 11)

	const TeXClassBin TeXClass = 2
	const TeXClassClose TeXClass = 5
	const TeXClassInner TeXClass = 7
	const TeXClassNone TeXClass = -1
	const TeXClassOp TeXClass = 1
	const TeXClassOpen TeXClass = 4
	const TeXClassOrd TeXClass = 0
	const TeXClassPunct TeXClass = 6
	const TeXClassRel TeXClass = 3
	const TeXClassVCenter TeXClass = 8
	const UnboundedArity int = 9223372036854775807
		UnboundedArity is the integer representation used by the Go tree for
		MathJax's JavaScript Infinity arity.  Negative one remains reserved for the
		inferred-mrow content model.

The pages are generated with Golds v0.8.7. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.