ПунктЗначение
ИмяDECLARE (BIND документа спецификации DECLARE)
TAG ID0x0BBL
Codec ID0x00000BB0
Документ спецификации0x00000000/codecs/0x00000BB0/ (цель DECLARE 0BB0)
Раздел5 0101 (Edge-высказывание), смещение C внутри раздела = 27
KindEdge · семейство: высказывание, группа: прочее
TAG WORD0000 1011 1011 LLLL (000K KKKC CCCC LLLL)
Описание в индексеОбъявление состава Payload одного Codec. Целевые Kind·Codec
Сторона Hugoedge/declare.md

Поля (документ спецификации)

Порядок FIELD в документе — это порядок полей Payload (документ спецификации Codec). Edge Id у Edge не объявляется через FIELD.

ПорядокПоле (BIND)FIELDШиринаПринимаемый формат (CODEC)ENUM
1target#2простое значение 1 WORD
2issuer#3остаток простого значения (0xFFFF)

DECLARE — Edge-высказывание, объявляющий состав Payload одного Codec. Codec 0x0BBL.

Вместе с FIELD (0x0BCL), ENUM (0x0BDL) и CODEC (0x0BEL) это словарь для записи спецификации Codec (документ спецификации Codec). Раскладка этих четырёх Edge встроена в декодер. Каждый документ спецификации Codec, записанный этим словарём, — обычный документ. Одна спецификация обслуживает проверку, разбор и отображение (средство просмотра). Средство просмотра не держит кода для каждого Codec, а рисует по спецификации.

Раскладка

TAG WORD          0000 1011 1011 LLLL
[Length, расширяющий TAG]
Edge Id           запись LOCAL Reference
цель              1 WORD. Из TAG WORD объявляемого Codec используется только позиция Codec (раздел и C) (LLLL = 0)
[Issuer·номер Codec] При объявлении Codec Issuer. Issuer и номер Codec, 2 WORD. Раскладка та же, что у расширяющего TAG Codec, и три Kind совпадают
                  Документ спецификации самого кода ISSUER (Issuer GEUL) содержит только цель
  • Список полей в DECLARE не размещается. Каждый FIELD указывает на свой DECLARE, и порядок этих FIELD в документе — это порядок полей Payload.

Правила интерпретации

Правила чтения и отображения записи по спецификации Codec.

  • Поле простого значения читается на фиксированное число WORD, объявленное FIELD. Одно поле может быть остатком простого значения (ширина 0xFFFF); оно читает оставшиеся WORD за вычетом ширины следующих за ним полей фиксированной ширины. После поля-остатка размещаются только простые значения фиксированной ширины.
  • Поле-запись начинается с TAG WORD и читается на Length этого TAG.
  • Поле простого значения — беззнаковое целое из n WORD в порядке big-endian. Записывается как 0x + hex из (ширина × 4) цифр, и если для этого значения есть ENUM, указывается и его имя BIND.
  • Смысл поля-записи определяет спецификация Codec этой записи. Значения, требующие интерпретации (знак, дробная часть, дата), помещаются не в простое значение, а в запись Value.

Других правил границ нет. Codec, у которого больше одного переменного простого значения, или после переменного простого значения идут запись либо переменное поле, или ширина простого значения зависит от других полей либо состояния документа, этим словарём объявить нельзя. Такую раскладку превращают так, чтобы переменная часть была обёрнута записью и осталась одна (например, подписант в SIGNATURE — запись Reference).

Действительность

  • Kind цели — одно из Reference, Value, Edge, Meta. Документ спецификации прямого кода GEUL — один на код. 5Q-система Reference тоже объявляется отдельно для каждого кода квантификации (LOCAL Identified 0050, Generic 0060, …). Указатели (0x040L, 0x041L, 0x042L), маркеры места и код ISSUER — тоже именно эти коды. Codec Issuer, определяемый Issuer и номером Codec после кода ISSUER, определяет документ этого Issuer.
  • Маркер места (Reference 0x000L~0x002L) тоже может быть целью DECLARE. Payload у него нет, поэтому размещается только DECLARE без FIELD. Смысл маркера и правила приёма встроены в декодер (слой 0). Codec, раскладка которого ещё не определена (SUPERSEDE-CHAIN, VERDICT, EVIDENCE и т. п.), тоже получает только DECLARE.
  • Edge Id у Edge через FIELD не объявляется. Он неявно является первым элементом каждого Edge (Edge). У EDGE-ISSUER это первый элемент после Issuer и номера Codec (EDGE-ISSUER-2WORD).
  • Поля DECLARE — это указывающие на него FIELD, их может быть 0. Один FIELD принадлежит только одному DECLARE. Даже для полей одинаковой формы FIELD заводится отдельно для каждого DECLARE.
  • В DECLARE нет ничего, кроме цели (и Issuer·номера Codec для цели формата Issuer).
  • Курсор после чтения полей по порядку должен точно совпасть с концом записи. Если остаток или нехватка — запись нарушает спецификацию.
  • В одном документе одну и ту же цель дважды не объявляют.
  • Варианты с разным хвостовым полем как ветвление не используются. Для каждого Codec заводится отдельный DECLARE.

