flatc -M: escape make-special characters in depfiles - #9207
Open
vee1e wants to merge 1 commit into
Open
Conversation
flatc -M emits dependency rules containing filenames as-is. Characters that are special to make ($ # : space \) are not escaped, so a schema whose include path contains any of them produces a depfile that make or Ninja mis-parses. GCC and Clang escape these in -M/-MD output, and glslang does the same via writeEscapedDepString. Add EscapeMakeDep and apply it to every active GenerateMakeRule site, and emit the rule as a single line instead of word-wrapping (wrapping splits escaped filenames on their spaces).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
flatc -M writes dependency rules with filenames unescaped. Make treats $, #, :, space, and backslash as syntax, so a schema whose include path contains any of them produces a depfile that make or Ninja parses wrong. For example an include named
my schema#1.fbsyields a rule that make splits at the space and truncates at the#.GCC and Clang already escape these characters in their -M/-MD output, and glslang does the same with its writeEscapedDepString helper. This change matches that behavior.
What it does:
Brackets are intentionally not escaped: Ninja's depfile parser does not unescape [, so escaping them would corrupt filenames for that consumer.
Adds a unit test covering the five characters, combined input, a trailing backslash, and empty and plain filenames.