1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

//! `glsl-lang` is a crate implementing a LALR parser for the GLSL 4.x language,
//! with partial support for preprocessor directives. Its AST and features are
//! modeled after [Dimitri Sabadie's `glsl` crate](https://github.com/phaazon/glsl).
//!
//! See the [homepage](https://github.com/vtavernier/glsl-lang) for more detailed comparison
//! elements.
//!
//! # Examples
//!
//! ## Parsing GLSL
//!
//! ```
//! use glsl_lang::{ast, parse::DefaultParse};
//!
//! // Some GLSL source to parse
//! let source = r#"void main() {
//!     gl_FragColor = vec4(1., 0.5, 0.25, 1.);
//! }"#;
//!
//! // Try parsing the source
//! let ast = ast::TranslationUnit::parse(source);
//! assert!(ast.is_ok());
//! ```
//!
//! # Crate features
//!
//! This crate has the following features:
//! - `parser-expr`: generate parser code for parsing GLSL expressions
//! - `parser-statement`: generate parser code for parsing GLSL statements
//!
//! None of these features are enabled by default, as they significantly increase the compile
//! times. As an alternative, you may use the [`Parsable`](crate::parse::Parsable) trait, which
//! wraps grammar rules in suitable source and matches the result to extract the part of the AST
//! we're interested in.
//!
//! ```
//! // parse::Parse is not implemented for ast::Expr with the default features
//! use glsl_lang::{ast, parse::Parsable};
//!
//! let source = "a = b ? 1.0 : 0.0";
//!
//! // Parse with Parsable::parse
//! let ast = ast::Expr::parse(source);
//! assert!(ast.is_ok());
//! ```
//!
//! # Useful links
//!
//! - [The OpenGL Shading Language Version 4.60](https://www.khronos.org/registry/OpenGL/specs/gl/GLSLangSpec.4.60.pdf)

#![deny(missing_docs)]

use lalrpop_util::lalrpop_mod;

#[cfg(any(
    feature = "lexer-v1",
    feature = "lexer-v2-min",
    feature = "lexer-v2-full"
))]
pub use glsl_lang_lexer as lexer;
pub use glsl_lang_types::ast;
lalrpop_mod!(
    #[allow(clippy::all)]
    parser
);
pub mod parse;
pub mod transpiler;
pub mod visitor;

#[cfg(all(
    test,
    any(
        feature = "lexer-v1",
        feature = "lexer-v2-min",
        feature = "lexer-v2-full"
    )
))]
mod parse_tests;