Parser test suite

Author: docd27

README.md

@@ -110,22 +110,23 @@ The following shader stages are supported by the Khronos tools and recognized by
 - ``optimizerDebugSkipOptimizer`` : ``boolean`` (default false) When ``optimize`` enabled, skip the SPIR-V optimizer - compiles to SPIR-V then cross-compiles back to GLSL immediately.
 - ``suppressLineExtensionDirective`` : ``boolean`` (default false) When `emitLineDirectives` enabled, suppress the ``GL_GOOGLE_cpp_style_line_directive`` directive.
 - ``extraValidatorParams``, ``extraOptimizerParams``, ``extraCrossParams`` : ``string[]`` (default undefined) Additional parameters for the Khronos Glslang Validator [here](doc/glslangValidator.md), the Khronos SPIR-V Optimizer [here](doc/spirv-opt.md), and the Khronos SPIR-V Cross compiler [here](doc/spirv-cross.md).
-- ``glslangValidatorPath``, ``glslangOptimizerPath``, ``glslangCrossPath`` : ``string`` (default undefined) Provide / override binary tool paths. Note the environment variables always take precedence if set.
+- ``glslangValidatorPath``, ``glslangOptimizerPath``, ``glslangCrossPath`` : ``string`` (default undefined) Provide / override binary tool paths.\
+*It's recommended to instead use the environment variables ``GLSLANG_VALIDATOR``, ``GLSLANG_OPTIMIZER``, ``GLSLANG_CROSS`` where needed. They always take precedence if set.*
 
 ## Changelog
 Available in [CHANGES.md](CHANGES.md).
 
 #### Caveats & Known Issues
-* This plugin handles glsl and glsify by itself. Use with conflicting plugins (e.g. rollup-plugin-glsl, rollup-plugin-glslify) will cause unpredictable results.
+* This plugin handles glsl and glslify by itself. Use with conflicting plugins (e.g. rollup-plugin-glsl, rollup-plugin-glslify) will cause unpredictable results.
 * Optimizer: ``lowp`` precision qualifier - emitted as ``mediump``\
