Syntax mark-up for documenting code?

dmoc · Post by **dmoc** » Wed Apr 26, 2006 9:34 am

I'm looking for a util that can take PB source and produce xml for syntax highlighting. I'd like then to import sections into an OpenOffice doc and also into html. I'd like to do this without wasting significant portion of my life

All suggestions welcome!

Post by **freak** » Wed Apr 26, 2006 10:27 am

What exactly should this xml output look like ?

dmoc · Post by **dmoc** » Wed Apr 26, 2006 11:15 am

I imagine it would just enclose each chunk according to type, ie, "comment", "PB-keyword", "constant", "variable", etc. For inclusion in a web page it would be nice to preserve tabs. The tool-chain (if that's the right way to describe it) would be:

PB-Source -> PARSE-TO-XML -> [PARSE-TO-HTML | PARSE-TO-OODOC]

First requirement is a way to tokenise PB src and I though there may already be a way to do this. I'm pretty sure someone has already done something similar. Wasn't there a web site for PB source that featured syntax highlighting and preserved spacing?

FYI - I have a large amount of PB source that I want to document so I can dump some on my web site and also include in a pdf (via OpenOfficeDoc).

Post by **freak** » Thu Apr 27, 2006 4:48 pm

We have decided to provide the syntax coloring engine of the PureBasic IDE as
a separate dll with the library sdk, to ease tasks like this one.

I have put it up for download here if you want to try it:
http://freak.purearea.net/v4/SyntaxHighlightning.zip

Should be very easy to do the stuff you want with that.

Flype · Post by **Flype** » Thu Apr 27, 2006 6:31 pm

very nice freak - thank you.

and if it's possible, can you provide the .lib, please ?

ts-soft · Post by **ts-soft** » Thu Apr 27, 2006 7:32 pm

@freak
thx

dmoc · Post by **dmoc** » Fri Apr 28, 2006 11:14 am

Freak u r freaking great!

Flype · Post by **Flype** » Wed May 31, 2006 11:34 am

Hi Freak,

1
the SyntaxHighlightning DLL doesn't work when in UNICODE mode.

Maybe you can provide 2 internals functions :

SyntaxHighlightA(*hBuf.l, lBuf.l, type.l, *userData)
SyntaxHighlightW(*hBuf.l, lBuf.l, type.l, *userData)

2
And it would be very handy to let the user specify
a *userData field in order to NOT deal with global vars.

Cheers.

Post by **freak** » Wed May 31, 2006 1:01 pm

Yes, unicode input is not supported, but utf8 input is. So you can convert the whole
buffer to utf8, then use the dll and convert the result back to unicode.
I can add a wrapper to do that automatically though.

For the userdata field: Yes, i can add that as well.
But keep in mind, that the dll is not threadsafe, so you can process only one
source at a time anyway, so you may just as well use global variables.

Flype · Post by **Flype** » Thu Jun 01, 2006 10:50 pm

thank you freak for the answer.

about userdata, yes, it would be nice. even if it's not threadsafe (not a problem in my case).

and about unicode, no problem, i will convert to utf8 myself.

srod · Post by **srod** » Fri Jun 02, 2006 12:06 am

Freak, this is a fantastic tool to release - thank you.

Shannara · Post by **Shannara** » Wed Sep 20, 2006 12:16 am

btw: broken link.

Post by **freak** » Wed Sep 20, 2006 12:40 am

The files are included in the PureBasic package (LibrarySDK folder) since v4.