org.vishia.zcmd

Class Zbnf2Text

java.lang.Object

org.vishia.zbnf.Zbnf2Xml

org.vishia.zcmd.Zbnf2Text

public class Zbnf2Text
extends Zbnf2Xml

This class reads any input text file with given syntay and creates a translated file from that data. It uses a JZtxtcmdScript to describe the text generation and the JZtxtcmdExecuter to generate the text. The translator from the generate control script is parsed with JZtxtcmd contained in this package. The translation process is full script controlled. Therewith the user can define and change the translation without study the complexly parsing and translation algorithm in Java, only adapt the maybe given scripts or writing own scripts based on examples and the knowledge of the script syntax.

 User                                       Internal                             User 
 input data --------> ZBNF parser --------> Java data -----> JZcmdExecuter ----> output data
 (textual)                 ^                 image               ^               usual textual
 ==========                |                                     |               =============s
                      ZBNF syntax                            JZcmdScript
                      script                                     ^
                      ==========                                 |
                                                                 |
                                            JZcmd   -------> JZcmd using
                                            generation       ZBNF parser
                                            script
                                            ==========
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Zbnf2Text.Args This class holds the gotten arguments from command line.
static class	Zbnf2Text.CmdLineText The inner class CmdLineText helps to evaluate the command line arguments and show help messages on command line.
static class	Zbnf2Text.Out
static interface	Zbnf2Text.PreparerParsedData

Nested classes/interfaces inherited from class org.vishia.zbnf.Zbnf2Xml

Zbnf2Xml.CmdLine, Zbnf2Xml.PrepareXmlNode

Field Summary

Fields

Modifier and Type	Field and Description
(package private) MainCmd_ifc	console Aggregation to the Console implementation class.
(package private) Zbnf2Text.PreparerParsedData	setZbnfResult
static java.lang.String	sVersion Version, history and license.

Fields inherited from class org.vishia.zbnf.Zbnf2Xml

argsx, logmaincmd, parser

Constructor Summary

Constructors

Constructor and Description
Zbnf2Text(Zbnf2Text.Args args, MainCmd_ifc mainCmdLine)

Method Summary

Modifier and Type	Method and Description
static void	main(java.lang.String[] sArgs) main started from java
boolean	parseAndTranslate(Zbnf2Text.Args args, java.lang.Object userData, Zbnf2Text.PreparerParsedData preparerParsedData) Executes the parsing and translation to the destination files

Methods inherited from class org.vishia.zbnf.Zbnf2Xml

execute, parseAndWriteXml, smain, writeZbnf2Xml

Methods inherited from class java.lang.Object

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

Field Detail

sVersion

public static final java.lang.String sVersion

Version, history and license.

• 2014-02-16 Hartmut chg: Argument -currdir=PATH for command line invocation main(String[])
• 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 ist 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

console

final MainCmd_ifc console

Aggregation to the Console implementation class.

setZbnfResult

Zbnf2Text.PreparerParsedData setZbnfResult

Constructor Detail

Zbnf2Text

public Zbnf2Text(Zbnf2Text.Args args,
                 MainCmd_ifc mainCmdLine)

Method Detail

main

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

main started from java

parseAndTranslate

public boolean parseAndTranslate(Zbnf2Text.Args args,
                                 java.lang.Object userData,
                                 Zbnf2Text.PreparerParsedData preparerParsedData)
                          throws java.io.IOException,
                                 java.lang.IllegalArgumentException,
                                 java.lang.IllegalAccessException,
                                 java.lang.InstantiationException,
                                 java.text.ParseException,
                                 XmlException

Executes the parsing and translation to the destination files

Parameters:

args - Zbnf2Text command line calling arguments.

userData - If null then the xmlResultTree of ZbnfParser.getResultTree() is used as data to produce the output texts. If given then ZbnfJavaOutput is used to set its content with the parsers result. If this instance is instance of Runnable then its run method will be execute after filling.

preparerParsedData - This is a callback which is called after generating the script variable and before execution the script. The user can set additional script variables before execution or can use script variables to get its content for any userData evaluation.

Returns:

Throws:

java.io.IOException

java.lang.IllegalArgumentException

java.lang.IllegalAccessException

java.lang.InstantiationException

java.text.ParseException

XmlException