org.vishia.jztxtcmd

Class JZtxtcmd

java.lang.Object

org.vishia.jztxtcmd.JZtxtcmd

All Implemented Interfaces:

javax.script.Compilable, javax.script.ScriptEngine, JZtxtcmdEngine

Direct Known Subclasses:

JZcmd

public class JZtxtcmd
extends java.lang.Object
implements JZtxtcmdEngine, javax.script.Compilable

This is the Script executer and text generator started form command line. The simplest form is:

 java path/to/zbnf.jar org.vishia.zcmd.JZcmd path/to/scriptFile
 

This class contains the translator which uses the ZBNF parser. The core executer is JZtxtcmdExecuter. The translated script is stored in an instance of JZtxtcmdScript which are both parts of the component srcJava_vishiaBase.
Execution from command line or from Java with String[]-args:

main(String[]) is the command line start. Arguments: smain(String[]) is the same as main(String[]) but without exit the VM. It can be used to invoke main from inside another Java program.

Execution in a java context

There are some differenz possibilities. The motivation to execute a part of a algorithm in a JZcmd script instead in Java pure may be:

• Text generation: The text is better able to write in the script form.
• Flexibility in application: It does not need to write or change Java source code for any changes
• It is possible to create data in the script and use it in Java after invocation.
• It is possible to output data in the script which are prepared in java before, especially for code generation.
• It is possible to prepare and complete data in the script.

The translation of the script without immediate execution can be done calling one of the static routine.

• translateAndSetGenCtrl(File, LogMessage): simplest form with a file as input
• translateAndSetGenCtrl(String, LogMessage): The script is given as String
• translateAndSetGenCtrl(StringPartScan, LogMessage, File, File): This is the core routine.

To execute a compiled script see JZtxtcmdExecuter.

This class contains 'execute' routines only for textual given scripts, in different variants:

• Simple execution with own JZcmdExecuter, without special data exchange. But inside the script static Java data can be used:
  • execute(String): for simple algorithms given as String, for example text preparation.
  • execute(File, LogMessage): translate and execute a given script.
• Execution with a given JZcmdExecuter instance:
  • execute(JZtxtcmdExecuter, File, Appendable, String, boolean, File, LogMessage): It reuses a given instance of JZcmdExecuter.

If the script is already compiled and stored in JZtxtcmdScript and an execution environment JZtxtcmdExecuter is established, one can invoke a subroutine of the script with JZtxtcmdExecuter.execSub(org.vishia.cmd.JZtxtcmdScript.Subroutine, Map, boolean, Appendable, File) or run the main routine of the script with JZtxtcmdExecuter.execute(JZtxtcmdScript, boolean, boolean, Appendable, String). See there.

This class is only necessary if a script is still to compile. Note that from a compiled script the routine JZtxtcmdScript.getEngine(), defined in CompiledScript.getEngine() returns this instance if the JZcmdScript was created with this.

• execute(File, org.vishia.cmd.JZtxtcmdExecuter.ExecuteLevel) compiles and executes a script given with file, whereby the given ExecuteLevel is used
• execSub(File, String, Map, org.vishia.cmd.JZtxtcmdExecuter.ExecuteLevel)

Execution with the ScriptEngine interface
That feature is not ready and not tested yet.

Exceptionhandling
On any exception outside main a ScriptException is thrown. That exception should be caught by the caller. The ScriptException contains

• an error text with the file, line and column if the error can be associated of a file-line,
• or an error text and the file name on file error, especially file not found.
• or an wrapped exception if any other usual unexpected exception was thrown.

The main routine writes a line or more as one line in the LogMessage#writeError(String) if the exception has a file info. Unexpected Exceptions were written with LogMessage.writeError(String, Throwable) with the unwrapped inner exception. That exceptions should be shown in detail.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	JZtxtcmd.Args
private static class	JZtxtcmd.CmdLine The organization class for command line invocation.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) LogMessage	log
(package private) ZbnfParser	parserGenCtrl The parser knows the correct syntax already.
static java.lang.String	version Version, history and license.

