1 // Show ToC at a specific location for a GitHub rendering
10 // This is to mimic what GitHub does so that anchors work in an offline
21 image::normand-logo.png[]
24 image:https://img.shields.io/pypi/v/normand.svg?label=Latest%20version[link="https://pypi.python.org/pypi/normand"]
27 _**Normand**_ is a text-to-binary processor with its own language.
29 This package offers both a portable {py3} module and a command-line
32 WARNING: This version of Normand is 0.21, meaning both the Normand
33 language and the module/CLI interface aren't stable.
36 // ToC location for a GitHub rendering
42 The purpose of Normand is to consume human-readable text representing
43 bytes and to produce the corresponding binary data.
47 Consider the following Normand input:
50 4f 55 32 bb $167 fe %10100111 a9 $-32
53 The generated nine bytes are:
56 4f 55 32 bb a7 fe a7 a9 e0
60 As you can see in the last example, the fundamental unit of the Normand
61 language is the _byte_. The order in which you list bytes will be the
62 order of the generated data.
64 The Normand language is more than simple lists of bytes, though. Its
67 Comments, including a bunch of insignificant symbols which may improve readability::
72 ff bb %1101:0010 # This is a comment
73 78 29 af $192 # This too # 99 $-80
74 fe80::6257:18ff:fea3:4229
76 10839636-5d65-4a68-8e6a-21608ddf7258
82 ff bb d2 78 29 af c0 99 b0 fe 80 62 57 18 ff fe
83 a3 42 29 60 57 18 a3 42 29 10 83 96 36 5d 65 4a
84 68 8e 6a 21 60 8d df 72 58
87 Hexadecimal, decimal, and binary byte constants::
92 aa bb $247 $-89 %0011_0010 %11.01= 10/10
107 u16le"stress\nverdict 🤣"
108 s:latin3{hex(ICITTE)}
114 68 65 6c 6c 6f 20 77 6f 72 6c 64 21 00 73 00 74 ┆ hello world!•s•t
115 00 72 00 65 00 73 00 73 00 0a 00 76 00 65 00 72 ┆ •r•e•s•s•••v•e•r
116 00 64 00 69 00 63 00 74 00 20 00 3e d8 23 dd 30 ┆ •d•i•c•t• •>•#•0
120 Labels: special variables holding the offset where they're defined::
123 <beg> b2 52 e3 bc 91 05
124 $100 $50 <chair> 33 9f fe
131 5e 65 {tower = 47} c6 7f f2 c4
132 44 {hurl = tower - 14} b5 {tower = hurl} 26 2d
135 The value of a variable assignment is the evaluation of a valid {py3}
136 expression which may include label and variable names.
138 Fixed-length number with a given length (8{nbsp}bits to 64{nbsp}bits) and byte order::
144 {be} 67 <lbl> 44 $178 {(end - lbl) * 8 + strength : 16} $99 <end>
152 67 44 b2 00 2c 63 37 f8 ff ff 7f bd c2 82 fb 21
156 The encoded number is the evaluation of a valid {py3} expression which
157 may include label and variable names.
159 https://en.wikipedia.org/wiki/LEB128[LEB128] integer::
164 aa bb cc {-1993 : sleb128} <meow> dd ee ff
165 {meow * 199 : uleb128}
171 aa bb cc b7 70 dd ee ff e3 07
174 The encoded integer is the evaluation of a valid {py3} expression which
175 may include label and variable names.
198 aa bb cc 66 6f 6f 66 69 67 68 74 66 6f 6f 66 69 ┆ •••foofightfoofi
199 67 68 74 66 6f 6f 62 61 72 66 6f 6f 62 61 72 ┆ ghtfoobarfoobar
207 aa bb * 5 cc <zoom> "yeah\0" * {zoom * 3}
217 aa bb bb bb bb bb cc 79 65 61 68 00 79 65 61 68 ┆ •••••••yeah•yeah
218 00 79 65 61 68 00 79 65 61 68 00 79 65 61 68 00 ┆ •yeah•yeah•yeah•
219 79 65 61 68 00 79 65 61 68 00 79 65 61 68 00 79 ┆ yeah•yeah•yeah•y
220 65 61 68 00 79 65 61 68 00 79 65 61 68 00 79 65 ┆ eah•yeah•yeah•ye
221 61 68 00 79 65 61 68 00 79 65 61 68 00 79 65 61 ┆ ah•yeah•yeah•yea
222 68 00 79 65 61 68 00 79 65 61 68 00 79 65 61 68 ┆ h•yeah•yeah•yeah
223 00 79 65 61 68 00 79 65 61 68 00 79 65 61 68 00 ┆ •yeah•yeah•yeah•
224 ff ee 6a 75 69 63 65 ff ee 6a 75 69 63 65 ff ee ┆ ••juice••juice••
225 6a 75 69 63 65 ┆ juice
244 00 00 00 c7 00 00 00 00 00 00 00 00 00 00 00 2b
245 ff 85 ff ff 00 00 15 d0
267 ef be ad de 37 f8 09 00 00 00 00 00 00 00 00 00 ┆ ••••7•••••••••••
268 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ┆ ••••••••••••••••
269 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ┆ ••••••••••••••••
270 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ┆ ••••••••••••••••
271 40 6d 65 6f 77 20 6d 69 78 ff ff ff ff ff ff ff ┆ @meow mix•••••••
272 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ┆ ••••••••••••••••
273 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ┆ ••••••••••••••••
274 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ┆ ••••••••••••••••
275 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ┆ ••••••••••••••••
276 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ┆ ••••••••••••••••
277 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ┆ ••••••••••••••••
278 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ┆ ••••••••••••••••
279 ff ff ff ff ff ff ff ff c8 ┆ •••••••••
287 "end of file @ " {end:8}
290 "this part will be gzipped"
299 65 6e 64 20 6f 66 20 66 69 6c 65 20 40 20 3c 1f ┆ end of file @ <•
300 8b 08 00 7b 7b 26 65 02 ff 2b c9 c8 2c 56 28 48 ┆ •••{{&e••+••,V(H
301 2c 2a 51 28 cf cc c9 51 48 4a 55 48 af ca 2c 28 ┆ ,*Q(•••QHJUH••,(
302 48 4d 01 00 d4 cc 5b 8a 19 00 00 00 ┆ HM••••[•••••
305 Multilevel grouping::
310 ff ((aa bb "zoom" cc) * 5) * 3 $-34 * 4
316 ff aa bb 7a 6f 6f 6d cc aa bb 7a 6f 6f 6d cc aa ┆ •••zoom•••zoom••
317 bb 7a 6f 6f 6d cc aa bb 7a 6f 6f 6d cc aa bb 7a ┆ •zoom•••zoom•••z
318 6f 6f 6d cc aa bb 7a 6f 6f 6d cc aa bb 7a 6f 6f ┆ oom•••zoom•••zoo
319 6d cc aa bb 7a 6f 6f 6d cc aa bb 7a 6f 6f 6d cc ┆ m•••zoom•••zoom•
320 aa bb 7a 6f 6f 6d cc aa bb 7a 6f 6f 6d cc aa bb ┆ ••zoom•••zoom•••
321 7a 6f 6f 6d cc aa bb 7a 6f 6f 6d cc aa bb 7a 6f ┆ zoom•••zoom•••zo
322 6f 6d cc aa bb 7a 6f 6f 6d cc de de de de ┆ om•••zoom•••••
332 !if world " world" !end
337 m:hello({ICITTE > 15 and ICITTE < 60})
344 ff ff ff ff 68 65 6c 6c 6f ff ff ff ff 68 65 6c ┆ ••••hello••••hel
345 6c 6f ff ff ff ff 68 65 6c 6c 6f 20 77 6f 72 6c ┆ lo••••hello worl
346 64 ff ff ff ff 68 65 6c 6c 6f 20 77 6f 72 6c 64 ┆ d••••hello world
347 ff ff ff ff 68 65 6c 6c 6f 20 77 6f 72 6c 64 ff ┆ ••••hello world•
348 ff ff ff 68 65 6c 6c 6f ff ff ff ff 68 65 6c 6c ┆ •••hello••••hell
349 6f ff ff ff ff 68 65 6c 6c 6f ff ff ff ff 68 65 ┆ o••••hello••••he
350 6c 6c 6f ff ff ff ff 68 65 6c 6c 6f ff ff ff ff ┆ llo••••hello••••
351 68 65 6c 6c 6f ff ff ff ff 68 65 6c 6c 6f ff ff ┆ hello••••hello••
352 ff ff 68 65 6c 6c 6f ff ff ff ff 68 65 6c 6c 6f ┆ ••hello••••hello
353 ff ff ff ff 68 65 6c 6c 6f ff ff ff ff 68 65 6c ┆ ••••hello••••hel
354 6c 6f ff ff ff ff 68 65 6c 6c 6f ┆ lo••••hello
357 Precise error reporting::
360 /tmp/meow.normand:10:24 - Expecting a bit (`0` or `1`).
364 /tmp/meow.normand:32:6 - Unexpected character `k`.
368 /tmp/meow.normand:24:19 - Illegal (unknown or unreachable) variable/label name `meow` in expression `(meow - 45) // 8`; the legal names are {`ICITTE`, `mix`, `zoom`}.
372 /tmp/meow.normand:32:19 - While expanding the macro `meow`:
373 /tmp/meow.normand:35:5 - While expanding the macro `zzz`:
374 /tmp/meow.normand:18:9 - Value 315 is outside the 8-bit range when evaluating expression `end - ICITTE`.
377 You can use Normand to track data source files in your favorite VCS
378 instead of raw binary files. The binary files that Normand generates can
379 be used to test file format decoding, including malformatted data, for
380 example, as well as for education.
382 See <<learn-normand>> to explore all the Normand features.
386 Normand requires Python ≥ 3.4.
391 $ python3 -m pip install --user normand
395 https://packaging.python.org/en/latest/tutorials/installing-packages/#installing-to-the-user-site[Installing to the User Site]
396 to learn more about a user site installation.
400 Normand has a single module file, `normand.py`, which you can copy as is
401 to your project to use it (both the <<python3-api,`normand.parse()`>>
402 function and the <<command-line-tool,command-line tool>>).
404 `normand.py` has _no external dependencies_, but if you're using
405 Python{nbsp}3.4, you'll need a local copy of the standard `typing`
411 The design goals of Normand are:
414 We're making sure `normand.py` works with Python{nbsp}≥{nbsp}3.4 and
415 doesn't have any external dependencies so that you may just copy the
416 module as is to your own project.
419 The most basic Normand input is a sequence of hexadecimal constants
420 (for example, `4e6f726d616e64`) which produce exactly what you'd
423 Most Normand features map to programming language concepts you already
424 know and understand: constant integers, literal strings, variables,
425 conditionals, repetitions/loops, and the rest.
427 Concise and readable input::
428 We could have chosen XML or YAML as the input format, but having a
429 DSL here makes a Normand input compact and easy to read, two
430 important traits when using Normand to write tests, for example.
432 Compare the following Normand input and some hypothetical XML
433 equivalent, for example:
435 .Actual normand input.
437 ff dd 01 ab $192 $-128 %1101:0011
444 # five times because xyz
446 "hello world " {iter:8}
454 .Hypothetical Normand XML input.
457 <?xml version="1.0" encoding="utf-8" ?>
459 <byte base="x" val="ff" />
460 <byte base="x" val="dd" />
461 <byte base="x" val="1" />
462 <byte base="x" val="ab" />
463 <byte base="d" val="192" />
464 <byte base="d" val="-128" />
465 <byte base="b" val="11010011" />
466 <fixed-len-num expr="end" len="8" />
467 <var-assign name="iter" expr="1" />
468 <cond expr="not something">
469 <!-- five times because xyz -->
471 <str>hello world </str>
472 <fixed-len-num expr="iter" len="8" />
473 <var-assign name="iter" expr="iter + 1" />
482 A Normand text input is a sequence of items which represent a sequence
485 [[state]] During the processing of items to data, Normand relies on a
490 |State variable |Description |Initial value: <<python3-api,{py3} API>> |Initial value: <<command-line-tool,CLI>>
492 |[[cur-offset]] Current offset
494 The current offset has an effect on the value of <<label,labels>> and of
495 the special `ICITTE` name in <<fixed-length-number,fixed-length
496 number>>, <<leb-128-integer,LEB128 integer>>, <<string,string>>,
497 <<filling,filling>>, <<variable-assignment,variable assignment>>,
498 <<conditional-block,conditional block>>, <<repetition-block,repetition
499 block>>, <<macro-expansion,macro expansion>>, and
500 <<post-item-repetition,post-item repetition>> expression evaluation.
502 Each generated byte increments the current offset.
504 A <<current-offset-setting,current offset setting>> may change the
505 current offset without generating data.
507 An <<current-offset-alignment,current offset alignment>> generates
508 padding bytes to make the current offset satisfy a given alignment.
509 |`init_offset` parameter of the `parse()` function.
512 |[[cur-bo]] Current byte order
514 The current byte order has an effect on the encoding of
515 <<fixed-length-number,fixed-length numbers>>.
517 A <<current-byte-order-setting,current byte order setting>> may change
518 the current byte order.
519 |`init_byte_order` parameter of the `parse()` function.
520 |`--byte-order` option.
523 |Mapping of label names to integral values.
524 |`init_labels` parameter of the `parse()` function.
525 |One or more `--label` options.
527 |<<variable-assignment,Variables>>
528 |Mapping of variable names to integral or floating point number values.
529 |`init_variables` parameter of the `parse()` function.
530 |One or more `--var` or `--var-str` options.
533 The available items are:
535 * A <<byte-constant,constant integer>> representing one or more
538 * A <<literal-string,literal string>> representing a constant sequence
539 of bytes encoding UTF-8, UTF-16, UTF-32, or Latin-1 to Latin-10 data.
541 * A <<current-byte-order-setting,current byte order setting>> (big or
544 * A <<fixed-length-number,fixed-length number>> (integer or
545 floating point) using the <<cur-bo,current byte order>> and of which
546 the value is the result of a {py3} expression.
548 * An <<leb128-integer,LEB128 integer>> of which the value is the result
549 of a {py3} expression.
551 * A <<string,string>> representing a sequence of bytes encoding UTF-8,
552 UTF-16, UTF-32, or Latin-1 to Latin-10 data, and of which the value is
553 the result of a {py3} expression.
555 * A <<current-offset-setting,current offset setting>>.
557 * A <<current-offset-alignment,current offset alignment>>.
559 * A <<filling,filling>>.
561 * A <<label,label>>, that is, a named constant holding the current
564 This is similar to an assembly label.
566 * A <<variable-assignment,variable assignment>> associating a name to
567 the integral result of an evaluated {py3} expression.
569 * A <<group,group>>, that is, a scoped sequence of items.
571 * A <<conditional-block,conditional block>>.
573 * A <<repetition-block,repetition block>>.
575 * A <<transformation-block,transformation block>>.
577 * A <<macro-definition-block,macro definition block>>.
579 * A <<macro-expansion,macro expansion>>.
581 Moreover, you can repeat many items above a constant or variable number
582 of times with the ``pass:[*]`` operator _after_ the item to repeat. This
583 is called a <<post-item-repetition,post-item repetition>>.
585 A Normand comment may exist pretty much anywhere between tokens.
587 A comment is anything between two ``pass:[#]`` characters on the same
588 line, or from ``pass:[#]`` until the end of the line. Whitespaces are
589 also considered comments. The following symbols are also considered
590 comments around and between items, as well as between hexadecimal
591 nibbles and binary bits of <<byte-constant,byte constants>>:
594 / \ ? & : ; . , [ ] _ = | -
597 The latter serve to improve readability so that you may write, for
598 example, a MAC address or a UUID as is.
600 [[const-int]] Many items require a _constant integer_, possibly
601 negative, in which case it may start with `-` for a negative integer. A
602 positive constant integer is any of:
605 One or mode digits (`0` to `9`).
610 * The `0x` or `0X` prefix followed with one or more hexadecimal digits
611 (`0` to `9`, `a` to `f`, or `A` to `F`).
612 * One or more hexadecimal digits followed with the `h` or `H` suffix.
617 * The `0o` or `0O` prefix followed with one or more octal digits
619 * One or more octal digits followed with the `o`, `O`, `q`, or `Q`
625 * The `0b` or `0B` prefix followed with one or more bits (`0` or `1`).
626 * One or more bits followed with the `b` or `B` suffix.
628 You can test the examples of this section with the `normand`
629 <<command-line-tool,command-line tool>> as such:
632 $ normand file | hexdump -C
635 where `file` is the name of a file containing the Normand input.
639 A _byte constant_ represents one or more constant bytes.
644 Two consecutive hexadecimal digits representing a single byte.
647 One or more digits after the `$` prefix representing a single byte.
649 Binary form:: {empty}
652 . __**N**__ `%` prefixes (at least one).
654 The number of `%` characters is the number of subsequent expected bytes.
656 . __**N**__{nbsp}×{nbsp}8 bits (`0` or `1`).
677 $192 %1100/0011 $ -77
691 58f64689-6316-4d55-8a1a-04cada366172
692 fe80::6257:18ff:fea3:4229
698 58 f6 46 89 63 16 4d 55 8a 1a 04 ca da 36 61 72 ┆ X•F•c•MU•••••6ar
699 fe 80 62 57 18 ff fe a3 42 29 ┆ ••bW••••B)
707 %01110011 %01100001 %01101100 %01110101 %01110100
708 %%%1101:0010 11111111 #A#11 #B#00 #C#011 #D#1
714 73 61 6c 75 74 d2 ff c7 ┆ salut•••
720 A _literal string_ represents the encoded bytes of a literal string
721 using the UTF-8, UTF-16, UTF-32, or Latin-1 to Latin-10 encoding.
723 The string to encode isn't implicitly null-terminated: use `\0` at the
724 end of the string to add a null character.
728 . **Optional**: one of the following encodings instead of the default
784 . The ``pass:["]`` prefix.
786 . A sequence of zero or more characters, possibly containing escape
789 An escape sequence is the ``\`` character followed by one of:
795 `b`:: Backspace (U+0008)
796 `e`:: Escape (U+001B)
797 `f`:: Form feed (U+000C)
798 `n`:: End of line (U+000A)
799 `r`:: Carriage return (U+000D)
800 `t`:: Character tabulation (U+0009)
801 `v`:: Line tabulation (U+000B)
802 ``\``:: Reverse solidus (U+005C)
803 ``pass:["]``:: Quotation mark (U+0022)
806 . The ``pass:["]`` suffix.
812 "coucou tout le monde!"
818 63 6f 75 63 6f 75 20 74 6f 75 74 20 6c 65 20 6d ┆ coucou tout le m
819 6f 6e 64 65 21 ┆ onde!
827 u16le"I am not young enough to know everything."
833 49 00 20 00 61 00 6d 00 20 00 6e 00 6f 00 74 00 ┆ I• •a•m• •n•o•t•
834 20 00 79 00 6f 00 75 00 6e 00 67 00 20 00 65 00 ┆ •y•o•u•n•g• •e•
835 6e 00 6f 00 75 00 67 00 68 00 20 00 74 00 6f 00 ┆ n•o•u•g•h• •t•o•
836 20 00 6b 00 6e 00 6f 00 77 00 20 00 65 00 76 00 ┆ •k•n•o•w• •e•v•
837 65 00 72 00 79 00 74 00 68 00 69 00 6e 00 67 00 ┆ e•r•y•t•h•i•n•g•
846 s:u32be "\"illusion is the first\nof all pleasures\" 🦉"
852 00 00 00 22 00 00 00 69 00 00 00 6c 00 00 00 6c ┆ •••"•••i•••l•••l
853 00 00 00 75 00 00 00 73 00 00 00 69 00 00 00 6f ┆ •••u•••s•••i•••o
854 00 00 00 6e 00 00 00 20 00 00 00 69 00 00 00 73 ┆ •••n••• •••i•••s
855 00 00 00 20 00 00 00 74 00 00 00 68 00 00 00 65 ┆ ••• •••t•••h•••e
856 00 00 00 20 00 00 00 66 00 00 00 69 00 00 00 72 ┆ ••• •••f•••i•••r
857 00 00 00 73 00 00 00 74 00 00 00 0a 00 00 00 6f ┆ •••s•••t•••••••o
858 00 00 00 66 00 00 00 20 00 00 00 61 00 00 00 6c ┆ •••f••• •••a•••l
859 00 00 00 6c 00 00 00 20 00 00 00 70 00 00 00 6c ┆ •••l••• •••p•••l
860 00 00 00 65 00 00 00 61 00 00 00 73 00 00 00 75 ┆ •••e•••a•••s•••u
861 00 00 00 72 00 00 00 65 00 00 00 73 00 00 00 22 ┆ •••r•••e•••s•••"
862 00 00 00 20 00 01 f9 89 ┆ ••• ••••
870 s:latin1 "Paul Piché"
876 50 61 75 6c 20 50 69 63 68 e9 ┆ Paul Pich•
880 === Current byte order setting
882 This special item sets the <<cur-bo,_current byte order_>>.
884 The two accepted forms are:
887 ``pass:[{be}]``:: Set the current byte order to big endian.
888 ``pass:[{le}]``:: Set the current byte order to little endian.
890 === Fixed-length number
892 A _fixed-length number_ represents a fixed number of bytes encoding
895 * An unsigned or signed integer (two's complement).
897 The available lengths are 8, 16, 24, 32, 40, 48, 56, and 64.
899 * A floating point number
900 (https://standards.ieee.org/standard/754-2008.html[IEEE{nbsp}754-2008]).
902 The available length are 32 (_binary32_) and 64 (_binary64_).
904 The value is the result of evaluating a {py3} expression using the
905 <<cur-bo,current byte order>>.
907 A fixed-length number is:
909 . The ``pass:[{]`` prefix.
911 . A valid {py3} expression.
913 For a fixed-length number at some source location{nbsp}__**L**__, this
914 expression may contain the name of any accessible <<label,label>> (not
915 within a nested group), including the name of a label defined
916 after{nbsp}__**L**__ (except within an <<encoded-block,encoded block>>),
917 as well as the name of any <<variable-assignment,variable>> known
920 The value of the special name `ICITTE` (`int` type) in this expression
921 is the <<cur-offset,current offset>> (before encoding the number).
925 . An encoding length in bits amongst:
928 The expression evaluates to an `int` or `bool` value::
929 `8`, `16`, `24`, `32`, `40`, `48`, `56`, and `64`.
931 NOTE: Normand automatically converts a `bool` value to `int`.
933 The expression evaluates to a `float` value::
960 # String length in bits
961 {8 * (str_end - str_beg) : 16}
972 00 60 68 65 6c 6c 6f 20 77 6f 72 6c 64 21 ┆ •`hello world!
980 {20 - ICITTE : 8} * 10
986 14 13 12 11 10 0f 0e 0d 0c 0b
1007 An _LEB128 integer_ represents a variable number of bytes encoding an
1008 unsigned or signed integer which is the result of evaluating a {py3}
1009 expression following the https://en.wikipedia.org/wiki/LEB128[LEB128]
1012 An LEB128 integer is:
1014 . The ``pass:[{]`` prefix.
1016 . A valid {py3} expression of which the evaluation result type
1017 is `int` or `bool` (automatically converted to `int`).
1019 For an LEB128 integer at some source location{nbsp}__**L**__, this
1020 expression may contain:
1023 * The name of any <<label,label>> defined before{nbsp}__**L**__
1024 which isn't within a nested group.
1025 * The name of any <<variable-assignment,variable>> known
1029 The value of the special name `ICITTE` (`int` type) in this expression
1030 is the <<cur-offset,current offset>> (before encoding the integer).
1032 . The `:` character.
1038 `uleb128`:: Use the unsigned LEB128 format.
1039 `sleb128`:: Use the signed LEB128 format.
1065 {-981238311 + (meow * -23) : sleb128}
1072 aa bb cc dd ee ff fd fa 8d ac 7c 68 65 6c 6c 6f ┆ ••••••••••|hello
1078 A _string_ represents a variable number of bytes encoding a string which
1079 is the result of evaluating a {py3} expression using the UTF-8, UTF-16,
1080 UTF-32, or Latin-1 to Latin-10 encoding.
1082 A string has two possible forms:
1084 Encoding prefix form:: {empty}
1086 . An encoding amongst:
1141 . The ``pass:[{]`` prefix.
1143 . A valid {py3} expression of which the evaluation result type
1144 is `bool`, `int`, `float`, or `str` (the first three automatically
1145 converted to `str`).
1147 For a string at some source location{nbsp}__**L**__, this expression may
1151 * The name of any <<label,label>> defined before{nbsp}__**L**__
1152 which isn't within a nested group.
1153 * The name of any <<variable-assignment,variable>> known
1157 The value of the special name `ICITTE` (`int` type) in this expression
1158 is the <<cur-offset,current offset>> (before encoding the string).
1162 Encoding suffix form:: {empty}
1164 . The ``pass:[{]`` prefix.
1166 . A valid {py3} expression of which the evaluation result type
1167 is `bool`, `int`, `float`, or `str` (the first three automatically
1168 converted to `str`).
1170 For a string at some source location{nbsp}__**L**__, this expression may
1174 * The name of any <<label,label>> defined before{nbsp}__**L**__
1175 which isn't within a nested group.
1176 * The name of any <<variable-assignment,variable>> known
1180 The value of the special name `ICITTE` (`int` type) in this expression
1181 is the <<cur-offset,current offset>> (before encoding the string).
1183 . The `:` character.
1185 . A string encoding amongst:
1252 31 20 32 20 33 20 34 20 35 20 36 20 37 20 38 20 ┆ 1 2 3 4 5 6 7 8
1253 39 20 31 30 20 ┆ 9 10
1261 {meow = 'salut jérémie'}
1262 {meow.upper() : s:latin1}
1268 53 41 4c 55 54 20 4a c9 52 c9 4d 49 45 ┆ SALUT J•R•MIE
1272 === Current offset setting
1274 This special item sets the <<cur-offset,_current offset_>>.
1276 A current offset setting is:
1280 . A <<const-int,positive constant integer>> which is the new current
1290 <0x61> {ICITTE : 8} * 8
1296 00 01 02 03 04 05 06 07 61 62 63 64 65 66 67 68 ┆ ••••••••abcdefgh
1304 aa bb cc dd <meow> ee ff
1305 <12> 11 22 33 <mix> 44 55
1306 {meow : 8} {mix : 8}
1312 aa bb cc dd ee ff 11 22 33 44 55 04 0f ┆ •••••••"3DU••
1316 === Current offset alignment
1318 A _current offset alignment_ represents zero or more padding bytes to
1319 make the <<cur-offset,current offset>> meet a given
1320 https://en.wikipedia.org/wiki/Data_structure_alignment[alignment] value.
1322 More specifically, for an alignment value of{nbsp}__**N**__{nbsp}bits,
1323 a current offset alignment represents the required padding bytes until
1324 the current offset is a multiple of __**N**__{nbsp}/{nbsp}8.
1326 A current offset alignment is:
1330 . A <<const-int,positive constant integer>> which is the alignment value
1333 This value must be greater than zero and a multiple of{nbsp}8.
1338 . The ``pass:[~]`` prefix.
1339 . A <<const-int,positive constant integer>> which is the value of the
1340 byte to use as padding to align the <<cur-offset,current offset>>.
1343 Without this section, the padding byte value is zero.
1349 11 22 (@32 aa bb cc) * 3
1355 11 22 00 00 aa bb cc 00 aa bb cc 00 aa bb cc
1365 @32~0xcc {-893.5:32}
1372 77 88 cc cc 00 60 5f c4 55 55 55 55 55 55 55 55 ┆ w••••`_•UUUUUUUU
1373 6d 65 6f 77 ┆ meow
1381 aa bb cc <29> @64~255 "zoom"
1387 aa bb cc ff ff ff 7a 6f 6f 6d ┆ ••••••zoom
1393 A _filling_ represents zero or more padding bytes to make the
1394 <<cur-offset,current offset>> reach a given value.
1398 . The ``pass:[+]`` prefix.
1402 ** A <<const-int,positive constant integer>> which is the current offset
1405 ** The ``pass:[{]`` prefix, a valid {py3} expression of which the
1406 evaluation result type is `int` or `bool` (automatically converted to
1407 `int`), and the ``pass:[}]`` suffix.
1409 For a filling at some source location{nbsp}__**L**__, this expression
1413 * The name of any <<label,label>> defined before{nbsp}__**L**__
1414 which isn't within a nested group.
1415 * The name of any <<variable-assignment,variable>> known
1419 The value of the special name `ICITTE` (`int` type) in this expression
1420 is the <<cur-offset,current offset>> (before handling the items to
1423 ** A valid {py3} name.
1425 For the name `__NAME__`, this is equivalent to the
1426 `pass:[{]__NAME__pass:[}]` form above.
1429 This value must be greater than or equal to the current offset where
1435 . The ``pass:[~]`` prefix.
1436 . A <<const-int,positive constant integer>> which is the value of the
1437 byte to use as padding to reach the current offset target.
1440 Without this section, the padding byte value is zero.
1454 aa bb cc dd 00 00 00 00 00 00 00 00 00 00 00 00 ┆ ••••••••••••••••
1455 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ┆ ••••••••••••••••
1456 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ┆ ••••••••••••••••
1457 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ┆ ••••••••••••••••
1458 68 65 6c 6c 6f 20 77 6f 72 6c 64 ┆ hello world
1466 !macro part(iter, fill)
1467 <0> "particular security " {ord('0') + iter : 8} +fill~0x80
1473 m:part(iter, {32 + 4 * iter})
1481 70 61 72 74 69 63 75 6c 61 72 20 73 65 63 75 72 ┆ particular secur
1482 69 74 79 20 31 80 80 80 80 80 80 80 80 80 80 80 ┆ ity 1•••••••••••
1483 80 80 80 80 70 61 72 74 69 63 75 6c 61 72 20 73 ┆ ••••particular s
1484 65 63 75 72 69 74 79 20 32 80 80 80 80 80 80 80 ┆ ecurity 2•••••••
1485 80 80 80 80 80 80 80 80 80 80 80 80 70 61 72 74 ┆ ••••••••••••part
1486 69 63 75 6c 61 72 20 73 65 63 75 72 69 74 79 20 ┆ icular security
1487 33 80 80 80 80 80 80 80 80 80 80 80 80 80 80 80 ┆ 3•••••••••••••••
1488 80 80 80 80 80 80 80 80 70 61 72 74 69 63 75 6c ┆ ••••••••particul
1489 61 72 20 73 65 63 75 72 69 74 79 20 34 80 80 80 ┆ ar security 4•••
1490 80 80 80 80 80 80 80 80 80 80 80 80 80 80 80 80 ┆ ••••••••••••••••
1491 80 80 80 80 80 80 80 80 70 61 72 74 69 63 75 6c ┆ ••••••••particul
1492 61 72 20 73 65 63 75 72 69 74 79 20 35 80 80 80 ┆ ar security 5•••
1493 80 80 80 80 80 80 80 80 80 80 80 80 80 80 80 80 ┆ ••••••••••••••••
1494 80 80 80 80 80 80 80 80 80 80 80 80 ┆ ••••••••••••
1500 A _label_ associates a name to the <<cur-offset,current offset>>.
1502 All the labels of a whole Normand input must have unique names.
1504 A label must not share the name of a <<variable-assignment,variable>>
1511 . A valid {py3} name which is not `ICITTE`.
1515 === Variable assignment
1517 A _variable assignment_ associates a name to the integral result of an
1518 evaluated {py3} expression.
1520 A variable assignment is:
1522 . The ``pass:[{]`` prefix.
1524 . A valid {py3} name which is not `ICITTE`.
1526 . The `=` character.
1528 . A valid {py3} expression of which the evaluation result type is `int`,
1529 `float`, or `bool` (automatically converted to `int`), or `str`.
1531 For a variable assignment at some source location{nbsp}__**L**__, this
1532 expression may contain:
1535 * The name of any <<label,label>> defined before{nbsp}__**L**__
1536 which isn't within a nested group.
1537 * The name of any <<variable-assignment,variable>> known
1541 The value of the special name `ICITTE` (`int` type) in this expression
1542 is the <<cur-offset,current offset>>.
1551 {meow = 42} 11 22 {meow:8} 33 {meow = ICITTE + 17}
1552 "yooo" {meow + mix : 16}
1558 11 22 2a 33 79 6f 6f 6f 7a 00 ┆ •"*3yoooz•
1564 A _group_ is a scoped sequence of items.
1566 The <<label,labels>> within a group aren't visible outside of it.
1568 The main purpose of a group is to <<post-item-repetition,repeat>> more
1569 than a single item and to isolate labels.
1573 . The `(`, `!group`, or `!g` opening.
1575 . Zero or more items except, recursively, a macro definition block.
1577 . Depending on the group opening:
1592 ((aa bb cc) dd () ee) "leclerc"
1598 aa bb cc dd ee 6c 65 63 6c 65 72 63 ┆ •••••leclerc
1607 (aa bb cc) * 3 dd ee
1614 aa bb cc aa bb cc aa bb cc dd ee aa bb cc aa bb
1615 cc aa bb cc dd ee aa bb cc aa bb cc aa bb cc dd
1616 ee aa bb cc aa bb cc aa bb cc dd ee aa bb cc aa
1617 bb cc aa bb cc dd ee
1627 <str_beg> u16le"sébastien diaz" <str_end>
1628 {ICITTE - str_beg : 8}
1629 {(end - str_beg) * 5 : 24}
1637 73 00 e9 00 62 00 61 00 73 00 74 00 69 00 65 00 ┆ s•••b•a•s•t•i•e•
1638 6e 00 20 00 64 00 69 00 61 00 7a 00 1c 00 01 e0 ┆ n• •d•i•a•z•••••
1639 73 00 e9 00 62 00 61 00 73 00 74 00 69 00 65 00 ┆ s•••b•a•s•t•i•e•
1640 6e 00 20 00 64 00 69 00 61 00 7a 00 1c 00 01 40 ┆ n• •d•i•a•z••••@
1641 73 00 e9 00 62 00 61 00 73 00 74 00 69 00 65 00 ┆ s•••b•a•s•t•i•e•
1642 6e 00 20 00 64 00 69 00 61 00 7a 00 1c 00 00 a0 ┆ n• •d•i•a•z•••••
1646 === Conditional block
1648 A _conditional block_ represents either the bytes of zero or more items
1649 if some expression is true, or the bytes of zero or more other items if
1652 A conditional block is:
1654 . The `!if` opening.
1658 ** The ``pass:[{]`` prefix, a valid {py3} expression of which the
1659 evaluation result type is `int` or `bool` (automatically converted to
1660 `int`), and the ``pass:[}]`` suffix.
1662 For a conditional block at some source location{nbsp}__**L**__, this
1663 expression may contain:
1666 * The name of any <<label,label>> defined before{nbsp}__**L**__
1667 which isn't within a nested group.
1668 * The name of any <<variable-assignment,variable>> known
1672 The value of the special name `ICITTE` (`int` type) in this expression
1673 is the <<cur-offset,current offset>> (before handling the contained
1676 ** A valid {py3} name.
1678 For the name `__NAME__`, this is equivalent to the
1679 `pass:[{]__NAME__pass:[}]` form above.
1681 . Zero or more items to be handled when the condition is true
1682 except, recursively, a macro definition block.
1686 .. The `!else` opening.
1687 .. Zero or more items to be handled when the condition is false
1688 except, recursively, a macro definition block
1690 . The `!end` closing.
1708 !if {at < rep_count} 20 !end
1717 6d 65 6f 77 20 7a 6f 6f 6d 20 6d 65 6f 77 20 7a ┆ meow zoom meow z
1718 6f 6f 6d 20 6d 65 6f 77 20 7a 6f 6f 6d 20 6d 65 ┆ oom meow zoom me
1719 6f 77 20 6d 69 78 20 6d 65 6f 77 20 6d 69 78 20 ┆ ow mix meow mix
1720 6d 65 6f 77 20 6d 69 78 20 6d 65 6f 77 20 6d 69 ┆ meow mix meow mi
1721 78 20 6d 65 6f 77 20 6d 69 78 20 6d 65 6f 77 20 ┆ x meow mix meow
1734 !if {str_end - str_beg > 10}
1742 6d 00 65 00 6f 00 77 00 20 00 6d 00 69 00 78 00 ┆ m•e•o•w• •m•i•x•
1743 21 00 20 42 49 47 ┆ !• BIG
1747 === Repetition block
1749 A _repetition block_ represents the bytes of one or more items repeated
1750 a given number of times.
1752 A repetition block is:
1754 . The `!repeat` or `!r` opening.
1758 ** A <<const-int,positive constant integer>> which is the number of
1759 times to repeat the previous item.
1761 ** The ``pass:[{]`` prefix, a valid {py3} expression of which the
1762 evaluation result type is `int` or `bool` (automatically converted to
1763 `int`), and the ``pass:[}]`` suffix.
1765 For a repetition block at some source location{nbsp}__**L**__, this
1766 expression may contain:
1769 * The name of any <<label,label>> defined before{nbsp}__**L**__
1770 which isn't within a nested group.
1771 * The name of any <<variable-assignment,variable>> known
1775 The value of the special name `ICITTE` (`int` type) in this expression
1776 is the <<cur-offset,current offset>> (before handling the items to
1779 ** A valid {py3} name.
1781 For the name `__NAME__`, this is equivalent to the
1782 `pass:[{]__NAME__pass:[}]` form above.
1784 . Zero or more items except, recursively, a macro definition block.
1786 . The `!end` closing.
1788 You may also use a <<post-item-repetition,post-item repetition>> after
1789 some items. The form ``!repeat{nbsp}__X__{nbsp}__ITEMS__{nbsp}!end``
1790 is equivalent to ``(__ITEMS__){nbsp}pass:[*]{nbsp}__X__``.
1797 {end - ICITTE - 1 : 8}
1806 ff fe fd fc fb fa f9 f8 f7 f6 f5 f4 f3 f2 f1 f0 ┆ ••••••••••••••••
1807 ef ee ed ec eb ea e9 e8 e7 e6 e5 e4 e3 e2 e1 e0 ┆ ••••••••••••••••
1808 df de dd dc db da d9 d8 d7 d6 d5 d4 d3 d2 d1 d0 ┆ ••••••••••••••••
1809 cf ce cd cc cb ca c9 c8 c7 c6 c5 c4 c3 c2 c1 c0 ┆ ••••••••••••••••
1810 bf be bd bc bb ba b9 b8 b7 b6 b5 b4 b3 b2 b1 b0 ┆ ••••••••••••••••
1811 af ae ad ac ab aa a9 a8 a7 a6 a5 a4 a3 a2 a1 a0 ┆ ••••••••••••••••
1812 9f 9e 9d 9c 9b 9a 99 98 97 96 95 94 93 92 91 90 ┆ ••••••••••••••••
1813 8f 8e 8d 8c 8b 8a 89 88 87 86 85 84 83 82 81 80 ┆ ••••••••••••••••
1814 7f 7e 7d 7c 7b 7a 79 78 77 76 75 74 73 72 71 70 ┆ •~}|{zyxwvutsrqp
1815 6f 6e 6d 6c 6b 6a 69 68 67 66 65 64 63 62 61 60 ┆ onmlkjihgfedcba`
1816 5f 5e 5d 5c 5b 5a 59 58 57 56 55 54 53 52 51 50 ┆ _^]\[ZYXWVUTSRQP
1817 4f 4e 4d 4c 4b 4a 49 48 47 46 45 44 43 42 41 40 ┆ ONMLKJIHGFEDCBA@
1818 3f 3e 3d 3c 3b 3a 39 38 37 36 35 34 33 32 31 30 ┆ ?>=<;:9876543210
1819 2f 2e 2d 2c 2b 2a 29 28 27 26 25 24 23 22 21 20 ┆ /.-,+*)('&%$#"!
1820 1f 1e 1d 1c 1b 1a 19 18 17 16 15 14 13 12 11 10 ┆ ••••••••••••••••
1821 0f 0e 0d 0c 0b 0a 09 08 07 06 05 04 03 02 01 00 ┆ ••••••••••••••••
1840 11 22 !repeat times 33 !end
1851 aa bb cc dd ee ff ee ff ee ff ee ff ee ff 11 22 ┆ •••••••••••••••"
1852 33 ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ 3•••••••••••••••
1853 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1854 ff ee ff ee ff 11 22 33 33 ee ff ee ff ee ff ee ┆ ••••••"33•••••••
1855 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1856 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1857 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1858 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1859 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1860 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1861 ff ee ff ee ff ee ff ee ff ee ff ee ff 11 22 33 ┆ ••••••••••••••"3
1862 33 33 63 6f 75 63 6f 75 21 ┆ 33coucou!
1866 === Transformation block
1868 A _transformation block_ represents the bytes of one or more items
1869 transformed into other bytes by a function.
1871 As of this version, Normand only offers a predetermined set of
1872 transformation functions.
1874 An encoded block is:
1876 . The `!transform` or `!t` opening.
1878 . A transformation function name amongst:
1884 Standard https://datatracker.ietf.org/doc/html/rfc4648.html#section-4[Base64].
1888 URL-safe Base64, using `-` instead of `pass:[+]` and `_` instead of
1893 Standard https://datatracker.ietf.org/doc/html/rfc4648.html#section-6[Base32].
1897 Standard https://datatracker.ietf.org/doc/html/rfc4648.html#section-8[Base16].
1901 https://en.wikipedia.org/wiki/Ascii85[Ascii85] without padding.
1905 Ascii85 with padding.
1909 https://en.wikipedia.org/wiki/Ascii85[Base85] (like Git-style binary
1910 diffs) without padding.
1914 Base85 with padding.
1919 https://datatracker.ietf.org/doc/html/rfc2045#section-6.7[quoted-printable]
1920 without quoted whitespaces.
1924 MIME quoted-printable with quoted whitespaces.
1928 https://en.wikipedia.org/wiki/Gzip[gzip].
1932 https://en.wikipedia.org/wiki/Bzip2[bzip2].
1935 . Zero or more items except, recursively, a macro definition block.
1937 Any {py3} expression within any of those items may not refer to a future
1940 The value of the special name `ICITTE` in any {py3} expression within
1941 any of those items is the <<cur-offset,current offset>> _before_ Normand
1942 applies the transformation function. Therefore, labels defined within
1943 those items also have the current offset value _before_ Normand applies
1944 the transformation function.
1946 . The `!end` closing.
1948 The <<cur-offset,current offset>> after having handled the last item of
1949 a transformation block is the value of the current offset before
1950 handling the first item plus the size of the generated (transformed)
1951 bytes. In other words, <<current-offset-setting,current offset
1952 settings>> within the items of the block have no impact outside said
1961 "size of compressed section: " {end - start : 8}
1966 "this will be compressed!"
1978 aa bb cc dd 73 69 7a 65 20 6f 66 20 63 6f 6d 70 ┆ ••••size of comp
1979 72 65 73 73 65 64 20 73 65 63 74 69 6f 6e 3a 20 ┆ ressed section:
1980 52 42 5a 68 39 31 41 59 26 53 59 68 e1 8c fc 00 ┆ RBZh91AY&SYh••••
1981 00 33 d1 e0 c0 00 60 00 5e 66 dc 80 00 20 00 80 ┆ •3••••`•^f••• ••
1982 00 08 20 00 31 40 d3 43 23 26 20 ca 87 a9 a1 e8 ┆ •• •1@•C#& •••••
1983 18 29 44 80 9c 80 49 bf cc b3 e8 45 ed e2 76 ad ┆ •)D•••I••••E••v•
1984 0f 12 8b 8a d6 cd 40 04 7e 2e e4 8a 70 a1 20 d1 ┆ ••••••@•~.••p• •
1985 c3 19 f8 79 65 73 21 ┆ •••yes!
1996 "I am determined to be cheerful and happy in whatever situation "
1997 "I may find myself. For I have learned that the greater part of "
1998 "our misery or unhappiness is determined not by our circumstance "
1999 "but by our disposition."
2004 !t qp <beg> {ICITTE - beg : 8} * 50 !end
2010 88 88 88 88 88 88 88 88 88 88 88 88 88 88 88 88 ┆ ••••••••••••••••
2011 38 4b 5f 47 59 2b 43 6f 26 2a 41 54 44 58 25 44 ┆ 8K_GY+Co&*ATDX%D
2012 49 6d 3f 24 46 44 69 3a 32 41 4b 59 4a 72 41 53 ┆ Im?$FDi:2AKYJrAS
2013 23 6d 6f 46 5f 69 31 2f 44 49 61 6c 27 40 3b 70 ┆ #moF_i1/DIal'@;p
2014 31 32 2b 44 47 5e 39 47 41 28 45 2c 41 54 68 58 ┆ 12+DG^9GA(E,AThX
2015 2a 2b 45 4d 37 3d 46 5e 5d 42 2b 44 66 2d 5b 68 ┆ *+EM7=F^]B+Df-[h
2016 2b 44 6b 50 34 2b 44 2c 3e 2a 41 30 3e 60 37 46 ┆ +DkP4+D,>*A0>`7F
2017 28 4b 30 22 2f 67 2a 57 25 45 5a 64 70 72 42 4f ┆ (K0"/g*W%EZdprBO
2018 51 27 71 2b 44 62 55 74 45 63 2c 48 21 2b 45 56 ┆ Q'q+DbUtEc,H!+EV
2019 3a 2a 46 3c 47 5b 3d 41 4b 59 57 2b 41 52 54 5b ┆ :*F<G[=AKYW+ART[
2020 6c 45 5a 66 3d 30 45 63 60 46 42 41 66 75 23 37 ┆ lEZf=0Ec`FBAfu#7
2021 45 5a 66 34 35 46 28 4b 42 3b 2b 45 29 39 43 46 ┆ EZf45F(KB;+E)9CF
2022 60 28 6c 24 45 2c 5d 4e 2f 41 54 4d 6f 38 42 6c ┆ `(l$E,]N/ATMo8Bl
2023 62 44 2d 41 54 56 4c 28 44 2f 21 6d 21 41 30 3e ┆ bD-ATVL(D/!m!A0>
2024 63 2e 46 3c 47 25 3c 2b 45 29 43 43 2b 43 66 2c ┆ c.F<G%<+E)CC+Cf,
2025 2b 40 73 29 58 30 46 43 42 26 73 41 4b 59 48 29 ┆ +@s)X0FCB&sAKYH)
2026 46 3c 47 25 3c 2b 45 29 43 43 2b 43 6f 32 2d 45 ┆ F<G%<+E)CC+Co2-E
2027 2c 54 66 33 46 44 35 5a 32 2f 63 99 99 99 99 99 ┆ ,Tf3FD5Z2/c•••••
2028 3d 30 30 3d 30 31 3d 30 32 3d 30 33 3d 30 34 3d ┆ =00=01=02=03=04=
2029 30 35 3d 30 36 3d 30 37 3d 30 38 3d 30 39 0a 3d ┆ 05=06=07=08=09•=
2030 30 42 3d 30 43 0d 3d 30 45 3d 30 46 3d 31 30 3d ┆ 0B=0C•=0E=0F=10=
2031 31 31 3d 31 32 3d 31 33 3d 31 34 3d 31 35 3d 31 ┆ 11=12=13=14=15=1
2032 36 3d 31 37 3d 31 38 3d 31 39 3d 31 41 3d 31 42 ┆ 6=17=18=19=1A=1B
2033 3d 31 43 3d 31 44 3d 31 45 3d 31 46 20 21 22 23 ┆ =1C=1D=1E=1F !"#
2034 24 25 26 27 28 29 2a 2b 2c 2d 3d 0a 2e 2f 30 31 ┆ $%&'()*+,-=•./01
2038 === Macro definition block
2040 A _macro definition block_ associates a name and parameter names to
2043 A macro definition block doesn't lead to generated bytes itself: a
2044 <<macro-expansion,macro expansion>> does so.
2046 A macro definition may only exist at the root level, that is, not within
2047 a <<group,group>>, a <<repetition-block,repetition block>>, a
2048 <<conditional-block,conditional block>>, or another
2049 <<macro-definition-block,macro definition block>>.
2051 All macro definitions must have unique names.
2053 A macro definition is:
2055 . The `!macro` or `!m` opening.
2057 . A valid {py3} name (the macro name).
2059 . The `(` parameter name list prefix.
2061 . A comma-separated list of zero or more unique parameter names,
2062 each one being a valid {py3} name.
2064 . The `)` parameter name list suffix.
2066 . Zero or more items except, recursively, a macro definition block.
2068 . The `!end` closing.
2073 {le} {ICITTE * 8 : 16}
2074 u16le"predict explode"
2081 !macro nail(rep, with_extra, val)
2085 {val + iter : uleb128}
2099 A _macro expansion_ expands the items of a defined
2100 <<macro-definition-block,macro>>.
2102 The macro to expand must be defined _before_ the expansion.
2104 The <<state,state>> before handling the first item of the chosen macro
2107 <<cur-offset,Current offset>>::
2110 <<cur-bo,Current byte order>>::
2114 The only available variables initially are the macro parameters.
2119 The state after having handled the last item of the chosen macro is:
2122 The one before handling the first item of the macro plus the size
2123 of the generated data of the macro expansion.
2125 IMPORTANT: This means <<current-offset-setting,current offset setting>>
2126 items within the expanded macro don't impact the final current offset.
2128 Current byte order::
2129 The one before handling the first item of the macro.
2132 The ones before handling the first item of the macro.
2135 The ones before handling the first item of the macro.
2137 A macro expansion is:
2141 . A valid {py3} name (the name of the macro to expand).
2143 . The `(` parameter value list prefix.
2145 . A comma-separated list of zero or more unique parameter values.
2147 The number of parameter values must match the number of parameter
2148 names of the definition of the chosen macro.
2150 A parameter value is one of:
2153 * A <<const-int,constant integer>>, possibly negative.
2155 * A constant floating point number.
2157 * The ``pass:[{]`` prefix, a valid {py3} expression of which the
2158 evaluation result type is `int` or `bool` (automatically converted to
2159 `int`), and the ``pass:[}]`` suffix.
2161 For a macro expansion at some source location{nbsp}__**L**__, this
2162 expression may contain:
2164 ** The name of any <<label,label>> defined before{nbsp}__**L**__
2165 which isn't within a nested group.
2166 ** The name of any <<variable-assignment,variable>> known
2170 The value of the special name `ICITTE` (`int` type) in this expression
2171 is the <<cur-offset,current offset>> (before handling the items of the
2174 * A valid {py3} name.
2176 For the name `__NAME__`, this is equivalent to the
2177 `pass:[{]__NAME__pass:[}]` form above.
2180 . The `)` parameter value list suffix.
2187 {le} {ICITTE * 8 : 16}
2188 u16le"predict explode"
2191 "hello [" m:bake() "] world"
2199 68 65 6c 6c 6f 20 5b 38 00 70 00 72 00 65 00 64 ┆ hello [8•p•r•e•d
2200 00 69 00 63 00 74 00 20 00 65 00 78 00 70 00 6c ┆ •i•c•t• •e•x•p•l
2201 00 6f 00 64 00 65 00 5d 20 77 6f 72 6c 64 70 01 ┆ •o•d•e•] worldp•
2202 70 00 72 00 65 00 64 00 69 00 63 00 74 00 20 00 ┆ p•r•e•d•i•c•t• •
2203 65 00 78 00 70 00 6c 00 6f 00 64 00 65 00 70 02 ┆ e•x•p•l•o•d•e•p•
2204 70 00 72 00 65 00 64 00 69 00 63 00 74 00 20 00 ┆ p•r•e•d•i•c•t• •
2205 65 00 78 00 70 00 6c 00 6f 00 64 00 65 00 70 03 ┆ e•x•p•l•o•d•e•p•
2206 70 00 72 00 65 00 64 00 69 00 63 00 74 00 20 00 ┆ p•r•e•d•i•c•t• •
2207 65 00 78 00 70 00 6c 00 6f 00 64 00 65 00 70 04 ┆ e•x•p•l•o•d•e•p•
2208 70 00 72 00 65 00 64 00 69 00 63 00 74 00 20 00 ┆ p•r•e•d•i•c•t• •
2209 65 00 78 00 70 00 6c 00 6f 00 64 00 65 00 70 05 ┆ e•x•p•l•o•d•e•p•
2210 70 00 72 00 65 00 64 00 69 00 63 00 74 00 20 00 ┆ p•r•e•d•i•c•t• •
2211 65 00 78 00 70 00 6c 00 6f 00 64 00 65 00 ┆ e•x•p•l•o•d•e•
2219 !macro A(val, is_be)
2229 !macro B(rep, is_be)
2233 m:A({iter * 3}, is_be)
2245 00 03 00 06 00 09 00 0c 00 0f 03 00 06 00 09 00
2253 !macro flt32be(val) {be} {val : 32} !end
2263 43 48 45 45 54 4f 53 c2 28 ae 14 3b b8 41 25 ┆ CHEETOS•(••;•A%
2267 === Post-item repetition
2269 A _post-item repetition_ represents the bytes of an item repeated a
2270 given number of times.
2272 A post-item repetition is:
2274 . One of those items:
2276 ** A <<byte-constant,byte constant>>.
2277 ** A <<literal-string,literal string>>.
2278 ** A <<fixed-length-number,fixed-length number>>.
2279 ** An <<leb128-integer,LEB128 integer>>.
2280 ** A <<string,string>>.
2281 ** A <<macro-expansion,macro-expansion>>.
2282 ** A <<transformation-block,transformation block>>.
2283 ** A <<group,group>>.
2285 . The ``pass:[*]`` character.
2289 ** A positive integer (hexadecimal starting with `0x` or `0X` accepted)
2290 which is the number of times to repeat the previous item.
2292 ** The ``pass:[{]`` prefix, a valid {py3} expression of which the
2293 evaluation result type is `int` or `bool` (automatically converted to
2294 `int`), and the ``pass:[}]`` suffix.
2296 For a post-item repetition at some source location{nbsp}__**L**__, this
2297 expression may contain:
2300 * The name of any <<label,label>> defined before{nbsp}__**L**__
2301 which isn't within a nested group and
2302 which isn't part of the repeated item.
2303 * The name of any <<variable-assignment,variable>> known
2304 at{nbsp}__**L**__, which isn't part of its repeated item, and which
2308 The value of the special name `ICITTE` (`int` type) in this expression
2309 is the <<cur-offset,current offset>> (before handling the items to
2312 ** A valid {py3} name.
2314 For the name `__NAME__`, this is equivalent to the
2315 `pass:[{]__NAME__pass:[}]` form above.
2317 You may also use a <<repetition-block,repetition block>>. The form
2318 ``__ITEM__{nbsp}pass:[*]{nbsp}__X__`` is equivalent to
2319 ``!repeat{nbsp}__X__{nbsp}__ITEM__{nbsp}!end``.
2325 {end - ICITTE - 1 : 8} * 0x100 <end>
2331 ff fe fd fc fb fa f9 f8 f7 f6 f5 f4 f3 f2 f1 f0 ┆ ••••••••••••••••
2332 ef ee ed ec eb ea e9 e8 e7 e6 e5 e4 e3 e2 e1 e0 ┆ ••••••••••••••••
2333 df de dd dc db da d9 d8 d7 d6 d5 d4 d3 d2 d1 d0 ┆ ••••••••••••••••
2334 cf ce cd cc cb ca c9 c8 c7 c6 c5 c4 c3 c2 c1 c0 ┆ ••••••••••••••••
2335 bf be bd bc bb ba b9 b8 b7 b6 b5 b4 b3 b2 b1 b0 ┆ ••••••••••••••••
2336 af ae ad ac ab aa a9 a8 a7 a6 a5 a4 a3 a2 a1 a0 ┆ ••••••••••••••••
2337 9f 9e 9d 9c 9b 9a 99 98 97 96 95 94 93 92 91 90 ┆ ••••••••••••••••
2338 8f 8e 8d 8c 8b 8a 89 88 87 86 85 84 83 82 81 80 ┆ ••••••••••••••••
2339 7f 7e 7d 7c 7b 7a 79 78 77 76 75 74 73 72 71 70 ┆ •~}|{zyxwvutsrqp
2340 6f 6e 6d 6c 6b 6a 69 68 67 66 65 64 63 62 61 60 ┆ onmlkjihgfedcba`
2341 5f 5e 5d 5c 5b 5a 59 58 57 56 55 54 53 52 51 50 ┆ _^]\[ZYXWVUTSRQP
2342 4f 4e 4d 4c 4b 4a 49 48 47 46 45 44 43 42 41 40 ┆ ONMLKJIHGFEDCBA@
2343 3f 3e 3d 3c 3b 3a 39 38 37 36 35 34 33 32 31 30 ┆ ?>=<;:9876543210
2344 2f 2e 2d 2c 2b 2a 29 28 27 26 25 24 23 22 21 20 ┆ /.-,+*)('&%$#"!
2345 1f 1e 1d 1c 1b 1a 19 18 17 16 15 14 13 12 11 10 ┆ ••••••••••••••••
2346 0f 0e 0d 0c 0b 0a 09 08 07 06 05 04 03 02 01 00 ┆ ••••••••••••••••
2358 (ee ff) * {here + 1}
2368 aa bb cc dd ee ff ee ff ee ff ee ff ee ff 11 22 ┆ •••••••••••••••"
2369 33 ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ 3•••••••••••••••
2370 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
2371 ff ee ff ee ff 11 22 33 33 ee ff ee ff ee ff ee ┆ ••••••"33•••••••
2372 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
2373 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
2374 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
2375 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
2376 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
2377 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
2378 ff ee ff ee ff ee ff ee ff ee ff ee ff 11 22 33 ┆ ••••••••••••••"3
2379 33 33 63 6f 75 63 6f 75 21 ┆ 33coucou!
2383 == Command-line tool
2385 If you <<install-normand,installed>> the `normand` package, then you
2386 can use the `normand` command-line tool:
2389 $ normand <<< '"ma gang de malades"' | hexdump -C
2393 00000000 6d 61 20 67 61 6e 67 20 64 65 20 6d 61 6c 61 64 |ma gang de malad|
2397 If you copy the `normand.py` module to your own project, then you can
2398 run the module itself:
2401 $ python3 -m normand <<< '"ma gang de malades"' | hexdump -C
2405 00000000 6d 61 20 67 61 6e 67 20 64 65 20 6d 61 6c 61 64 |ma gang de malad|
2409 Without a path argument, the `normand` tool reads from the standard
2412 The `normand` tool prints the generated binary data to the standard
2415 Various options control the initial <<state,state>> of the processor:
2416 use the `--help` option to learn more.
2420 The whole `normand` package/module public API is:
2425 class ByteOrder(enum.Enum):
2437 def line_no(self) -> int:
2442 def col_no(self) -> int:
2446 # Parsing error message.
2447 class ParseErrorMessage:
2453 # Source text location.
2455 def text_location(self):
2460 class ParseError(RuntimeError):
2461 # Parsing error messages.
2463 # The first message is the most _specific_ one.
2469 # Variables dictionary type (for type hints).
2470 VariablesT = typing.Dict[str, typing.Union[int, float]]
2473 # Labels dictionary type (for type hints).
2474 LabelsT = typing.Dict[str, int]
2481 def data(self) -> bytearray:
2484 # Updated variable values.
2486 def variables(self) -> SymbolsT:
2489 # Updated main group label values.
2491 def labels(self) -> SymbolsT:
2496 def offset(self) -> int:
2501 def byte_order(self) -> typing.Optional[ByteOrder]:
2505 # Parses the `normand` input using the initial state defined by
2506 # `init_variables`, `init_labels`, `init_offset`, and `init_byte_order`,
2507 # and returns the corresponding parsing result.
2508 def parse(normand: str,
2509 init_variables: typing.Optional[SymbolsT] = None,
2510 init_labels: typing.Optional[SymbolsT] = None,
2511 init_offset: int = 0,
2512 init_byte_order: typing.Optional[ByteOrder] = None) -> ParseResult:
2516 The `normand` parameter is the actual <<learn-normand,Normand input>>
2517 while the other parameters control the initial <<state,state>>.
2519 The `parse()` function raises a `ParseError` instance should it fail to
2520 parse the `normand` string for any reason.
2524 Normand is a https://python-poetry.org/[Poetry] project.
2526 To develop it, install it through Poetry and enter the virtual
2532 $ normand <<< '"lol" * 10 0a'
2535 `normand.py` is processed by:
2537 * https://microsoft.github.io/pyright/[Pyright]
2538 * https://github.com/psf/black[Black]
2539 * https://pycqa.github.io/isort/[isort]
2543 Use https://docs.pytest.org/[pytest] to test Normand once the package is
2544 part of your virtual environment, for example:
2548 $ poetry run pip3 install pytest
2552 The `pytest` project is currently not a development dependency in
2553 `pyproject.toml` due to backward compatibiliy issues with
2556 In the `tests` directory, each `*.nt` file is a test. The file name
2557 prefix indicates what it's meant to test:
2560 Everything above the `---` line is the valid Normand input
2563 Everything below the `---` line is the expected data
2564 (whitespace-separated hexadecimal bytes).
2567 Everything above the `---` line is the invalid Normand input
2570 Everything below the `---` line is the expected error message having
2579 Normand uses https://review.lttng.org/admin/repos/normand,general[Gerrit]
2582 To report a bug, https://github.com/efficios/normand/issues/new[create a