An Application Using Writer as a GUI for Creating and Maintaining [e]BNFs
1 like713 views
The document describes 'bnf4ooo', an application created for editing and converting extended Backus-Naur Form (eBNF) using OpenOffice Writer as a graphical user interface. It offers features such as error-free diagram creation, command-line processing, and compatibility with XML, catering to programmers and language designers. The project is hosted on SourceForge and aims to simplify the creation of visually appealing syntax diagrams and ease the maintenance of complex eBNF definitions.
![BNF4OOo An Application Using Writer as a GUI for Creating and Maintaining [e]BNFs Rony G. Flatscher, WU Wien](https://image.slidesharecdn.com/bnf-writer-101001023302-phpapp02/85/An-Application-Using-Writer-as-a-GUI-for-Creating-and-Maintaining-e-BNFs-1-320.jpg)
![Purpose Make it easy to edit and convert [e]BNF](https://image.slidesharecdn.com/bnf-writer-101001023302-phpapp02/85/An-Application-Using-Writer-as-a-GUI-for-Creating-and-Maintaining-e-BNFs-7-320.jpg)
![Allows the definition of variants of [e]BNF](https://image.slidesharecdn.com/bnf-writer-101001023302-phpapp02/85/An-Application-Using-Writer-as-a-GUI-for-Creating-and-Maintaining-e-BNFs-8-320.jpg)
![Introduction, 3 "Rail track diagrams" Easy to comprehend Graphical syntax diagrams, from [e]BNF Have been used in the documentation of programming languages](https://image.slidesharecdn.com/bnf-writer-101001023302-phpapp02/85/An-Application-Using-Writer-as-a-GUI-for-Creating-and-Maintaining-e-BNFs-15-320.jpg)
![Complex syntaxes turn out to be error-prone, if maintained manually A burden becoming too high over time One strong opinion is to define a [e]BNF, but to not create the ASCII-based diagrams by hand Having a tool that creates error-free and nice looking rail track diagrams may be very helpful !](https://image.slidesharecdn.com/bnf-writer-101001023302-phpapp02/85/An-Application-Using-Writer-as-a-GUI-for-Creating-and-Maintaining-e-BNFs-23-320.jpg)
![XML, 1 [e]BNF definitions Almost 50 years old](https://image.slidesharecdn.com/bnf-writer-101001023302-phpapp02/85/An-Application-Using-Writer-as-a-GUI-for-Creating-and-Maintaining-e-BNFs-27-320.jpg)
![[e]BNF definitions as pure (7-Bit ASCII) text Adding explicitly structural information XML markup Allows the application of XML parsers and XSLT If expressive enough, then it could be used as repository format for all kind of [e]BNFs! Intermediate format for rendering](https://image.slidesharecdn.com/bnf-writer-101001023302-phpapp02/85/An-Application-Using-Writer-as-a-GUI-for-Creating-and-Maintaining-e-BNFs-28-320.jpg)
An Application Using Writer as a GUI for Creating and Maintaining [e]BNFs
- 1. BNF4OOo An Application Using Writer as a GUI for Creating and Maintaining [e]BNFs Rony G. Flatscher, WU Wien
- 2. Overview Introduction BNF, eBNF
- 3. Rail track diagrams Features Functionality
- 5. Roundup
- 6. Introduction, 1 Has been created by one of my students, Franz Hohenegger , at "WU Wien"
- 7. Purpose Make it easy to edit and convert [e]BNF
- 8. Allows the definition of variants of [e]BNF
- 9. Find or define a XML document type and supply converters from/to that format Target users Programmers and language designers
- 10. Introduction, 2 BNF Backus-Naur-Form Used to define the syntax of languages
- 12. IETF RFC's for defining protocols
- 13. OOo for defining protocols
- 14. ANSI SQL 92, e.g. http://www.contrib.andrew.cmu.edu/~shadow/sql/sql2bnf.aug92.txt XML for defining the markup language eBNF Many variants "e"xtending BNF
- 15. Introduction, 3 "Rail track diagrams" Easy to comprehend Graphical syntax diagrams, from [e]BNF Have been used in the documentation of programming languages
- 16. Easy, but not quite as easy to program or to create nice looking ones Either create one's own individual scripts
- 17. Or use utilities of other programmers Usually not well documented
- 18. Not supporting all possible features of eBNFs
- 19. Cannot create error-free and nice looking diagrams
- 20. Introduction, 4 "Rail track diagrams" (continued) ooRexx development "Open Object Rexx" opensourced by IBM
- 21. The supplied IBM documentation is full of easy to comprehend rail track diagrams
- 22. Can only be maintained as ASCII-diagrams (!)
- 23. Complex syntaxes turn out to be error-prone, if maintained manually A burden becoming too high over time One strong opinion is to define a [e]BNF, but to not create the ASCII-based diagrams by hand Having a tool that creates error-free and nice looking rail track diagrams may be very helpful !
- 24. eBNF and Rail Diagram, 1 (ASCII Characters)
- 25. eBNF and Rail Diagram, 2 (Unicode Characters)
- 26. eBNF and Rail Diagram, 3 (Unicode Characters, Boxed)
- 27. XML, 1 [e]BNF definitions Almost 50 years old
- 28. [e]BNF definitions as pure (7-Bit ASCII) text Adding explicitly structural information XML markup Allows the application of XML parsers and XSLT If expressive enough, then it could be used as repository format for all kind of [e]BNFs! Intermediate format for rendering
- 29. Base format for comprehensive eBNFs
- 30. XML, 2 The DITA XML projekt Topic-based authoring http://dita.xml.org Use subtyping to add new information types Become able to take advantage of the DITA Open Toolkit Jean-Louis Faucher's "DocMusings" Experiments with rail track diagrams for the documentation needs of the ooRexx project
- 32. eBNF as Dita XML
- 33. "BNF4OOo" Prerequisites Tool is an ooRexx application/macro Needs the opensource ooRexx from http://build.oorexx.org (latest Linux versions needed)
- 34. http://www.oorexx.org/download.html Needs the BSF4ooRexx package from http://wi.wu-wien.ac.at/rgf/rexx/bsf4oorexx/current/ Installation all in all: 20 seconds "BNF4OOo" is hosted at SourceForge Homepage (with svn checkout available) http://sourceforge.net/projects/bnf4ooo/
- 36. BNF4Shell.rex, 1 Command-line interface Interactive rendering of [e]BNFs
- 37. Batch oriented processing of [e]BNFs Simple to use Uses settings supplied as text files *.properties GUI editing possible: "rexx OptionGUI.rex" Settings can be overriden by supplying them as switches on the command line
- 38. BNF4Shell.rex, 2 rony@rony-laptop:~$ rexx BNF4Shell.rex -help known options are: -BNFVERSION filepath (default: selection in OptionGUI.rex) -DIAGRAM "ASCII"|"UNICODE"|"PRETTYUNICODE" (default: selection in OptionGUI.rex) -INPUT filepath (default: cmd/shell) -LOGLEVEL "TRACE"|"DEBUG"|"INFO"|"WARN"|"ERROR"|"FATAL" (default: WARN) -MODE "BNF2DIAGRAM"|"BNF2XML"|"XML2BNF" (default: BNF2DIAGRAM) -OUTPUT filepath (default: cmd/shell) rony@rony-laptop:~$
- 39. BNF4Shell.rex, 3
- 40. Writer as GUI, 1 OpenOffice.org Writer Can be employed as a GUI
- 41. Supply toolbars to Import text files containing [e]BNFs
- 42. Use the formatting features to highlight [e]BNFs
- 43. Diagrams
- 44. XML renderings
- 45. Error messages Render [e]BNFs to different representations
- 46. Use documents as a storage and catalog
- 47. Export created diagrams as graphics
- 48. Writer as GUI, 2
- 54. Demonstration Do we have enough time ?
- 55. State of the Project, 1 Development Environment Linux (Ubuntu) ooRexx
- 56. BSF4ooRexx OOo Latest version with English user interface Target platforms Linux
- 58. State of the Project, 2 Programming the hard part Done OOo Writer as GUI Almost done Needs some bug-fixing Paragraph styles work only in the English OOo UI Needs one more export function Export [e]BNF, XML to file system Documentation In process, will take a couple of weeks
- 59. Roundup "BNF4OOo" "Backus-Naur-Form for OpenOffice.org"
- 60. Easy to setup, easy to use and quite a versatile (conversion) tool Can be used interactively using Writer as an Editor/GUI Toolbar
- 61. Menu Can be used standalone as well Rexx program "BNF4Shell.rex" Interactive shell
- 62. Can be used quietly as a command-line utility
- 63. Credits "BNF4OOo" has been created by Franz Hohenegger at WU Wien http://sourceforge.net/projects/bnf4ooo/
- 64. svn co https://bnf4ooo.svn.sourceforge.net/svnroot/bnf4ooo bnf4ooo The ooRexx development team
- 65. The Apache Software Foundation's (ASF) Jakarta project "Bean Scripting Framework (BSF)"