Fields inherited from interface org.vishia.cmd.JZtxtcmdEngine

sVersion

Fields inherited from interface javax.script.ScriptEngine

ARGV, ENGINE, ENGINE_VERSION, FILENAME, LANGUAGE, LANGUAGE_VERSION, NAME

Constructor Summary

Constructors

Constructor and Description
JZtxtcmd() Instantiates.
JZtxtcmd(LogMessage log) Instantiates with maybe given MainCmd logging.

Method Summary

Modifier and Type	Method and Description
JZtxtcmdScript	compile(java.io.File fileGenCtrl, java.io.File checkXmlOut)
javax.script.CompiledScript	compile(java.io.Reader script) JSR-223-conform method to compile.
javax.script.CompiledScript	compile(java.lang.String script) JSR-223-conform method to compile.
private JZtxtcmdScript	compile(StringPartScan sourceScript, java.io.File checkXmlOutput, java.io.File fileScript) Deprecated.
javax.script.Bindings	createBindings()
java.lang.Object	eval(java.io.Reader reader)
java.lang.Object	eval(java.io.Reader reader, javax.script.Bindings n)
java.lang.Object	eval(java.io.Reader reader, javax.script.ScriptContext context)
java.lang.Object	eval(java.lang.String script)
java.lang.Object	eval(java.lang.String script, javax.script.Bindings n)
java.lang.Object	eval(java.lang.String script, javax.script.ScriptContext context)
java.lang.Object	evalSub(java.io.File fileScript, java.lang.String subroutine, java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> args, JZtxtcmdExecuter.ExecuteLevel execLevel) Executes a sub routine in a special script, but uses a given execution environment.
static java.lang.CharSequence	execSub(java.io.File fileScript, java.lang.String subroutine, java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> args, JZtxtcmdExecuter.ExecuteLevel execLevel) Executes a sub routine in a special script, but uses a given execution environment.
static java.lang.CharSequence	execSub(java.io.File fileScript, java.lang.String subroutine, java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> args, JZtxtcmdExecuter.ExecuteLevel execLevel, java.lang.Appendable output) Executes a sub routine in a special script, but uses a given execution environment.
static java.lang.CharSequence	execute(java.io.File script, JZtxtcmdExecuter.ExecuteLevel execLevel) Parses the script and executes it in an own environment but with usage of the given local variables, the current directory and the log of a given JZcmd ExecuterLevel.
static void	execute(java.io.File script, LogMessage log) Executes a JZcmd script.
static void	execute(JZtxtcmdExecuter executer, java.io.File fileScript, java.lang.Appendable out, java.util.List<DataAccess.Variable<java.lang.Object>> data, java.lang.String sCurrdir, boolean accessPrivate, java.io.File testOut, LogMessage log) Translates and executes a JZcmd script.
static void	execute(JZtxtcmdExecuter executer, java.io.File fileScript, java.lang.Appendable out, java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> data, java.lang.String sCurrdir, boolean accessPrivate, java.io.File testOut, LogMessage log) Translates and executes a JZcmd script.
static void	execute(JZtxtcmdExecuter executer, java.io.File fileScript, java.lang.Appendable out, java.lang.String sCurrdir, boolean accessPrivate, java.io.File testOut, LogMessage log) Translates and executes a JZcmd script.
static void	execute(JZtxtcmdExecuter executer, java.io.File fileScript, StringPartScan script, java.lang.Appendable out, java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> data, java.lang.String sCurrdir, boolean accessPrivate, java.io.File testOut, LogMessage log) Executes a textual given script in a existing instance of a JZtxtcmdExecuter.
static void	execute(java.lang.String script) Executes a JZcmd script.
java.lang.Object	get(java.lang.String key)
javax.script.Bindings	getBindings(int scope)
javax.script.ScriptContext	getContext()
javax.script.ScriptEngineFactory	getFactory()
static void	main(java.lang.String[] sArgs) main started from java command line.
void	put(java.lang.String key, java.lang.Object value)
static java.lang.String	readJZcmdCfg(JZtxtcmdScript.AddSub2List dst, java.io.File jzScriptFile, LogMessage log, CmdExecuter execToInit) Reads a scriptfile and stores the subroutines, nested in classes too, to the given CmdStore.
void	setBindings(javax.script.Bindings bindings, int scope)
void	setContext(javax.script.ScriptContext context)
static int	smain(java.lang.String[] sArgs) Invocation from another java program without exit the JVM
static JZtxtcmdScript	translateAndSetGenCtrl(java.io.File fileGenCtrl, java.io.File checkXmlOut, LogMessage log)
static JZtxtcmdScript	translateAndSetGenCtrl(java.io.File fileScript, LogMessage log) Translates a script into its internal form.
static JZtxtcmdScript	translateAndSetGenCtrl(java.lang.String sourceScript, LogMessage log)
static JZtxtcmdScript	translateAndSetGenCtrl(StringPartScan sourceScript, LogMessage log) Translates with a new Parser and the given script in text format.
static JZtxtcmdScript	translateAndSetGenCtrl(StringPartScan sourceScript, LogMessage log, java.io.File checkXmlOutput, java.io.File fileScript) Deprecated. this routine is given in JZtxtcmdScript.createScriptFromString(StringPartScan, LogMessage, File, File)
static JZtxtcmdScript	translateScriptFromJar(java.lang.Class<?> clazz, java.lang.String pathInJarFromClazz, java.io.File checkXmlOut, LogMessage log)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