Документ спецификации

  • Документ спецификации прямого кода — документ Codec Issuer GEUL 0x00000000. Codec ID — это 32-битное значение целевого TAG WORD (L=0) (0x0B80 → 0x00000B80), и публикуется он в <Issuer>/codecs/<Codec ID>/ с ID версии и versions.geul (документ спецификации Codec).
  • Документ Codec для Codec Issuer лежит в <Issuer>/codecs/<номер Codec>/ этого Issuer. Номер Codec независимо от Kind не повторяется внутри этого Issuer. Если Kind записи и Kind цели DECLARE различаются, интерпретатор считает это ошибкой (адрес публикации и список версий).
  • В одном документе спецификации один DECLARE, и его цель должна совпадать с TAG WORD из Codec ID. DOC-ID — это CODEC-POINTER (0x00000000, Codec ID этого Codec, 0).

Имена

  • Имя Codec привязывается к Edge Id DECLARE через BIND (например, PUBLICATION). UTF8-TEXT, прикрепляемые к DECLARE, FIELD, ENUM и CODEC, все задаются через BIND и не прикрепляются другими Edge, например LABEL.
  • Имена полей и имена enum привязываются к FIELD и ENUM тем же способом.

Пример

Документ спецификации PUBLICATION (Edge 0x0B8L) 0x00000000/codecs/0x00000B80/: после Edge Id идут запись DOC-POINTER и хеш содержимого из 16 WORD.

0BB3 0051 0001 0B80                 DECLARE #1  Edge 0x0B8L               (BIND "PUBLICATION")
0BC5 0051 0002 0051 0001 0000       FIELD #2    DECLARE #1, запись         (BIND "doc")
0BE5 0051 0009 0051 0002 0410       CODEC #9    FIELD #2, DOC-POINTER
0BE5 0051 000A 0051 0002 0420       CODEC #10   FIELD #2, CODEC-POINTER (список версий Codec)
0BC5 0051 0004 0051 0001 0010       FIELD #4    DECLARE #1, простое значение 16 WORD   (BIND "hash")
  • DECLARE: TAG 1 + Edge Id 2 + цель 1 = 4 WORD, LLLL = 0011.
  • FIELD: TAG 1 + Edge Id 2 + DECLARE 2 + ширина 1 = 6 WORD (LLLL = 0101). Принимаемые Kind·Codec задаются отдельно через CODEC (0410 = DOC-POINTER, 0420 = CODEC-POINTER).
  • Необязательное поле объявляется целью CODEC 0000. На пропущенное место ставится ABSENT (0x0000) (CODEC, необязательные поля).
  • Порядок полей — порядок, в котором в документе расположены FIELD #2 и #4. Edge Id не обязаны идти подряд (LOCAL AUTO INCREMENT — рекомендация).

Открытые проблемы

  • Повторение. Состав, в котором предшествующее простое значение задаёт число, как «аргумент × число аргументов» у CALL. Сейчас объявить нельзя.
  • Способ объявления Codec с подформатами (TAG для Codec) (WORLD и т. п.).
  • Какому набору версий документов спецификации прямых кодов соответствует SPEC-VERSION.

Связанные страницы

Исходный текст документа спецификации

Документ спецификации 0x00000000/codecs/0x00000BB0/latest.geul, прочитанный через geul show (16-ричные цифры в верхнем регистре).

SPEC-VERSION 0x0001
DOC-ID 0x04260000000000000BB000000000
BODY
#1 DECLARE 0x0BB0
#2 FIELD #1 0x0001
#3 FIELD #1 rest
#4 BIND #1 "DECLARE"
#5 BIND #2 "target"
#6 BIND #3 "issuer"