BracketHighlighter2 BETA Branch

[facelessuser]

Just paste the php define before tags. Order counts in the settings file.

[pre=#2D2D2D] // PHP enclosure
{
“name”: “php_enclosure”,
“open”: “(<\?php)”,
“close”: “(\?>)”,
“icon”: “angle”,
“color”: “brackethighlighter.angle”,
“style”: “underline”,
“language_filter”: “whitelist”,
“scope_exclude”: “string”, “comment”, “keyword.operator”],
“language_list”: “HTML”, “HTML 5”, “XML”, “PHP”, “HTML+CFML”, “ColdFusion”, “ColdFusionCFC”],
“enabled”: true
},
// HTML Tags
{
“name”: “tag”,
“open”: “(<)”,
“close”: “(>)”,
“icon”: “tag”,
“color”: “brackethighlighter.tag”,
“style”: “outline”,
“language_filter”: “whitelist”,
“scope_exclude”: “string”, “comment”, “keyword.operator”],
“language_list”: “HTML”, “HTML 5”, “XML”, “PHP”, “HTML+CFML”, “ColdFusion”, “ColdFusionCFC”],
“plugin_library”: “bh_modules.tags”,
“enabled”: true
},[/pre]

[vitaLee]

@facelessuser is that a custom color scheme you’re using?
care to share?

[iamntz]

Man, you are awesome! Thanks a lot, now looks beautiful!

Btw, there is a way we can reward you for the awesome job you do? A paypal account maybe?

[facelessuser]

[quote=“iamntz”]Man, you are awesome! Thanks a lot, now looks beautiful!

Btw, there is a way we can reward you for the awesome job you do? A paypal account maybe? [/quote]

Yeah, when you click it, it references a different project, but you can go here.

https://www.paypal.com/en_US/i/btn/btn_donateCC_LG.gif

[quote=“vitaLee”]@facelessuser is that a custom color scheme you’re using?
care to share?[/quote]

Sure, it is a modified Tomorrow-Night-Eighties theme.

Here is the gist gist.github.com/3946761.

It isn’t perfect yet. Tomorrow-Night by default highlights some things I don’t want it to in some languages, I have changed most of those cases though. Also, there is a number of personal scopes in there you can keep or remove. And one more thing, some things that you see mine highlight won’t highlight on yours because I use some modified languages that insert some special scopes for my theme to trigger off of, but in general, it should work fine for you.

[iamntz]

Found a small bug (i think).
So…

If the matching group consist in more than one char, like, let’s say <?php ?> thing and one it’s invalid, it should stop highlight when you focus it. Don’t know if this make sense, but try to look at the movie (i only moved left/right with arrow keys):

(http://img.iamntz.com/jing/2012-10-25_2114.swf)

//edit:
actually scratch that, me dumb!

[iamntz]

Ok, so, as i said, me dumb
I’m trying to make ST to also highlight if/endif foreach/endforeach and so on in php. What i have now (after like 50 different combinations or so) is this:

open": "(^if|foreach|while.+:$)", "close": "(^endif|endforeach|endwhile;$)",

But will not match correctly what i need (php have two ways of doing blocks; one is with if/endif and the other is with curly braces)

However, if i’ll do only this:

"open": "(^if.+:$)", "close": "(^endif;$)",

works good…ish. Because will make things red (which is an error) when i focus inside of the condition:

While things are peachy when i’m inside of the block:

What do i do wrong?

Thanks!

[facelessuser]

[quote=“iamntz”]Ok, so, as i said, me dumb
I’m trying to make ST to also highlight if/endif foreach/endforeach and so on in php. What i have now (after like 50 different combinations or so) is this:

open": "(^if|foreach|while.+:$)", "close": "(^endif|endforeach|endwhile;$)",

But will not match correctly what i need (php have two ways of doing blocks; one is with if/endif and the other is with curly braces)

However, if i’ll do only this:

"open": "(^if.+:$)", "close": "(^endif;$)",

works good…ish. Because will make things red (which is an error) when i focus inside of the condition:

While things are peachy when i’m inside of the block:

What do i do wrong?

Thanks![/quote]

You are doing nothing wrong. What you need is a bracket plugin that taps into the compare event. During that event, you would need to compare the values to help sort out which closing bracket goes with which opening bracket. Give me an hour or so and I will try and show you what I mean. You are diving into undocumented awesomeness.

[facelessuser]

Okay, I got to it quite a bit earlier…

Tweak this to your liking:
[pre=#2D2D2D] {
“name”: “php_keywords”,
“open”: “^\s*(if|foreach|while.+:$)”,
“close”: “^\s*(endif|endforeach|endwhile;$)”,
“icon”: “dot”,
“color”: “brackethighlighter.tag”,
“style”: “underline”,
“language_filter”: “whitelist”,
“scope_exclude”: “string”, “comment”],
“language_list”: “HTML”, “HTML 5”, “XML”, “PHP”, “HTML+CFML”, “ColdFusion”, “ColdFusionCFC”],
“plugin_library”: “User.phpkeywords”,
“enabled”: true
},[/pre]

