Opentk/Source/Converter
Fraser Waters 7427f44bbe Ask for web auth if required
Ask for authentication to download private Khronos files.
2015-03-01 14:44:28 +00:00
..
Headers Normalized line endings 2013-10-11 01:58:54 +02:00
Properties Normalized line endings 2013-10-11 01:58:54 +02:00
ESCLParser.cs Fixed compilation warnings on Mono 3.4.0 2014-07-21 17:55:12 +02:00
Generator.Convert.csproj Remove spec support from converter 2015-03-01 14:25:30 +00:00
GLXmlParser.cs Fixed compilation warnings on Mono 3.4.0 2014-07-21 17:55:12 +02:00
Main.cs Remove spec support from converter 2015-03-01 14:25:30 +00:00
Options.cs Fixed project layout (files should be at root of project, not inside a folder). 2009-09-06 09:35:11 +00:00
Parser.cs Ask for web auth if required 2015-03-01 14:44:28 +00:00
Readme.txt Remove spec support from converter 2015-03-01 14:25:30 +00:00
XML schema notes.txt Normalized line endings 2013-10-11 01:58:54 +02:00

[Introduction]

This is a simple tool to convert C headers to XML files. It works using simple pattern matching - it does not actually parse the header files. For this reason, it will work with only a few, specific header files: ES and CL at this point.


[Examples]

To download and convert the XML API registry from Khronos:
Convert.exe -p:gl -t:xml -o:../../../Source/Bind/Specifications/GL2/signatures.xml https://cvs.khronos.org/svn/repos/ogl/trunk/doc/registry/public/api/gl.xml

The line above will download the latest .xml files from the public Khronos repository and update signatures.xml for the binding generator.

[Usage]

Convert.exe -p:{PREFIX} -v:{VERSION} -t:{TYPE} -o:{OUT} {INPUT1} ... {INPUTn}
    {PREFIX} is a simple string that defines the a common prefix for functions and constants in this header. This prefix will be removed from the generated XML file.
    {VERSION} is a string that defines that version that will be used for functions in the generated XML file. Specific input files may override this setting.
	{TYPE} can be either 'xml' or 'header' to indicate whether the input files are OpenGL .xml files or C headers.
	{OUT} is the output filename (optional). If no output file is specified, output will be directed to the console.
    {INPUT1..n} is a space-separated list of input files (headers).
    
Despite what the help says, prefix, version and type parameters are necessary at the moment.

[Support]

If you encounter a bug, please file an issue report at http://github.com/opentk/opentk/issues

We will only accept bug reports for supported header files. This is not a generic tool and will fail to parse unsupported files.