version

public static final java.lang.String version

Version, history and license.

• 2023-08-12 Hartmut now ctor JZtxtcmd(LogMessage) is specific exception free. The exception was nevertheless not expected because the used syntax does not depend from user. If there is really an error, an IllegalArgumentException is thrown.
• 2021-12-30 Hartmut cleanup, some deprecated removed. Because of change in JZtxtcmdScript.createScriptFromString(StringPartScan, LogMessage, File, File) for includes, not twice refactored. Better remove old stuff.
• 2021-12-30 Hartmut Enhancement: execute(JZtxtcmdExecuter, File, StringPartScan, Appendable, Map, String, boolean, File, LogMessage): Uses now JZtxtcmdScript.createScriptFromString(StringPartScan, LogMessage, File, File) instead the deprecated #translateAndSetGenCtrl(StringPartScan, org.vishia.cmd.JZtxtcmdScript.ZbnfJZcmdScript, File, File). Same for compile(StringPartScan, File, File). With changes there it is possible to read an include script from an operation, which is hence stored in the jar file. Syntay is: include %<#?backlevel>:pkg.path.Class.operation(). The backlevel is to built a reference current directory for further includes. It should be relative in the same working tree, usual on the root of a working tree.
• 2020-02-02 Hartmut new translateScriptFromJar(Class, String, File, LogMessage)
• 2019-02-20 Hartmut chg execSub(File, String, Map, org.vishia.cmd.JZtxtcmdExecuter.ExecuteLevel, Appendable) with Appendable as argument. The old form without this argument is available too.
• 2017-01-01 Hartmut chg adaption to JZtxtcmdExecuter- Now execute(JZtxtcmdExecuter, File, Appendable, List, String, boolean, File, LogMessage) with List-given additional variables are available. Note that JZtxtcmdExecuter.setScriptVariable(String, char, Object, boolean) is deprecated now.
• 2017-01-01 Hartmut new readJZcmdCfg(org.vishia.cmd.JZtxtcmdScript.AddSub2List, File, LogMessage, CmdExecuter)
• 2014-08-10 Hartmut bugfix: Now translateAndSetGenCtrl(File, File, LogMessage) : close() will be invoked.
• 2014-08-10 Hartmut new: message "JZcmd - cannot create output text file" with the output file path.
• 2014-08-10 Hartmut new: !checkXmlFile = filename;
• 2014-06-10 Hartmut chg: improved Exception handling of the script.
• 2014-05-18 Hartmut new: try to implement javax.script interfaces, not ready yet
• 2014-02-16 Hartmut new: #jbatch(File, org.vishia.cmd.JZtxtcmdExecuter.ExecuteLevel) is deprecated now, instead execSub(File, String, Map, org.vishia.cmd.JZtxtcmdExecuter.ExecuteLevel) used. The difference: No scriptlevel created for the new compiled script, with given scriptlevel the subroutine is executed.
• 2014-02-16 Hartmut chg: execute(... String sCurrdir) now with current directory from outside. translateAndSetGenCtrl( File fileScript, ...) with the script file. Argument -currdir=PATH for command line invocation main(String[]) Build of script variable currdir, scriptfile, scriptdir with them in JZtxtcmdExecuter#initialize(JZtxtcmdScript, boolean, Map, String, boolean).
• 2013-10-27 Hartmut chg: #jbatch(String, org.vishia.cmd.JZtxtcmdExecuter.ExecuteLevel)
• 2012-10-03 created. Backgorund was the org.vishia.zmake.Zmake generator, but that is special for make problems. A generator which converts ZBNF-parsed data from an Java data context to output texts in several form, documenation, C-sources was need.

