1LaTeXML::Core::DefinitiUosne(r3)Contributed Perl DocumenLtaaTteiXoMnL::Core::Definition(3)
2
3
4

NAME

6       "LaTeXML::Core::Definition"  - Control sequence definitions.
7

DESCRIPTION

9       This abstract class represents the various executables corresponding to
10       control sequences.  See LaTeXML::Package for the most convenient means
11       to create them.
12
13       It extends LaTeXML::Common::Object.
14
15   Methods
16       "$token = $defn->getCS;"
17           Returns the (main) token that is bound to this definition.
18
19       "$string = $defn->getCSName;"
20           Returns the string form of the token bound to this definition,
21           taking into account any alias for this definition.
22
23       "$defn->readArguments($gullet);"
24           Reads the arguments for this $defn from the $gullet, returning a
25           list of LaTeXML::Core::Tokens.
26
27       "$parameters = $defn->getParameters;"
28           Return the "LaTeXML::Core::Parameters" object representing the
29           formal parameters of the definition.
30
31       "@tokens = $defn->invocation(@args);"
32           Return the tokens that would invoke the given definition with the
33           provided arguments.  This is used to recreate the TeX code (or it's
34           equivalent).
35
36       "$defn->invoke;"
37           Invoke the action of the $defn.  For expandable definitions, this
38           is done in the Gullet, and returns a list of LaTeXML::Core::Tokens.
39           For primitives, it is carried out in the Stomach, and returns a
40           list of LaTeXML::Core::Boxes.  For a constructor, it is also
41           carried out by the Stomach, and returns a LaTeXML::Core::Whatsit.
42           That whatsit will be responsible for constructing the XML document
43           fragment, when the LaTeXML::Core::Document invokes
44           "$whatsit-"beAbsorbed($document);>.
45
46           Primitives and Constructors also support before and after daemons,
47           lists of subroutines that are executed before and after digestion.
48           These can be useful for changing modes, etc.
49

SEE ALSO

51       LaTeXML::Core::Definition::Expandable,
52       LaTeXML::Core::Definition::Conditional,
53       LaTeXML::Core::Definition::Primitive,
54       LaTeXML::Core::Definition::Register, LaTeXML::Core::Definition::CharDef
55       and LaTeXML::Core::Definition::Constructor.
56

AUTHOR

58       Bruce Miller <bruce.miller@nist.gov>
59

61       Public domain software, produced as part of work done by the United
62       States Government & not subject to copyright in the US.
63
64
65
66perl v5.34.0                      2022-01-19      LaTeXML::Core::Definition(3)
Impressum