Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

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

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

NAME

       "LaTeXML::Token" - representation of a token, and "LaTeXML::Tokens", representing lists of tokens.

DESCRIPTION

       This module defines Tokens ("LaTeXML::Token", "LaTeXML::Tokens") that get created during tokenization and  expansion.

       A "LaTeXML::Token" represents a TeX token which is a pair of a character or string and a category code.	A "LaTeXML::Tokens" is a list of
       tokens (and also implements the API of a LaTeXML::Mouth so that tokens can be read from a list).

   Common methods
       The following methods apply to all objects.

       "@tokens = $object->unlist;"
	   Return a list of the tokens making up this $object.

       "$string = $object->toString;"
	   Return a string representing $object.

   Token methods
       The following methods are specific to "LaTeXML::Token".

       "$string = $token->getCSName;"
	   Return the string or character part of the $token; for the special category codes, returns the standard string (eg.
	   "T_BEGIN-"getCSName> returns "{").

       "$string = $token->getString;"
	   Return the string or character part of the $token.

       "$code = $token->getCharcode;"
	   Return the character code of the character part of the $token, or 256 if it is a control sequence.

       "$code = $token->getCatcode;"
	   Return the catcode of the $token.

   Tokens methods
       The following methods are specific to "LaTeXML::Tokens".

       "$tokenscopy = $tokens->clone;"
	   Return a shallow copy of the $tokens.  This is useful before reading from a "LaTeXML::Tokens".

       "$token = $tokens->readToken;"
	   Returns (and remove) the next token from $tokens.  This is part of the public API of LaTeXML::Mouth so that a "LaTeXML::Tokens" can
	   serve as a LaTeXML::Mouth.

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::Token(3pm)

Check Out this Related Man Page

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

NAME

       "LaTeXML::Error" - Internal Error reporting code.

DESCRIPTION

       "LaTeXML::Error" does some simple stack analysis to generate more informative, readable, error messages for LaTeXML.  Its routines are used
       by the error reporting methods from LaTeXML::Global, namely "Warn", "Error" and "Fatal".

       No user serviceable parts inside.  No symbols are exported.

   Functions
       "$string = LaTeXML::Error::generateMessage($typ,$msg,$lng,@more);"
	   Constructs an error or warning message based on the current stack and the current location in the document.	$typ is a short string
	   characterizing the type of message, such as "Error".  $msg is the error message itself. If $lng is true, will generate a more verbose
	   message; this also uses the VERBOSITY set in the $STATE.  Longer messages will show a trace of the objects invoked on the stack, @more
	   are additional strings to include in the message.

       "$string = LaTeXML::Error::stacktrace;"
	   Return a formatted string showing a trace of the stackframes up until this function was invoked.

       "@objects = LaTeXML::Error::objectStack;"
	   Return a list of objects invoked on the stack.  This procedure only considers those stackframes which involve methods, and the objects
	   are those (unique) objects that the method was called on.

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::Error(3pm)
Man Page