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.7, 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.
180 aa bb * 5 cc <zoom> "yeah\0" * {zoom * 3}
186 aa bb bb bb bb bb cc 79 65 61 68 00 79 65 61 68 ┆ •••••••yeah•yeah
187 00 79 65 61 68 00 79 65 61 68 00 79 65 61 68 00 ┆ •yeah•yeah•yeah•
188 79 65 61 68 00 79 65 61 68 00 79 65 61 68 00 79 ┆ yeah•yeah•yeah•y
189 65 61 68 00 79 65 61 68 00 79 65 61 68 00 79 65 ┆ eah•yeah•yeah•ye
190 61 68 00 79 65 61 68 00 79 65 61 68 00 79 65 61 ┆ ah•yeah•yeah•yea
191 68 00 79 65 61 68 00 79 65 61 68 00 79 65 61 68 ┆ h•yeah•yeah•yeah
192 00 79 65 61 68 00 79 65 61 68 00 79 65 61 68 00 ┆ •yeah•yeah•yeah•
211 00 00 00 c7 00 00 00 00 00 00 00 00 00 00 00 2b
212 ff 85 ff ff 00 00 15 d0
215 Multilevel grouping::
220 ff ((aa bb "zoom" cc) * 5) * 3 $-34 * 4
226 ff aa bb 7a 6f 6f 6d cc aa bb 7a 6f 6f 6d cc aa ┆ •••zoom•••zoom••
227 bb 7a 6f 6f 6d cc aa bb 7a 6f 6f 6d cc aa bb 7a ┆ •zoom•••zoom•••z
228 6f 6f 6d cc aa bb 7a 6f 6f 6d cc aa bb 7a 6f 6f ┆ oom•••zoom•••zoo
229 6d cc aa bb 7a 6f 6f 6d cc aa bb 7a 6f 6f 6d cc ┆ m•••zoom•••zoom•
230 aa bb 7a 6f 6f 6d cc aa bb 7a 6f 6f 6d cc aa bb ┆ ••zoom•••zoom•••
231 7a 6f 6f 6d cc aa bb 7a 6f 6f 6d cc aa bb 7a 6f ┆ zoom•••zoom•••zo
232 6f 6d cc aa bb 7a 6f 6f 6d cc de de de de ┆ om•••zoom•••••
235 Precise error reporting::
238 /tmp/meow.normand:10:24 - Expecting a bit (`0` or `1`).
242 /tmp/meow.normand:32:6 - Unexpected character `k`.
246 /tmp/meow.normand:24:19 - Illegal (unknown or unreachable) variable/label name `meow` in expression `(meow - 45) // 8`; the legal names are {`mix`, `zoom`}.
250 /tmp/meow.normand:18:9 - Value 315 is outside the 8-bit range when evaluating expression `end - ICITTE` at byte offset 45.
253 You can use Normand to track data source files in your favorite VCS
254 instead of raw binary files. The binary files that Normand generates can
255 be used to test file format decoding, including malformatted data, for
256 example, as well as for education.
258 See <<learn-normand>> to explore all the Normand features.
262 Normand requires Python ≥ 3.4.
267 $ python3 -m pip install --user normand
271 https://packaging.python.org/en/latest/tutorials/installing-packages/#installing-to-the-user-site[Installing to the User Site]
272 to learn more about a user site installation.
276 Normand has a single module file, `normand.py`, which you can copy as is
277 to your project to use it (both the <<python3-api,`normand.parse()`>>
278 function and the <<command-line-tool,command-line tool>>).
280 `normand.py` has _no external dependencies_, but if you're using
281 Python{nbsp}3.4, you'll need a local copy of the standard `typing`
287 A Normand text input is a sequence of items which represent a sequence
290 [[state]] During the processing of items to data, Normand relies on a
295 |State variable |Description |Initial value: <<python3-api,{py3} API>> |Initial value: <<command-line-tool,CLI>>
297 |[[cur-offset]] Current offset
299 The current offset has an effect on the value of <<label,labels>> and of
300 the special `ICITTE` name in <<fixed-length-number,fixed-length
301 number>>, <<leb-128-integer,LEB128 integer>>, and
302 <<variable-assignment,variable assignment>> expression evaluation.
304 Each generated byte increments the current offset.
306 A <<current-offset-setting,current offset setting>> may change the
307 current offset without generating data.
309 An <<current-offset-alignment,current offset alignment>> generates
310 padding bytes to make the current offset satisfy a given alignment.
311 |`init_offset` parameter of the `parse()` function.
314 |[[cur-bo]] Current byte order
316 The current byte order has an effect on the encoding of
317 <<fixed-length-number,fixed-length numbers>>.
319 A <<current-byte-order-setting,current byte order setting>> may change
320 the current byte order.
321 |`init_byte_order` parameter of the `parse()` function.
322 |`--byte-order` option.
325 |Mapping of label names to integral values.
326 |`init_labels` parameter of the `parse()` function.
327 |One or more `--label` options.
329 |<<variable-assignment,Variables>>
330 |Mapping of variable names to integral values.
331 |`init_variables` parameter of the `parse()` function.
332 |One or more `--var` options.
335 The available items are:
337 * A <<byte-constant,constant integer>> representing a single byte.
339 * A <<literal-string,literal string>> representing a sequence of bytes
340 encoding UTF-8, UTF-16, or UTF-32 data.
342 * A <<current-byte-order-setting,current byte order setting>> (big or
345 * A <<fixed-length-number,fixed-length number>> (integer or
346 floating point) using the <<cur-bo,current byte order>> and of which
347 the value is the result of a {py3} expression.
349 * An <<leb128-integer,LEB128 integer>> of which the value is the result
350 of a {py3} expression.
352 * A <<current-offset-setting,current offset setting>>.
354 * A <<current-offset-alignment,current offset alignment>>.
356 * A <<label,label>>, that is, a named constant holding the current
359 This is similar to an assembly label.
361 * A <<variable-assignment,variable assignment>> associating a name to
362 the integral result of an evaluated {py3} expression.
364 * A <<group,group>>, that is, a scoped sequence of items.
366 Moreover, you can <<repetition,repeat>> any item above, except an offset
367 or a label, a given fixed or variable number of times. This is called a
370 A Normand comment may exist:
372 * Between items, possibly within a group.
373 * Between the nibbles of a constant hexadecimal byte.
374 * Between the bits of a constant binary byte.
375 * Between the last item and the ``pass:[*]`` character of a repetition,
376 and between that ``pass:[*]`` character and the following number
379 A comment is anything between two ``pass:[#]`` characters on the same
380 line, or from ``pass:[#]`` until the end of the line. Whitespaces and
381 the following symbol characters are also considered comments where a
385 ! / \ ? & : ; . , + [ ] _ = | -
388 The latter serve to improve readability so that you may write, for
389 example, a MAC address or a UUID as is.
391 You can test the examples of this section with the `normand`
392 <<command-line-tool,command-line tool>> as such:
395 $ normand file | hexdump -C
398 where `file` is the name of a file containing the Normand input.
402 A _byte constant_ represents a single byte.
407 Two consecutive hexits.
410 A decimal number after the `$` prefix.
413 Eight bits after the `%` prefix.
433 $192 %1100/0011 $ -77
447 58f64689-6316-4d55-8a1a-04cada366172
448 fe80::6257:18ff:fea3:4229
454 58 f6 46 89 63 16 4d 55 8a 1a 04 ca da 36 61 72 ┆ X•F•c•MU•••••6ar
455 fe 80 62 57 18 ff fe a3 42 29 ┆ ••bW••••B)
463 %01110011 %01100001 %01101100 %01110101 %01110100
469 73 61 6c 75 74 ┆ salut
475 A _literal string_ represents the UTF-8-, UTF-16-, or UTF-32-encoded
478 The string to encode isn't implicitly null-terminated: use `\0` at the
479 end of the string to add a null character.
483 . **Optional**: one of the following encodings instead of UTF-8:
493 . The ``pass:["]`` prefix.
495 . A sequence of zero or more characters, possibly containing escape
498 An escape sequence is the ``\`` character followed by one of:
504 `b`:: Backspace (U+0008)
505 `e`:: Escape (U+001B)
506 `f`:: Form feed (U+000C)
507 `n`:: End of line (U+000A)
508 `r`:: Carriage return (U+000D)
509 `t`:: Character tabulation (U+0009)
510 `v`:: Line tabulation (U+000B)
511 ``\``:: Reverse solidus (U+005C)
512 ``pass:["]``:: Quotation mark (U+0022)
515 . The ``pass:["]`` suffix.
521 "coucou tout le monde!"
527 63 6f 75 63 6f 75 20 74 6f 75 74 20 6c 65 20 6d ┆ coucou tout le m
528 6f 6e 64 65 21 ┆ onde!
536 u16le"I am not young enough to know everything."
542 49 00 20 00 61 00 6d 00 20 00 6e 00 6f 00 74 00 ┆ I• •a•m• •n•o•t•
543 20 00 79 00 6f 00 75 00 6e 00 67 00 20 00 65 00 ┆ •y•o•u•n•g• •e•
544 6e 00 6f 00 75 00 67 00 68 00 20 00 74 00 6f 00 ┆ n•o•u•g•h• •t•o•
545 20 00 6b 00 6e 00 6f 00 77 00 20 00 65 00 76 00 ┆ •k•n•o•w• •e•v•
546 65 00 72 00 79 00 74 00 68 00 69 00 6e 00 67 00 ┆ e•r•y•t•h•i•n•g•
555 u32be "\"illusion is the first\nof all pleasures\" 🦉"
561 00 00 00 22 00 00 00 69 00 00 00 6c 00 00 00 6c ┆ •••"•••i•••l•••l
562 00 00 00 75 00 00 00 73 00 00 00 69 00 00 00 6f ┆ •••u•••s•••i•••o
563 00 00 00 6e 00 00 00 20 00 00 00 69 00 00 00 73 ┆ •••n••• •••i•••s
564 00 00 00 20 00 00 00 74 00 00 00 68 00 00 00 65 ┆ ••• •••t•••h•••e
565 00 00 00 20 00 00 00 66 00 00 00 69 00 00 00 72 ┆ ••• •••f•••i•••r
566 00 00 00 73 00 00 00 74 00 00 00 0a 00 00 00 6f ┆ •••s•••t•••••••o
567 00 00 00 66 00 00 00 20 00 00 00 61 00 00 00 6c ┆ •••f••• •••a•••l
568 00 00 00 6c 00 00 00 20 00 00 00 70 00 00 00 6c ┆ •••l••• •••p•••l
569 00 00 00 65 00 00 00 61 00 00 00 73 00 00 00 75 ┆ •••e•••a•••s•••u
570 00 00 00 72 00 00 00 65 00 00 00 73 00 00 00 22 ┆ •••r•••e•••s•••"
571 00 00 00 20 00 01 f9 89 ┆ ••• ••••
575 === Current byte order setting
577 This special item sets the <<cur-bo,_current byte order_>>.
579 The two accepted forms are:
582 ``pass:[{be}]``:: Set the current byte order to big endian.
583 ``pass:[{le}]``:: Set the current byte order to little endian.
585 === Fixed-length number
587 A _fixed-length number_ represents a fixed number of bytes encoding
590 * An unsigned or signed integer (two's complement).
592 The available lengths are 8, 16, 24, 32, 40, 48, 56, and 64.
594 * A floating point number
595 ([IEEE{nbsp}754-2008[https://standards.ieee.org/standard/754-2008.html]).
597 The available length are 32 (_binary32_) and 64 (_binary64_).
599 The value is the result of evaluating a {py3} expression using the
600 <<cur-bo,current byte order>>.
602 A fixed-length number is:
604 . The ``pass:[{]`` prefix.
606 . A valid {py3} expression.
608 For a fixed-length number at some source location{nbsp}__**L**__, this
609 expression may contain the name of any accessible <<label,label>> (not
610 within a nested group), including the name of a label defined
611 after{nbsp}__**L**__, as well as the name of any
612 <<variable-assignment,variable>> known at{nbsp}__**L**__.
614 The value of the special name `ICITTE` (`int` type) in this expression
615 is the <<cur-offset,current offset>> (before encoding the number).
619 . An encoding length in bits amongst:
622 The expression evaluates to an `int` value::
623 `8`, `16`, `24`, `32`, `40`, `48`, `56`, and `64`.
625 The expression evaluates to a `float` value::
652 # String length in bits
653 {8 * (str_end - str_beg) : 16}
664 00 60 68 65 6c 6c 6f 20 77 6f 72 6c 64 21 ┆ •`hello world!
672 {20 - ICITTE : 8} * 10
678 14 13 12 11 10 0f 0e 0d 0c 0b
699 An _LEB128 integer_ represents a variable number of bytes encoding an
700 unsigned or signed integer which is the result of evaluating a {py3}
701 expression following the https://en.wikipedia.org/wiki/LEB128[LEB128]
704 An LEB128 integer is:
706 . The ``pass:[{]`` prefix.
708 . A valid {py3} expression.
710 For an LEB128 integer at some source location{nbsp}__**L**__, this
711 expression may contain:
714 * The name of any <<label,label>> defined before{nbsp}__**L**__.
715 * The name of any <<variable-assignment,variable>> known at{nbsp}__**L**__
716 which doesn't, directly or indirectly, refer to a label
717 defined after{nbsp}__**L**__.
720 The value of the special name `ICITTE` (`int` type) in this expression
721 is the <<cur-offset,current offset>> (before encoding the integer).
729 `uleb128`:: Use the unsigned LEB128 format.
730 `sleb128`:: Use the signed LEB128 format.
756 {-981238311 + (meow * -23) : sleb128}
763 aa bb cc dd ee ff fd fa 8d ac 7c 68 65 6c 6c 6f ┆ ••••••••••|hello
767 === Current offset setting
769 This special item sets the <<cur-offset,_current offset_>>.
771 A current offset setting is:
775 . A positive integer (hexadecimal starting with `0x` or `0X` accepted)
776 which is the new current offset.
785 <0x61> {ICITTE : 8} * 8
791 00 01 02 03 04 05 06 07 61 62 63 64 65 66 67 68 ┆ ••••••••abcdefgh
799 aa bb cc dd <meow> ee ff
800 <12> 11 22 33 <mix> 44 55
807 aa bb cc dd ee ff 11 22 33 44 55 04 0f ┆ •••••••"3DU••
811 === Current offset alignment
813 An _current offset alignment_ represents zero or more padding bytes to
814 make the <<cur-offset,current offset>> meet a given
815 https://en.wikipedia.org/wiki/Data_structure_alignment[alignment] value.
817 More specifically, for an alignment value of{nbsp}__**N**__{nbsp}bits,
818 a current offset alignment represents the required padding bytes until
819 the current offset is a multiple of __**N**__{nbsp}/{nbsp}8.
821 A current offset alignment is:
825 . A positive integer (hexadecimal starting with `0x` or `0X` accepted)
826 which is the alignment value in _bits_.
828 This value must be greater than zero and a multiple of{nbsp}8.
833 . The ``pass:[~]`` prefix.
834 . A positive integer (hexadecimal starting with `0x` or `0X` accepted)
835 which is the value of the byte to use as padding to align the
836 <<cur-offset,current offset>>.
839 Without this section, the padding byte value is zero.
845 11 22 (@32 aa bb cc) * 3
851 11 22 00 00 aa bb cc 00 aa bb cc 00 aa bb cc
868 77 88 cc cc 00 60 5f c4 55 55 55 55 55 55 55 55 ┆ w••••`_•UUUUUUUU
877 aa bb cc <29> @64~255 "zoom"
883 aa bb cc ff ff ff 7a 6f 6f 6d ┆ ••••••zoom
889 A _label_ associates a name to the <<cur-offset,current offset>>.
891 All the labels of a whole Normand input must have unique names.
893 A label must not share the name of a <<variable-assignment,variable>>
900 . A valid {py3} name which is not `ICITTE` (see
901 <<fixed-length-number>>, <<leb128-integer>>, and
902 <<variable-assignment>> to learn more).
906 === Variable assignment
908 A _variable assignment_ associates a name to the integral result of an
909 evaluated {py3} expression.
911 A variable assignment is:
913 . The ``pass:[{]`` prefix.
915 . A valid {py3} name which is not `ICITTE` (see
916 <<fixed-length-number>>, <<leb128-integer>>, and
917 <<variable-assignment>> to learn more).
921 . A valid {py3} expression.
923 For a variable assignment at some source location{nbsp}__**L**__, this
924 expression may contain the name of any accessible <<label,label>> (not
925 within a nested group), including the name of a label defined
926 after{nbsp}__**L**__, as well as the name of any
927 <<variable-assignment,variable>> known at{nbsp}__**L**__.
929 The value of the special name `ICITTE` (`int` type) in this expression
930 is the <<cur-offset,current offset>>.
939 {meow = 42} 11 22 {meow:8} 33 {meow = ICITTE + 17}
940 "yooo" {meow + mix : 16}
946 11 22 2a 33 79 6f 6f 6f 7a 00 ┆ •"*3yoooz•
952 A _group_ is a scoped sequence of items.
954 The <<label,labels>> within a group aren't visible outside of it.
956 The main purpose of a group is to <<repetition,repeat>> more than a
963 . Zero or more items.
971 ((aa bb cc) dd () ee) "leclerc"
977 aa bb cc dd ee 6c 65 63 6c 65 72 63 ┆ •••••leclerc
985 ((aa bb cc) * 3 dd ee) * 5
991 aa bb cc aa bb cc aa bb cc dd ee aa bb cc aa bb
992 cc aa bb cc dd ee aa bb cc aa bb cc aa bb cc dd
993 ee aa bb cc aa bb cc aa bb cc dd ee aa bb cc aa
1004 <str_beg> u16le"sébastien diaz" <str_end>
1005 {ICITTE - str_beg : 8}
1006 {(end - str_beg) * 5 : 24}
1014 73 00 e9 00 62 00 61 00 73 00 74 00 69 00 65 00 ┆ s•••b•a•s•t•i•e•
1015 6e 00 20 00 64 00 69 00 61 00 7a 00 1c 00 01 e0 ┆ n• •d•i•a•z•••••
1016 73 00 e9 00 62 00 61 00 73 00 74 00 69 00 65 00 ┆ s•••b•a•s•t•i•e•
1017 6e 00 20 00 64 00 69 00 61 00 7a 00 1c 00 01 40 ┆ n• •d•i•a•z••••@
1018 73 00 e9 00 62 00 61 00 73 00 74 00 69 00 65 00 ┆ s•••b•a•s•t•i•e•
1019 6e 00 20 00 64 00 69 00 61 00 7a 00 1c 00 00 a0 ┆ n• •d•i•a•z•••••
1025 A _repetition_ represents the bytes of an item repeated a given number
1032 ** A <<current-byte-order-setting,current byte order setting>>.
1033 ** A <<current-offset-setting,current offset setting>>.
1034 ** A <<label,label>>.
1035 ** A <<offset-alignment,offset alignment>>.
1036 ** A <<variable-assignment,variable assignment>>.
1038 . The ``pass:[*]`` character.
1042 ** A positive integer (hexadecimal starting with `0x` or `0X` accepted)
1043 which is the number of times to repeat the previous item.
1045 ** The ``pass:[{]`` prefix, a valid {py3} expression, and the
1046 ``pass:[}]`` suffix.
1048 For a repetition at some source location{nbsp}__**L**__, this expression
1052 * The name of any <<label,label>> defined before{nbsp}__**L**__ and
1053 which isn't part of its repeated item.
1054 * The name of any <<variable-assignment,variable>> known
1055 at{nbsp}__**L**__, which isn't part of its repeated item, and which
1056 doesn't, directly or indirectly, refer to a label defined
1057 after{nbsp}__**L**__.
1060 This expression must not contain the special name `ICITTE`.
1066 {end - ICITTE - 1 : 8} * 0x100 <end>
1072 ff fe fd fc fb fa f9 f8 f7 f6 f5 f4 f3 f2 f1 f0 ┆ ••••••••••••••••
1073 ef ee ed ec eb ea e9 e8 e7 e6 e5 e4 e3 e2 e1 e0 ┆ ••••••••••••••••
1074 df de dd dc db da d9 d8 d7 d6 d5 d4 d3 d2 d1 d0 ┆ ••••••••••••••••
1075 cf ce cd cc cb ca c9 c8 c7 c6 c5 c4 c3 c2 c1 c0 ┆ ••••••••••••••••
1076 bf be bd bc bb ba b9 b8 b7 b6 b5 b4 b3 b2 b1 b0 ┆ ••••••••••••••••
1077 af ae ad ac ab aa a9 a8 a7 a6 a5 a4 a3 a2 a1 a0 ┆ ••••••••••••••••
1078 9f 9e 9d 9c 9b 9a 99 98 97 96 95 94 93 92 91 90 ┆ ••••••••••••••••
1079 8f 8e 8d 8c 8b 8a 89 88 87 86 85 84 83 82 81 80 ┆ ••••••••••••••••
1080 7f 7e 7d 7c 7b 7a 79 78 77 76 75 74 73 72 71 70 ┆ •~}|{zyxwvutsrqp
1081 6f 6e 6d 6c 6b 6a 69 68 67 66 65 64 63 62 61 60 ┆ onmlkjihgfedcba`
1082 5f 5e 5d 5c 5b 5a 59 58 57 56 55 54 53 52 51 50 ┆ _^]\[ZYXWVUTSRQP
1083 4f 4e 4d 4c 4b 4a 49 48 47 46 45 44 43 42 41 40 ┆ ONMLKJIHGFEDCBA@
1084 3f 3e 3d 3c 3b 3a 39 38 37 36 35 34 33 32 31 30 ┆ ?>=<;:9876543210
1085 2f 2e 2d 2c 2b 2a 29 28 27 26 25 24 23 22 21 20 ┆ /.-,+*)('&%$#"!
1086 1f 1e 1d 1c 1b 1a 19 18 17 16 15 14 13 12 11 10 ┆ ••••••••••••••••
1087 0f 0e 0d 0c 0b 0a 09 08 07 06 05 04 03 02 01 00 ┆ ••••••••••••••••
1099 (ee ff) * {here + 1}
1109 aa bb cc dd ee ff ee ff ee ff ee ff ee ff 11 22 ┆ •••••••••••••••"
1110 33 ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ 3•••••••••••••••
1111 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1112 ff ee ff ee ff 11 22 33 33 ee ff ee ff ee ff ee ┆ ••••••"33•••••••
1113 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1114 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1115 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1116 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1117 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1118 ff ee ff ee ff ee ff ee ff ee ff ee ff ee ff ee ┆ ••••••••••••••••
1119 ff ee ff ee ff ee ff ee ff ee ff ee ff 11 22 33 ┆ ••••••••••••••"3
1120 33 33 63 6f 75 63 6f 75 21 ┆ 33coucou!
1125 This example shows how to use a repetition as a conditional section
1126 depending on some predefined variable.
1132 (ee ff "meow mix" 00) * {cond}
1136 Output (`cond` is 0):
1142 Output (`cond` is 1):
1145 aa bb cc dd ee ff 6d 65 6f 77 20 6d 69 78 00 f8 ┆ ••••••meow mix••
1150 == Command-line tool
1152 If you <<install-normand,installed>> the `normand` package, then you
1153 can use the `normand` command-line tool:
1156 $ normand <<< '"ma gang de malades"' | hexdump -C
1160 00000000 6d 61 20 67 61 6e 67 20 64 65 20 6d 61 6c 61 64 |ma gang de malad|
1164 If you copy the `normand.py` module to your own project, then you can
1165 run the module itself:
1168 $ python3 -m normand <<< '"ma gang de malades"' | hexdump -C
1172 00000000 6d 61 20 67 61 6e 67 20 64 65 20 6d 61 6c 61 64 |ma gang de malad|
1176 Without a path argument, the `normand` tool reads from the standard
1179 The `normand` tool prints the generated binary data to the standard
1182 Various options control the initial <<state,state>> of the processor:
1183 use the `--help` option to learn more.
1187 The whole `normand` package/module API is:
1191 class ByteOrder(enum.Enum):
1202 def line_no(self) -> int:
1207 def col_no(self) -> int:
1211 class ParseError(RuntimeError):
1212 # Source text location.
1214 def text_loc(self) -> TextLoc:
1218 SymbolsT = typing.Dict[str, int]
1224 def data(self) -> bytearray:
1227 # Updated variable values.
1229 def variables(self) -> SymbolsT:
1232 # Updated main group label values.
1234 def labels(self) -> SymbolsT:
1239 def offset(self) -> int:
1244 def byte_order(self) -> typing.Optional[ByteOrder]:
1248 def parse(normand: str,
1249 init_variables: typing.Optional[SymbolsT] = None,
1250 init_labels: typing.Optional[SymbolsT] = None,
1251 init_offset: int = 0,
1252 init_byte_order: typing.Optional[ByteOrder] = None) -> ParseResult:
1256 The `normand` parameter is the actual <<learn-normand,Normand input>>
1257 while the other parameters control the initial <<state,state>>.
1259 The `parse()` function raises a `ParseError` instance should it fail to
1260 parse the `normand` string for any reason.
1264 Normand is a https://python-poetry.org/[Poetry] project.
1266 To develop it, install it through Poetry and enter the virtual
1272 $ normand <<< '"lol" * 10 0a'
1275 `normand.py` is processed by:
1277 * https://microsoft.github.io/pyright/[Pyright]
1278 * https://github.com/psf/black[Black]
1279 * https://pycqa.github.io/isort/[isort]
1283 Use https://docs.pytest.org/[pytest] to test Normand once the package is
1284 part of your virtual environment, for example:
1288 $ poetry run pip3 install pytest
1292 The `pytest` project is currently not a development dependency in
1293 `pyproject.toml` due to backward compatibiliy issues with
1296 In the `tests` directory, each `*.nt` file is a test. The file name
1297 prefix indicates what it's meant to test:
1300 Everything above the `---` line is the valid Normand input
1303 Everything below the `---` line is the expected data
1304 (whitespace-separated hexadecimal bytes).
1307 Everything above the `---` line is the invalid Normand input
1310 Everything below the `---` line is the expected error message having
1319 Normand uses https://review.lttng.org/admin/repos/normand,general[Gerrit]
1322 To report a bug, https://github.com/efficios/normand/issues/new[create a