-  *SPIR-V has a single ``RelaxedPrecision`` decoration for 16-32bit precision. However most implementations now treat ``mediump`` and ``lowp`` equivalently, hence the lack of need for it in SPIR-V.*
+  *SPIR-V has a single ``RelaxedPrecision`` decoration for 16-32bit precision. However most implementations actually treat ``mediump`` and ``lowp`` equivalently, hence the lack of need for it in SPIR-V.*
 
 ## License
 
 Released under the [MIT license](LICENSE).\
 *Strip whitespace function adapted from code by Vincent Wochnik ([rollup-plugin-glsl](https://github.com/vwochnik/rollup-plugin-glsl)).*
 
-Khronos tool binaries (built by the upstream projects) are distributed and installed with this plugin under the terms of the Apache License Version 2.0. See the corresponding LICENSE files in the ``bin`` folder.
+Khronos tool binaries (built by the upstream projects) are distributed and installed with this plugin under the terms of the Apache License Version 2.0. See the corresponding LICENSE files installed in the ``bin`` folder and the [binary releases](https://github.com/docd27/rollup-plugin-glsl-optimize/releases/).
 
 [ci]: https://github.com/docd27/rollup-plugin-glsl-optimize/actions/workflows/node-ci.yml/badge.svg
 [ci-url]: https://github.com/docd27/rollup-plugin-glsl-optimize/actions/workflows/node-ci.yml

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "rollup-plugin-glsl-optimize",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Import GLSL source files as strings. Pre-processed, validated and optimized with Khronos Group SPIRV-Tools. Supports glslify.",
   "homepage": "https://github.com/docd27/rollup-plugin-glsl-optimize#readme",
   "keywords": [

package.json

@@ -281,16 +281,14 @@ function* parser(input) {
   }
 }
 
+const warnParse = (message, token) => console.error(`Warning: ${formatParseError(message, token)}`);
 
-const warnParse = (message, token) => console.error(formatParseError(message, token));
-
-/* c8 ignore start */
 /**
  * @internal
  * @param {string} message
  * @param {LexerToken} token
  */
-export const formatParseError = (message, token) => `Warning: ${message}\nLine ${
+export const formatParseError = (message, token) => `${message}\nLine ${
   token.line} col ${token.col}:\n${formatLine(token.text)}`;
 
 const formatLine = (line) => {
@@ -326,11 +324,9 @@ const printToken = (t) => {
       restKV.length ? ` | ${restKV.map(([k, v]) => `${k} : '${v}'`).join(' | ')}`: ''}`;
 };
 
-/** @internal */
-export function parseDump(input) {
-  for (const token of simpleParse(input)) {
-    console.log(printToken(token));
-  }
-}
-
-/* c8 ignore stop */
+export const test = {
+  iterateStringLookahead,
+  lexer,
+  parser,
+  printToken,
+};

src/lib/parse.js

@@ -9,7 +9,7 @@ const GLSL_LINE_EXT = 'GL_GOOGLE_cpp_style_line_directive';
  * @param {string} filePath
  * @param {(version: string) => string} [versionReplacer]
  * @param {string} [extraPreamble]
- * @return {{code: string, didInsertion: boolean, foundVersionString?: string}}
+ * @return {{code: string, didInsertion: boolean}}
  */
 export function insertExtensionPreamble(code, filePath, versionReplacer = (v) => v, extraPreamble) {
   // let extensionDirectiveRequired = true;
@@ -105,18 +105,30 @@ export function fixupDirectives(code, preserve = false, required = true, searchL
  * @internal
  * @param {Iterable<import('./parse.js').ParserToken>} tokens
  * @param {(fixupLineNo: number) => import('./parse.js').ParserToken} preambleToken
+ * PRE: emits trailing \n
  * @param {(version: string) => string} [versionReplacer]
- * @return {{code: string, didInsertion: boolean, foundVersionString?: string}}
+ * If versionReplacer(undefined) !== undefined also inserts a version token when an existing one is not found
+ * @return {{code: string, didInsertion: boolean}}
  */
 function insertPreambleTokens(tokens, preambleToken, versionReplacer = (v) => v) {
-  const versionToken = function* (token) {
-    yield {type: TOK.Version, Version: versionReplacer(undefined), col: token.col, line: token.line,
-      text: `#version ${versionReplacer(undefined)}`, value: ''};
-    yield {type: TOK.EOL, col: token.col, line: token.line, text: '\n', value: '\n'};
+  /** @param {import('./parse.js').ParserToken} token */
+  const newVersionToken = function* (token) {
+    const newVersion = versionReplacer(undefined);
+    if (newVersion !== undefined) {
+      yield {type: TOK.Version, Version: newVersion, col: token.col, line: token.line,
+        text: `#version ${newVersion}`, value: ''};
+      yield {type: TOK.EOL, col: token.col, line: token.line, text: '\n', value: '\n'};
+    }
   };
 
   return {code: [...(/** @return {Generator<import('./parse.js').ParserToken>} */ function* () {
     let insertNext = false, acceptVersion = true, foundVersion = false, didInsertion = false;
+    /** @param {import('./parse.js').ParserToken} token */
+    const newVersionPreambleTokens = function* (token) {
+      acceptVersion = false; didInsertion = true;
+      yield* newVersionToken(token);
+      yield preambleToken(token.line);
+    };
     for (const token of tokens) {
       if (insertNext) {
         insertNext = false;
@@ -125,34 +137,47 @@ function insertPreambleTokens(tokens, preambleToken, versionReplacer = (v) => v)
       switch (token.type) {
         case TOK.Comment: break;
         case TOK.EOF:
-          if (!didInsertion) {
-            didInsertion = true;
-            // Needs a new line
-            if (acceptVersion) yield* versionToken(token);
-            yield {type: TOK.EOL, col: token.col, line: token.line, text: '\n', value: '\n'};
-            yield preambleToken(token.line + 1);
+          if (acceptVersion) { // Zero-length input
+            yield* newVersionPreambleTokens(token);
+          } else {
+            if (!didInsertion) { // EOF directly after version directive
+              didInsertion = true;
+              // Needs a new line
+              yield {type: TOK.EOL, col: token.col, line: token.line, text: '\n', value: '\n'};
+              yield preambleToken(token.line + 1);
+            }
           }
           break;
         case TOK.EOL:
-          if (acceptVersion) yield* versionToken(token);
-          acceptVersion = false;
-          if (!didInsertion) {
-            didInsertion = true; insertNext = true;
+          if (acceptVersion) { // Zero-length first line
+            yield* newVersionPreambleTokens(token);
+          } else {
+            if (!didInsertion) { // Newline after version directive, insert after this EOL
+              insertNext = true; didInsertion = true;
+            }
           }
           break;
         case TOK.Version:
           if (acceptVersion) {
             acceptVersion = false; foundVersion = true;
             const newVersion = versionReplacer(token.Version);
             token.Version = newVersion;
+            /*
+            Even though the parser may parse a line like "#version{COMMENT}300"
+            The following is legal because per the spec:
+            The #version directive must be present in the first line of a shader
+            and must be followed by a newline. It may contain optional white-space as specified below
+            but no other characters are allowed.
+            */
             token.text = `#version ${newVersion}`;
           } else {
             throw new Error(formatParseError(`Parse error: #version directive must be on first line`, token));
           }
           break;
         default:
-          if (acceptVersion) yield* versionToken(token);
-          acceptVersion = false;
+          if (acceptVersion) { // Some other token on first line
+            yield* newVersionPreambleTokens(token);
+          }
       }
       yield token;
     }
@@ -172,3 +197,7 @@ export function insertPreamble(code, preamble) {
       (fixupLineNo) => ({col: 0, line: fixupLineNo, type: TOK.Comment, value: '', text:
       `${preamble}\n`}));
 }
+
+export const test = {
+  insertPreambleTokens,
+};

src/lib/preamble.js

@@ -1,12 +1,15 @@
 import * as util from 'util';
 import chai from 'chai';
 import chaiAsPromised from 'chai-as-promised';
+import {settings} from '../../settings.js';
 
 import {installTests} from './install.js';
 import {utilTests} from './util.js';
+import {parserTests} from './parser.js';
+import {preambleTests} from './preamble.js';
 import {glslifyTests} from './glslify.js';
 import {shaderTests} from './shader.js';
-import {settings} from '../../settings.js';
+
 
 /**
  * Log to console without mocking
@@ -24,6 +27,8 @@ export function runTests(glslOptimize) {
 
   installTests();
   utilTests();
+  parserTests();
+  preambleTests();
   shaderTests(glslOptimize);
   glslifyTests(glslOptimize);
 }