Copyright/Copyleft: For this source the LGPL Lesser General Public License, published by the Free Software Foundation is valid. It means:

1. You can use this source without any restriction for any desired purpose.
2. You can redistribute copies of this source to everybody.
3. Every user of this source, also the user of redistribute copies with or without payment, must accept this license for further using.
4. But the LPGL is not appropriate for a whole software product, if this source is only a part of them. It means, the user must publish this part of source, but don't need to publish the whole source of the own product.
5. You can study and modify (improve) this source for own using or for redistribution, but you have to license the modified sources likewise under this LGPL Lesser General Public License. You mustn't delete this Copyright/Copyleft inscription in this source file.

If you are intent to use this sources without publishing its usage, you can get a second license subscribing a special contract with the author.

See Also:

Constant Field Values

parserGenCtrl

final ZbnfParser parserGenCtrl

The parser knows the correct syntax already. One should use JZtxtcmdSyntax.syntax to set ZbnfParser#setSyntax(String). One should use an abbreviating syntax for experience.

log

final LogMessage log

Constructor Detail

JZtxtcmd

public JZtxtcmd()

Instantiates. The console output of the parser will be send to System.out. It invokes #JZcmd(LogMessage) with null as argument.

Throws:

javax.script.ScriptException

JZtxtcmd

public JZtxtcmd(LogMessage log)

Instantiates with maybe given MainCmd logging.

Parameters:

log - if null then the MainCmdLoggingStream is used with System.out.

Throws:

java.lang.IllegalArgumentException - only if the internal syntax has a problem.

Method Detail

main

public static void main(java.lang.String[] sArgs)

main started from java command line.

INPUT          pathTo JZcmd-File to execute
-t:OUTEXT      pathTo text-File for output
-debug:TEST.xml pathTo XML output of parsed script
-u:userArgs
--help         show the help for command line and the syntax
--currdir=PATH Set the currdir variable.
 

smain

public static int smain(java.lang.String[] sArgs)
                 throws javax.script.ScriptException

Invocation from another java program without exit the JVM

Parameters:

sArgs - same like main(String[])

Returns:

the exit level 0 - successful 1..6 see LogMessage#exitWithArgumentError etc.

Throws:

javax.script.ScriptException

execute

public static java.lang.CharSequence execute(java.io.File script,
                                             JZtxtcmdExecuter.ExecuteLevel execLevel)
                                      throws java.lang.IllegalAccessException

Parses the script and executes it in an own environment but with usage of the given local variables, the current directory and the log of a given JZcmd ExecuterLevel. That is the possibility to start a independent JZcmd execution in a JZcmd script itself.