Here is the awesome sauce…save as User/phpkeywords.py
[pre=#2D2D2D]def compare(name, first, second, bfr):
return “end” + bfrfirst.begin:first.end] == bfrsecond.begin:second.end][/pre]

Not so bad eh?

[vitaLee]

is it a default behaviour for Sublime to add icon in the gutter for each line of a multiline underlined (mouthful) region, or it’s something you control?
i found myself exploitinhg BH2 in attempt to match Obj-C @interface @implementation directives and noticed if i use style:underline for each line of the opening “bracket” there’s an icon in gutter, while the same is not true for outline, solid (icon only on first line).

[facelessuser]

Sorry, got a little careless:

[pre=#2D2D2D]def compare(name, first, second, bfr):
opening = bfrfirst.begin:first.end]
closing = bfrsecond.begin:second.end]
match = False
if opening.startswith(“while”):
if closing.startswith(“endwhile”):
match = True
else:
match = “end” + bfrfirst.begin:first.end] == bfrsecond.begin:second.end]
return match[/pre]

That should be better.

[facelessuser]

[quote=“vitaLee”]is it a default behaviour for Sublime to add icon in the gutter for each line of a multiline underlined (mouthful) region, or it’s something you control?
i found myself exploitinhg BH2 in attempt to match Obj-C @interface @implementation directives and noticed if i use style:underline for each line of the opening “bracket” there’s an icon in gutter, while the same is not true for outline, solid (icon only on first line).[/quote]

Underline is a trick. It isn’t like a normal region. There is no underline style really. There is an option in Sublime that says if a region is size 0, you can render it as an underline. So, to simulate an underline region, I take region X, Y and break it up into a series of zero size regions. So really an underline (y-x) regions, not one. That is why multi-line will show multiple icons. Because each underlined character is its own region.

[iamntz]

Thanks! Works… partially

because it also match if(){} expressions (and it shouldn’t)

what i came up is this pattern:

            "open": "^\\s*(if|foreach|while).*:$",
            "close": "^\\s*(endif|endforeach|endwhile;$)"

Thing is… while in regexbuddy works just fine, in editor it doesn’t. Most likely i do some escaping wrong. Any idea which is that? Thanks!

Btw, i noticed that if there is an error somewhere in the config file, the plugin stop to works until i restart ST. It’s a bug, a feature or a bit of both?

[facelessuser]

[quote=“iamntz”]Thanks! Works… partially

because it also match if(){} expressions (and it shouldn’t)

what i came up is this pattern:

            "open": "^\\s*(if|foreach|while).*:$",
            "close": "^\\s*(endif|endforeach|endwhile;$)"

