Headers2Glossary
Headers2Glossary is a Perl script written for the purpose of taking Apple's header files (aka. Universal Headers, CarbonLib Headers, etc.) and converting them into glossaries for use in BBEdit.
Glossaries are a sort of snippet collection. They appear in hierarchical list form in a separate window. Items can be double clicked to be inserted into the current editing document.
Here is a sample of a glossary for the URL Access Manager:
Double clicking on the constants or the datatypes pastes that constant or datatype into the document -- great for quick reference. Double clicking on the function pastes the function definition in the document.
The greatest thing about this program is the promise that your reference material will always be current with the headers your are compiling against. When a new version of the headers comes from Apple it will be a simple drag and drop to get the latest information into BBEdit. At least, that's the idea...
Headers2Glossary is in a very early stage. Right now I need people to use it and tell me what works or doesn't work for them. There are many coding nuances in the headers that I would like to pick up on (i.e., having a declaration for a datatype "URLState" right before an enum means that enum contains the constants for "URLState") but this will take time. Any feedback at all is appreciated. Go ahead and download it and give it a try.
If you have questions about the Headers2Glossary check out the FAQ. Check out the bug list to see what problems have already been reported. If there is something you would like to see in Headers2Glossary head over the feature request.
josh jacob
josh.jacob@joshjacob.com
|