Documentation System Integration for Advtrains

• Index

Contents

• Functions

Modules

• advtrains_doc_integration.bc
• advtrains_doc_integration.describe
• advtrains_doc_integration.hypertext
• advtrains_doc_integration
• advtrains_doc_integration.latex
• advtrains_doc_integration.mathutils
• advtrains_doc_integration.utils

Topics

• README

Module advtrains_doc_integration.bc

Bytecode parsing.

Please note that this module is experimental and subject to change.

Functions

is_enabled ()	Check whether bytecode parsing is enabled.
parse (dump)	Try to parse a bytecode dump.
tostring (dump)	Try to format a bytecode dump.

Functions

is_enabled ()

Check whether bytecode parsing is enabled.

Returns:

bool Whether bytecode parsing is enabled.

parse (dump)

Try to parse a bytecode dump.

Parameters:

• dump string or function The bytecode input or the function to read.

Returns:

1. "luajit" If dump is valid LuaJIT bytecode.
2. ... Data parsed from the bytecode.

Or

1. nil If the dump cannot be parsed.
2. string A message indicating the error.

tostring (dump)

Try to format a bytecode dump.

Parameters:

• dump string or function The bytecode input of the function to read.

Returns:

1. "luajit" If dump is valid LuaJIT bytecode.
2. string A string describing the bytecode dump. The format is similar to that of luajit -bl

Or

1. nil If the dump cannot be parsed.
2. string A message indicating the error.