Parameters:

script - Path to the script.

execLevel - subroutine level where this is called. All variables of this level are used as script variables for the script to execute. Especially the currdir of the level is used as script level currdir

Returns:

The text which are created in the script using <:>text<.>

Throws:

java.lang.IllegalAccessException

execSub

public static java.lang.CharSequence execSub(java.io.File fileScript,
                                             java.lang.String subroutine,
                                             java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> args,
                                             JZtxtcmdExecuter.ExecuteLevel execLevel,
                                             java.lang.Appendable output)

Executes a sub routine in a special script, but uses a given execution environment. The script level of the special script is not used. The script variables are taken from the existing level. It means the script should only contain some subroutine codes. This routine can be called inside another script with invocation:

 { ## any JZcmd script
     Map args;
     String args.name  = value;
     java org.vishia.zcmd.JZcmd.execSub(File:"path/JZcmdscript.jzcmd", "class.subroutine-Name", args, jzcmdsub);
 }
 

Parameters:

fileScript - The file which contains the script

subroutine - name of the subroutine in the script.

args - Arguments for this subroutine.

execLevel - Execution level where this routine from where it is called.

Returns:

execSub

public static java.lang.CharSequence execSub(java.io.File fileScript,
                                             java.lang.String subroutine,
                                             java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> args,
                                             JZtxtcmdExecuter.ExecuteLevel execLevel)

Executes a sub routine in a special script, but uses a given execution environment. The script level of the special script is not used. The script variables are taken from the existing level. It means the script should only contain some subroutine codes. This routine can be called inside another script with invocation:

 { ## any JZcmd script
     Map args;
     String args.name  = value;
     java org.vishia.zcmd.JZcmd.execSub(File:"path/JZcmdscript.jzcmd", "class.subroutine-Name", args, jzcmdsub);
 }
 

Parameters:

fileScript - The file which contains the script

subroutine - name of the subroutine in the script.

args - Arguments for this subroutine.

execLevel - Execution level where this routine from where it is called.

Returns:

evalSub

public java.lang.Object evalSub(java.io.File fileScript,
                                java.lang.String subroutine,
                                java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> args,
                                JZtxtcmdExecuter.ExecuteLevel execLevel)
                         throws javax.script.ScriptException

Executes a sub routine in a special script, but uses a given execution environment. The script level of the special script is not used. The script variables are taken from the existing level. It means the script should only contain some subroutine codes. This routine can be called inside another script with invocation:

 { ## any JZcmd script
     Map args;
     String args.name  = value;
     java org.vishia.zcmd.JZcmd.execSub(File:"path/JZcmdscript.jzcmd", "class.subroutine-Name", args, jzcmdsub);
 }
 

Specified by:

evalSub in interface JZtxtcmdEngine

Parameters:

fileScript - The file which contains the script

subroutine - name of the subroutine in the script.

args - Arguments for this subroutine.

execLevel - Execution level where this routine from where it is called.

Returns:

Throws:

javax.script.ScriptException

execute

public static void execute(java.lang.String script)
                    throws javax.script.ScriptException

Executes a JZcmd script. A log output using the console script variable is written to System.out.

Parameters:

script - the script in ASCII-format, syntax see JZtxtcmdSyntax

Throws:

javax.script.ScriptException

execute

public static void execute(java.io.File script,
                           LogMessage log)
                    throws javax.script.ScriptException

Executes a JZcmd script.

Parameters:

script - the script in ASCII-format, syntax see JZtxtcmdSyntax

log - A given log output

Throws:

javax.script.ScriptException

execute

public static void execute(JZtxtcmdExecuter executer,
                           java.io.File fileScript,
                           java.lang.Appendable out,
                           java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> data,
                           java.lang.String sCurrdir,
                           boolean accessPrivate,
                           java.io.File testOut,
                           LogMessage log)
                    throws javax.script.ScriptException

Translates and executes a JZcmd script.

Parameters:

executer - A given instance of the executer.

