latexml::mouth(3pm) [debian man page]

LaTeXML::Mouth(3pm)					User Contributed Perl Documentation				       LaTeXML::Mouth(3pm)

NAME

       "LaTeXML::Mouth" - tokenize the input.

DESCRIPTION

       A "LaTeXML::Mouth" (and subclasses) is responsible for tokenizing, ie.  converting plain text and strings into LaTeXML::Tokens according to
       the current category codes (catcodes) stored in the "LaTeXML::State".

       "LaTeXML::FileMouth"
	   specializes "LaTeXML::Mouth" to tokenize from a file.

       "LaTeXML::StyleMouth"
	   further specializes "LaTeXML::FileMouth" for processing style files, setting the catcode for "@" and ignoring comments.

       "LaTeXML::PerlMouth"
	   is not really a Mouth in the above sense, but is used to definitions from perl modules with exensions ".ltxml" and ".latexml".

   Creating Mouths
       "$mouth = LaTeXML::Mouth->new($string);"
	   Creates a new Mouth reading from $string.

       "$mouth = LaTeXML::FileMouth->new($pathname);"
	   Creates a new FileMouth to read from the given file.

       "$mouth = LaTeXML::StyleMouth->new($pathname);"
	   Creates a new StyleMouth to read from the given style file.

   Methods
       "$token = $mouth->readToken;"
	   Returns the next LaTeXML::Token from the source.

       "$boole = $mouth->hasMoreInput;"
	   Returns whether there is more data to read.

       "$string = $mouth->getLocator($long);"
	   Return a description of current position in the source, for reporting errors.

       "$tokens = $mouth->readTokens($until);"
	   Reads tokens until one matches $until (comparing the character, but not catcode).  This is useful for the "verb" command.

       "$lines = $mouth->readRawLines($endline,$exact);"
	   Reads raw (untokenized) lines from $mouth until a line matching $endline is found.  If $exact is true, $endline is matched exactly,
	   with no leading or trailing data (like in the c<comment> package).  Otherwise, the match is done like with the c<verbatim> environment;
	   any text preceding $endline is returned as the last line, and any characters after $endline remains in the mouth to be tokenized.

AUTHOR

       Bruce Miller <bruce.miller@nist.gov>

COPYRIGHT

       Public domain software, produced as part of work done by the United States Government & not subject to copyright in the US.

perl v5.10.1							    2009-06-11						       LaTeXML::Mouth(3pm)

LaTeXML::Parameters(3pm)				User Contributed Perl Documentation				  LaTeXML::Parameters(3pm)

NAME

       "LaTeXML::Parameters" - formal parameters, including "LaTeXML::Parameter".

DESCRIPTION

       Provides a representation for the formal parameters of LaTeXML::Definitions:

       "LaTeXML::Parameter"
	   represents an individual parameter.

   Parameters Methods
       "$parameters = parseParameters($prototype,$for);"
	   Parses a string for a sequence of parameter specifications.	Each specification should be of the form

	    {}	   reads a regular TeX argument, a sequence of
		   tokens delimited by braces, or a single token.
	    {spec} reads a regular TeX argument, then reparses it
		   to match the given spec. The spec is parsed
		   recursively, but usually should correspond to
		   a single argument.
	    [spec] reads an LaTeX-style optional argument. If the
		   spec is of the form Default:stuff, then stuff
		   would be the default value.
	    Type   Reads an argument of the given type, where either
		   Type has been declared, or there exists a ReadType
		   function accessible from LaTeXML::Package::Pool.
	    Type:value, or Type:value1:value2...    These forms
		   pass additional Tokens to the reader function.
	    OptionalType  Similar to Type, but it is not considered
		   an error if the reader returns undef.
	    SkipType  Similar to OptionalType, but the value returned
		   from the reader is ignored, and does not occupy a
		   position in the arguments list.

       "@parameters = $parameters->getParameters;"
	   Return the list of "LaTeXML::Parameter" contained in $parameters.

       "@tokens = $parameters->revertArguments(@args);"
	   Return a list of LaTeXML::Token that would represent the arguments such that they can be parsed by the Gullet.

       "@args = $parameters->readArguments($gullet,$fordefn);"
	   Read the arguments according to this $parameters from the $gullet.  This takes into account any special forms of arguments, such as
	   optional, delimited, etc.

       "@args = $parameters->readArgumentsAndDigest($stomach,$fordefn);"
	   Reads and digests the arguments according to this $parameters, in sequence.	this method is used by Constructors.

AUTHOR

       Bruce Miller <bruce.miller@nist.gov>

COPYRIGHT

       Public domain software, produced as part of work done by the United States Government & not subject to copyright in the US.

perl v5.10.1							    2009-06-11						  LaTeXML::Parameters(3pm)