Machinetalk code generator

This code generator is based on zeromq/gsl and generates code for Machinetalk protocol bindings. The idea is that protocol description resides in a single model from which documentation and different language bindings can be generated.

Currently machinetalk-gsl supports following languages:

• Python
• Qt/C++
• JavaScript
• Node.js
• Markdown and Graphviz

Directory structure

The project is organized in the following structure:

• models: contains all protocol and channel models
• scripts: contains scripts for the code generator
• generated: here all the generated code is output
• generate.sh: fires up the code generator

Getting started

• First install gsl by following these instructions.
• Then install graphviz sudo apt install graphviz
• Fire up sh generate.sh

You can use the entr tool to automatically trigger a new build when a model changes by issuing following command:

   ls models/* scripts/* | entr sh -c "sh generate.sh"

Working with the models

All models are written in standard XML format. The files should be pretty self explanatory. I will add a better description once a good model has been established.

Working with the code generators

The code generators are written in the GSL language. For more information follow the tutorials at GitHub:zeromq/gsl

I found it most useful to use GNU Emacs to edit the gsl files. Put the editor into the major-mode for the corresponding language (e.g. python-mode) and enable the following minor mode by issuing gsl-mode.

(defface hi-gsl-com
  '((((background dark)) (:background "gray21" :foreground "gray48"))
    (t (:weight medium :background "gray21")))
  "Face for gsl-minor-mode."
  :group 'hi-lock-faces)

(defface hi-gsl-code
  '((((background dark)) (:background "gray21" :foreground "green"))
    (t (:weight medium :background "gray21")))
  "Face for gsl-minor-mode."
  :group 'hi-lock-faces)

(define-minor-mode gsl-minor-mode
  "Highlight zeromq/GSL code."
  :global t
  :lighter " gsl"
  (if gsl-minor-mode
      (highlight-regexp "\\(^\\..*\\)\n" 'hi-gsl-code)
    (unhighlight-regexp "\\(^\\..*\\)\n"))
  (if gsl-minor-mode
      (highlight-regexp "\\(\\$(.*?)\\)" 'hi-red-b)
    (unhighlight-regexp "\\(\\$(.*?)\\)"))
  (if gsl-minor-mode
      (highlight-regexp "\\(^\\.-.*\\)\n" 'hi-gsl-com)
    (unhighlight-regexp "\\(^\\.-.*\\)\n")))

I found the electric indent mode very annoying when editing gsl files. You can easily turn it off by issuing electric-indent-mode