diff options
| author | Carl Worth <cworth@cworth.org> | 2010-08-23 09:06:11 -0700 |
|---|---|---|
| committer | Carl Worth <cworth@cworth.org> | 2010-08-23 10:48:10 -0700 |
| commit | c15f04b326aafc27aa2e508ab88bf209c829abd7 (patch) | |
| tree | 8d17174b078680597c4b34f808acd81135c77257 /src/glsl/glcpp | |
| parent | 0acd68c4050fea82797f80ad90212926df4cf001 (diff) | |
glcpp: Update README file (new specifications and fewer limitations).
The README file had grown a little bit stale. We've been using newer
versions of both the GLSL and C99 specifications, so list those. Also,
several of the documented known limitations have since been fixed, so
remove those.
Diffstat (limited to 'src/glsl/glcpp')
| -rw-r--r-- | src/glsl/glcpp/README | 26 |
1 files changed, 14 insertions, 12 deletions
diff --git a/src/glsl/glcpp/README b/src/glsl/glcpp/README index ab42a3ffe1..0b5ef508ce 100644 --- a/src/glsl/glcpp/README +++ b/src/glsl/glcpp/README @@ -4,26 +4,28 @@ This is a simple preprocessor designed to provide the preprocessing needs of the GLSL language. The requirements for this preprocessor are specified in the GLSL 1.30 specification availble from: -http://www.opengl.org/registry/doc/GLSLangSpec.Full.1.30.08.pdf +http://www.opengl.org/registry/doc/GLSLangSpec.Full.1.30.10.pdf This specification is not precise on some semantics, (for example, #define and #if), defining these merely "as is standard for C++ -preprocessors". To fill in these details, I've been using the C99 -standard (for which I had a convenient copy) as available from: +preprocessors". To fill in these details, I've been using a draft of +the C99 standard as available from: -http://www.open-std.org/jtc1/sc22/wg14/www/docs/n1124.pdf +http://www.open-std.org/jtc1/sc22/wg14/www/docs/n1256.pdf -Known limitations ------------------ -Macro invocations cannot include embedded newlines. +Any downstream compiler accepting output from glcpp should be prepared +to encounter and deal with the following preprocessor macros: -The __LINE__, __FILE__, and __VERSION__ macros are not yet supported. + #line + #pragma + #extension -The argument of the 'defined' operator cannot yet include enclosing -parentheses. +All other macros will be handles according to the GLSL specification +and will not appear in the output. -The #error, #pragma, #extension, #version, and #line macros are not -yet supported. +Known limitations +----------------- +The __LINE__ and __FILE__ macros are not yet supported. A file that ends with a function-like macro name as the last non-whitespace token will result in a parse error, (where it should be |