§ 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.

$line = LaTeXML::Error:line_in_file($file);

This returns the line number in $file that is currently being executed, assuming that some stackframe is invoking code defined in that file.