Rework of SDC syntax definition for Issue #4 EOL Comments

[Remillard]

1. Added *.sublime-project to the .gitignore because I tend to keep the project file in the project area.
2. Removed the original syntax files that were in TextMate format.
3. After a few false starts, realized that SDC is effectively just Tcl with special commands.
4. The Tcl syntax definition already scopes command words that aren't part of the base command set, so that takes care of all the actual special commands. I added two contexts for the special SDC switches frequently seen that were in the original syntax file.
5. Note that I removed the all caps versions of the switches simply because we can put in a (?i) and made the regular expression case-insensitive.
6. Known issues are due to the Tcl syntax at this point. Due to the way Tcl inconsistently uses {} there are some guesses made by the Tcl syntax as to whether to scope the text inside a {} as a string, or as a command block. Additionally, Tcl does not know all switches to all commands and largely doesn't try to figure it out, so the SDC switches (like -add_delay) will be scoped in SDC mode, however regular Tcl switches will not be scoped. For the most part this doesn't matter unless writing really elaborate SDC files (I tested it with some automatically generated DDR SDC files and it did alright, though you'll start to see some weaknesses in the basic Tcl syntax.)

[leoheck]

Awesome @Remillard, thank you for your PR. I will review it later.

[leoheck]

I am testing it right now, and I saw that words ending with a number are wrong:

I don't like this behavior. I don't know if it was caused by your PR I have to verify.

[leoheck]

Something to check.

[leoheck]

Ah, just answering your items,

1. Added *.sublime-project to the .gitignore because I tend to keep the project file in the project area.
2. Removed the original syntax files that were in TextMate format.

Cool, awesome.

3. After a few false starts, realized that SDC is effectively just Tcl with special commands.

Yes, it is.

4. The Tcl syntax definition already scopes command words that aren't part of the base command set, so that takes care of all the actual special commands. I added two contexts for the special SDC switches frequently seen that were in the original syntax file.

Ok.

5. Note that I removed the all caps versions of the switches simply because we can put in a (?i) and made the regular expression case-insensitive.

Good!

6. Known issues are due to the Tcl syntax at this point. Due to the way Tcl inconsistently uses {} there are some guesses made by the Tcl syntax as to whether to scope the text inside a {} as a string, or as a command block. Additionally, Tcl does not know all switches to all commands and largely doesn't try to figure it out, so the SDC switches (like -add_delay) will be scoped in SDC mode, however regular Tcl switches will not be scoped. For the most part this doesn't matter unless writing really elaborate SDC files (I tested it with some automatically generated DDR SDC files and it did alright, though you'll start to see some weaknesses in the basic Tcl syntax.)

Ok, I agree with that.

[Remillard]

Those are probably in the base TCL syntax. I could try to override it maybe. The problem is that TCL is not really precise when it comes to token names. I'll see what I can do tomorrow.

[leoheck]

Yeah, I agree with you. I am almost about to merge your PR. So, if you can give it a try I will wait until the end of the week. We can also fix these things later.

[Remillard]

I've got to do some constraint work this afternoon so it'll be a perfect time to try to figure out if there's anything that can be done about the numeric constant issue.

[Remillard]

Okay as for the numeric constants, I think you have something else doing that to you. I see the following (just typing in one of your constraints into my own SDC file)

I have a little routine in VHDL mode that is a scope sniffer at the point which is handy for navigating the details. If I put the point at the 18 that colored wrongly for you, I don't see any scope that would indicate numeric constant. So I don't know what to chalk that up to. Additionally in my own constraints I have the following:

where I also have some strings that have numbers inside them and they are colored as a string, though that is definitely one of the quirks of the TCL syntax module in Sublime. They say if there is no space between curly brace and the first character like {test text} then it treats it as a string. If there is a space like: { probably_command_word } then it treats it like a list of command words.

So I can't explain your number constant issue.

I can add capacitance and time switches quite easily and will do that.

[Remillard]

Okay, with the time and capacitance, it looks like that's covered already: I see the following with your example:

[Remillard]

The only thing I can think is that you might need to reselect the syntax type? If you have both the old file and the new file around, your SDC file might have selected the original? I know the original had the number issue -- I don't know about the keyword. Make sure it says "Synopsys Design Constraints". I made that the full name instead of just SDC.

[leoheck]

Oh, cool, that looks good.