Thing is… while in regexbuddy works just fine, in editor it doesn’t. Most likely i do some escaping wrong. Any idea which is that? Thanks!

Btw, i noticed that if there is an error somewhere in the config file, the plugin stop to works until i restart ST. It’s a bug, a feature or a bit of both? [/quote]

I need to think about this. Basically the open regex and close regex occur on separate passes. So for “if():” the open regex gobbles up “(” and “)”, but the close pass finds “)”. So when the brackets get resolved, it can’t pair up “)”, because the open got gobbled up in “if():”.

Basically, the this is a case where the open regex intersects with the close. I need time to think how to resolve this issue.

As for the plugin stopping working on bad settings file? I will have to think about how to gracefully handle that as well.

[facelessuser]

@iamntz
I need to change the algorithm to do opening and closing in one pass. I have it working on my computer, but I need to stream line it. I guess it will actually be a little quicker this way.

I will let you know when it is done, maybe sometime in the next couple of days.

[iamntz]

I will let you know when it is done, maybe sometime in the next couple of days.

I survived about 4-5 years without that highlight, I guess i’ll handle it few more days!

Thanks!

[sublimator]

Dunno what you doing exactly but look ahead / behinds?

[facelessuser]

Dunno what you doing exactly but look ahead / behinds?

Yes lookaheads will help him because they won’t capture, and can allow things like “()” to be used twice, but regardless it is probably better to do find opening and closing in one shot to limit confusion.

With the current implementation of processing opening and closing separately, it is easy for a user to not really understand what is happening. They expect if they capture something in opening, it shouldn’t be captured in closing.

I should have a fix posted in a couple of minutes. I will also post a solution for your problem @imantz using lookaheads.

[facelessuser]

Fix is in on the alpha branch.

Based on your earlier config, try this (I am not entirely sure what you are looking for, so I have just adapted your earlier post):

[pre=#2D2D2D] {
“name”: “php_keywords”,
“open”: “^\s*\b(if|foreach|while)\b(?=.:$)",
“close”: "^\s\b(endif\b|endforeach\b|endwhile(?=;$))”,
“icon”: “dot”,
“color”: “brackethighlighter.tag”,
“style”: “underline”,
“language_filter”: “whitelist”,
“scope_exclude”: “string”, “comment”],
“language_list”: “HTML”, “HTML 5”, “XML”, “PHP”, “HTML+CFML”, “ColdFusion”, “ColdFusionCFC”],
“plugin_library”: “User.phpkeywords”,
“enabled”: true
},[/pre]

A much simplier phpkeywords.py now:
[pre=#2D2D2D]def compare(name, first, second, bfr):
return “end” + bfrfirst.begin:first.end].lower() == bfrsecond.begin:second.end].lower()[/pre]

Just to be safe, restart ST2 when you update BH to the latest commit.

Edit: The regex is a little sloppy and can be cleaned up, but it is fine for a starting point.

[vitaLee]

Yes, lookaheads might help but the problem is they won’t capture.
The consequence of that will be if later you’d like to take advantage of other features like “select between brackets”, “remove brackets”, “go to opening/closing bracket” you’ll have problems with leftovers that were’t captured, etc…

[facelessuser]

[quote=“vitaLee”]Yes, lookaheads might help but the problem is they won’t capture.
The consequence of that will be if later you’d like to take advantage of other features like “select between brackets”, “remove brackets”, “go to opening/closing bracket” you’ll have problems with leftovers that were’t captured, etc…[/quote]

Yes, there will be a tradeoff. If you use lookaheads, “select between brackets” will grab the “()” brackets which may not be desirable. If you don’t use the lookaheads. BH will not match the “()”. The good news is I fixed the issue where BH would find the closing bracket twice, now it will just ignore it.

The tradeoff is a limitation of BH. The needed complexity of recursive bracket matching to overcome this I don’t think is worth it, but it could be a possibility in the future if it is really required, but I will push back on it for now.