The glsl-toolkit Reference Manual

3.1.1 glsl-toolkit/glsl-toolkit.asd

Source

glsl-toolkit.asd.

Parent Component

glsl-toolkit (system).

ASDF Systems

glsl-toolkit.

---

3.1.2 glsl-toolkit/package.lisp

Source

glsl-toolkit.asd.

Parent Component

glsl-toolkit (system).

Packages

• glsl-parser-rules.
• glsl-toolkit.

---

3.1.3 glsl-toolkit/toolkit.lisp

Dependency

package.lisp (file).

Source

glsl-toolkit.asd.

Parent Component

glsl-toolkit (system).

Public Interface

• *glsl-keyword-symbols* (special variable).
• *glsl-keywords* (special variable).

Internals

• ends-with (function).
• enlist (function).
• find-any (function).
• mapcar* (function).
• merge-plists (function).
• starts-with (function).
• unlist (function).

---

3.1.4 glsl-toolkit/parser.lisp

Dependency

toolkit.lisp (file).

Source

glsl-toolkit.asd.

Parent Component

glsl-toolkit (system).

Public Interface

• advance (compiler macro).
• advance (function).
• backtrack (compiler macro).
• backtrack (function).
• compile-rule (function).
• consume (compiler macro).
• consume (function).
• consume-any (function).
• consume-notany (function).
• consume-string (function).
• consume-whitespace (function).
• define-object (macro).
• define-reference (macro).
• define-rule (macro).
• end-of-tokens-p (compiler macro).
• end-of-tokens-p (function).
• lex (function).
• no-value (symbol macro).
• normalize-shader-source (function).
• parse (function).
• peek (compiler macro).
• peek (function).
• remove-rule (function).
• rule (function).
• (setf rule) (function).
• trace-parse (function).
• untrace-parse (function).
• with-token-input (macro).

Internals

• *max-index* (special variable).
• *token-array* (special variable).
• *token-index* (special variable).
• *trace-level* (special variable).
• *traced* (special variable).
• call-traced-function (function).
• check-parse-complete (function).
• discover-expr-around (function).
• ensure-shader (function).
• index (type).
• newline-p (function).
• trace-parse-func (function).
• untrace-parse-func (function).

---

3.1.5 glsl-toolkit/grammar.lisp

Dependency

parser.lisp (file).

Source

glsl-toolkit.asd.

Parent Component

glsl-toolkit (system).

Public Interface

• ! (function).
• != (function).
• % (function).
• %= (function).
• & (function).
• && (function).
• &= (function).
• ( (function).
• ) (function).
• * (function).
• *= (function).
• + (function).
• ++ (function).
• += (function).
• , (function).
• - (function).
• -- (function).
• -= (function).
• . (function).
• / (function).
• /= (function).
• ∶ (function).
• ; (function).
• < (function).
• << (function).
• <<= (function).
• <= (function).
• = (function).
• == (function).
• > (function).
• >= (function).
• >> (function).
• >>= (function).
• ? (function).
• [ (function).
• ] (function).
• ^ (function).
• ^= (function).
• ^^ (function).
• addition (function).
• array-initializer (function).
• array-modifier (function).
• array-specifier (function).
• assignment (function).
• assignment-expression (function).
• basic-type (function).
• bit-inversion (function).
• bitwise-and (function).
• boolean-constant (function).
• break (function).
• call-modifier (function).
• case-label (function).
• compound-statement (function).
• condition (function).
• condition-declarator (function).
• conditional (function).
• conditional-expression (function).
• constant-expression (function).
• continue (function).
• decimal-token (function).
• declaration (function).
• decrement-modifier (function).
• discard (function).
• division (function).
• do-statement (function).
• equal (function).
• exclusive-or (function).
• expression (function).
• expression-statement (function).
• field-modifier (function).
• float-constant (function).
• float-token (function).
• for-statement (function).
• function-declaration (function).
• function-definition (function).
• function-prototype (function).
• greater-equal-than (function).
• greater-than (function).
• hexadecimal-token (function).
• identifier (function).
• identifier-token (function).
• inclusive-or (function).
• increment-modifier (function).
• initializer (function).
• instance-name (function).
• integer-constant (function).
• integer-token (function).
• interface-declaration (function).
• interpolation-qualifier (function).
• invariant-qualifier (function).
• inversion (function).
• iteration-statement (function).
• jump-statement (function).
• keyword-token (function).
• layout-qualifier (function).
• layout-qualifier-id (function).
• left-shift (function).
• less-equal-than (function).
• less-than (function).
• logical-and (function).
• logical-or (function).
• logical-xor (function).
• modified-reference (function).
• modulus (function).
• multiple-expressions (function).
• multiplication (function).
• negation (function).
• not-equal (function).
• octal-token (function).
• operator (function).
• parameter-declaration (function).
• postfix-expression (function).
• precise-qualifier (function).
• precision-declaration (function).
• precision-qualifier (function).
• prefix-decrement (function).
• prefix-increment (function).
• preprocessor-directive (function).
• preprocessor-token (function).
• primary-expression (function).
• reference-modifier (function).
• return (function).
• right-shift (function).
• same-+ (function).
• selection-statement (function).
• shader (function).
• simple-statement (function).
• statement (function).
• storage-qualifier (function).
• struct-declaration (function).
• struct-declarator (function).
• struct-field-declarator (function).
• struct-specifier (function).
• subroutine-qualifier (function).
• subtraction (function).
• switch-statement (function).
• token (function).
• tokenize (function).
• type-name (function).
• type-qualifier (function).
• type-specifier (function).
• type-specifier-nonarray (function).
• unary-expression (function).
• variable-declaration (function).
• variable-initializer (function).
• while-statement (function).
• whitespace (function).
• { (function).
• | (function).
• |= (function).
• || (function).
• } (function).

