Embedded SQL-Syntax only works for inline SQL

[screeny05]

Used Atom Version: 1.0
Expected behaviour: Correct highlighting of SQL within PHP-Strings
Has this ever worked: No

Highlighting of SQL within strings is a very useful feature, but there's a little problem:

the language-php package only seems to highlight them if the beginning of the sql-statement lies on the same line as the opening of the string with quotation marks.

(Notice, that Lines 6-8 are all green)

[zr9]

Atom uses textmate like grammar, if main principles of grammar is same then this one is impossible.
Textmate grammar limited to 1 rule per line, so it not possible to match few lines with 1 regex, here is info about that behavior Textmate Grammar

That problem require a multiline matching of text, because it is not possible otherwise distinguish SQL string from regular string basing only on quote.

Someone can fill bug/question about grammar to core devs?

[thisispiers]

any updates? an issue where the string is incorrectly ended occurs with concatenated, embedded sql and it screws up the highlighting of the rest of the file

[zr9]

@thisispiers You probably talking about other one, could you post test example which code broke highlight? That one is related only to case when you not get correct highlight if SQL is not single line.

[Arcanemagus]

This is the same issue as #52, the switch to SQL gets broken with any break in the string. (Including, apparently, a newline.)

[winstliu]

@Arcanemagus I'm going to keep this one separate just in case.

[zr9]

@Arcanemagus @50Wliu
In concept of bugs this is 2 different issues, #52 can be solved. When this one almost nope. Since tokenizer not support multiline capture

[winstliu]

Since tokenizer not support multiline capture

Yes it does: just use begin/end instead of match.

[zr9]

@50Wliu Yup in global it does. Problem so being and end is match only edges, and in that case there will be no different between SQL inside quotes and Str inside quotes. For detect this case there is need proper multiline regex with checks what is between begin and end. So for example is not possible to make expression(as simple example) like /"\s*SELECT.*"/ because part .* not catch multiline.

The other way to do it, is do quotes support in grammar and all cases inside them, it works if i'm correctly recall atom and textmate grammar. But itself way take too much time and efforts and still can give false positive in that case.

The third way is to set begin and end to some uniq to SQL tokens, problem so SQL not have some special end token.

[james-radford-854]

We could match /"\s*--\s*SQL$/, which would match the following:

$foo = "-- SQL
    SELECT *
    FROM users
    WHERE foo = 'bar'
";

[zr9]

@james-radford-854 That is a bit crazy way to invent syntax to cover highlight i'm would say. Since in that case everyone need to agree on that way and keep it, which i'm assume not happens. But yup will work in total

[PeteDevoy]

I assume most people use PDO now and most people name their variables for SQL $sql, $query or $statement. So if the code could pattern match for ->exec(, ->prepare(, $sql =, etc. it might be an acceptable compromise?

̣Even if it's a bad idea because of false positives I would like to try for myself anyway. Please could someone tell me where in the file I would need to write the patterns? Disregard that, looks like there is no easy way to hack at the grammar files.

[zr9]

@PeteDevoy It basically not hard, you need file /grammars/php.cson. And you need to use begin/end to capture multiline, end in your case probably will be /["'];/ and begin some like /$sql\s*=/. But please keep in mind it only examples, in reality you need to set them in synergy with others, because if i'm not wrong if you capture group which belongs to other then other will fall. May be wrong since used grammar a bit time ago. As reference look on string-double-quoted group, it almost close to perfect example i'm assume, since it have not only group capture but pattern include as well. And please keep in mind so your end syntax need too be a unique string, since if i'm not wrong it dumb capture, and so it captures without patterns check and then only start pattern checking.

[PeteDevoy]

@zr9 Yes, thanks the tips. What you are saying sounds perfectly correct but unfortunately I do not think /grammars/php.cson in file:///~/.atom/? I believe I would have to change at source and then do a custom build. Although it might be simple technically speaking, custom building Atom sounds like a it cause headaches :(