package mhchem

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

Dependency Relation
	imports 8 packages, and imported by one package

Involved Source Files

	    actions.go
	  d buffer.go
		Package mhchem ports mhchemparser 4.1.1, the parser used by MathJax 3.2.2.
		ToTeX converts \ce and \pu source into a TeX expansion for a host parser.

	    data.go
	    engine.go
	    error.go
	    jsregexp.go
	  d mhchem.go
		Package mhchem is a native Go port of mhchemparser 4.1.1, the exact parser
		used by MathJax 3.2.2.  It expands chemistry and physical-unit notation into
		ordinary TeX for a host TeX parser to consume.

	    patterns.go
	    texify.go
Package-Level Type Names (total 12)

	/* sort by: alphabet | popularity */
	 type ActionSpec (struct)

		Fields (total 2)
			Option json.RawMessage
			Type string

	 type Buffer (struct)
		Buffer mirrors the mhchemparser buffer object used by the action
		handlers in actions.go. Slots a..rm are typed as *string so we can
		distinguish "unset" from "empty string".

		Fields (total 17)
			A *string
			B *string
			BeginsWithBond bool
			D *string
			DType *string
			O *string
			P *string
			ParenthesisLevel int
			Q *string
			R *string
			Rd *string
			Rdt *string
			Rm *string
			Rq *string
			Rqt *string
			Sb bool
			Text *string
		Methods (total 2)
			(*Buffer) ClearAll()
				ClearAll resets the buffer to its zero value.

			(*Buffer) ClearSoft()
				ClearSoft clears all slots except ParenthesisLevel/BeginsWithBond.

		As Outputs Of (at least one exported)
			func NewBuffer() *Buffer

	 type Data (struct)

		Fields (total 2)
			Machines Machines
			Regexes map[string]*jsRegexp
		As Outputs Of (at least 2)
			func LoadData() (*Data, error)
			func MustData() *Data

	 type Error (struct)
		Error preserves the identifier and message pair thrown by mhchemparser.
		TeX integrations can pass these fields directly to their native TexError.

		Fields (total 2)
			ID string
			Message string
		Methods (only one)
			(*Error) Error() string
		Implements (at least one exported)
			*Error : error

	 type MachineDef (struct)

		Fields (total 2)
			HasLocalActions bool
			Transitions map[string][]Transition

	 type Machines (map)
	 type MatchToken (struct)
		MatchToken is the result of matching one mhchem transition pattern.
		Either a single string (S) or an ordered tuple of substrings (A).

		Fields (total 3)
			A []string
			IsArray bool
				IsArray distinguishes the two variants. Using a bool keeps the
				type comparable and lets callers branch without a tagged union.

			S string

	 type Mode string (basic type)
		Mode selects one of mhchemparser's three source state machines.

		As Inputs Of (at least one exported)
			func ToTeX(input string, mode Mode) (string, error)
		As Types Of (total 3)
			const ModeCE
			const ModePU
			const ModeTeX

	 type PatternHit (struct)
		PatternHit is one successful pattern match: the captured token plus
		whatever input remained after it.

		Fields (total 2)
			Remainder string
			Token MatchToken

	 type Task (struct)

		Fields (total 4)
			Action []ActionSpec
			NextState *string
			Revisit bool
			ToContinue bool

	 type Transition (struct)

		Fields (total 2)
			Pattern string
			Task Task

	 type Value any (interface)
		Output value: a polymorphic JSON-like list. Either a string (a TeX
		fragment) or a tagged map ({type_: "...", ...}).


Package-Level Functions (total 6)

	 func IsSlotEmpty(s *string) bool
		IsSlotEmpty reports whether s is nil or points to an empty string.

	 func LoadData() (*Data, error)
	 func MustData() *Data
	 func NewBuffer() *Buffer
		NewBuffer returns a fresh, zeroed Buffer.

	 func SetSlot(slot **string, v string)
		SetSlot writes v to *slot, allocating if nil.

	 func ToTeX(input string, mode Mode) (string, error)
		ToTeX returns the exact TeX expansion produced by mhchemparser 4.1.1.


Package-Level Constants (total 3)

	const ModeCE Mode = "ce"
		ModeCE parses the argument of \ce.

	const ModePU Mode = "pu"
		ModePU parses the argument of \pu.

	const ModeTeX Mode = "tex"
		ModeTeX scans ordinary TeX and expands nested \ce and \pu commands.

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.