Internals

• define-binary-op (macro).
• define-operator-objects (macro).

---

3.1.6 glsl-toolkit/printer.lisp

Dependency

grammar.lisp (file).

Source

glsl-toolkit.asd.

Parent Component

glsl-toolkit (system).

Public Interface

• define-serialization (macro).
• define-serializer (macro).
• indent (function).
• remove-serializer (function).
• serialize (function).
• serialize-part (function).
• serializer (function).
• (setf serializer) (function).
• sformat (compiler macro).
• sformat (function).
• with-indentation (macro).

Internals

• %format-object (function).
• *indent* (special variable).
• *serialize-stream* (special variable).
• *serializers* (special variable).
• compile-format-string (function).

---

3.1.7 glsl-toolkit/walker.lisp

Dependency

printer.lisp (file).

Source

glsl-toolkit.asd.

Parent Component

glsl-toolkit (system).

Public Interface

• binding (function).
• (setf binding) (function).
• constant-p (function).
• control-flow-p (function).
• declaration-p (function).
• define-binary-op-walker (macro).
• define-empty-op-walker (macro).
• define-unary-op-walker (macro).
• define-walker (macro).
• define-walking-body (macro).
• environment (class).
• expression-p (function).
• function-identifier-p (function).
• global-identifier-p (function).
• identifier-p (function).
• keyword-p (function).
• local-identifier-p (function).
• make-environment (function).
• preprocessor-p (function).
• remove-walker (function).
• root-environment-p (function).
• statement-p (function).
• variable-identifier-p (function).
• walk (function).
• walk-part (function).
• walker (function).
• (setf walker) (function).

Internals

• *walkers* (special variable).
• bindings (reader method).
• root (reader method).

---

3.1.8 glsl-toolkit/merge.lisp

Dependency

walker.lisp (file).

Source

glsl-toolkit.asd.

Parent Component

glsl-toolkit (system).

Public Interface

• matching-declarators-p (function).
• matching-qualifiers-p (function).
• matching-specifiers-p (function).
• merge-shader-sources (function).
• merge-shaders (function).
• uniquify (function).

Internals

• *unique-counter* (special variable).
• find-direction-qualifier (function).
• find-layout-qualifier (function).
• find-matching-layout-declaration (function).
• handle-declaration (function).
• handle-identifier (function).
• split-shader-into-groups (function).

---

3.1.9 glsl-toolkit/sexpr.lisp

Dependency

merge.lisp (file).

Source

glsl-toolkit.asd.

Parent Component

glsl-toolkit (system).

Internals

