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.15, 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
101 UTF-8, UTF-16, and UTF-32 literal strings::
107 u16le"stress\nverdict 🤣"
113 68 65 6c 6c 6f 20 77 6f 72 6c 64 21 00 73 00 74 ┆ hello world!•s•t
114 00 72 00 65 00 73 00 73 00 0a 00 76 00 65 00 72 ┆ •r•e•s•s•••v•e•r
115 00 64 00 69 00 63 00 74 00 20 00 3e d8 23 dd ┆ •d•i•c•t• •>•#•
118 Labels: special variables holding the offset where they're defined::
121 <beg> b2 52 e3 bc 91 05
122 $100 $50 <chair> 33 9f fe
129 5e 65 {tower = 47} c6 7f f2 c4
130 44 {hurl = tower - 14} b5 {tower = hurl} 26 2d
133 The value of a variable assignment is the evaluation of a valid {py3}
134 expression which may include label and variable names.
136 Fixed-length number with a given length (8{nbsp}bits to 64{nbsp}bits) and byte order::
142 {be} 67 <lbl> 44 $178 {(end - lbl) * 8 + strength : 16} $99 <end>
150 67 44 b2 00 2c 63 37 f8 ff ff 7f bd c2 82 fb 21
154 The encoded number is the evaluation of a valid {py3} expression which
155 may include label and variable names.
157 https://en.wikipedia.org/wiki/LEB128[LEB128] integer::
162 aa bb cc {-1993 : sleb128} <meow> dd ee ff
163 {meow * 199 : uleb128}
169 aa bb cc b7 70 dd ee ff e3 07
172 The encoded integer is the evaluation of a valid {py3} expression which
173 may include label and variable names.
196 aa bb cc 66 6f 6f 66 69 67 68 74 66 6f 6f 66 69 ┆ •••foofightfoofi
197 67 68 74 66 6f 6f 62 61 72 66 6f 6f 62 61 72 ┆ ghtfoobarfoobar
205 aa bb * 5 cc <zoom> "yeah\0" * {zoom * 3}
215 aa bb bb bb bb bb cc 79 65 61 68 00 79 65 61 68 ┆ •••••••yeah•yeah
216 00 79 65 61 68 00 79 65 61 68 00 79 65 61 68 00 ┆ •yeah•yeah•yeah•
217 79 65 61 68 00 79 65 61 68 00 79 65 61 68 00 79 ┆ yeah•yeah•yeah•y
218 65 61 68 00 79 65 61 68 00 79 65 61 68 00 79 65 ┆ eah•yeah•yeah•ye
219 61 68 00 79 65 61 68 00 79 65 61 68 00 79 65 61 ┆ ah•yeah•yeah•yea
220 68 00 79 65 61 68 00 79 65 61 68 00 79 65 61 68 ┆ h•yeah•yeah•yeah
221 00 79 65 61 68 00 79 65 61 68 00 79 65 61 68 00 ┆ •yeah•yeah•yeah•
222 ff ee 6a 75 69 63 65 ff ee 6a 75 69 63 65 ff ee ┆ ••juice••juice••
223 6a 75 69 63 65 ┆ juice
242 00 00 00 c7 00 00 00 00 00 00 00 00 00 00 00 2b
243 ff 85 ff ff 00 00 15 d0
265 ef be ad de 37 f8 09 00 00 00 00 00 00 00 00 00 ┆ ••••7•••••••••••
266 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ┆ ••••••••••••••••
267 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ┆ ••••••••••••••••
268 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ┆ ••••••••••••••••
269 40 6d 65 6f 77 20 6d 69 78 ff ff ff ff ff ff ff ┆ @meow mix•••••••
270 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ┆ ••••••••••••••••
271 ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ff ┆ ••••••••••••••••
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 c8 ┆ •••••••••
280 Multilevel grouping::
285 ff ((aa bb "zoom" cc) * 5) * 3 $-34 * 4
291 ff aa bb 7a 6f 6f 6d cc aa bb 7a 6f 6f 6d cc aa ┆ •••zoom•••zoom••
292 bb 7a 6f 6f 6d cc aa bb 7a 6f 6f 6d cc aa bb 7a ┆ •zoom•••zoom•••z
293 6f 6f 6d cc aa bb 7a 6f 6f 6d cc aa bb 7a 6f 6f ┆ oom•••zoom•••zoo
294 6d cc aa bb 7a 6f 6f 6d cc aa bb 7a 6f 6f 6d cc ┆ m•••zoom•••zoom•
295 aa bb 7a 6f 6f 6d cc aa bb 7a 6f 6f 6d cc aa bb ┆ ••zoom•••zoom•••
296 7a 6f 6f 6d cc aa bb 7a 6f 6f 6d cc aa bb 7a 6f ┆ zoom•••zoom•••zo
297 6f 6d cc aa bb 7a 6f 6f 6d cc de de de de ┆ om•••zoom•••••
307 !if world " world" !end
312 m:hello({ICITTE > 15 and ICITTE < 60})
319 ff ff ff ff 68 65 6c 6c 6f ff ff ff ff 68 65 6c ┆ ••••hello••••hel
320 6c 6f ff ff ff ff 68 65 6c 6c 6f 20 77 6f 72 6c ┆ lo••••hello worl
321 64 ff ff ff ff 68 65 6c 6c 6f 20 77 6f 72 6c 64 ┆ d••••hello world
322 ff ff ff ff 68 65 6c 6c 6f 20 77 6f 72 6c 64 ff ┆ ••••hello world•
323 ff ff ff 68 65 6c 6c 6f ff ff ff ff 68 65 6c 6c ┆ •••hello••••hell
324 6f ff ff ff ff 68 65 6c 6c 6f ff ff ff ff 68 65 ┆ o••••hello••••he
325 6c 6c 6f ff ff ff ff 68 65 6c 6c 6f ff ff ff ff ┆ llo••••hello••••
326 68 65 6c 6c 6f ff ff ff ff 68 65 6c 6c 6f ff ff ┆ hello••••hello••
327 ff ff 68 65 6c 6c 6f ff ff ff ff 68 65 6c 6c 6f ┆ ••hello••••hello
328 ff ff ff ff 68 65 6c 6c 6f ff ff ff ff 68 65 6c ┆ ••••hello••••hel
329 6c 6f ff ff ff ff 68 65 6c 6c 6f ┆ lo••••hello
332 Precise error reporting::
335 /tmp/meow.normand:10:24 - Expecting a bit (`0` or `1`).
339 /tmp/meow.normand:32:6 - Unexpected character `k`.
343 /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`}.
347 /tmp/meow.normand:32:19 - While expanding the macro `meow`:
348 /tmp/meow.normand:35:5 - While expanding the macro `zzz`:
349 /tmp/meow.normand:18:9 - Value 315 is outside the 8-bit range when evaluating expression `end - ICITTE`.
352 You can use Normand to track data source files in your favorite VCS
353 instead of raw binary files. The binary files that Normand generates can
354 be used to test file format decoding, including malformatted data, for
355 example, as well as for education.
357 See <<learn-normand>> to explore all the Normand features.
361 Normand requires Python ≥ 3.4.
366 $ python3 -m pip install --user normand
370 https://packaging.python.org/en/latest/tutorials/installing-packages/#installing-to-the-user-site[Installing to the User Site]
371 to learn more about a user site installation.
375 Normand has a single module file, `normand.py`, which you can copy as is
376 to your project to use it (both the <<python3-api,`normand.parse()`>>
377 function and the <<command-line-tool,command-line tool>>).
379 `normand.py` has _no external dependencies_, but if you're using
380 Python{nbsp}3.4, you'll need a local copy of the standard `typing`
386 A Normand text input is a sequence of items which represent a sequence
389 [[state]] During the processing of items to data, Normand relies on a
394 |State variable |Description |Initial value: <<python3-api,{py3} API>> |Initial value: <<command-line-tool,CLI>>
396 |[[cur-offset]] Current offset
398 The current offset has an effect on the value of <<label,labels>> and of
399 the special `ICITTE` name in <<fixed-length-number,fixed-length
400 number>>, <<leb-128-integer,LEB128 integer>>,
401 <<filling,filling>>, <<variable-assignment,variable assignment>>,
402 <<conditional-block,conditional block>>, <<repetition-block,repetition
403 block>>, <<macro-expansion,macro expansion>>, and
404 <<post-item-repetition,post-item repetition>> expression evaluation.
406 Each generated byte increments the current offset.
408 A <<current-offset-setting,current offset setting>> may change the
409 current offset without generating data.
411 An <<current-offset-alignment,current offset alignment>> generates
412 padding bytes to make the current offset satisfy a given alignment.
413 |`init_offset` parameter of the `parse()` function.
416 |[[cur-bo]] Current byte order
418 The current byte order has an effect on the encoding of
419 <<fixed-length-number,fixed-length numbers>>.
421 A <<current-byte-order-setting,current byte order setting>> may change
422 the current byte order.
423 |`init_byte_order` parameter of the `parse()` function.
424 |`--byte-order` option.
427 |Mapping of label names to integral values.
428 |`init_labels` parameter of the `parse()` function.
429 |One or more `--label` options.
431 |<<variable-assignment,Variables>>
432 |Mapping of variable names to integral or floating point number values.
433 |`init_variables` parameter of the `parse()` function.
434 |One or more `--var` options.
437 The available items are:
439 * A <<byte-constant,constant integer>> representing a single byte.
441 * A <<literal-string,literal string>> representing a sequence of bytes
442 encoding UTF-8, UTF-16, or UTF-32 data.
444 * A <<current-byte-order-setting,current byte order setting>> (big or
447 * A <<fixed-length-number,fixed-length number>> (integer or
448 floating point) using the <<cur-bo,current byte order>> and of which
449 the value is the result of a {py3} expression.
451 * An <<leb128-integer,LEB128 integer>> of which the value is the result
452 of a {py3} expression.
454 * A <<current-offset-setting,current offset setting>>.
456 * A <<current-offset-alignment,current offset alignment>>.
458 * A <<filling,filling>>.
460 * A <<label,label>>, that is, a named constant holding the current
463 This is similar to an assembly label.
465 * A <<variable-assignment,variable assignment>> associating a name to
466 the integral result of an evaluated {py3} expression.
468 * A <<group,group>>, that is, a scoped sequence of items.
470 * A <<conditional-block,conditional block>>.
472 * A <<repetition-block,repetition block>>.
474 * A <<macro-definition-block,macro definition block>>.
476 * A <<macro-expansion,macro expansion>>.
478 Moreover, you can repeat many items above a constant or variable number
479 of times with the ``pass:[*]`` operator _after_ the item to repeat. This
480 is called a <<post-item-repetition,post-item repetition>>.
482 A Normand comment may exist:
484 * Between items, possibly within a group.
485 * Between the nibbles of a constant hexadecimal byte.
486 * Between the bits of a constant binary byte.
487 * Between the last item and the ``pass:[*]`` character of a post-item
488 repetition, and between that ``pass:[*]`` character and the following
489 number or expression.
490 * Between the ``!repeat``/``!r`` block opening and the following
491 constant integer, name, or expression of a repetition block.
492 * Between the ``!if`` block opening and the following name or expression
493 of a conditional block.
495 A comment is anything between two ``pass:[#]`` characters on the same
496 line, or from ``pass:[#]`` until the end of the line. Whitespaces and
497 the following symbol characters are also considered comments where a
501 / \ ? & : ; . , [ ] _ = | -
504 The latter serve to improve readability so that you may write, for
505 example, a MAC address or a UUID as is.
507 [[const-int]] Many items require a _constant integer_, possibly
508 negative, in which case it may start with `-` for a negative integer. A
509 positive constant integer is any of:
512 One or mode digits (`0` to `9`).
517 * The `0x` or `0X` prefix followed with one or more hexadecimal digits
518 (`0` to `9`, `a` to `f`, or `A` to `F`).
519 * One or more hexadecimal digits followed with the `h` or `H` suffix.
524 * The `0o` or `0O` prefix followed with one or more octal digits
526 * One or more octal digits followed with the `o`, `O`, `q`, or `Q`
532 * The `0b` or `0B` prefix followed with one or more bits (`0` or `1`).
533 * One or more bits followed with the `b` or `B` suffix.
535 You can test the examples of this section with the `normand`
536 <<command-line-tool,command-line tool>> as such:
539 $ normand file | hexdump -C
542 where `file` is the name of a file containing the Normand input.
546 A _byte constant_ represents a single byte.
551 Two consecutive hexadecimal digits.
554 One or more digits after the `$` prefix.
557 Eight bits after the `%` prefix.
577 $192 %1100/0011 $ -77
591 58f64689-6316-4d55-8a1a-04cada366172
592 fe80::6257:18ff:fea3:4229
598 58 f6 46 89 63 16 4d 55 8a 1a 04 ca da 36 61 72 ┆ X•F•c•MU•••••6ar
599 fe 80 62 57 18 ff fe a3 42 29 ┆ ••bW••••B)
607 %01110011 %01100001 %01101100 %01110101 %01110100
613 73 61 6c 75 74 ┆ salut
619 A _literal string_ represents the UTF-8-, UTF-16-, or UTF-32-encoded
622 The string to encode isn't implicitly null-terminated: use `\0` at the
623 end of the string to add a null character.
627 . **Optional**: one of the following encodings instead of UTF-8:
637 . The ``pass:["]`` prefix.
639 . A sequence of zero or more characters, possibly containing escape
642 An escape sequence is the ``\`` character followed by one of:
648 `b`:: Backspace (U+0008)
649 `e`:: Escape (U+001B)
650 `f`:: Form feed (U+000C)
651 `n`:: End of line (U+000A)
652 `r`:: Carriage return (U+000D)
653 `t`:: Character tabulation (U+0009)
654 `v`:: Line tabulation (U+000B)
655 ``\``:: Reverse solidus (U+005C)
656 ``pass:["]``:: Quotation mark (U+0022)
659 . The ``pass:["]`` suffix.
665 "coucou tout le monde!"
671 63 6f 75 63 6f 75 20 74 6f 75 74 20 6c 65 20 6d ┆ coucou tout le m
672 6f 6e 64 65 21 ┆ onde!
680 u16le"I am not young enough to know everything."
686 49 00 20 00 61 00 6d 00 20 00 6e 00 6f 00 74 00 ┆ I• •a•m• •n•o•t•
687 20 00 79 00 6f 00 75 00 6e 00 67 00 20 00 65 00 ┆ •y•o•u•n•g• •e•
688 6e 00 6f 00 75 00 67 00 68 00 20 00 74 00 6f 00 ┆ n•o•u•g•h• •t•o•
689 20 00 6b 00 6e 00 6f 00 77 00 20 00 65 00 76 00 ┆ •k•n•o•w• •e•v•
690 65 00 72 00 79 00 74 00 68 00 69 00 6e 00 67 00 ┆ e•r•y•t•h•i•n•g•
699 u32be "\"illusion is the first\nof all pleasures\" 🦉"
705 00 00 00 22 00 00 00 69 00 00 00 6c 00 00 00 6c ┆ •••"•••i•••l•••l
706 00 00 00 75 00 00 00 73 00 00 00 69 00 00 00 6f ┆ •••u•••s•••i•••o
707 00 00 00 6e 00 00 00 20 00 00 00 69 00 00 00 73 ┆ •••n••• •••i•••s
708 00 00 00 20 00 00 00 74 00 00 00 68 00 00 00 65 ┆ ••• •••t•••h•••e
709 00 00 00 20 00 00 00 66 00 00 00 69 00 00 00 72 ┆ ••• •••f•••i•••r
710 00 00 00 73 00 00 00 74 00 00 00 0a 00 00 00 6f ┆ •••s•••t•••••••o
711 00 00 00 66 00 00 00 20 00 00 00 61 00 00 00 6c ┆ •••f••• •••a•••l
712 00 00 00 6c 00 00 00 20 00 00 00 70 00 00 00 6c ┆ •••l••• •••p•••l
713 00 00 00 65 00 00 00 61 00 00 00 73 00 00 00 75 ┆ •••e•••a•••s•••u
714 00 00 00 72 00 00 00 65 00 00 00 73 00 00 00 22 ┆ •••r•••e•••s•••"
715 00 00 00 20 00 01 f9 89 ┆ ••• ••••
719 === Current byte order setting
721 This special item sets the <<cur-bo,_current byte order_>>.
723 The two accepted forms are:
726 ``pass:[{be}]``:: Set the current byte order to big endian.
727 ``pass:[{le}]``:: Set the current byte order to little endian.
729 === Fixed-length number
731 A _fixed-length number_ represents a fixed number of bytes encoding
734 * An unsigned or signed integer (two's complement).
736 The available lengths are 8, 16, 24, 32, 40, 48, 56, and 64.
738 * A floating point number
739 (https://standards.ieee.org/standard/754-2008.html[IEEE{nbsp}754-2008]).
741 The available length are 32 (_binary32_) and 64 (_binary64_).
743 The value is the result of evaluating a {py3} expression using the
744 <<cur-bo,current byte order>>.
746 A fixed-length number is:
748 . The ``pass:[{]`` prefix.
750 . A valid {py3} expression.
752 For a fixed-length number at some source location{nbsp}__**L**__, this
753 expression may contain the name of any accessible <<label,label>> (not
754 within a nested group), including the name of a label defined
755 after{nbsp}__**L**__, as well as the name of any
756 <<variable-assignment,variable>> known at{nbsp}__**L**__.
758 The value of the special name `ICITTE` (`int` type) in this expression
759 is the <<cur-offset,current offset>> (before encoding the number).
763 . An encoding length in bits amongst:
766 The expression evaluates to an `int` or `bool` value::
767 `8`, `16`, `24`, `32`, `40`, `48`, `56`, and `64`.
769 NOTE: Normand automatically converts a `bool` value to `int`.
771 The expression evaluates to a `float` value::
798 # String length in bits
799 {8 * (str_end - str_beg) : 16}
810 00 60 68 65 6c 6c 6f 20 77 6f 72 6c 64 21 ┆ •`hello world!
818 {20 - ICITTE : 8} * 10
824 14 13 12 11 10 0f 0e 0d 0c 0b
845 An _LEB128 integer_ represents a variable number of bytes encoding an
846 unsigned or signed integer which is the result of evaluating a {py3}
847 expression following the https://en.wikipedia.org/wiki/LEB128[LEB128]
850 An LEB128 integer is:
852 . The ``pass:[{]`` prefix.
854 . A valid {py3} expression of which the evaluation result type
855 is `int` or `bool` (automatically converted to `int`).
857 For an LEB128 integer at some source location{nbsp}__**L**__, this
858 expression may contain:
861 * The name of any <<label,label>> defined before{nbsp}__**L**__
862 which isn't within a nested group.
863 * The name of any <<variable-assignment,variable>> known
867 The value of the special name `ICITTE` (`int` type) in this expression
868 is the <<cur-offset,current offset>> (before encoding the integer).
876 `uleb128`:: Use the unsigned LEB128 format.
877 `sleb128`:: Use the signed LEB128 format.
903 {-981238311 + (meow * -23) : sleb128}
910 aa bb cc dd ee ff fd fa 8d ac 7c 68 65 6c 6c 6f ┆ ••••••••••|hello
914 === Current offset setting
916 This special item sets the <<cur-offset,_current offset_>>.
918 A current offset setting is:
922 . A <<const-int,positive constant integer>> which is the new current
932 <0x61> {ICITTE : 8} * 8
938 00 01 02 03 04 05 06 07 61 62 63 64 65 66 67 68 ┆ ••••••••abcdefgh
946 aa bb cc dd <meow> ee ff
947 <12> 11 22 33 <mix> 44 55
954 aa bb cc dd ee ff 11 22 33 44 55 04 0f ┆ •••••••"3DU••
958 === Current offset alignment
960 A _current offset alignment_ represents zero or more padding bytes to
961 make the <<cur-offset,current offset>> meet a given
962 https://en.wikipedia.org/wiki/Data_structure_alignment[alignment] value.
964 More specifically, for an alignment value of{nbsp}__**N**__{nbsp}bits,
965 a current offset alignment represents the required padding bytes until
966 the current offset is a multiple of __**N**__{nbsp}/{nbsp}8.
968 A current offset alignment is:
972 . A <<const-int,positive constant integer>> which is the alignment value
975 This value must be greater than zero and a multiple of{nbsp}8.
980 . The ``pass:[~]`` prefix.
981 . A <<const-int,positive constant integer>> which is the value of the
982 byte to use as padding to align the <<cur-offset,current offset>>.
985 Without this section, the padding byte value is zero.
991 11 22 (@32 aa bb cc) * 3
997 11 22 00 00 aa bb cc 00 aa bb cc 00 aa bb cc
1007 @32~0xcc {-893.5:32}
1014 77 88 cc cc 00 60 5f c4 55 55 55 55 55 55 55 55 ┆ w••••`_•UUUUUUUU
1015 6d 65 6f 77 ┆ meow
1023 aa bb cc <29> @64~255 "zoom"
1029 aa bb cc ff ff ff 7a 6f 6f 6d ┆ ••••••zoom
1035 A _filling_ represents zero or more padding bytes to make the
1036 <<cur-offset,current offset>> reach a given value.
1040 . The ``pass:[+]`` prefix.
1044 ** A <<const-int,positive constant integer>> which is the current offset
1047 ** The ``pass:[{]`` prefix, a valid {py3} expression of which the
1048 evaluation result type is `int` or `bool` (automatically converted to
1049 `int`), and the ``pass:[}]`` suffix.
1051 For a filling at some source location{nbsp}__**L**__, this expression
1055 * The name of any <<label,label>> defined before{nbsp}__**L**__
1056 which isn't within a nested group.
1057 * The name of any <<variable-assignment,variable>> known
1061 The value of the special name `ICITTE` (`int` type) in this expression
1062 is the <<cur-offset,current offset>> (before handling the items to
1065 ** A valid {py3} name.
1067 For the name `__NAME__`, this is equivalent to the
1068 `pass:[{]__NAME__pass:[}]` form above.
1071 This value must be greater than or equal to the current offset where
1077 . The ``pass:[~]`` prefix.
1078 . A <<const-int,positive constant integer>> which is the value of the
1079 byte to use as padding to reach the current offset target.
1082 Without this section, the padding byte value is zero.
1096 aa bb cc dd 00 00 00 00 00 00 00 00 00 00 00 00 ┆ ••••••••••••••••
1097 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ┆ ••••••••••••••••
1098 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ┆ ••••••••••••••••
1099 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ┆ ••••••••••••••••
1100 68 65 6c 6c 6f 20 77 6f 72 6c 64 ┆ hello world
1108 !macro part(iter, fill)
1109 <0> "particular security " {ord('0') + iter : 8} +fill~0x80
1115 m:part(iter, {32 + 4 * iter})
1123 70 61 72 74 69 63 75 6c 61 72 20 73 65 63 75 72 ┆ particular secur
1124 69 74 79 20 31 80 80 80 80 80 80 80 80 80 80 80 ┆ ity 1•••••••••••
1125 80 80 80 80 70 61 72 74 69 63 75 6c 61 72 20 73 ┆ ••••particular s
1126 65 63 75 72 69 74 79 20 32 80 80 80 80 80 80 80 ┆ ecurity 2•••••••
1127 80 80 80 80 80 80 80 80 80 80 80 80 70 61 72 74 ┆ ••••••••••••part
1128 69 63 75 6c 61 72 20 73 65 63 75 72 69 74 79 20 ┆ icular security
1129 33 80 80 80 80 80 80 80 80 80 80 80 80 80 80 80 ┆ 3•••••••••••••••
1130 80 80 80 80 80 80 80 80 70 61 72 74 69 63 75 6c ┆ ••••••••particul
1131 61 72 20 73 65 63 75 72 69 74 79 20 34 80 80 80 ┆ ar security 4•••
1132 80 80 80 80 80 80 80 80 80 80 80 80 80 80 80 80 ┆ ••••••••••••••••
1133 80 80 80 80 80 80 80 80 70 61 72 74 69 63 75 6c ┆ ••••••••particul
1134 61 72 20 73 65 63 75 72 69 74 79 20 35 80 80 80 ┆ ar security 5•••
1135 80 80 80 80 80 80 80 80 80 80 80 80 80 80 80 80 ┆ ••••••••••••••••
1136 80 80 80 80 80 80 80 80 80 80 80 80 ┆ ••••••••••••
1142 A _label_ associates a name to the <<cur-offset,current offset>>.
1144 All the labels of a whole Normand input must have unique names.
1146 A label must not share the name of a <<variable-assignment,variable>>
1153 . A valid {py3} name which is not `ICITTE`.
1157 === Variable assignment
1159 A _variable assignment_ associates a name to the integral result of an
1160 evaluated {py3} expression.
1162 A variable assignment is:
1164 . The ``pass:[{]`` prefix.
1166 . A valid {py3} name which is not `ICITTE`.
1168 . The `=` character.
1170 . A valid {py3} expression of which the evaluation result type
1171 is `int`, `float`, or `bool` (automatically converted to `int`).
1173 For a variable assignment at some source location{nbsp}__**L**__, this
1174 expression may contain:
1177 * The name of any <<label,label>> defined before{nbsp}__**L**__
1178 which isn't within a nested group.
1179 * The name of any <<variable-assignment,variable>> known
1183 The value of the special name `ICITTE` (`int` type) in this expression
1184 is the <<cur-offset,current offset>>.
1193 {meow = 42} 11 22 {meow:8} 33 {meow = ICITTE + 17}
1194 "yooo" {meow + mix : 16}
1200 11 22 2a 33 79 6f 6f 6f 7a 00 ┆ •"*3yoooz•
1206 A _group_ is a scoped sequence of items.
1208 The <<label,labels>> within a group aren't visible outside of it.
1210 The main purpose of a group is to <<post-item-repetition,repeat>> more
1211 than a single item and to isolate labels.
1215 . The `(`, `!group`, or `!g` opening.
1217 . Zero or more items.
1219 . Depending on the group opening:
1234 ((aa bb cc) dd () ee) "leclerc"
1240 aa bb cc dd ee 6c 65 63 6c 65 72 63 ┆ •••••leclerc
1249 (aa bb cc) * 3 dd ee
1256 aa bb cc aa bb cc aa bb cc dd ee aa bb cc aa bb
1257 cc aa bb cc dd ee aa bb cc aa bb cc aa bb cc dd
1258 ee aa bb cc aa bb cc aa bb cc dd ee aa bb cc aa
1259 bb cc aa bb cc dd ee
1269 <str_beg> u16le"sébastien diaz" <str_end>
1270 {ICITTE - str_beg : 8}
1271 {(end - str_beg) * 5 : 24}
1279 73 00 e9 00 62 00 61 00 73 00 74 00 69 00 65 00 ┆ s•••b•a•s•t•i•e•
1280 6e 00 20 00 64 00 69 00 61 00 7a 00 1c 00 01 e0 ┆ n• •d•i•a•z•••••
1281 73 00 e9 00 62 00 61 00 73 00 74 00 69 00 65 00 ┆ s•••b•a•s•t•i•e•
1282 6e 00 20 00 64 00 69 00 61 00 7a 00 1c 00 01 40 ┆ n• •d•i•a•z••••@
1283 73 00 e9 00 62 00 61 00 73 00 74 00 69 00 65 00 ┆ s•••b•a•s•t•i•e•
1284 6e 00 20 00 64 00 69 00 61 00 7a 00 1c 00 00 a0 ┆ n• •d•i•a•z•••••
1288 === Conditional block
1290 A _conditional block_ represents either the bytes of zero or more items
1291 if some expression is true, or the bytes of zero or more other items if
1294 A conditional block is:
1296 . The `!if` opening.
1300 ** The ``pass:[{]`` prefix, a valid {py3} expression of which the
1301 evaluation result type is `int` or `bool` (automatically converted to
1302 `int`), and the ``pass:[}]`` suffix.
1304 For a conditional block at some source location{nbsp}__**L**__, this
1305 expression may contain:
1308 * The name of any <<label,label>> defined before{nbsp}__**L**__
1309 which isn't within a nested group.
1310 * The name of any <<variable-assignment,variable>> known
1314 The value of the special name `ICITTE` (`int` type) in this expression
1315 is the <<cur-offset,current offset>> (before handling the contained
1318 ** A valid {py3} name.
1320 For the name `__NAME__`, this is equivalent to the
1321 `pass:[{]__NAME__pass:[}]` form above.
1323 . Zero or more items to be handled when the condition is true.
1327 .. The `!else` opening.
1328 .. Zero or more items to be handled when the condition is false.
1330 . The `!end` closing.
1348 !if {at < rep_count} 20 !end
1357 6d 65 6f 77 20 7a 6f 6f 6d 20 6d 65 6f 77 20 7a ┆ meow zoom meow z
1358 6f 6f 6d 20 6d 65 6f 77 20 7a 6f 6f 6d 20 6d 65 ┆ oom meow zoom me
1359 6f 77 20 6d 69 78 20 6d 65 6f 77 20 6d 69 78 20 ┆ ow mix meow mix
1360 6d 65 6f 77 20 6d 69 78 20 6d 65 6f 77 20 6d 69 ┆ meow mix meow mi
1361 78 20 6d 65 6f 77 20 6d 69 78 20 6d 65 6f 77 20 ┆ x meow mix meow
1374 !if {str_end - str_beg > 10}
1382 6d 00 65 00 6f 00 77 00 20 00 6d 00 69 00 78 00 ┆ m•e•o•w• •m•i•x•
1383 21 00 20 42 49 47 ┆ !• BIG
1387 === Repetition block
1389 A _repetition block_ represents the bytes of one or more items repeated
1390 a given number of times.
1392 A repetition block is:
1394 . The `!repeat` or `!r` opening.
1398 ** A <<const-int,positive constant integer>> which is the number of
1399 times to repeat the previous item.
1401 ** The ``pass:[{]`` prefix, a valid {py3} expression of which the
1402 evaluation result type is `int` or `bool` (automatically converted to
1403 `int`), and the ``pass:[}]`` suffix.
1405 For a repetition block at some source location{nbsp}__**L**__, this
1406 expression may contain:
1409 * The name of any <<label,label>> defined before{nbsp}__**L**__
1410 which isn't within a nested group.
1411 * The name of any <<variable-assignment,variable>> known
1415 The value of the special name `ICITTE` (`int` type) in this expression
1416 is the <<cur-offset,current offset>> (before handling the items to
1419 ** A valid {py3} name.
1421 For the name `__NAME__`, this is equivalent to the
1422 `pass:[{]__NAME__pass:[}]` form above.
1424 . Zero or more items.
1426 . The `!end` closing.
1428 You may also use a <<post-item-repetition,post-item repetition>> after
1429 some items. The form ``!repeat{nbsp}__X__{nbsp}__ITEMS__{nbsp}!end``
1430 is equivalent to ``(__ITEMS__){nbsp}pass:[*]{nbsp}__X__``.
1437 {end - ICITTE - 1 : 8}
1446 ff fe fd fc fb fa f9 f8 f7 f6 f5 f4 f3 f2 f1 f0 ┆ ••••••••••••••••
1447 ef ee ed ec eb ea e9 e8 e7 e6 e5 e4 e3 e2 e1 e0 ┆ ••••••••••••••••
1448 df de dd dc db da d9 d8 d7 d6 d5 d4 d3 d2 d1 d0 ┆ ••••••••••••••••
1449 cf ce cd cc cb ca c9 c8 c7 c6 c5 c4 c3 c2 c1 c0 ┆ ••••••••••••••••
1450 bf be bd bc bb ba b9 b8 b7 b6 b5 b4 b3 b2 b1 b0 ┆ ••••••••••••••••
1451 af ae ad ac ab aa a9 a8 a7 a6 a5 a4 a3 a2 a1 a0 ┆ ••••••••••••••••
1452 9f 9e 9d 9c 9b 9a 99 98 97 96 95 94 93 92 91 90 ┆ ••••••••••••••••
1453 8f 8e 8d 8c 8b 8a 89 88 87 86 85 84 83 82 81 80 ┆ ••••••••••••••••
1454 7f 7e 7d 7c 7b 7a 79 78 77 76 75 74 73 72 71 70 ┆ •~}|{zyxwvutsrqp
1455 6f 6e 6d 6c 6b 6a 69 68 67 66 65 64 63 62 61 60 ┆ onmlkjihgfedcba`
1456 5f 5e 5d 5c 5b 5a 59 58 57 56 55 54 53 52 51 50 ┆ _^]\[ZYXWVUTSRQP
1457 4f 4e 4d 4c 4b 4a 49 48 47 46 45 44 43 42 41 40 ┆ ONMLKJIHGFEDCBA@
1458 3f 3e 3d 3c 3b 3a 39 38 37 36 35 34 33 32 31 30 ┆ ?>=<;:9876543210
1459 2f 2e 2d 2c 2b 2a 29 28 27 26 25 24 23 22 21 20 ┆ /.-,+*)('&%$#"!
1460 1f 1e 1d 1c 1b 1a 19 18 17 16 15 14 13 12 11 10 ┆ ••••••••••••••••
1461 0f 0e 0d 0c 0b 0a 09 08 07 06 05 04 03 02 01 00 ┆ ••••••••••••••••
1480 11 22 !repeat times 33 !end
1491 aa bb cc dd ee ff ee ff ee ff ee ff ee ff 11 22 ┆ •••••••••••••••"
1492 33 ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ 3•••••••••••••••
1493 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1494 ff ee ff ee ff 11 22 33 33 ee ff ee ff ee ff ee ┆ ••••••"33•••••••
1495 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1496 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1497 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1498 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1499 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1500 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1501 ff ee ff ee ff ee ff ee ff ee ff ee ff 11 22 33 ┆ ••••••••••••••"3
1502 33 33 63 6f 75 63 6f 75 21 ┆ 33coucou!
1506 === Macro definition block
1508 A _macro definition block_ associates a name and parameter names to
1511 A macro definition block doesn't lead to generated bytes itself: a
1512 <<macro-expansion,macro expansion>> does so.
1514 A macro definition may only exist at the root level, that is, not within
1515 a <<group,group>>, a <<repetition-block,repetition block>>, a
1516 <<conditional-block,conditional block>>, or another
1517 <<macro-definition-block,macro definition block>>.
1519 All macro definitions must have unique names.
1521 A macro definition is:
1523 . The `!macro` or `!m` opening.
1525 . A valid {py3} name (the macro name).
1527 . The `(` parameter name list prefix.
1529 . A comma-separated list of zero or more unique parameter names,
1530 each one being a valid {py3} name.
1532 . The `)` parameter name list suffix.
1534 . Zero or more items except, recursively, a macro definition block.
1536 . The `!end` closing.
1541 {le} {ICITTE * 8 : 16}
1542 u16le"predict explode"
1549 !macro nail(rep, with_extra, val)
1553 {val + iter : uleb128}
1567 A _macro expansion_ expands the items of a defined
1568 <<macro-definition-block,macro>>.
1570 The macro to expand must be defined _before_ the expansion.
1572 The <<state,state>> before handling the first item of the chosen macro
1575 <<cur-offset,Current offset>>::
1578 <<cur-bo,Current byte order>>::
1582 The only available variables initially are the macro parameters.
1587 The state after having handled the last item of the chosen macro is:
1590 The one before handling the first item of the macro plus the size
1591 of the generated data of the macro expansion.
1593 IMPORTANT: This means <<current-offset-setting,current offset setting>>
1594 items within the expanded macro don't impact the final current offset.
1596 Current byte order::
1597 The one before handling the first item of the macro.
1600 The ones before handling the first item of the macro.
1603 The ones before handling the first item of the macro.
1605 A macro expansion is:
1609 . A valid {py3} name (the name of the macro to expand).
1611 . The `(` parameter value list prefix.
1613 . A comma-separated list of zero or more unique parameter values.
1615 The number of parameter values must match the number of parameter
1616 names of the definition of the chosen macro.
1618 A parameter value is one of:
1621 * A <<const-int,constant integer>>, possibly negative.
1623 * The ``pass:[{]`` prefix, a valid {py3} expression of which the
1624 evaluation result type is `int` or `bool` (automatically converted to
1625 `int`), and the ``pass:[}]`` suffix.
1627 For a macro expansion at some source location{nbsp}__**L**__, this
1628 expression may contain:
1630 ** The name of any <<label,label>> defined before{nbsp}__**L**__
1631 which isn't within a nested group.
1632 ** The name of any <<variable-assignment,variable>> known
1636 The value of the special name `ICITTE` (`int` type) in this expression
1637 is the <<cur-offset,current offset>> (before handling the items of the
1640 * A valid {py3} name.
1642 For the name `__NAME__`, this is equivalent to the
1643 `pass:[{]__NAME__pass:[}]` form above.
1646 . The `)` parameter value list suffix.
1653 {le} {ICITTE * 8 : 16}
1654 u16le"predict explode"
1657 "hello [" m:bake() "] world"
1665 68 65 6c 6c 6f 20 5b 38 00 70 00 72 00 65 00 64 ┆ hello [8•p•r•e•d
1666 00 69 00 63 00 74 00 20 00 65 00 78 00 70 00 6c ┆ •i•c•t• •e•x•p•l
1667 00 6f 00 64 00 65 00 5d 20 77 6f 72 6c 64 70 01 ┆ •o•d•e•] worldp•
1668 70 00 72 00 65 00 64 00 69 00 63 00 74 00 20 00 ┆ p•r•e•d•i•c•t• •
1669 65 00 78 00 70 00 6c 00 6f 00 64 00 65 00 70 02 ┆ e•x•p•l•o•d•e•p•
1670 70 00 72 00 65 00 64 00 69 00 63 00 74 00 20 00 ┆ p•r•e•d•i•c•t• •
1671 65 00 78 00 70 00 6c 00 6f 00 64 00 65 00 70 03 ┆ e•x•p•l•o•d•e•p•
1672 70 00 72 00 65 00 64 00 69 00 63 00 74 00 20 00 ┆ p•r•e•d•i•c•t• •
1673 65 00 78 00 70 00 6c 00 6f 00 64 00 65 00 70 04 ┆ e•x•p•l•o•d•e•p•
1674 70 00 72 00 65 00 64 00 69 00 63 00 74 00 20 00 ┆ p•r•e•d•i•c•t• •
1675 65 00 78 00 70 00 6c 00 6f 00 64 00 65 00 70 05 ┆ e•x•p•l•o•d•e•p•
1676 70 00 72 00 65 00 64 00 69 00 63 00 74 00 20 00 ┆ p•r•e•d•i•c•t• •
1677 65 00 78 00 70 00 6c 00 6f 00 64 00 65 00 ┆ e•x•p•l•o•d•e•
1685 !macro A(val, is_be)
1695 !macro B(rep, is_be)
1699 m:A({iter * 3}, is_be)
1711 00 03 00 06 00 09 00 0c 00 0f 03 00 06 00 09 00
1715 === Post-item repetition
1717 A _post-item repetition_ represents the bytes of an item repeated a
1718 given number of times.
1720 A post-item repetition is:
1722 . One of those items:
1724 ** A <<byte-constant,byte constant>>.
1725 ** A <<literal-string,literal string>>.
1726 ** A <<fixed-length-number,fixed-length number>>.
1727 ** An <<leb128-integer,LEB128 integer>>.
1728 ** A <<macro-expansion,macro-expansion>>.
1729 ** A <<group,group>>.
1731 . The ``pass:[*]`` character.
1735 ** A positive integer (hexadecimal starting with `0x` or `0X` accepted)
1736 which is the number of times to repeat the previous item.
1738 ** The ``pass:[{]`` prefix, a valid {py3} expression of which the
1739 evaluation result type is `int` or `bool` (automatically converted to
1740 `int`), and the ``pass:[}]`` suffix.
1742 For a post-item repetition at some source location{nbsp}__**L**__, this
1743 expression may contain:
1746 * The name of any <<label,label>> defined before{nbsp}__**L**__
1747 which isn't within a nested group and
1748 which isn't part of the repeated item.
1749 * The name of any <<variable-assignment,variable>> known
1750 at{nbsp}__**L**__, which isn't part of its repeated item, and which
1754 The value of the special name `ICITTE` (`int` type) in this expression
1755 is the <<cur-offset,current offset>> (before handling the items to
1758 ** A valid {py3} name.
1760 For the name `__NAME__`, this is equivalent to the
1761 `pass:[{]__NAME__pass:[}]` form above.
1763 You may also use a <<repetition-block,repetition block>>. The form
1764 ``__ITEM__{nbsp}pass:[*]{nbsp}__X__`` is equivalent to
1765 ``!repeat{nbsp}__X__{nbsp}__ITEM__{nbsp}!end``.
1771 {end - ICITTE - 1 : 8} * 0x100 <end>
1777 ff fe fd fc fb fa f9 f8 f7 f6 f5 f4 f3 f2 f1 f0 ┆ ••••••••••••••••
1778 ef ee ed ec eb ea e9 e8 e7 e6 e5 e4 e3 e2 e1 e0 ┆ ••••••••••••••••
1779 df de dd dc db da d9 d8 d7 d6 d5 d4 d3 d2 d1 d0 ┆ ••••••••••••••••
1780 cf ce cd cc cb ca c9 c8 c7 c6 c5 c4 c3 c2 c1 c0 ┆ ••••••••••••••••
1781 bf be bd bc bb ba b9 b8 b7 b6 b5 b4 b3 b2 b1 b0 ┆ ••••••••••••••••
1782 af ae ad ac ab aa a9 a8 a7 a6 a5 a4 a3 a2 a1 a0 ┆ ••••••••••••••••
1783 9f 9e 9d 9c 9b 9a 99 98 97 96 95 94 93 92 91 90 ┆ ••••••••••••••••
1784 8f 8e 8d 8c 8b 8a 89 88 87 86 85 84 83 82 81 80 ┆ ••••••••••••••••
1785 7f 7e 7d 7c 7b 7a 79 78 77 76 75 74 73 72 71 70 ┆ •~}|{zyxwvutsrqp
1786 6f 6e 6d 6c 6b 6a 69 68 67 66 65 64 63 62 61 60 ┆ onmlkjihgfedcba`
1787 5f 5e 5d 5c 5b 5a 59 58 57 56 55 54 53 52 51 50 ┆ _^]\[ZYXWVUTSRQP
1788 4f 4e 4d 4c 4b 4a 49 48 47 46 45 44 43 42 41 40 ┆ ONMLKJIHGFEDCBA@
1789 3f 3e 3d 3c 3b 3a 39 38 37 36 35 34 33 32 31 30 ┆ ?>=<;:9876543210
1790 2f 2e 2d 2c 2b 2a 29 28 27 26 25 24 23 22 21 20 ┆ /.-,+*)('&%$#"!
1791 1f 1e 1d 1c 1b 1a 19 18 17 16 15 14 13 12 11 10 ┆ ••••••••••••••••
1792 0f 0e 0d 0c 0b 0a 09 08 07 06 05 04 03 02 01 00 ┆ ••••••••••••••••
1804 (ee ff) * {here + 1}
1814 aa bb cc dd ee ff ee ff ee ff ee ff ee ff 11 22 ┆ •••••••••••••••"
1815 33 ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ 3•••••••••••••••
1816 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1817 ff ee ff ee ff 11 22 33 33 ee ff ee ff ee ff ee ┆ ••••••"33•••••••
1818 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1819 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1820 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1821 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1822 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1823 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1824 ff ee ff ee ff ee ff ee ff ee ff ee ff 11 22 33 ┆ ••••••••••••••"3
1825 33 33 63 6f 75 63 6f 75 21 ┆ 33coucou!
1829 == Command-line tool
1831 If you <<install-normand,installed>> the `normand` package, then you
1832 can use the `normand` command-line tool:
1835 $ normand <<< '"ma gang de malades"' | hexdump -C
1839 00000000 6d 61 20 67 61 6e 67 20 64 65 20 6d 61 6c 61 64 |ma gang de malad|
1843 If you copy the `normand.py` module to your own project, then you can
1844 run the module itself:
1847 $ python3 -m normand <<< '"ma gang de malades"' | hexdump -C
1851 00000000 6d 61 20 67 61 6e 67 20 64 65 20 6d 61 6c 61 64 |ma gang de malad|
1855 Without a path argument, the `normand` tool reads from the standard
1858 The `normand` tool prints the generated binary data to the standard
1861 Various options control the initial <<state,state>> of the processor:
1862 use the `--help` option to learn more.
1866 The whole `normand` package/module public API is:
1871 class ByteOrder(enum.Enum):
1883 def line_no(self) -> int:
1888 def col_no(self) -> int:
1892 # Parsing error message.
1893 class ParseErrorMessage:
1899 # Source text location.
1901 def text_location(self):
1906 class ParseError(RuntimeError):
1907 # Parsing error messages.
1909 # The first message is the most _specific_ one.
1915 # Variables dictionary type (for type hints).
1916 VariablesT = typing.Dict[str, typing.Union[int, float]]
1919 # Labels dictionary type (for type hints).
1920 LabelsT = typing.Dict[str, int]
1927 def data(self) -> bytearray:
1930 # Updated variable values.
1932 def variables(self) -> SymbolsT:
1935 # Updated main group label values.
1937 def labels(self) -> SymbolsT:
1942 def offset(self) -> int:
1947 def byte_order(self) -> typing.Optional[ByteOrder]:
1951 # Parses the `normand` input using the initial state defined by
1952 # `init_variables`, `init_labels`, `init_offset`, and `init_byte_order`,
1953 # and returns the corresponding parsing result.
1954 def parse(normand: str,
1955 init_variables: typing.Optional[SymbolsT] = None,
1956 init_labels: typing.Optional[SymbolsT] = None,
1957 init_offset: int = 0,
1958 init_byte_order: typing.Optional[ByteOrder] = None) -> ParseResult:
1962 The `normand` parameter is the actual <<learn-normand,Normand input>>
1963 while the other parameters control the initial <<state,state>>.
1965 The `parse()` function raises a `ParseError` instance should it fail to
1966 parse the `normand` string for any reason.
1970 Normand is a https://python-poetry.org/[Poetry] project.
1972 To develop it, install it through Poetry and enter the virtual
1978 $ normand <<< '"lol" * 10 0a'
1981 `normand.py` is processed by:
1983 * https://microsoft.github.io/pyright/[Pyright]
1984 * https://github.com/psf/black[Black]
1985 * https://pycqa.github.io/isort/[isort]
1989 Use https://docs.pytest.org/[pytest] to test Normand once the package is
1990 part of your virtual environment, for example:
1994 $ poetry run pip3 install pytest
1998 The `pytest` project is currently not a development dependency in
1999 `pyproject.toml` due to backward compatibiliy issues with
2002 In the `tests` directory, each `*.nt` file is a test. The file name
2003 prefix indicates what it's meant to test:
2006 Everything above the `---` line is the valid Normand input
2009 Everything below the `---` line is the expected data
2010 (whitespace-separated hexadecimal bytes).
2013 Everything above the `---` line is the invalid Normand input
2016 Everything below the `---` line is the expected error message having
2025 Normand uses https://review.lttng.org/admin/repos/normand,general[Gerrit]
2028 To report a bug, https://github.com/efficios/normand/issues/new[create a