Fix GLSL parsing to ignore preprocessor statements. Bump version and …

…build files.
kbirk · Jul 18, 2016 · 66d6954 · 66d6954
1 parent e505a3f
commit 66d6954
Show file tree

Hide file tree

Showing 31 changed files with 101 additions and 41 deletions.
diff --git a/bower.json b/bower.json
@@ -1,6 +1,6 @@
 {
   "name": "esper",
-  "version": "0.10.3",
+  "version": "0.10.4",
   "description": "A low-level WebGL rendering framework",
   "homepage": "https://github.com/kbirk/esper",
   "authors": [

diff --git a/build/esper.js b/build/esper.js
diff --git a/build/esper.min.js b/build/esper.min.js
diff --git a/docs/ColorTexture2D.html b/docs/ColorTexture2D.html
@@ -1689,7 +1689,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jun 09 2016 17:00:56 GMT-0400 (EDT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Jul 18 2016 17:00:27 GMT-0400 (EDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/ColorTexture2D.js.html b/docs/ColorTexture2D.js.html
@@ -210,7 +210,7 @@ <h1 class="page-title">ColorTexture2D.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jun 09 2016 17:00:56 GMT-0400 (EDT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Jul 18 2016 17:00:27 GMT-0400 (EDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/DepthTexture2D.html b/docs/DepthTexture2D.html
@@ -1545,7 +1545,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jun 09 2016 17:00:56 GMT-0400 (EDT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Jul 18 2016 17:00:27 GMT-0400 (EDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/DepthTexture2D.js.html b/docs/DepthTexture2D.js.html
@@ -148,7 +148,7 @@ <h1 class="page-title">DepthTexture2D.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jun 09 2016 17:00:56 GMT-0400 (EDT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Jul 18 2016 17:00:27 GMT-0400 (EDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/IndexBuffer.html b/docs/IndexBuffer.html
@@ -936,7 +936,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jun 09 2016 17:00:56 GMT-0400 (EDT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Jul 18 2016 17:00:27 GMT-0400 (EDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/IndexBuffer.js.html b/docs/IndexBuffer.js.html
@@ -296,7 +296,7 @@ <h1 class="page-title">IndexBuffer.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jun 09 2016 17:00:56 GMT-0400 (EDT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Jul 18 2016 17:00:27 GMT-0400 (EDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/RenderTarget.html b/docs/RenderTarget.html
@@ -907,7 +907,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jun 09 2016 17:00:56 GMT-0400 (EDT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Jul 18 2016 17:00:27 GMT-0400 (EDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/RenderTarget.js.html b/docs/RenderTarget.js.html
@@ -213,7 +213,7 @@ <h1 class="page-title">RenderTarget.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jun 09 2016 17:00:56 GMT-0400 (EDT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Jul 18 2016 17:00:27 GMT-0400 (EDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Renderable.html b/docs/Renderable.html
@@ -733,7 +733,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jun 09 2016 17:00:56 GMT-0400 (EDT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Jul 18 2016 17:00:27 GMT-0400 (EDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Renderable.js.html b/docs/Renderable.js.html
@@ -176,7 +176,7 @@ <h1 class="page-title">Renderable.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jun 09 2016 17:00:56 GMT-0400 (EDT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Jul 18 2016 17:00:27 GMT-0400 (EDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Shader.html b/docs/Shader.html
@@ -918,7 +918,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jun 09 2016 17:00:56 GMT-0400 (EDT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Jul 18 2016 17:00:27 GMT-0400 (EDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Shader.js.html b/docs/Shader.js.html
@@ -481,7 +481,7 @@ <h1 class="page-title">Shader.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jun 09 2016 17:00:56 GMT-0400 (EDT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Jul 18 2016 17:00:27 GMT-0400 (EDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/ShaderParser.js.html b/docs/ShaderParser.js.html
@@ -69,6 +69,7 @@ <h1 class="page-title">ShaderParser.js</h1>
     var NAME_COUNT_REGEXP = /([a-zA-Z_][a-zA-Z0-9_]*)(?:\[(\d+)\])?/;
     var PRECISION_REGEX = /\b(precision)\s+(\w+)\s+(\w+)/;
     var GLSL_REGEXP =  /void\s+main\s*\(\s*(void)*\s*\)\s*/mi;
+    var PREP_REGEXP = /#(define|if|ifdef|ifndef|else|elif|endif|undef|error|pragma|extension|version|line).*\n/g;
 
     /**
      * Removes standard comments from the provided string.
@@ -202,7 +203,7 @@ <h1 class="page-title">ShaderParser.js</h1>
         var statements = normalized.split(';');
         // build regex for parsing statements with targetted keywords
         var keywordStr = keywords.join('|');
-        var keywordRegex = new RegExp( '.*\\b(' + keywordStr + ')\\b.*' );
+        var keywordRegex = new RegExp( '\\b(' + keywordStr + ')\\b.*' );
         // parse and store global precision statements and any declarations
         var precisions = {};
         var matched = [];
@@ -231,7 +232,8 @@ <h1 class="page-title">ShaderParser.js</h1>
     }
 
     /**
-     * Filters out duplicate declarations present between shaders.
+     * Filters out duplicate declarations present between shaders. Currently
+     * just removes all # statements.
      * @private
      *
      * @param {Array} declarations - The array of declarations.
@@ -251,6 +253,19 @@ <h1 class="page-title">ShaderParser.js</h1>
         });
     }
 
+    /**
+     * Runs the preprocessor on the glsl code.
+     * @private
+     *
+     * @param {String} source - The unprocessed source code.
+     *
+     * @returns {String} The processed source code.
+     */
+    function preprocess( source ) {
+        // TODO: implement this correctly...
+        return source.replace(PREP_REGEXP, '');
+    }
+
     module.exports = {
 
         /**
@@ -283,7 +298,8 @@ <h1 class="page-title">ShaderParser.js</h1>
             // parse out targetted declarations
             var declarations = [];
             sources.forEach( function( source ) {
-                declarations = declarations.concat( parseSource( source, qualifiers ) );
+                var preprocessed = preprocess( source );
+                declarations = declarations.concat( parseSource( preprocessed, qualifiers ) );
             });
             // remove duplicates and return
             return filterDuplicatesByName( declarations );
@@ -315,7 +331,7 @@ <h1 class="page-title">ShaderParser.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jun 09 2016 17:00:56 GMT-0400 (EDT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Jul 18 2016 17:00:27 GMT-0400 (EDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Texture2D.html b/docs/Texture2D.html
@@ -1544,7 +1544,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jun 09 2016 17:00:56 GMT-0400 (EDT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Jul 18 2016 17:00:27 GMT-0400 (EDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Texture2D.js.html b/docs/Texture2D.js.html
@@ -442,7 +442,7 @@ <h1 class="page-title">Texture2D.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jun 09 2016 17:00:56 GMT-0400 (EDT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Jul 18 2016 17:00:27 GMT-0400 (EDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/TextureCubeMap.html b/docs/TextureCubeMap.html
@@ -1370,7 +1370,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jun 09 2016 17:00:56 GMT-0400 (EDT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Jul 18 2016 17:00:27 GMT-0400 (EDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/TextureCubeMap.js.html b/docs/TextureCubeMap.js.html
@@ -556,7 +556,7 @@ <h1 class="page-title">TextureCubeMap.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jun 09 2016 17:00:56 GMT-0400 (EDT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Jul 18 2016 17:00:27 GMT-0400 (EDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/VertexBuffer.html b/docs/VertexBuffer.html
@@ -1170,7 +1170,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jun 09 2016 17:00:56 GMT-0400 (EDT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Jul 18 2016 17:00:27 GMT-0400 (EDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/VertexBuffer.js.html b/docs/VertexBuffer.js.html
@@ -445,7 +445,7 @@ <h1 class="page-title">VertexBuffer.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jun 09 2016 17:00:56 GMT-0400 (EDT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Jul 18 2016 17:00:27 GMT-0400 (EDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/VertexPackage.html b/docs/VertexPackage.html
@@ -373,7 +373,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jun 09 2016 17:00:56 GMT-0400 (EDT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Jul 18 2016 17:00:27 GMT-0400 (EDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/VertexPackage.js.html b/docs/VertexPackage.js.html
@@ -316,7 +316,7 @@ <h1 class="page-title">VertexPackage.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jun 09 2016 17:00:56 GMT-0400 (EDT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Jul 18 2016 17:00:27 GMT-0400 (EDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Viewport.html b/docs/Viewport.html
@@ -794,7 +794,7 @@ <h5>Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jun 09 2016 17:00:56 GMT-0400 (EDT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Jul 18 2016 17:00:27 GMT-0400 (EDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/Viewport.js.html b/docs/Viewport.js.html
@@ -177,7 +177,7 @@ <h1 class="page-title">Viewport.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jun 09 2016 17:00:56 GMT-0400 (EDT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Jul 18 2016 17:00:27 GMT-0400 (EDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/WebGLContext.js.html b/docs/WebGLContext.js.html
@@ -355,7 +355,7 @@ <h1 class="page-title">WebGLContext.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jun 09 2016 17:00:56 GMT-0400 (EDT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Jul 18 2016 17:00:27 GMT-0400 (EDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/docs/index.html b/docs/index.html
@@ -302,10 +302,10 @@ <h2>Example</h2><ul>
     mode: TRIANGLES
 });
 
-// Draw points from a byte offset.
+// Draw points from an index offset.
 vertexBuffer.draw({
     mode: POINTS,
-    byteOffset: 100 * 4 * 2
+    indexOffset: 100
 });
 
 // Draw n lines.
@@ -506,7 +506,7 @@ <h3>DepthTextures</h3><p>Depth textures can be used to store depth values and ar
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Thu Jun 09 2016 17:00:56 GMT-0400 (EDT) using the Minami theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Mon Jul 18 2016 17:00:27 GMT-0400 (EDT) using the Minami theme.
 </footer>
 
 <script>prettyPrint();</script>

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "esper",
-  "version": "0.10.3",
+  "version": "0.10.4",
   "description": "A low-level WebGL rendering framework",
   "author": "Kevin Birk <birk.kevin@gmail.com>",
   "main": "src/exports.js",

diff --git a/src/core/ShaderParser.js b/src/core/ShaderParser.js
@@ -29,6 +29,7 @@
     var NAME_COUNT_REGEXP = /([a-zA-Z_][a-zA-Z0-9_]*)(?:\[(\d+)\])?/;
     var PRECISION_REGEX = /\b(precision)\s+(\w+)\s+(\w+)/;
     var GLSL_REGEXP =  /void\s+main\s*\(\s*(void)*\s*\)\s*/mi;
+    var PREP_REGEXP = /#(define|if|ifdef|ifndef|else|elif|endif|undef|error|pragma|extension|version|line).*\n/g;
 
     /**
      * Removes standard comments from the provided string.
@@ -162,7 +163,7 @@
         var statements = normalized.split(';');
         // build regex for parsing statements with targetted keywords
         var keywordStr = keywords.join('|');
-        var keywordRegex = new RegExp( '.*\\b(' + keywordStr + ')\\b.*' );
+        var keywordRegex = new RegExp( '\\b(' + keywordStr + ')\\b.*' );
         // parse and store global precision statements and any declarations
         var precisions = {};
         var matched = [];
@@ -191,7 +192,8 @@
     }
 
     /**
-     * Filters out duplicate declarations present between shaders.
+     * Filters out duplicate declarations present between shaders. Currently
+     * just removes all # statements.
      * @private
      *
      * @param {Array} declarations - The array of declarations.
@@ -211,6 +213,19 @@
         });
     }
 
+    /**
+     * Runs the preprocessor on the glsl code.
+     * @private
+     *
+     * @param {String} source - The unprocessed source code.
+     *
+     * @returns {String} The processed source code.
+     */
+    function preprocess( source ) {
+        // TODO: implement this correctly...
+        return source.replace(PREP_REGEXP, '');
+    }
+
     module.exports = {
 
         /**
@@ -243,7 +258,8 @@
             // parse out targetted declarations
             var declarations = [];
             sources.forEach( function( source ) {
-                declarations = declarations.concat( parseSource( source, qualifiers ) );
+                var preprocessed = preprocess( source );
+                declarations = declarations.concat( parseSource( preprocessed, qualifiers ) );
             });
             // remove duplicates and return
             return filterDuplicatesByName( declarations );

diff --git a/test/core/ShaderParserTest.js b/test/core/ShaderParserTest.js
@@ -143,6 +143,9 @@
                 var source = [
                     'uniform highp mat4 A[ 10], B, C [2];',
                     'uniform highp mat4 D;',
+                    'float func() {',
+                    'return 5.0;',
+                    '}',
                     'uniform highp mat4 E ,',
                     'F ',
                     '[11 ] ;',
@@ -169,6 +172,15 @@
                 assert( declarations[0].precision === 'highp' );
                 assert( declarations[1].precision === 'mediump' );
             });
+            it('should handle preprocessor statements', function() {
+                var source = [
+                    'precision highp float;',
+                    '#define TEST 5',
+                    '#define CONST 6',
+                    'void main() { ... }'].join('\n');
+                var declarations = ShaderParser.parseDeclarations( source, [ 'uniform', 'attribute' ] );
+                assert( declarations.length === 0 );
+            });
         });
         describe('#isGLSL()', function() {
             it('should return true if the argument string contains a `void main(...) {}`', function() {