Clapham - a railroad diagram generator

View: New views
5 Messages — Rating Filter:   Alert me  

Clapham - a railroad diagram generator

by Julian Hyde-2 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

I'm a long time JavaCC user and I'm very happy with it - but my product manager wants me to generate railroad diagrams of our SQL grammar for our documentation.
 
I couldn't find a tool to do that, so I've started an open source project called Clapham. I just released the first version, and I thought that the JavaCC community would be interested.
 
Clapham doesn't read JavaCC source files (yet) but it's easy to take the BNF generated by jjdoc and generate diagrams from that. Please give it a try, and let me know what you think. I'm also looking for contributors.
 
More details:
Julian

Re: Clapham - a railroad diagram generator

by Tom Copeland :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message


On May 11, 2009, at 3:35 PM, Julian Hyde wrote:

> I'm a long time JavaCC user and I'm very happy with it - but my  
> product manager wants me to generate railroad diagrams of our SQL  
> grammar for our documentation.
>
> I couldn't find a tool to do that, so I've started an open source  
> project called Clapham. I just released the first version, and I  
> thought that the JavaCC community would be interested.
>
> Clapham doesn't read JavaCC source files (yet) but it's easy to take  
> the BNF generated by jjdoc and generate diagrams from that. Please  
> give it a try, and let me know what you think. I'm also looking for  
> contributors.
>
> More details:
> • My blog post: http://julianhyde.blogspot.com/2009/05/clapham-railroad-diagram-generator.html
> • Home page: http://clapham.hydromatic.net/
> • SourceForge project: https://sourceforge.net/projects/clapham

Julian, that is very cool!  If folks want to see a larger example,  
check out what it generated for the Java grammar:

http://infoether.com/~tom/clapham_java/

Pretty awesome stuff!

Yours,

Tom


---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@...
For additional commands, e-mail: users-help@...


Re: Clapham - a railroad diagram generator

by Harshad Chavan :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message


This is amazing stuff Julian. Thanks for doing that.

I might need this in my project.

Kudos to you, JavaCC team and the whole concept of open source and community process.


----- Original Message ----
From: Tom Copeland <tom@...>
To: users@...
Sent: Thursday, June 18, 2009 7:00:28 AM
Subject: Re: [JavaCC] Clapham - a railroad diagram generator


On May 11, 2009, at 3:35 PM, Julian Hyde wrote:

> I'm a long time JavaCC user and I'm very happy with it - but my product manager wants me to generate railroad diagrams of our SQL grammar for our documentation.
>
> I couldn't find a tool to do that, so I've started an open source project called Clapham. I just released the first version, and I thought that the JavaCC community would be interested.
>
> Clapham doesn't read JavaCC source files (yet) but it's easy to take the BNF generated by jjdoc and generate diagrams from that. Please give it a try, and let me know what you think. I'm also looking for contributors.
>
> More details:
>     • My blog post: http://julianhyde.blogspot.com/2009/05/clapham-railroad-diagram-generator.html
>     • Home page: http://clapham.hydromatic.net/
>     • SourceForge project: https://sourceforge.net/projects/clapham

Julian, that is very cool!  If folks want to see a larger example, check out what it generated for the Java grammar:

http://infoether.com/~tom/clapham_java/

Pretty awesome stuff!

Yours,

Tom


---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@...
For additional commands, e-mail: users-help@...




---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@...
For additional commands, e-mail: users-help@...


RE: Clapham - a railroad diagram generator

by Julian Hyde-2 :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

You're all most welcome.

Frankly, I'm not a graphics expert, and I'm busy with a couple of other
projects, so I'd welcome bug fixes & enhancements.

I'd love to make it so that it can generate small diagrams, each containing
a few related symbols, and generate maps/hyperlinks so you can click on a
symbol in a diagram and jump to the definition of that symbol.

And, as several people have pointed out, the layout isn't quite right, and
the text sometimes overflows the boxes.

Julian

> -----Original Message-----
> From: Harshad Chavan [mailto:harshadchavan@...]
> Sent: Thursday, June 18, 2009 10:53 AM
> To: users@...
> Subject: Re: [JavaCC] Clapham - a railroad diagram generator
>
>
> This is amazing stuff Julian. Thanks for doing that.
>
> I might need this in my project.
>
> Kudos to you, JavaCC team and the whole concept of open
> source and community process.
>
>
> ----- Original Message ----
> From: Tom Copeland <tom@...>
> To: users@...
> Sent: Thursday, June 18, 2009 7:00:28 AM
> Subject: Re: [JavaCC] Clapham - a railroad diagram generator
>
>
> On May 11, 2009, at 3:35 PM, Julian Hyde wrote:
>
> > I'm a long time JavaCC user and I'm very happy with it -
> but my product manager wants me to generate railroad diagrams
> of our SQL grammar for our documentation.
> >
> > I couldn't find a tool to do that, so I've started an open
> source project called Clapham. I just released the first
> version, and I thought that the JavaCC community would be interested.
> >
> > Clapham doesn't read JavaCC source files (yet) but it's
> easy to take the BNF generated by jjdoc and generate diagrams
> from that. Please give it a try, and let me know what you
> think. I'm also looking for contributors.
> >
> > More details:
> >     . My blog post:
> http://julianhyde.blogspot.com/2009/05/clapham-railroad-diagra
> m-generator.html
> >     . Home page: http://clapham.hydromatic.net/
> >     . SourceForge project: https://sourceforge.net/projects/clapham
>
> Julian, that is very cool!  If folks want to see a larger
> example, check out what it generated for the Java grammar:
>
> http://infoether.com/~tom/clapham_java/
>
> Pretty awesome stuff!
>
> Yours,
>
> Tom
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@...
> For additional commands, e-mail: users-help@...
>
>
>      
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@...
> For additional commands, e-mail: users-help@...
>
>


---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@...
For additional commands, e-mail: users-help@...


Re: Clapham - a railroad diagram generator

by Tom Copeland :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message


On Jun 20, 2009, at 11:40 PM, Julian Hyde wrote:

> You're all most welcome.
>
> Frankly, I'm not a graphics expert, and I'm busy with a couple of  
> other
> projects, so I'd welcome bug fixes & enhancements.
>
> I'd love to make it so that it can generate small diagrams, each  
> containing
> a few related symbols, and generate maps/hyperlinks so you can click  
> on a
> symbol in a diagram and jump to the definition of that symbol.
>
> And, as several people have pointed out, the layout isn't quite  
> right, and
> the text sometimes overflows the boxes.

FYI, I've added a BNF generator to JJDoc, so it's now much easier to  
get from a JavaCC grammar to an SVG graph generated by Clapham.  
Details are here:

http://tomcopeland.blogs.com/juniordeveloper/2009/06/lovely-svg-railroad-diagrams-revisited.html

Fun stuff!

Yours,

Tom
http://generatingparserswithjavacc.com/


---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@...
For additional commands, e-mail: users-help@...