root
/
rabbitmq-server
mirror of https://github.com/rabbitmq/rabbitmq-server.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

updated docs

This commit is contained in:
Alexandru Scvortov 2010-06-11 07:17:14 +01:00
parent 2cc2af31ee
commit 7b5be26842
1 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
deps/rabbitmq_codegen/README.extensions.md vendored
View File

@ -142,22 +142,22 @@ invoked.
## Invoking the spec compiler ## Invoking the spec compiler
Your code generation code should invoke `amqp_codegen.do_main` with Your code generation code should invoke `amqp_codegen.do_main_dict`
two functions as arguments: one for generating "header-file" text, and with a dictionary of functions as the sole argument. Each will be
one for generating "implementation-file" text. The `do_main` function used for generationg a separate file. The `do_main_dict` function
will parse the command-line arguments supplied when python was will parse the command-line arguments supplied when python was
invoked. invoked.
The command-line will be parsed as: The command-line will be parsed as:
python your_codegen.py <headerorbody> <mainspec> [<extspec> ...] <outfile> python your_codegen.py <action> <mainspec> [<extspec> ...] <outfile>
where `<headerorbody>` is either the word `header` or the word `body`, where `<action>` is a key into the dictionary supplied to
to select which generation function is called by `do_main`. The `do_main_dict` and is used to select which generation function is
`<mainspec>` and `<extspec>` arguments are file names of specification called. The `<mainspec>` and `<extspec>` arguments are file names of
documents containing expressions in the syntax given above. The specification documents containing expressions in the syntax given
*final* argument on the command line, `<outfile>`, is the name of the above. The *final* argument on the command line, `<outfile>`, is the
source-code file to generate. name of the source-code file to generate.
Here's a tiny example of the layout of a code generation module that Here's a tiny example of the layout of a code generation module that
uses `amqp_codegen`: uses `amqp_codegen`:
@ -173,9 +173,10 @@ uses `amqp_codegen`:
... ...
if __name__ == "__main__": if __name__ == "__main__":
amqp_codegen.do_main(generateHeader, generateImpl) amqp_codegen.do_main_dict({"header": generateHeader,
"body": generateImpl})
The reasons for this split, such as they are, are that The reasons for allowing more than one action, are that
- many languages have separate "header"-type files (C and Erlang, to - many languages have separate "header"-type files (C and Erlang, to
name two) name two)