jshrake / jshrake/glsl-include

#include directive in block comments is expanded

Open
#1 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Rust
Stars
5
Forks
3
PR merge metrics
No merged PRs in 30d

Description

Consider the following failing test case:

// A.glsl
void A () {}
// main.glsl
/*
#include <A.glsl>
*/

void main () {}

Currently, the preprocessor expands the code to

// main.glsl
/*
void A () {}
*/

void main () {}

However, the expectation is that the source input is unchanged:

// main.glsl
/*
#include <A.glsl>
*/

void main () {}

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the preprocessor handling of the shown main.glsl input and compare it with the expected unchanged source. Add a regression test using A.glsl and main.glsl, then verify that an #include inside the block comment is preserved while active directives still expand.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
compilers
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.