org.vishia.header2Reflection

Class CheaderParser

java.lang.Object

org.vishia.header2Reflection.CheaderParser

public class CheaderParser
extends java.lang.Object

This class parses C-files and builds a result tree, which can be proceed especially with a JZcmd script. Therewith output files from headers can be generated with a control script without hard-core Java programming. This class should be matched stronly to the parser script Cheader.zbnf in the software component www.vishia.org/ZBNF/zbnfjax.

This class contains some public static class Subclasses which are the complements to the parsers result component. The structure of the syntax of a header file may be able to recognized with them. See the syntax definition.

The class representing the root of the parse result for each header file is CheaderParser.ZbnfResultFile. This class contains new_... and add_.. methods for the parser's result components of the header file.
All headerfile's results are stored in an instance of CheaderParser.ZbnfResultData which is returned by the execute(Args) method of this class.

To invoke this class from a JZcmd script write a script with content:

##A ZZcmd script:
sub ExampleGen(Obj target: org.vishia.cmd.ZmakeTarget)  ##a zmake target
{ 
  Obj headerTranslator = java new org.vishia.header2Reflection.CheaderParser(console);  ##create instance of this class

  Obj args = java new org.vishia.header2Reflection.CheaderParser$Args();     ##arguments have to be filled firstly
  List inputsExpanded = target.allInputFilesExpanded();
  for(input:inputsExpanded)
  { args.addSrc(input.absfile(), input.namext());                            ##input files, here from zmake target.
  }
  args.setDst(target.output.absfile());                                      ##the output file
  args.setZbnfHeader(<:><&scriptdir>/../../zbnfjax/zbnf/Cheader.zbnf<.>);    ##the Zbnf syntax control script. 
  //
  Obj headers = headerTranslator.execute(args);              ##executes
 

The result tree headers is contained in the instance of CheaderParser.ZbnfResultData. That result can be evaluated with JZcmd for example:

  ##A ZZcmd script:
  for(headerfile: headers.files){
    for(classC: headerfile.listClassC) {
      for(entry: classC.entries) {
        if(entry.whatisit == "structDefinition") {
          call genStruct(struct=entry, headerName = &headerfile.fileName);
        }
      }
    }
  }

 

For Zmake see www.vishia.org/ZBNF/sf/docu/Zmake.html.
This class can be downloaded from www.sf.net/projects/zbnf

See Also:

JZtxtcmd, JZtxtcmdExecuter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CheaderParser.Args
static class	CheaderParser.Arraysize
static class	CheaderParser.Assignment
static class	CheaderParser.AttribAsMacro An attribute in a struct (variable definition).
static class	CheaderParser.AttributeOrTypedef An attribute in a struct (variable definition) or in an argument list.
static class	CheaderParser.ClassC
static class	CheaderParser.ClassDefinition
static class	CheaderParser.ConditionalStatement
static class	CheaderParser.ConditionBlock
static class	CheaderParser.ConditionDef
static class	CheaderParser.Constructor
static class	CheaderParser.Define
static class	CheaderParser.DefineDefinition
static class	CheaderParser.DefineParameter
static class	CheaderParser.Description
static class	CheaderParser.Destructor
static class	CheaderParser.EnumDefinition
static class	CheaderParser.EnumElement
static class	CheaderParser.ExternObject
static class	CheaderParser.FnPointer A C like funktion pointer definition.
static class	CheaderParser.FriendClass
static class	CheaderParser.HeaderBlock
static class	CheaderParser.HeaderBlockEntry
static class	CheaderParser.IncludeDef
static class	CheaderParser.InitializationInCtor
static class	CheaderParser.MethodCall
static class	CheaderParser.MethodDef
static class	CheaderParser.MethodTypedef
static class	CheaderParser.Number
static class	CheaderParser.Operator
static class	CheaderParser.ParamDescription
static class	CheaderParser.Pointer Designation whether a type is a pointer type.
static class	CheaderParser.RefCastingValue
static class	CheaderParser.SizeofDescription
static class	CheaderParser.SrcFile
static class	CheaderParser.Statement
static class	CheaderParser.StatementBlock A StatementBlock contains statements.
static class	CheaderParser.StructClassDecl
static class	CheaderParser.StructDefinition
static class	CheaderParser.StructOrClassDef
static class	CheaderParser.Superclass Form parsing it is only an entry with given name.
static class	CheaderParser.Type This class presents the properties of a type.
static class	CheaderParser.Value A value is syntactically an expression.
static class	CheaderParser.ValueEntry
static class	CheaderParser.Variable
static class	CheaderParser.VariableDefinition
static class	CheaderParser.ZbnfResultData
static class	CheaderParser.ZbnfResultFile

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static java.util.Map<java.lang.String,CheaderParser.StructOrClassDef>	allClasses All yet parsed struct or class.
private MainCmd_ifc	console
static java.lang.String	sVersion Version, history and license.

Constructor Summary

Constructors

Constructor and Description
CheaderParser(MainCmd_ifc console)

Method Summary

Modifier and Type	Method and Description
CheaderParser.ZbnfResultData	execute(CheaderParser.Args args)
private CheaderParser.ZbnfResultData	parseAndStoreInput(CheaderParser.Args args) This method reads the input script, parses it with ZBNF, stores all results in the Java-class CheaderParser.ZbnfResultData
static java.lang.String	prepareReflName(java.lang.String name) Prepares a name for a variable, may be longer than 30 chars or may contain "." for sub structure.

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.

• 2018-10-10 JzHartmut change; handling of macro because comment is necessary.
• 2018-10-10 JzHartmut CheaderParser.StructDefinition.new_attribMacro(), the HeaderBlock.add_macro is removed. It is more systematic. Cheader.zbnf adequate changed.
• 2018-10-10 JzHartmut Some adaption to jzTc generation script, especially up to now all Type_s produces reflection_Type without suffix _s. It is necessary because it should be given a simple rule to deduce from the TYPE_t tagname to the type. The rule is:

  struct TYPE_t{....} TYPE_s; class TYPE : TYPE_s{...}; reflection_TYPE 

  The reflection_TYPE is for a struct TYPE_s which is presented by a class TYPE without own reflection.
• 2018-09-02 JzHartmut first super element for non-ObjectJc superclass, see StructDefinition#add_attribute(AttributeOrTypedef)
• 2018-09-02 JzHartmut structNameTypeOffs removed, see StructDefinition#add_innerStructAttribute(StructDefinition)
• 2018-08-28 JzHartmut CheaderParser.HeaderBlock.set_const(), CheaderParser.HeaderBlock.new_structContentInsideCondition() should return a CheaderParser.ConditionBlock. HeaderBlock#add_macro(AttribAsMacro) and StructDefinition#add_macro(AttribAsMacro): The OS_HandlePtr should be accepted as attribute. Some more container for semantics from CHeader.zbnf
• 2018-08-12 JzHartmut inner named or unnamed struct handled, named struct are stored as extra type..
• 2018-01-03 JzHartmut new Some enhancements adequate to syntax in Cheader.zbnf, while testing reflection.
• 2017-12-20 JzHartmut new CheaderParser.StructDefinition with attributes and isBasedOnObjectJc. Used for Sfunction not based on ObjectJc.
• 2017-05-29 JzHartmut CheaderParser.Type.pointer_ with CheaderParser.Pointer designation
• 2017-05-10 JzHartmut adapt to Cheader.zbnf
• 2016-10-18 JzHartmut chg: The UnionVariante is syntactically identically with a struct definition. Therefore the same class CheaderParser.StructDefinition is used for CheaderParser.HeaderBlock.new_undefDefinition() instead the older extra class UnionVariante. the CheaderParser.StructDefinition.isUnion designates that it is a union in semantic. Using scripts should be changed. Some new definitions StructDefinition#set_innerUnion() and StructDefinition#set_innerStruct() are added.
• 2014-10-18 JzHartmut created. In the past either the parse result was used immediately with a Java programm as generator, for example for CmdHeader2Reflection, or the generation of some things are done via the XML output from the parser via an XSLT translator.

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

allClasses

static java.util.Map<java.lang.String,CheaderParser.StructOrClassDef> allClasses

All yet parsed struct or class. The key is the basename on a struct, to detect it for a forward declared type usage.

console

private final MainCmd_ifc console

Constructor Detail

CheaderParser

public CheaderParser(MainCmd_ifc console)

Method Detail

execute

public CheaderParser.ZbnfResultData execute(CheaderParser.Args args)

prepareReflName

public static java.lang.String prepareReflName(java.lang.String name)

Prepares a name for a variable, may be longer than 30 chars or may contain "." for sub structure.

Parameters:

name -

Returns:

parseAndStoreInput

private CheaderParser.ZbnfResultData parseAndStoreInput(CheaderParser.Args args)

This method reads the input script, parses it with ZBNF, stores all results in the Java-class CheaderParser.ZbnfResultData