Overview
Package
Class
Use
Tree
Index
Help
PREV NEXT
FRAMES
NO FRAMES
All Classes
A
C
D
E
F
G
I
M
N
O
P
R
S
T
U
V
W
A
addToSearchPath(String)
- Method in class mmp.engine.
Settings
Adds directory to the search path for includes.
addWrapupSource(Reader)
- Method in class mmp.engine.
Input
Adds the reader 'source' to the wrapupQueue, to be processed at the end of input.
C
call(List<String>, EngineContext)
- Method in class mmp.engine.
Macro
Calls the macro with the argument 'macArg' in the 'engineContext'.
call(List<String>, EngineContext)
- Method in class mmp.engine.
UserMacro
changeComment(String, String)
- Method in class mmp.engine.
Settings
Changes the delimiters for comments.
changeQuote(String, String)
- Method in class mmp.engine.
Settings
Changes the delimiters for quoted strings.
CharType
- Class in
mmp.util
Utility functions for ISO characters.
CharType()
- Constructor for class mmp.util.
CharType
close()
- Method in class mmp.engine.
Output
Closes the output and flushes all diversions to the writer with divnum '0'.
D
define(String, String)
- Method in class mmp.engine.
Engine
define(String, String)
- Method in interface mmp.engine.
EngineContext
Defines macro named 'macroName' to expand to 'expansion'.
divert(int)
- Method in class mmp.engine.
Output
Sets the current writer to the string writer with diversion number 'divnum'.
E
Engine
- Class in
mmp.engine
The MNI macro processor engine.
Engine(Reader, Writer)
- Constructor for class mmp.engine.
Engine
Constructs the MMP engine with default compatibility level.
Engine(Reader, Writer, Settings.CompatibilityLevel)
- Constructor for class mmp.engine.
Engine
Constructs the MMP engine.
EngineContext
- Interface in
mmp.engine
The interface EngineContext gives macro objects access to the engine.
exit()
- Method in class mmp.engine.
Output
Closes the output without flushing the diversions.
F
format(LogRecord)
- Method in class mmp.util.
MySimpleFormatter
format(LogRecord)
- Method in class mmp.util.
TraceFormatter
G
getBegComment()
- Method in class mmp.engine.
Settings
Get the string that begins a comment.
getBegQuote()
- Method in class mmp.engine.
Settings
Get the string that's the beginning quote.
getBuiltin(String)
- Method in class mmp.engine.
MacroRegistry
Gets the builtin macro named 'name', even if it has been undefined.
getCurrentDivnum()
- Method in class mmp.engine.
Output
Get the number of current diversion.
getEndComment()
- Method in class mmp.engine.
Settings
Get the string that ends a comment.
getEndQuote()
- Method in class mmp.engine.
Settings
Get the string that's the end quote.
getExitCode()
- Method in exception mmp.engine.
M4ExitException
Get exit code.
getExpansion()
- Method in class mmp.engine.
UserMacro
Get the expansion of the macro.
getInput()
- Method in class mmp.engine.
Engine
getInput()
- Method in interface mmp.engine.
EngineContext
Get input of macro processor.
getInstInfo()
- Method in class mmp.engine.
Macro
Provides instantiation info for a Java macro.
getInstInfo()
- Method in class mmp.engine.
UserMacro
getMacro(String)
- Method in class mmp.engine.
MacroRegistry
Get macro named 'name'.
getMacroNames()
- Method in class mmp.engine.
MacroRegistry
Get the set of all names of currently defined macros.
getMacroRegistry()
- Method in class mmp.engine.
Engine
getMacroRegistry()
- Method in interface mmp.engine.
EngineContext
Get macro registry of macro processor.
getName()
- Method in class mmp.engine.
UserMacro
Get the name of the user defined macro.
getOutput()
- Method in class mmp.engine.
Engine
getOutput()
- Method in interface mmp.engine.
EngineContext
Get output of macro processor.
getRecursionLevel()
- Method in class mmp.engine.
Engine
getRecursionLevel()
- Method in interface mmp.engine.
EngineContext
Get current recursion level of expansion of macro.
getRecursionLimit()
- Method in class mmp.engine.
Settings
Get the limit for recursive calls of macros.
getSearchPath()
- Method in class mmp.engine.
Settings
Get list of all directories in the search path.
getSettings()
- Method in class mmp.engine.
Engine
getSettings()
- Method in interface mmp.engine.
EngineContext
Get settings of macro processor.
getTraceHandler()
- Method in class mmp.engine.
Settings
Get current trace handler.
I
Input
- Class in
mmp.engine
Input is responsible for the management of the input sources of mmp.
Input(Reader)
- Constructor for class mmp.engine.
Input
Constructor, that initializes the Input with a Reader source.
isDelimiter(String)
- Static method in class mmp.util.
CharType
Is the string allowed as a delimiter string?
isDelimiterFirstChar(char)
- Static method in class mmp.util.
CharType
Is character ch allowed as first character of a delimiter?
isDigit(char)
- Static method in class mmp.util.
CharType
Does character ch match [0-9] ?.
isIdentifierChar(char)
- Static method in class mmp.util.
CharType
Is character ch
isIdentifierFirstChar(char)
||
isDigit(char)
?
isIdentifierFirstChar(char)
- Static method in class mmp.util.
CharType
Does character ch match [a-z]||[A-Z]||'_' ?.
M
M4ExitException
- Exception in
mmp.engine
Exception that causes exit of mmp, used by 'm4exit'
M4ExitException(int)
- Constructor for exception mmp.engine.
M4ExitException
Constructor.
M4ExitException(int, String)
- Constructor for exception mmp.engine.
M4ExitException
Constructor.
Macro
- Class in
mmp.engine
Abstract class that must be extended by the provider of a Java macro.
Macro(boolean)
- Constructor for class mmp.engine.
Macro
Constructor for a user defined Java macro.
MacroRegistry
- Class in
mmp.engine
The macroRegistry holds stacks of macros identified by name.
MacroRegistry()
- Constructor for class mmp.engine.
MacroRegistry
main(String[])
- Static method in class mmp.cli.
mmp
usage: mmp <filename>.
matches(String)
- Method in class mmp.engine.
Input
The method checks whether the input matches string.
mmp
- Class in
mmp.cli
mmp's command line interface.
mmp()
- Constructor for class mmp.cli.
mmp
Constructor.
mmp.cli
- package mmp.cli
Provides the command line interface to the MNI macro processor mmp.
mmp.engine
- package mmp.engine
Provides the engine of the MNI macro processor mmp.
mmp.util
- package mmp.util
Provides utility classes for the MNI macro processor mmp.
MySimpleFormatter
- Class in
mmp.util
A very simple formatter for Java logging.
MySimpleFormatter()
- Constructor for class mmp.util.
MySimpleFormatter
N
needsParenthesis()
- Method in class mmp.engine.
Macro
Macro needs parenthesis to be recognized as a macro.
O
Output
- Class in
mmp.engine
Output manages the diversions.
Output(Writer)
- Constructor for class mmp.engine.
Output
Initializes the output to the given writer.
P
peekChar()
- Method in class mmp.engine.
Input
Lookahead of one character in the Input.
popMacro(String)
- Method in class mmp.engine.
MacroRegistry
The macro named 'name' is popped from the stack of macros.
pushInputSource(Reader)
- Method in class mmp.engine.
Input
Pushes the reader 'source' on the inputStack.
pushMacro(String, Macro)
- Method in class mmp.engine.
MacroRegistry
Pushes macro object on the top of an already defined macro with the same name.
R
readChar()
- Method in class mmp.engine.
Input
Reads a single character from Input.
register(String, Macro)
- Method in class mmp.engine.
Engine
register(String, Macro)
- Method in interface mmp.engine.
EngineContext
Registers the macro object 'macro' under the name 'macroName'.
registerMacro(String, Macro)
- Method in class mmp.engine.
MacroRegistry
Register macro object as macro 'name'.
run()
- Method in class mmp.engine.
Engine
Runs the MMP engine.
RuntimeErrorException
- Exception in
mmp.engine
Exception for runtime errors during execution of the mmp engine.
RuntimeErrorException(int, String)
- Constructor for exception mmp.engine.
RuntimeErrorException
Constructor.
S
setDefaultComment()
- Method in class mmp.engine.
Settings
Sets the delimiters for comments to default.
setDefaultQuote()
- Method in class mmp.engine.
Settings
Sets the delimiters for quoted strings to default.
setRecursionLimit(int)
- Method in class mmp.engine.
Settings
Set the limit for recursion.
Settings
- Class in
mmp.engine
Settings of the MNI macro processor.
Settings()
- Constructor for class mmp.engine.
Settings
Default constructor
Settings.CompatibilityLevel
- Enum in
mmp.engine
Levels of compatibility of builtin macros MMP > GNU > POSIX
setTraceHandler(Handler)
- Method in class mmp.engine.
Engine
setTraceHandler(Handler)
- Method in interface mmp.engine.
EngineContext
mmp uses the Java logging mechanism for tracing.
setTraceHandler(Handler)
- Method in class mmp.engine.
Settings
Set handler as trace handler.
setTraceOn(String)
- Method in class mmp.engine.
Engine
setTraceOn(String)
- Method in interface mmp.engine.
EngineContext
Turn tracing of macro 'macroName' on.
SyntaxErrorException
- Exception in
mmp.engine
Exception for syntax errors in input.
SyntaxErrorException(int, String)
- Constructor for exception mmp.engine.
SyntaxErrorException
Constructor.
T
TraceFormatter
- Class in
mmp.util
A formatter for tracing in mmp.
TraceFormatter()
- Constructor for class mmp.util.
TraceFormatter
U
undivert(int)
- Method in class mmp.engine.
Output
Writes the content of diversion 'divnum' to the current writer and discards the diversion.
undivert()
- Method in class mmp.engine.
Output
Undiverts all diversions in numerical order into the current diversion.
unregisterMacro(String)
- Method in class mmp.engine.
MacroRegistry
The macro named 'name' is unregistered.
UserMacro
- Class in
mmp.engine
Implementation of user defined macros.
UserMacro(String, String)
- Constructor for class mmp.engine.
UserMacro
Creates user defined macro with name 'name' that expands to 'expansion'.
V
valueOf(String)
- Static method in enum mmp.engine.
Settings.CompatibilityLevel
Returns the enum constant of this type with the specified name.
values()
- Static method in enum mmp.engine.
Settings.CompatibilityLevel
Returns an array containing the constants of this enum type, in the order they are declared.
W
write(String)
- Method in class mmp.engine.
Output
Write string to current writer.
write(int)
- Method in class mmp.engine.
Output
Write single char to current writer.
A
C
D
E
F
G
I
M
N
O
P
R
S
T
U
V
W
Overview
Package
Class
Use
Tree
Index
Help
PREV NEXT
FRAMES
NO FRAMES
All Classes