fileScript - the script in ASCII-format, syntax see JZtxtcmdSyntax

out - Output channel for <+text>...<.+>

sCurrdir - The start value for currdir

accessPrivate - if true then private data are accessed too. The accessing of private data may be helpfull for debugging. It is not recommended for general purpose! The access mechanism is given with AccessibleObject.setAccessible(boolean).

testOut - if not null then outputs a data tree of the generate script.

log - A given log output

Throws:

javax.script.ScriptException

execute

public static void execute(JZtxtcmdExecuter executer,
                           java.io.File fileScript,
                           java.lang.Appendable out,
                           java.util.List<DataAccess.Variable<java.lang.Object>> data,
                           java.lang.String sCurrdir,
                           boolean accessPrivate,
                           java.io.File testOut,
                           LogMessage log)
                    throws javax.script.ScriptException

Translates and executes a JZcmd script.

Parameters:

executer - A given instance of the executer.

fileScript - the script in ASCII-format, syntax see JZtxtcmdSyntax

out - Output channel for <+text>...<.+>

sCurrdir - The start value for currdir

accessPrivate - if true then private data are accessed too. The accessing of private data may be helpfull for debugging. It is not recommended for general purpose! The access mechanism is given with AccessibleObject.setAccessible(boolean).

testOut - if not null then outputs a data tree of the generate script.

log - A given log output

Throws:

javax.script.ScriptException

execute

public static void execute(JZtxtcmdExecuter executer,
                           java.io.File fileScript,
                           java.lang.Appendable out,
                           java.lang.String sCurrdir,
                           boolean accessPrivate,
                           java.io.File testOut,
                           LogMessage log)
                    throws javax.script.ScriptException

Translates and executes a JZcmd script.

Parameters:

executer - A given instance of the executer.

fileScript - the script in ASCII-format, syntax see JZtxtcmdSyntax

out - Output channel for <+text>...<.+>

sCurrdir - The start value for currdir

accessPrivate - if true then private data are accessed too. The accessing of private data may be helpfull for debugging. It is not recommended for general purpose! The access mechanism is given with AccessibleObject.setAccessible(boolean).

testOut - if not null then outputs a data tree of the generate script.

log - A given log output

Throws:

javax.script.ScriptException

execute

public static void execute(JZtxtcmdExecuter executer,
                           java.io.File fileScript,
                           StringPartScan script,
                           java.lang.Appendable out,
                           java.util.Map<java.lang.String,DataAccess.Variable<java.lang.Object>> data,
                           java.lang.String sCurrdir,
                           boolean accessPrivate,
                           java.io.File testOut,
                           LogMessage log)
                    throws javax.script.ScriptException

Executes a textual given script in a existing instance of a JZtxtcmdExecuter.

Parameters:

executer -

fileScript - This file is used only as information to support the <&scriptdir>.

script - The input which contains the JZcmd script

out - output for the text

sCurrdir -

accessPrivate - if true then private data are accessed too. The accessing of private data may be helpfull for debugging. It is not recommended for general purpose! The access mechanism is given with AccessibleObject.setAccessible(boolean).

testOut - if not null then outputs a data tree of the generate script.

log -

Throws:

javax.script.ScriptException - on any non-caught exception in the script

translateAndSetGenCtrl

public static JZtxtcmdScript translateAndSetGenCtrl(java.io.File fileScript,
                                                    LogMessage log)
                                             throws javax.script.ScriptException

Translates a script into its internal form.

Parameters:

fileScript -

log -

Returns:

Throws:

javax.script.ScriptException

See Also:

, {@link #translateAndSetGenCtrl(StringPartScan, LogMessage, File, File)} , {@link #translateAndSetGenCtrl(File, File, LogMessage)}

translateAndSetGenCtrl

public static JZtxtcmdScript translateAndSetGenCtrl(java.io.File fileGenCtrl,
                                                    java.io.File checkXmlOut,
                                                    LogMessage log)
                                             throws javax.script.ScriptException

Throws:

javax.script.ScriptException

translateScriptFromJar

public static JZtxtcmdScript translateScriptFromJar(java.lang.Class<?> clazz,
                                                    java.lang.String pathInJarFromClazz,
                                                    java.io.File checkXmlOut,
                                                    LogMessage log)
                                             throws javax.script.ScriptException

Throws:

javax.script.ScriptException

compile

public JZtxtcmdScript compile(java.io.File fileGenCtrl,
                              java.io.File checkXmlOut)
                       throws javax.script.ScriptException

Throws:

javax.script.ScriptException

translateAndSetGenCtrl

public static JZtxtcmdScript translateAndSetGenCtrl(java.lang.String sourceScript,
                                                    LogMessage log)
                                             throws javax.script.ScriptException

Throws:

javax.script.ScriptException

translateAndSetGenCtrl

public static JZtxtcmdScript translateAndSetGenCtrl(StringPartScan sourceScript,
                                                    LogMessage log)
                                             throws javax.script.ScriptException

Translates with a new Parser and the given script in text format.

Parameters:

fileParent - The directory which is the anchor for included scripts. Maybe null if included scripts does not exists.

sourceScript - The script in form of StringPartScan. User new StringPartScan.StringPartScan(CharSequence) to create one with a String given syntax.

checkXmlOutput - may be null, for output the script in XML form.

log -

Returns:

Throws:

java.text.ParseException

java.lang.IllegalArgumentException

java.lang.IllegalAccessException

java.lang.InstantiationException

java.io.FileNotFoundException

java.io.IOException

javax.script.ScriptException

See Also:

#translateAndSetGenCtrl(String, LogMessage), {@link #translateAndSetGenCtrl(File, LogMessage)} , {@link #translateAndSetGenCtrl(File, File, LogMessage)}

readJZcmdCfg

public static java.lang.String readJZcmdCfg(JZtxtcmdScript.AddSub2List dst,
                                            java.io.File jzScriptFile,
                                            LogMessage log,
                                            CmdExecuter execToInit)

Reads a scriptfile and stores the subroutines, nested in classes too, to the given CmdStore. The content of the CmdStore can be presented in a choice list or commands can be selected by name later to execute there.

Parameters:

dst - The command store. Its content won't be cleared, this file is added. invoke CmdStore#clear() before.

jzScriptFile -

log -

executerToInit - The executer will be initialized with the script variables of the parsed script-

Returns:

null if successfully. Elsewhere an error text.

translateAndSetGenCtrl

@Deprecated
public static JZtxtcmdScript translateAndSetGenCtrl(StringPartScan sourceScript,
                                                                 LogMessage log,
                                                                 java.io.File checkXmlOutput,
                                                                 java.io.File fileScript)
                                                          throws javax.script.ScriptException

Deprecated. this routine is given in JZtxtcmdScript.createScriptFromString(StringPartScan, LogMessage, File, File)

Translates with a new Parser and the given script in text format.

Parameters:

fileScript - The file which has contained the script. It is used only to provide the variables 'scriptdir' and 'scriptfile' for execution. The file is not evaluated. It means, it does not need to exist.
The fileScript's parent is the directory which is the anchor for included scripts. Maybe null if included scripts are not used and the variable 'scriptfile' and 'scriptdir' are not used in the script.s

sourceScript - The content of fileScript or from any other source. This is the script source. Use new StringPartScan.StringPartScan(CharSequence) to create one with a String given syntax.

log - if null then the MainCmdLoggingStream is used with System.out.

checkXmlOutput - may be null, for output the script in XML form.

Returns:

Throws:

java.text.ParseException

java.lang.IllegalArgumentException

java.lang.IllegalAccessException

java.lang.InstantiationException

java.io.FileNotFoundException

java.io.IOException

javax.script.ScriptException

compile

@Deprecated
private JZtxtcmdScript compile(StringPartScan sourceScript,
                                            java.io.File checkXmlOutput,
                                            java.io.File fileScript)
                                     throws javax.script.ScriptException

Deprecated.

Translates with a new Parser and the given script in text format.

Parameters:

fileScript - The file which has contained the script. It is used only to provide the variables 'scriptdir' and 'scriptfile' for execution. The file is not evaluated. It means, it does not need to exist.
The fileScript's parent is the directory which is the anchor for included scripts. Maybe null if included scripts are not used and the variable 'scriptfile' and 'scriptdir' are not used in the script.s

sourceScript - The content of fileScript or from any other source. This is the script source. Use new StringPartScan.StringPartScan(CharSequence) to create one with a String given syntax.

log -

checkXmlOutput - may be null, for output the script in XML form.

Returns:

Throws:

java.text.ParseException

java.lang.IllegalArgumentException

java.lang.IllegalAccessException

java.lang.InstantiationException

java.io.FileNotFoundException

java.io.IOException

javax.script.ScriptException

compile

public javax.script.CompiledScript compile(java.lang.String script)
                                    throws javax.script.ScriptException

JSR-223-conform method to compile. This method does not support included scripts with relative path.

Specified by:

compile in interface javax.script.Compilable

Throws:

javax.script.ScriptException

See Also:

Compilable.compile(java.lang.String)

compile

public javax.script.CompiledScript compile(java.io.Reader script)
                                    throws javax.script.ScriptException

JSR-223-conform method to compile. This method does not support included scripts with relative path.

Specified by:

compile in interface javax.script.Compilable

Throws:

javax.script.ScriptException

See Also:

Compilable.compile(java.lang.String)

createBindings

public javax.script.Bindings createBindings()

Specified by:

createBindings in interface javax.script.ScriptEngine

eval

public java.lang.Object eval(java.lang.String script)
                      throws javax.script.ScriptException

Specified by:

eval in interface javax.script.ScriptEngine

Throws:

javax.script.ScriptException

eval

public java.lang.Object eval(java.io.Reader reader)
                      throws javax.script.ScriptException

Specified by:

eval in interface javax.script.ScriptEngine

Throws:

javax.script.ScriptException

eval

public java.lang.Object eval(java.lang.String script,
                             javax.script.ScriptContext context)
                      throws javax.script.ScriptException

Specified by:

eval in interface javax.script.ScriptEngine

Throws:

javax.script.ScriptException

eval

public java.lang.Object eval(java.io.Reader reader,
                             javax.script.ScriptContext context)
                      throws javax.script.ScriptException

Specified by:

eval in interface javax.script.ScriptEngine

Throws:

javax.script.ScriptException

eval

public java.lang.Object eval(java.lang.String script,
                             javax.script.Bindings n)
                      throws javax.script.ScriptException

Specified by:

eval in interface javax.script.ScriptEngine

Throws:

javax.script.ScriptException

eval

public java.lang.Object eval(java.io.Reader reader,
                             javax.script.Bindings n)
                      throws javax.script.ScriptException

Specified by:

eval in interface javax.script.ScriptEngine

Throws:

javax.script.ScriptException

get

public java.lang.Object get(java.lang.String key)

Specified by:

get in interface javax.script.ScriptEngine

getBindings

public javax.script.Bindings getBindings(int scope)

Specified by:

getBindings in interface javax.script.ScriptEngine

getContext

public javax.script.ScriptContext getContext()

Specified by:

getContext in interface javax.script.ScriptEngine

getFactory

public javax.script.ScriptEngineFactory getFactory()

Specified by:

getFactory in interface javax.script.ScriptEngine

put

public void put(java.lang.String key,
                java.lang.Object value)

Specified by:

put in interface javax.script.ScriptEngine

setBindings

public void setBindings(javax.script.Bindings bindings,
                        int scope)

Specified by:

setBindings in interface javax.script.ScriptEngine

setContext

public void setContext(javax.script.ScriptContext context)

Specified by:

setContext in interface javax.script.ScriptEngine