• *sexpr-transforms* (special variable).
• define-expr-binary (macro).
• define-sexpr-comparator (macro).
• define-sexpr-transform (macro).
• remove-sexpr-transform (function).
• separate-qualifier-specifier (function).
• sexpr->glsl-ast (function).
• sexpr-transform (function).
• (setf sexpr-transform) (function).
• symbol->identifier (function).
• with-glsl-syntax (macro).

---

3.1.10 glsl-toolkit/transform.lisp

Dependency

sexpr.lisp (file).

Source

glsl-toolkit.asd.

Parent Component

glsl-toolkit (system).

Public Interface

• preprocess (function).
• transform (function).

Internals

• transform-to-core (function).
• transform-to-gles (function).

---

3.1.11 glsl-toolkit/method-combination.lisp

Dependency

transform.lisp (file).

Source

glsl-toolkit.asd.

Parent Component

glsl-toolkit (system).

Public Interface

combine-methods (function).

Internals

• definition-argvars (function).
• definition-identifier (function).
• (setf definition-identifier) (function).
• definition-signature (function).
• handle-function-definition (function).
• resolve-method-definitions (function).

---

3.1.12 glsl-toolkit/documentation.lisp

Dependency

method-combination.lisp (file).

Source

glsl-toolkit.asd.

Parent Component

glsl-toolkit (system).

---

5.1.1 Special variables

Special Variable: *glsl-keyword-symbols* ¶

List to all the keywords in GLSL shader files but as interned and upcased keyword symbols.

See *GLSL-KEYWORDS*

Package

glsl-toolkit.

Source

toolkit.lisp.

Special Variable: *glsl-keywords* ¶

List to all the keywords in GLSL shader files.

