https://github.com/noteed/opengl-api

A parser for the OpenGL spec files
https://github.com/noteed/opengl-api

Last synced: about 2 months ago
JSON representation

A parser for the OpenGL spec files

• Host: GitHub
• URL: https://github.com/noteed/opengl-api
• Owner: noteed
• License: bsd-3-clause
• Created: 2010-07-29T22:39:12.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2012-01-24T19:16:17.000Z (almost 13 years ago)
• Last Synced: 2023-04-13T10:31:56.153Z (over 1 year ago)
• Language: C
• Homepage:
• Size: 438 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# opengl-api

Represent and parse spec files from the OpenGL [registry][].

[registry]: http://www.opengl.org/registry/#specfiles

## Directory layout

- `spec-files` contains the `.spec` and `.tm` files provided by [opengl.org][].

- `results` contains a modified `glext.h` file. This is a `glext.h` header

  provided by [opengl.org][] with one line modified (the one with the last

  update date). It is used to ensure that opengl-api still generates the same

  results after refactoring.

[opengl.org]: http://www.opengl.org/registry/#specfiles

## Current state

`Text.OpenGL.Spec` has code to completely parse and represent the content of

`enumext.spec` , `gl.tm` and `gl.spec`. (Probably there is not much left to do

to support `enum.spec`.) The representations includes comments, blank lines,

and passthru lines.

The representations are nearly feature complete, the only missing important bit

is the text defining the array size (in the description of function

parameters).

`Text.OpenGL.Api` has code to create higher-level data structures from the

one in `Text.OpenGL.Spec`.

`Text.OpenGL.ExtHeader` is able to perfectly recreate the `glext.h` file

from the spec files.

`Text.OpenGL.GenChecks` is able to generate macros to call glGetError after

every GL commands.

## To do

- Offer a simplified representation of `[EnumLine]` with no comment, no blank

  line, no passthru, maybe references already resolved, and a single number

  format.

- Offer a parser for `enum.spec`.

- State in the doc that there is some doc about the spec file format at the

  good old Haskell-OpenGL [page][]!

[page]: http://www.haskell.org/HOpenGL-old/spec_explained.html