open-dis / xmlpg Goto Github PK

Xml Multi-Language Protocol Generator -- code generator for Open DIS

License: BSD 2-Clause "Simplified" License

Java 97.20% XSLT 2.69% Shell 0.11%

xmlpg's Introduction

XMLPG (XML Multi-Language Protocol Generator)

Define your binary protocol in an XML file and then use this tool to generate network message marshalling code for Java, C++, C#, Objective-C, Python, and JavaScript languages.

An example XML specification file is DIS2012.xml.

For more info see XMLPG.md.

Compiling

The XMLPG tool uses the Maven build system, available from Apache.org.

mvn compile: Compiles the XMLPG program itself

Running

There is a sample script runXmlpg.sh that uses the sample DIS2012.xml spec and will generate output in target/generated-sources/.

License

XMLPG is released under the BSD license. See LICENSE.md for details.

xmlpg's People

Contributors

Stargazers

Watchers

Forkers

dalemarchand tzneal improbable-archive nfowl phoppermann mbeckerle

xmlpg's Issues

cpp: include DataStream must always use the "utils" namespace

Currently, the namespace defined in the xml is used.

Fix indentation of geneated cpp

Some lines are indented differrently. E.g.:

https://github.com/open-dis/open-dis-cpp/blob/86e8c24edfd0132ef3f4e38c0f17067781e6c892/cpp/DIS/AcknowledgePdu.cpp#L75

https://github.com/open-dis/open-dis-cpp/blob/86e8c24edfd0132ef3f4e38c0f17067781e6c892/cpp/DIS/AcknowledgePdu.cpp#L86

https://github.com/open-dis/open-dis-cpp/blob/86e8c24edfd0132ef3f4e38c0f17067781e6c892/cpp/DIS/AcknowledgePdu.h#L47

Possible to have calculated variable length attributes?

E.g. countFieldName="my_count * 2"

How is setPduType() generated?

e.g. in https://github.com/open-dis/open-dis-cpp/blob/86e8c24edfd0132ef3f4e38c0f17067781e6c892/cpp/DIS/AcknowledgePdu.cpp#L11

Possible to use variable length attributes of primitive type?

Variable list with primitve types not working (cpp)

How to reproduce:

define variable list of type "unsigned byte"
define variable list of type "float"
run xmlpg
try to compile generated class

Add unit tests

in the simplest case: run generator on XML and check that generated output is as expected

CppGenerator: same header included multiple times

If multiple class attributes are objects of the same class, the corresponding header is included multiple times.
See

xmlpg/src/main/java/edu/nps/moves/xmlpg/CppGenerator.java

Line 192 in 11f88b3

for (int idx = 0; idx < aClass.getClassAttributes().size(); idx++) {

Possible solution: store includes in Set<String>.

Make CppGenerator IVAR_PREFIX configurable

Python code not generating

When I run xmlpg with DIS2012.xml and python the language I see this:

putting network code in null/null

cpp: variable length types produce SIGSEGV on unmarshal

Any generated PDU with a vector produces a SIGSEGV in unmarshal because the vector is never initialized to the required size before data is written into it (array style access).

Add basic validity checks

The input xml should be checked for some basic errors.
E.g. class name may not contain spaces (currently, an invalid class is created).

Add context to error messages

When an error occurs, it's completely unclear which PDU definition is affected.

Add run instructions to README

cd dist
java -cp xmlpg.jar edu.nps.moves.xmlpg.Xmlpg <xml> <language>

Is it supposed to work without specifying the main class (it didn't for me)?

Allow nested namespace

Invalid assumption for variable lists

It is assumed that the count field attribute appears before the variable list. This is not valid in general.

Sync DIS2012.xml and DIS7.xml

The file in this repo, xmlpg/DIS2012.xml and the one over in DISDescription/DIS7.xml differ slightly. They should be the same.

https://github.com/open-dis/xmlpg/blob/master/DIS2012.xml
https://github.com/open-dis/DISDescription/blob/master/DIS7.xml

It looks to me like different fixes have gone into both so a careful merge of the two should be considered.

Fix XML format documentation

In general, the documentation in XMLPG.html is not really accessible. I would prefer to have it in the README.

document all possibilities of the XML format (e.g. defaultValue is missing)
fix documentation (e.g. fixed → fixedlist, variable → variablelist)

What makes it even worse: The DIS2012.xml file is not accepted by XMLPG.

Fix DIS2012.xml

The XML format does not match the one used by xmlpg. Also, the file should be linted.