CW Plugin API - Questions for All
by Sam Bacsa · 03/14/2006 (6:06 am) · 4 comments
Greetings fellow Torquers,
I'm putting the finishing touches on the next release of Codeweaver, which will be graduated out of delta and into RC (release candidate).
I expect this coming version to be one of two RCs as I fix up bugs created by enabling the plugins architecture.
I've implemented a bunch of API calls to the IDE (this does not include the events that the IDE triggers given certain states [ie, file close, open, etc]).
Below is the list of the complete set of API calls to the IDE (in a nice image format, since I don't want to re-type them all, heh).
If you are thinking about developing a plugin, and would like an API call of somesort (given the current and future functionality of CW), please add it here!
Note: This listing does not include the API for SCC plugins. That's a separate thing that's still being ironed out.
Thanks!
- Sam Bacsa
PS - If you'd rather e-mail me, you can do so to the email in my profile.
PPS --
A couple of calls that may need to be clarified because there's not much information:
AddIndicatorSpan - Adds a line indicator to the editor (like the red breakpoints or the yellow instruction pointers)
AddIndicatorIcon - Only add an icon in the margin, and no colorful span.
RegisterEditorTrigger - Executes your trigger whenever your conditions are true (key pressed w/ modifiers in specific state [comment, string, function declaration, etc])
IntellicodeScan*** - Returns syntax errors
IntellicodeDisplay*** - Displays memberlist or infopop (function tip) based on the collection given
RegisterWindow - Dockable workspace window like Project Explorer
Also, something that didn't make it into the screenshot (why, I don't know) --
AddIndicatorSquiggly - Squiggle underline in custom color from offset to offset
I'm putting the finishing touches on the next release of Codeweaver, which will be graduated out of delta and into RC (release candidate).
I expect this coming version to be one of two RCs as I fix up bugs created by enabling the plugins architecture.
I've implemented a bunch of API calls to the IDE (this does not include the events that the IDE triggers given certain states [ie, file close, open, etc]).
Below is the list of the complete set of API calls to the IDE (in a nice image format, since I don't want to re-type them all, heh).
If you are thinking about developing a plugin, and would like an API call of somesort (given the current and future functionality of CW), please add it here!
Note: This listing does not include the API for SCC plugins. That's a separate thing that's still being ironed out.
Thanks!
- Sam Bacsa
PS - If you'd rather e-mail me, you can do so to the email in my profile.
PPS --
A couple of calls that may need to be clarified because there's not much information:
AddIndicatorSpan - Adds a line indicator to the editor (like the red breakpoints or the yellow instruction pointers)
AddIndicatorIcon - Only add an icon in the margin, and no colorful span.
RegisterEditorTrigger - Executes your trigger whenever your conditions are true (key pressed w/ modifiers in specific state [comment, string, function declaration, etc])
IntellicodeScan*** - Returns syntax errors
IntellicodeDisplay*** - Displays memberlist or infopop (function tip) based on the collection given
RegisterWindow - Dockable workspace window like Project Explorer
Also, something that didn't make it into the screenshot (why, I don't know) --
AddIndicatorSquiggly - Squiggle underline in custom color from offset to offset
#2
But I do back Jay B. on the Find dialog not getting immediate focus...Not a huge issue, but I use it every few minutes, and the operation makes a noticeable stall in the workflow...so that's a lot of time that could easily be spent elsewhere.
Otherwise, I really really love the program and couldn't live without it :)
03/14/2006 (6:50 pm)
I started using Codeweaver 3 weeks ago. LOVE IT!!!!!!!But I do back Jay B. on the Find dialog not getting immediate focus...Not a huge issue, but I use it every few minutes, and the operation makes a noticeable stall in the workflow...so that's a lot of time that could easily be spent elsewhere.
Otherwise, I really really love the program and couldn't live without it :)
#3
I guess I thinking how this could be useful for the SCC plugins, to give some kind of visual status of files (checked out, non-head version, etc). You might want to also think of including some official status icons for SCC, ie, the same icons you currently use but with a little checkmark in the upper right for "checked out files", exclamation mark for those files which are in the head revision, etc.
03/15/2006 (5:52 am)
Sam, I noticed you have a AddProjectTreeIconResource function, but do you have a function to actually change the icons for specified files/folders in the project tree?I guess I thinking how this could be useful for the SCC plugins, to give some kind of visual status of files (checked out, non-head version, etc). You might want to also think of including some official status icons for SCC, ie, the same icons you currently use but with a little checkmark in the upper right for "checked out files", exclamation mark for those files which are in the head revision, etc.
#4
@Simon - Glad CW is working nicely for you :) That problem will definitely be fixed :)
@Robert - There currently is an "event" that is called, called "CWFileNeedIconIndex", when the IDE wants to find out what icon is assigned to a file. I've been thinking about adding an "icon" property to files instead, where the plugin would set the icon separately, and the IDE would display the icon appropriately.
As for providing icons for SCC, that's definitely possible.
Thanks :)
- Sam
03/15/2006 (6:43 pm)
@Jay - Yep, all those things that you listed are already slated to be fixed in the coming version. Thanks :)@Simon - Glad CW is working nicely for you :) That problem will definitely be fixed :)
@Robert - There currently is an "event" that is called, called "CWFileNeedIconIndex", when the IDE wants to find out what icon is assigned to a file. I've been thinking about adding an "icon" property to files instead, where the plugin would set the icon separately, and the IDE would display the icon appropriately.
As for providing icons for SCC, that's definitely possible.
Thanks :)
- Sam
Torque 3D Owner Jay Barnson
There are also some problems it has with parsing some of the code in the common and editor area - you've probably seen that. For some reason it thinks that there are syntax errors in about three places. But I know what they are, and I've learned to ignore 'em.
Oh, and I finally got around to doing the integrated debugging, and it worked great with the wizard.
This is an excellent tool (my few complaints aside). Fantastic job!