mmp.engine
Class Settings

java.lang.Object
  extended by mmp.engine.Settings

public class Settings
extends java.lang.Object

Settings of the MNI macro processor.

Author:
Burkhardt Renz

Nested Class Summary
static class Settings.CompatibilityLevel
          Levels of compatibility of builtin macros (MMP > GNU > POSIX).
 
Constructor Summary
Settings()
          Default constructor.
 
Method Summary
 void addToSearchPath(java.lang.String directory)
          Adds directory to the search path for includes.
 void changeComment(java.lang.String begComment, java.lang.String endComment)
          Changes the delimiters for comments.
 void changeQuote(java.lang.String begQuote, java.lang.String endQuote)
          Changes the delimiters for quoted strings.
 java.lang.String getBegComment()
          Get the string that begins a comment.
 java.lang.String getBegQuote()
          Get the string that's the beginning quote.
 java.lang.String getEndComment()
          Get the string that ends a comment.
 java.lang.String getEndQuote()
          Get the string that's the end quote.
 int getRecursionLimit()
          Get the limit for recursive calls of macros.
 java.util.List<java.lang.String> getSearchPath()
          Get list of all directories in the search path.
 java.util.logging.Handler getTraceHandler()
          Get current trace handler.
 void setDefaultComment()
          Sets the delimiters for comments to default.
 void setDefaultQuote()
          Sets the delimiters for quoted strings to default.
 void setRecursionLimit(int recursionLimit)
          Set the limit for recursion.
 void setTraceHandler(java.util.logging.Handler traceHandler)
          Set handler as trace handler.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Settings

public Settings()
Default constructor.

Method Detail

addToSearchPath

public final void addToSearchPath(java.lang.String directory)
Adds directory to the search path for includes.

Parameters:
directory - to be searched too
Modifies:
this

changeComment

public final void changeComment(java.lang.String begComment,
                                java.lang.String endComment)
Changes the delimiters for comments.

Parameters:
begComment - the begComment to set
endComment - the endComment to set
Pre:
The delimiters should not begin with a letter in [A-Z,a-z], a digit, '_', '(', ')', or ','.
Modifies:
this

changeQuote

public final void changeQuote(java.lang.String begQuote,
                              java.lang.String endQuote)
Changes the delimiters for quoted strings.

Parameters:
begQuote - the begQuote to set
endQuote - the endQuote to set
Pre:
The delimiters should not begin with a letter in [A-Z,a-z], a digit, '_', '(', ')', or ','.
Modifies:
this

getBegComment

public final java.lang.String getBegComment()
Get the string that begins a comment.

Returns:
the begComment

getBegQuote

public final java.lang.String getBegQuote()
Get the string that's the beginning quote.

Returns:
the begQuote

getEndComment

public final java.lang.String getEndComment()
Get the string that ends a comment.

Returns:
the endComment

getEndQuote

public final java.lang.String getEndQuote()
Get the string that's the end quote.

Returns:
the endQuote

getRecursionLimit

public final int getRecursionLimit()
Get the limit for recursive calls of macros.

Returns:
the recursion limit

getSearchPath

public final java.util.List<java.lang.String> getSearchPath()
Get list of all directories in the search path.

Returns:
search path

getTraceHandler

public final java.util.logging.Handler getTraceHandler()
Get current trace handler.

Returns:
trace handler

setDefaultComment

public final void setDefaultComment()
Sets the delimiters for comments to default.

Modifies:
this

setDefaultQuote

public final void setDefaultQuote()
Sets the delimiters for quoted strings to default.

Modifies:
this

setRecursionLimit

public final void setRecursionLimit(int recursionLimit)
Set the limit for recursion.

Parameters:
recursionLimit - the limit to set
Modifies:
this

setTraceHandler

public final void setTraceHandler(java.util.logging.Handler traceHandler)
Set handler as trace handler.

Parameters:
traceHandler - to be set
Modifies:
this