Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

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

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

NAME

       "LaTeXML::Object" - abstract base class for most LaTeXML objects.

DESCRIPTION

       "LaTeXML::Object" serves as an abstract base class for all other objects (both the data objects and control objects).  It provides for
       common methods for stringification and comparison operations to simplify coding and to beautify error reporting.

   Methods
       "$string = $object->stringify;"
	   Returns a readable representation of $object, useful for debugging.

       "$string = $object->toString;"
	   Returns the string content of $object; most useful for extracting a usable string from tokens or boxes that might representing a
	   filename or such.

       "$boole = $object->equals($other);"
	   Returns whether $object and $other are equal.  Should perform a deep comparision, but the default implementation just compares for
	   object identity.

       "$boole = $object->isaToken;"
	   Returns whether $object is an LaTeXML::Token.

       "$boole = $object->isaBox;"
	   Returns whether $object is an LaTeXML::Box.

       "$boole = $object->isaDefinition;"
	   Returns whether $object is an LaTeXML::Definition.

       "$digested = $object->beDigested;"
	   Does whatever is needed to digest the object, and return the digested representation.  Tokens would be digested into boxes; Some
	   objects, such as numbers can just return themselves.

       "$object->beAbsorbed($document);"
	   Do whatever is needed to absorb the $object into the $document, typically by invoking appropriate methods on the $document.

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::Object(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