This does not include terminals and other keywords such as {}/*+ etc.

Package

glsl-toolkit.

Source

toolkit.lisp.

---

5.1.2 Symbol macros

Symbol Macro: no-value ¶

Package

glsl-toolkit.

Source

parser.lisp.

---

5.1.3 Macros

Macro: define-binary-op-walker (type) ¶

Define a walker for a binary AST object.

This walker recurses over the left and right nodes in the object and returns a fresh value constructed from them.

Package

glsl-toolkit.

Source

walker.lisp.

Macro: define-empty-op-walker (type) ¶

Define a walker for an empty AST object.

This walker function does nothing but construct a fresh return value.

Package

glsl-toolkit.

Source

walker.lisp.

Macro: define-object (name rule &body transform) ¶

Defines a parsing object.

The RULE should be a parsing rule to match against. It should probably contain calls to the V rule in order to populate the V values list. This list is used to store the return values of the object.

TRANSFORM is an optional list of forms to be evaluated to transform the values list on a successful match. It acts as an implicit PROGN and the last value is returned as the value of the rule.

If no TRANSFORM is given, the return value is the V values list prepended with the name of the rule.

See DEFINE-RULE

Package

glsl-toolkit.

Source

parser.lisp.

Macro: define-reference (name &body rules) ¶

Defines a reference parsing rule.

The body should be a number of sub-rules that may be matched in order to match this rule. Either the value stored in V by the V function, or the return value of the first matching sub-rule is returned.

See DEFINE-RULE

Package

glsl-toolkit.

Source

parser.lisp.

Macro: define-rule (name &body body) ¶

Defines a new parsing rule of the given name.

This will create a function definition in the ORG.SHIRAKUMO.TRIAL.GLSL.RULES package by re-interning the symbol in that package.

A default lexical binding named V is provided.

See DEFINE-REFERENCE
See DEFINE-OBJECT

Package

glsl-toolkit.

Source

parser.lisp.

Macro: define-serialization (type args &body body) ¶

Convenience function to define the serialization of AST objects of the given type.

ARGS must be a lambda-list to destructure the contents of the
AST object.

See SERIALIZER

Package

glsl-toolkit.

Source

printer.lisp.

Macro: define-serializer (type (object) &body body) ¶

Convenience function to define a serializer function for AST objects of the given type.

See SERIALIZER

Package

glsl-toolkit.

Source

printer.lisp.

Macro: define-unary-op-walker (type) ¶

Define a walker for a unary AST object.

This walker recurses over the single node in the object and returns a fresh value constructed from it.

Package

glsl-toolkit.

Source

walker.lisp.

Macro: define-walker (type (ast func env) &body body) ¶

Define a new walker function that is responsible for walking over a particular type of AST object node.

See *WALKERS*
See WALKER
See DEFINE-WALKING-BODY

Package

glsl-toolkit.

Source

walker.lisp.

Macro: define-walking-body (type args &body body) ¶

Convenience definition macro.

The ARGS should be a destructuring-bind lambda-list to destructure the contents of the object.

The body should be forms that provide the values to use in the resulting AST object. The last value should be the tail of the object’s list. Thus this is about equivalent to

(define-walker type (o)
(destructuring-bind .. (o)
(list* ’type body)))

Within the body the WALK function is rebound to one that can be conveniently used to recursively walk the AST. It only needs the new node to walk over. It optionally takes a new environment to supply.

You can reach the other function values like the full AST, the walk function, and the environment by changing the type to a list and providing the binding symbols as keyword arguments in it with :KEY :FUNC and :ENV.

See DEFINE-WALKER

Package

glsl-toolkit.

Source

walker.lisp.

Macro: with-indentation ((&optional step) &body body) ¶

Makes sure the body is evaluated with an increased indentation level.

See *INDENT*
See INDENT

Package

glsl-toolkit.

Source

printer.lisp.

Macro: with-token-input (vector &body body) ¶

Readies the environment for token parsing.

This binds *TOKEN-ARRAY* to the given vector and binds *TOKEN-INDEX* to 0.

See *TOKEN-ARRAY*
See *TOKEN-INDEX*

Package

glsl-toolkit.

Source

parser.lisp.

---

5.1.4 Compiler macros

Compiler Macro: advance (&optional offset) ¶

Package

glsl-toolkit.

Source

parser.lisp.

Compiler Macro: backtrack (&optional offset) ¶

Package

glsl-toolkit.

Source

parser.lisp.

Compiler Macro: consume () ¶

Package

glsl-toolkit.

Source

parser.lisp.

Compiler Macro: end-of-tokens-p () ¶

Package

glsl-toolkit.

Source

parser.lisp.

Compiler Macro: peek (&optional offset) ¶

Package

glsl-toolkit.

Source

parser.lisp.

Compiler Macro: sformat (string &rest args) ¶

Package

glsl-toolkit.

Source

printer.lisp.

---

5.1.5 Ordinary functions

Function: ! () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: != () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: % () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: %= () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: & () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: && () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: &= () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: ( () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: ) () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: * () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: *= () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: + () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: ++ () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: += () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: , () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: - () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: -- () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: -= () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: . () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: / () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: /= () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: : () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: ; () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: < () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: << () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: <<= () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: <= () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: = () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: == () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: > () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: >= () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: >> () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: >>= () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: ? () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: [ () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: ] () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: ^ () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: ^= () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: ^^ () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: addition () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: advance (&optional offset) ¶

Advances the current token index.

See *TOKEN-INDEX*
See BACKTRACK

Package

glsl-toolkit.

Source

parser.lisp.

Function: array-initializer () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: array-modifier () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: array-specifier () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: assignment () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: assignment-expression () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: backtrack (&optional offset) ¶

Reduces the current token index.

See *TOKEN-INDEX*
See ADVANCE

Package

glsl-toolkit.

Source

parser.lisp.

Function: basic-type () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: binding (name environment) ¶

Accessor to the binding in the environment for the given name.

See BINDINGS
See ENVIRONMENT

Package

glsl-toolkit.

Source

walker.lisp.

Function: (setf binding) (name environment) ¶

Package

glsl-toolkit.

Source

walker.lisp.

Function: bit-inversion () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: bitwise-and () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: boolean-constant () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: break () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: call-modifier () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: case-label () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: combine-methods (shaders) ¶

Performs method combination on the listed shader parts.

Each shader in SHADERS may be a string, pathname, stream, or shader AST.

The method combination replicates the CLOS standard method combination, including before/after/around, call-next-method, and next-method-p.

Any standard function definition is assumed to be a primary
method. Before, after, and around methods can be defined by suffixing the name with @before/@after/@around, respectively. Note that aside from the suffix the function signatures (including qualifiers, return type, and argument types, but not argument names) have to match exactly, as otherwise the functions are considered separate units.

Within any primary or around method body, the variable next_method_p is statically replaced with 1 or 0 depending on whether a next method is available or not, and a call to call_next_method is replaced with a call to the next method function. If no arguments are passed to call_next_method, the arguments are copied automatically. You can also make use of maybe_call_next_method, which is semantically the same as if(next_method_p) call_next_method(...);

If methods are defined without a single corresponding primary method, an error is signalled.

The order of method definitions is relevant in the following way:
- For @before, the later methods are called *first*
- For @after, the later methods are called *last*
- For @around, the later methods are called *first*
- For @primary, the later methods are called *first*

Example:

void foo@after(int x){ 1; }
int foo(int y){ return 2; }
int foo(int z){
if(next_method_p) return call_next_method();
return -1;
}
void foo@before(int w){ 0; }

See PARSE

Package

glsl-toolkit.

Source

method-combination.lisp.

Function: compile-rule (rule) ¶

Compile the rule s-expression.

The following types are handled specially:
- NULL NIL is returned
- KEYWORD Attempts to match a token that is EQ to this keyword. On success returns the keyword.
- SYMBOL Attempts to match the rule given named by the symbol. Returns whatever the rule returns.
- CHARACTER Attempts to match a token that is EQL to this character. Returns the character on match.
- STRING Attempts to match the string against the tokens. Returns the string on successful match.
- CONS One of the following compound, identified by the first symbol.
- AND Matches if all of the sub-rules match. Returns the last rule’s return value on successful match. - OR Matches if any of the sub-rules match.
Returns the first successful rule’s return value. - NOTANY Matches if none of the choices match.
Returns the token that did not match.
- ANY Matches if any of the choices match.
Returns the token that did match.
- WHEN Performs all the other sub-rules only if the first sub-rule matches. Returns the last sub-rule’s return value.
- V Makes sure the result of the sub-rule is added to the values list if the sub-rule matches. Returns what the sub-rule returned.
- * Repeatedly matches the sub-rule as many times as possible. Returns T.
- + Attempts to match the sub-rule at least once. Returns T on success.
- ? Attempts to match the sub-rule. If it does not match the secondary form is returned, or NO-VALUE. - ! Evaluates the sub-rule and returns its result, but always resets the token index to its initial value. - Otherwise the rule is returned unchanged.

See CONSUME-STRING
See CONSUME-ANY
See CONSUME-NOTANY
See DEFINE-RULE

Package

glsl-toolkit.

Source

parser.lisp.

Function: compound-statement () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: condition () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: condition-declarator () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: conditional () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: conditional-expression () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: constant-expression () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: constant-p (value environment) ¶

Returns T if the given AST node is a constant value.

Package

glsl-toolkit.

Source

walker.lisp.

Function: consume () ¶

Returns the token at the current index and advances the index by one.

See PEEK
See ADVANCE

Package

glsl-toolkit.

Source

parser.lisp.

Function: consume-any (choices) ¶

Consume any of the tokens in the choices sequence, if possible.

If a token matches, it is returned. Otherwise NIL is returned instead. The index is only modified if a match occurs.

Package

glsl-toolkit.

Source

parser.lisp.

Function: consume-notany (choices) ¶

Consume any token that is not one of the tokens in the choices sequence.

If a token matches, it is returned. Otherwise NIL is
returned instead. The index is only modified if a match
occurs.

Package

glsl-toolkit.

Source

parser.lisp.

Function: consume-string (string) ¶

Attempts to consume the given string from the token array.

If the string matches, it is returned. Otherwise, NIL is returned instead. If the match succeeds, the token index is modified. Otherwise it is reset to the point where it was before the match was attempted.

Package

glsl-toolkit.

Source

parser.lisp.

Function: consume-whitespace () ¶

Consumes all spaces and newlines in the token array from the current position on.

Package

glsl-toolkit.

Source

parser.lisp.

Function: continue () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: control-flow-p (value environment) ¶

Returns T if the given AST node is a control-flow instruction.

Package

glsl-toolkit.

Source

walker.lisp.

Function: decimal-token () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: declaration () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: declaration-p (value environment) ¶

Returns T if the given AST node is a declaration statement.

Package

glsl-toolkit.

Source

walker.lisp.

Function: decrement-modifier () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: discard () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: division () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: do-statement () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: end-of-tokens-p () ¶

Returns true if the end of the token array has been reached.

See *TOKEN-ARRAY*
See *TOKEN-INDEX*

Package

glsl-toolkit.

Source

parser.lisp.

Function: equal () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: exclusive-or () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: expression () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: expression-p (value environment) ¶

Returns T if the given AST node is an expression.

Package

glsl-toolkit.

Source

walker.lisp.

Function: expression-statement () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: field-modifier () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: float-constant () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: float-token () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: for-statement () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: function-declaration () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: function-definition () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: function-identifier-p (value environment) ¶

Returns T if the given AST node is an identifier for a function.

Package

glsl-toolkit.

Source

walker.lisp.

Function: function-prototype () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: global-identifier-p (value environment) ¶

Returns T if the given AST node is an identifier that refers to a global definition.

Package

glsl-toolkit.

Source

walker.lisp.

Function: greater-equal-than () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: greater-than () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: hexadecimal-token () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: identifier () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: identifier-p (value environment) ¶

Returns T if the given AST node might be an identifier.

This is not always accurate, as some identifiers can also be types at the same time. It thus depends on the context.

Package

glsl-toolkit.

Source

walker.lisp.

Function: identifier-token () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: inclusive-or () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: increment-modifier () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: indent (&optional offset) ¶

Starts a fresh line and emits as many spaces as the *INDENT* variable dictates.

Package

glsl-toolkit.

Source

printer.lisp.

Function: initializer () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: instance-name () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: integer-constant () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: integer-token () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: interface-declaration () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: interpolation-qualifier () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: invariant-qualifier () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: inversion () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: iteration-statement () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: jump-statement () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: keyword-p (value environment) ¶

Returns T if the given AST node is a GLSL keyword.

See *GLSL-KEYWORD-SYMBOLS*

Package

glsl-toolkit.

Source

walker.lisp.

Function: keyword-token () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: layout-qualifier () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: layout-qualifier-id () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: left-shift () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: less-equal-than () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: less-than () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: lex (input &optional toplevel-rule) ¶

Lex the input string into a token array for use in parsing.

See NORMALIZE-SHADER-SOURCE
See RULE
See PARSE

Package

glsl-toolkit.

Source

parser.lisp.

Function: local-identifier-p (value environment) ¶

Returns T if the given AST node is an identifier that refers to a local definition.

Package

glsl-toolkit.

Source

walker.lisp.

Function: logical-and () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: logical-or () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: logical-xor () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: make-environment (&optional parent) ¶

Create a new environment object.

If not parent environment is passed in, the environment is assumed to be a top-level root environment.

See ENVIRONMENT

Package

glsl-toolkit.

Source

walker.lisp.

Function: matching-declarators-p (a b) ¶

Returns true if the two variable declarations are considered to match.

This is true if:
- The first of both lists (qualifiers) match by MATCHING-QUALIFIERS-P - The second of both lists (specifiers) match by MATCHING-SPECIFIERS-P - The fourth of both lists (array-identifiers) match by EQUAL

The third of both lists (identifiers) must not match.
The fifth of both lists (initializers) must not match.

Package

glsl-toolkit.

Source

merge.lisp.

Function: matching-qualifiers-p (a b) ¶

Returns true if the two given qualifier lists are considered to match.

The following qualifier parts are not considered:
:HIGHP :MEDIUMP :LOWP :INVARIANT :PRECISE :SMOOTH :FLAT :NOPERSPECTIVE

All other qualifiers must match by EQUAL, but don’t have to be
in the same order.

See https://www.khronos.org/opengl/wiki/Shader_Compilation#Qualifier_matching

Package

glsl-toolkit.

Source

merge.lisp.

Function: matching-specifiers-p (a b) ¶

Returns true if the two given specifier lists are considered to match.

In order to match, the two lists have to be EQUAL.

Package

glsl-toolkit.

Source

merge.lisp.

Function: merge-shader-sources (sources &key to min-version profile) ¶

Convenience function to merge the sources of multiple shaders into a single one.

Each source may be a string, pathname, or shader AST.

See PARSE
See MERGE-SHADERS
See SERIALIZE

Package

glsl-toolkit.

Source

merge.lisp.

Function: merge-shaders (shaders &key min-version profile) ¶

Merge the given shader ASTs into a single AST.

The top-level AST nodes must be AST objects of type SHADER.

The merging will attempt to conflate declarations where possible and rename variables where necessary, in order to create a single shader that is internally consistent.

It also emits a single main function at the end, which does nothing but call the main function of each sub-shader in the sequence that the shaders were passed.

See HANDLE-DECLARATION
See HANDLE-IDENTIFIER
See WALK
See MERGE-SHADER-SOURCES

Package

glsl-toolkit.

Source

merge.lisp.

Function: modified-reference () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: modulus () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: multiple-expressions () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: multiplication () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: negation () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: normalize-shader-source (input) ¶

Attempts to normalise the shader source code.

This does the following:
- Removes any and all comments from the code
- Handles the backslash-before-newline trick to get multiple lines to act as one.
- Converts CRLF/LFCR/LFLF/CRCR into NEWLINE
- Converts TAB to SPACE
- Converts consecutive whitespace into singular whitespace while preserving newlines.

The input may be one of the following types:
- PATHNAME
- STRING
- STREAM

See NEWLINE-P

Package

glsl-toolkit.

Source

parser.lisp.

Function: not-equal () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: octal-token () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: operator () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: parameter-declaration () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: parse (input &optional toplevel-rule) ¶

Parses the given GLSL shader source input into an AST.

The input may be of the following types:
- STRING STREAM PATHNAME
The input is lexed before parsing as by LEX
- LIST
The input is converted into a vector
- VECTOR
The input is parsed by the given toplevel parsing rule.

See LEX
See RULE

Package

glsl-toolkit.

Source

parser.lisp.

Function: peek (&optional offset) ¶

Returns the token at the index relative to the current position.

See *TOKEN-ARRAY*
See *TOKEN-INDEX*

Package

glsl-toolkit.

Source

parser.lisp.

Function: postfix-expression () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: precise-qualifier () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: precision-declaration () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: precision-qualifier () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: prefix-decrement () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: prefix-increment () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: preprocess (source &key include-resolution) ¶

Package

glsl-toolkit.

Source

transform.lisp.

Function: preprocessor-directive () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: preprocessor-p (value environment) ¶

Returns T if the given AST node is a preprocessor instruction.

Package

glsl-toolkit.

Source

walker.lisp.

Function: preprocessor-token () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: primary-expression () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: reference-modifier () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: remove-rule (name) ¶

Removes the parsing rule of the given name.

Package

glsl-toolkit.

Source

parser.lisp.

Function: remove-serializer (type) ¶

Removes the serializer function for AST objects of the given type.

See *SERIALIZERS*
See SERIALIZER

Package

glsl-toolkit.

Source

printer.lisp.

Function: remove-walker (type) ¶

Removes the walker function for AST objects of the given type.

See WALKER
See *WALKERS*

Package

glsl-toolkit.

Source

walker.lisp.

Function: return () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: right-shift () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: root-environment-p (environment) ¶

Returns T if the environment is a top-level root environment.

See ENVIRONMENT
See ROOT

Package

glsl-toolkit.

Source

walker.lisp.

Function: rule (name) ¶

Returns the symbol that identifies the parsing rule of the given name.

This is a place that can be set with the function object
that should be used to parse the rule of the given name.

If no such rule exists, an error is signalled.

Package

glsl-toolkit.

Source

parser.lisp.

Function: (setf rule) (name) ¶

Package

glsl-toolkit.

Source

parser.lisp.

Function: same-+ () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: selection-statement () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: serialize (part &optional to) ¶

Serializes the AST part to shader source.

TO may be one of the following:
- NULL
The output is gathered into a string and returned. - T
The output is sent to *STANDARD-OUTPUT*.
- STREAM
The output is sent to this stream.
- PATHNAME
The output is written to the file. If the file already exists, an error is signalled.

See *SERIALIZE-STREAM*
See SERIALIZE-PART

Package

glsl-toolkit.

Source

printer.lisp.

Function: serialize-part (part) ¶

Serializes the AST part.

This appropriately handles all values that can be contained in the AST. For AST objects, an appropriate serializer function is called if possible. Should an unknown AST object occur, an error is signalled.

See SERIALIZER

Package

glsl-toolkit.

Source

printer.lisp.

Function: serializer (type) ¶

Accessor to the serializing function for AST objects of the given type.

See *SERIALIZERS*
See DEFINE-SERIALIZER
See REMOVE-SERIALIZER

Package

glsl-toolkit.

Source

printer.lisp.

Function: (setf serializer) (type) ¶

Package

glsl-toolkit.

Source

printer.lisp.

Function: sformat (string &rest args) ¶

Convenience function used to format to the serializing stream.

A special format directive ~O is provided as well, which causes SERIALIZE-PART to be called on the respective object.

Package

glsl-toolkit.

Source

printer.lisp.

Function: shader () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: simple-statement () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: statement () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: statement-p (value environment) ¶

Returns T if the given AST node is a statement.

See DECLARATION-P
See EXPRESSION-P
See CONTROL-FLOW-P

Package

glsl-toolkit.

Source

walker.lisp.

Function: storage-qualifier () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: struct-declaration () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: struct-declarator () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: struct-field-declarator () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: struct-specifier () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: subroutine-qualifier () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: subtraction () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: switch-statement () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: token () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: tokenize () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: trace-parse () ¶

Cause all parse rule functions to emit tracing information.

See UNTRACE-PARSE
See TRACE-PARSE-FUNC

Package

glsl-toolkit.

Source

parser.lisp.

Function: transform (source profile version) ¶

Package

glsl-toolkit.

Source

transform.lisp.

Function: type-name () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: type-qualifier () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: type-specifier () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: type-specifier-nonarray () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: unary-expression () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: uniquify (table &optional name) ¶

Create a (hopefully) unique identifier for the given name.

The returned name is prefixed by two underscores. Identifiers like that are reserved for use by the underlying library or framework (us), so there should not be any clash with user identifiers unless the shader is not conforming to begin with.

See *UNIQUE-COUNTER*

Package

glsl-toolkit.

Source

merge.lisp.

Function: untrace-parse () ¶

Make all parse rule functions cease to emit tracing information.

See TRACE-PARSE
See UNTRACE-PARSE-FUNC

Package

glsl-toolkit.

Source

parser.lisp.

Function: variable-declaration () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: variable-identifier-p (value environment) ¶

Returns T if the given AST node is an identifier for a variable.

Package

glsl-toolkit.

Source

walker.lisp.

Function: variable-initializer () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: walk (ast function &optional environment) ¶

Walk over the AST, calling FUNCTION on each interesting node.

Returns a fresh AST that was constructed by the function.

The function will be called with three arguments:
- The AST node at the current point
- The surrounding context in which the AST node is
- The environment object that maintains lexical information

The function should return a single value, which is the value that should be put into a fresh AST in place of the original node.

Note that calling any of the environment inspection functions on an identifier in a lower level than the current AST node that the function received is not going to work. The lexical information is only guaranteed to be ready by the time the function is called with the identifier itself.

See ROOT-ENVIRONMENT-P
See PREPROCESSOR-P
See CONSTANT-P
See DECLARATION-P
See EXPRESSION-P
See CONTROL-FLOW-P
See KEYWORD-P
See STATEMENT-P
See IDENTIFIER-P
See GLOBAL-IDENTIFIER-P
See LOCAL-IDENTIFIER-P
See VARIABLE-IDENTIFIER-P
See FUNCTION-IDENTIFIER-P
See ENVIRONMENT
See WALK-PART

Package

glsl-toolkit.

Source

walker.lisp.

Function: walk-part (ast context function environment) ¶

Walk over the given AST node.

On AST objects, this will call out to the respective walker function.

See WALKER

Package

glsl-toolkit.

Source

walker.lisp.

Function: walker (type) ¶

Accessor to the walker function for AST objects of the given type.

See *WALKERS*
See REMOVE-WALKER
See DEFINE-WALKER

Package

glsl-toolkit.

Source

walker.lisp.

Function: (setf walker) (type) ¶

Package

glsl-toolkit.

Source

walker.lisp.

Function: while-statement () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: whitespace () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: { () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: | () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: |= () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: || () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

Function: } () ¶

Package

glsl-parser-rules.

Source

grammar.lisp.

---