|
|
|
|
|||||||
|
|
|
|
|||||||
|
|
|
||||||||
|
|
|||||||||
|
Network Working Group Request for Comments: 2234 Category: Standards Track
|
D. Crocker, Ed.
Internet Mail Consortium
P. Overell
Demon Internet Ltd.
November 1997
|
||||||||
|
|
|||||||||
|
Расширенная спецификация синтаксиса Бэкуса-Наура (ABNF)
Augmented BNF for Syntax Specifications: ABNF1
Статус документа
В этом документе содержится спецификация протокола, предложенного сообществу Internet. Документ служит приглашением к дискуссии в целях развития и совершенствования протокола. Текущее состояние стандартизации протокола вы можете узнать из документа "Internet Official Protocol Standards" (STD 1). Документ может распространяться без ограничений.
Авторские права
Copyright (C) The Internet Society (1997). All Rights Reserved.
Оглавление
1. Введение ................................................................................................................................................................................ ...... .................... 1
2. Определения правил ................................................................................................................................................................................ ...2....
2.1 Именование правил .......................................................................................................................................................................... ..2....
2.2. Форма правил ................................................................................................................................................................................. ....2...
2.3. Терминальные значения ................................................................................................................................................................. ...2...
2.4. Внешнее кодирование ......................................................................................................................................................... .... ............. 2
3. Операторы ............................................................................................................................................................................. ..... .. .................. 3
3.1. Конкатенация: Rule1 Rule2 .......................................................................................................................................................... ......3. .
3.2. Варианты: Rule1 / Rule2 ............................................................................................................................................ ........................ 3
3.3. Дополнительные варианты: Rule1 =/ Rule2 .................................................................................................................................. ..3...
3.4. Диапазоны вариантов: %c##-## ...................................................................................................................................................... 3
3.5. Упорядоченная группа: (Rule1 Rule2) .................................................................................................................................... .............4
3.6. Переменное число повторов: *Rule ............................................................................................................................... ....... ............. 4
3.7. Заданное число повторов: nRule ................................................................................................................................................... ..4....
3.8. Необязательная последовательность: [RULE] ............................................................................................................ .. ................... 4
3.9. Комментарий: ; Comment ......................................................................................................................................... ......................... 4
3.10. Старшинство операторов .............................................................................................................................................................. ..4...
4. ABNF-определение для ABNF .............................................................................................................................................................. ..... 5. .
5. Вопросы безопасности ....................................................................................................................................................... ..... ...................... 5
6. Приложение A - основы ............................................................................................................................................................................. 5....
6.1 Базовые правила .................................................................................................................................................................. ................ 5
6.2 Общие правила кодирования .................................................................................................................................................... ..... ......6
7. Благодарности ..................................................................................................................................................................................... ........ 6
8. Литература ................................................................................................................................................................................................ ...6..
9. Контактная информация ............................................................................................................................................................................. 6.
10. Полное заявление авторских прав ..................................................................................................................................... ....................... 6
|
|||||||||
|
|
|||||||||
|
1. Введение
В технических спецификациях Internet часто требуется определять формальный синтаксис и можно выбирать ту или иную нотацию, которую авторы считают полезной. За долгие годы модифицированная версия формы Бэкуса-Наура (BNF), названная (ABNF) приобрела популярность во множестве спецификаций Internet. Эта форма сочетает компактность и простоту с достаточно мощными средствами представления. В раннюю эпоху Arpanet каждая спецификация использовала свое определение ABNF. К таким определениям относится спецификация электронной почты [RFC733] и более поздний документ [RFC822], которые стали основой для последующих определений ABNF. Текущий документ разделяет эти определения для того, чтобы можно было независимо ссылаться на них. Кроме того в этом документе внесены некоторые изменения и усовершенствования.
Различия между стандартной формой BNF и ABNF включают правила именования, повторения, варианты, независимость от порядка (order-independence) и диапазоны значений. В Приложении A (Основы) даются определения правил и кодирования для основы лексического анализатора типа, используемого в нескольких спецификациях Internet. Они приводятся для удобства и отделения от мета-языка, определенного в основной части данного документа, и его формального статуса.
|
|||||||||
|
|
|||||||||
|
1Документ утратил силу
|
и заменен RFC 4234. Перевод имеется на сайте http://rfc.com.ru. Прим. перев.
|
||||||||
|
|
|||||||||
|
|
|||
|
|
Перевод RFC 2234
|
||
|
|
|||
|
2. Определения правил 2.1 Именование правил
Имя правила является лишь именем как таковым, т. е., последовательностью символов, начинающейся с буквы2 или цифры, за которой следует комбинация букв, цифр и знаков дефиса3 (-).
Примечание: строчные и прописные буквы в именах правил не различаются.
Имена <rulename>, <Rulename>, <RULENAME> <rUlENamE> указывают на одно правило.
В отличие от исходной формы BNF угловые скобки (< и >) не являются обязательными. Однако в такие скобки могут заключаться имена правил, когда нужно подчеркнуть использование имени правила. Это обычно относится к именам правил, указанным в свободной форме, или для выделения имен правил включенных в строку без разделения символами пробела, как показано ниже при обсуждении повторов.
2.2. Форма правил
Правила определяются следующим способом:
name = elements crlf
где <name> - имя правила, <elements> - одно или множество имен правила или терминальных спецификаций, а <crlf> - индикатор завершения строки (возврат каретки с последующим переводом строки). Знак равенства отделяет имя от определения правила. Элементы формируют последовательность из одного или множества имен правил и/или определений значений, объединенных с помощью различных операторов, определяемых в данном документе, таких, как повторы или варианты.
Для наглядности определения правил выравнены по левому краю. Если правило не помещается на одной строке, используются знаки продолжения строки. Выравнивание по левому краю и сдвиг от края определяются первой строкой правила ABNF, чтобы правила можно было легко отличить от остального текста документа.
2.3. Терминальные значения
Правила преобразуются в строки терминальных значений, иногда называемых символами. В ABNF символ – это просто неотрицательное целое число. В некоторых случаях задается специфическое отображение (кодирование) значений в набор символов (такой, как ASCII).
Терминалы задаются одной или множеством цифр с явно заданным основанием. В настоящее время определены следующие варианты оснований чисел:
b = binary (двоичное)
d = decimal (десятичное)
x = hexadecimal (шестнадцатеричное)
Следовательно, записи:
CR = %d13 CR = %x0D
задают, соответственно, десятичное и шестнадцатеричное представление символа возврата каретки [US-ASCII].
Связанные (concatenated) строки таких значений задаются в компактной форме с использованием символа точки (.) в качестве разделителя. Следовательно,
CRLF = %d13.10
ABNF разрешает указывать текстовые строки4 непосредственно, помещая текст в двойные кавычки.
command = "command string"
Текстовые строки интерпретируются как связанное множество печатных символов.
Примечание: регистр букв текстовых строках ABNF не принимается во внимание, а в качестве набора символов используется US-ASCII.
Следовательно,
rulename = "abc"
и
rulename = "aBc"
будут соответствовать "abc", "Abc", "aBc", "abC", "ABc", "aBC", "AbC" и "ABC".
Для задания правила, в котором регистр символов принимается во внимание символы следует задавать по-отдельности. Например,
rulename = %d97 %d98 %d99
или
rulename = %d97.98.99
будут соответствовать только строкам, содержащим лишь строчные буквы abc.
2.4. Внешнее кодирование
Внешнее представление символов терминальных значений будет меняться в соответствии с условиями среды хранения и передачи. Следовательно, одна и та же грамматическая конструкция ABNF может иметь различное внешнее кодирование
|
|||
|
|
|||
|
2Здесь и далее в тексте документа термин “буква” означает буквы латинского алфавита. Прим. перев. 3В английском языке hyphen или dash. Прим. перев. 4Literal text string
|
|||
|
|
|||
|
|
||
|
Перевод
RFC 2234
(например, одно представление для 7-битовой среды US-ASCII, другое для двоичной среды на базе октетов5, третье для 16-битовой среды Unicode). Детали кодирования выходят за пределы ABNF, хотя в Приложении A (Основы) приводятся определения для 7-битовой среды US-ASCII, как наиболее распространенной в Internet.
Разделение внешнего кодирования и синтаксиса предназначено для того, чтобы могли использоваться дополнительные среды кодирования для одного и того же синтаксиса.
3. Операторы
3.1. Конкатенация6: Rule1 Rule2
Правило может определять простую, упорядоченную строку значений (например, конкатенация последовательных символов) путем перечисления последовательности имен правил. Например,
foo = %x61 ; a
bar = %x62 ; b
mumble = foo bar foo
В результате правило <mumble> будет соответствовать строке строчных букв "aba".
Пробельные символы (linear white space): Конкатенация является основой модели разбора (parsing) ABNF. Строка непрерывных (contiguous) символов (значений) разбирается согласно правилам, определенным в ABNF. Для спецификаций Internet в силу исторических причин допускается свободное “рассеяние” символов пробела и горизонтальной табуляции вокруг основных конструкций (таких, как специальные разделители7 или строки-атомы8).
Примечание:
В данной спецификации ABNF не предполагается неявно такого “рассеяния” пробельных символов (linear white space).
Любая грамматическая конструкция, которая разрешает “рассеяние” пробельных символов вокруг разделителей и сегментов строк, должна указывать это явно. Зачастую бывает полезно обеспечить такое пустое пространство в основных (core) правилах, которые используются среди правил вышележащих уровней9. “Основные” правила могут формироваться в лексический анализатор или просто быть частью главного набора правил.
3.2. Варианты10: Rule1 / Rule2
Элементы, разделенные символом дробной черты11 (/), задают варианты. Следовательно,
foo / bar
будет принимать <foo> или <bar>.
Примечание:
Заключенные в двойные кавычки строки букв представляют собой специальную форму задания дополнительных символов и интерпретируются как нетерминальное представление набора комбинаторных строк с содержащимися в них символами в указанном порядке, но с любыми комбинациями строчных и прописных букв.
3.3. Дополнительные варианты12: Rule1 =/ Rule2
Иногда удобно задавать список вариантов в виде фрагментов. Т. е., начальному правилу соответствует один или множество вариантов, а последующие определения правил добавляют набор вариантов. Это особенно полезно для создания иной независимой спецификации, которая является производной от того же родительского набора правил, как это часто бывает со списками параметров. ABNF поддерживает такие дополнения с помощью конструкции:
oldrule =/ additional-alternatives
Таким образом набор правил
ruleset = alt1 / alt2 ruleset =/ alt3 ruleset =/ alt4 / alt5
представляет собой то же самое, что и
ruleset = alt1 / alt2 / alt3 / alt4 / alt5
3.4. Диапазоны вариантов13: %c##-##
Диапазон вариантов цифровых значений может быть представлен в компактной форме с использованием символа дефиса (-) для индикации диапазона вариантов. Следовательно,
DIGIT = %x30-39
является эквивалентом:
DIGIT = "0" / "1" / "2" / "3" / "4" / "5" / "6" / "7" / "8" / "9"
|
||
|
|
||
|
5binary octet environment 6Слияние. Прим. перев. 7delimiter 8atomic string 9higher-level rule 10Alternative 11forward slash 12Incremental Alternative 13Value Range Alternatives
|
||
|
|
||
|
|
|||
|
|
Перевод RFC 2234
|
||
|
|
|||
|
Конкатенация цифровых значений и диапазон цифровых значений не могут быть заданы в одной строке. Цифровое значение может использовать нотацию с точками для конкатенации14 или нотацию с дефисом15 для задания одного диапазона значений. Следовательно, для задания одного печатного символа между последовательностями завершения строк, можно указать:
char-line = %x0D.0A %x20-7E %x0D.0A
3.5. Упорядоченная группа16: (Rule1 Rule2)
Элементы, заключенные в круглые скобки, трактуются как один элемент со строгим упорядочением. Таким образом,
elem (foo / bar) blat
соответствует (elem foo blat) или (elem bar blat), а
elem foo / bar blat
соответствует (elem foo) или (bar blat).
Примечание:
Настоятельно рекомендуется использовать группы взамен вариантов, состоящих из множества имен правил или литералов. Следовательно, рекомендуется использовать приведенную ниже форму:
(elem foo) / (bar blat)
Это позволит предотвратить ошибочную интерпретацию при невнимательном чтении.
Упорядоченные группы используются также внутри свободного текста для выделения порядка слов в тексте.
3.6. Переменное число повторов17: *Rule
Оператор *, предшествующий элементу, указывает на повторение. Полная форма имеет вид:
<a>*<b>element
где <a> и <b> - необязательные десятичные значения, показывающие минимальное (<a>) и максимальное (<b>) число повторов элемента.
По умолчанию для верхнего и нижнего порога используются значения 0 и “бесконечность”, поэтому *<element> позволяет любое число элементов (включая 0), 1*<element> требует по крайней мере один элемент, 3*3<element> разрешает в точности три повтора, а 1*2<element> разрешает 1 или 2 повтора.
3.7. Заданное число повторов18: nRule
Правило вида:
<n>element
эквивалентно правилу
<n>*<n>element
Т. е., допускается в точности <N> включений <element>. Таким образом 2DIGIT представляет собой двухзначное число, а 3ALPHA – строку из трех букв.
3.8. Необязательная последовательность19: [RULE]
В квадратных скобках указывается необязательная последовательность элементов.
[foo bar]
эквивалентно
*1(foo bar).
3.9. Комментарий: ; Comment
Точка с запятой (;) служит началом комментария, который продолжается до конца строки. Это обеспечивает простой способ включения в спецификацию полезных примечаний.
3.10. Старшинство операторов
Описанные выше операторы имеют разный уровень старшинства (порядок применения). Далее операторы перечислены в соответствии со старшинством – сначала указаны операторы с высшим приоритетом, а последним указан оператор с низшим уровнем старшинства:
Строки, имена (Strings, Names)
Комментарий (Comment)
Диапазон значений (Value range)
Повтор (Repetition)
Группировка, необязательные последовательности (Grouping, Optional)
Конкатенация (Concatenation)
Варианты (Alternative)
|
|||
|
|
|||
|
14dotted notation 15dash notation 16Sequence Group 17Variable Repetition 18 Specific Repetition 19Optional Sequence
|
|||
|
|
|||
|
|
|||||||||
|
Перевод RFC 2234
|
|
||||||||
|
|
|||||||||
|
Использование вариантов, произвольно перемешанных с операторами конкатенации, может привести к путанице.
Снова рекомендуется использовать оператор группировки для явного указания сливаемых воедино (concatenation) групп.
4. ABNF-определение для ABNF
Синтаксис использует правила, приведенные в Приложении A (Основы).
|
|||||||||
|
|
|||||||||
|
rulelist rule
rulename defined-as
elements
c-wsp
c-nl
|
1*( rule / (*c-wsp c-nl) ) rulename defined-as elements c-nl
; продолжение, если следующая строка начинается с пробела ALPHA *(ALPHA / DIGIT / "-") *c-wsp ("=" / "=/") *c-wsp
; определение базовых правил и дополнительных вариантов alternation *c-wsp WSP / (c-nl WSP) comment / CRLF
; комментарий или новая строка
|
||||||||
|
|
|
|
|||||||
|
comment
alternation
concatenation
repetition
repeat
element
group
option
char-val
num-val bin-val
|
*(WSP / VCHAR) CRLF concatenation *(*c-wsp "/" *c-wsp concatenation) repetition *(1*c-wsp repetition) [repeat] element 1*DIGIT / (*DIGIT "*" *DIGIT)
rulename / group / option / char-val / num-val / prose-val "(" *c-wsp alternation *c-wsp ")" "[" *c-wsp alternation *c-wsp "]" DQUOTE *(%x20-21 / %x23-7E) DQUOTE
|
||||||||
|
"%"
|
; заключенная в кавычки строка SP и VCHAR без DQUOTE
(bin-val / dec-val / hex-val)
|
||||||||
|
1*BIT [ 1*("." 1*BIT) / ("-" 1*BIT) ]
|
|||||||||
|
|
"d" "x"
"<"
|
; последовательность объединенных (concatenated) битовых
; значений или один диапазон ONEOF
|
|||||||
|
dec-val hex-val prose-val
|
1*DIGIT [ 1*("." 1*DIGIT) / ("-" 1*DIGIT) ]
1*HEXDIG [ 1*("." 1*HEXDIG) / ("-" 1*HEXDIG) ]
*(%x20-3D / %x3F-7E) ">"
|
||||||||
|
|
|
||||||||
|
; заключенная в угловые скобки последовательность SP и VCHAR
; за исключением правых угловых скобок будет использоваться
; как последний шанс
5. Вопросы безопасности
Искренне надеемся, что вопросы безопасности не имеют отношения к этому документу.
6. Приложение A - основы
Это приложение включено как удобная основа для грамматических конструкций. Приведенные здесь определения можно использовать как базовый набор правил.
|
|||||||||
|
|
|||||||||
|
6.1 Базовые правила
Для некоторых базовых правил (таких, как SP, HTAB, CRLF, DIGIT, ALPHA и т. п.) используются заглавные буквы.
|
|||||||||
|
|
|||||||||
|
ALPHA
BIT
CHAR
CR
|
= %x41-5A / %x61-7A
|
; A-Z / a-z
|
|||||||
|
= "0" / "1" = %x01-7F
; любой 7-битовый символ US-ASCII, за исключением NUL = %x0D
; возврат каретки
|
|||||||||
|
|
|||||||||
|
CRLF
CTL
DIGIT
DQUOTE
HEXDIG HTAB
LF
LWSP
OCTET
SP
VCHAR
|
= CR LF
; стандартная в Internet последовательность для новой строки = %x00-1F / %x7F
; коды управления = %x30-39
; цифры 0-9 = %x22
; " (двойные кавычки) = DIGIT / "A" / "B" / "C" / "D" / "E" / "F" = %x09
; символ горизонтальной табуляции = %x0A
; перевод строки = *(WSP / CRLF WSP)
; linear white space (после новой строки) = %x00-FF
; 8 битов данных = %x20
; пробел = %x21-7E
; видимые (печатные) символы
|
||||||||
|
|
|||||||||
|
|
|||
|
|
Перевод RFC 2234
|
||
|
|
|||
|
WSP = SP / HTAB
; пробельные символы
6.2 Общие правила кодирования
Для внешнего представления данных используется 7-битовая кодировка US-ASCII с нулевым значением старшего бита20. Строки значений используют “сетевой порядок байтов21,” при котором старший (наиболее значимый байт) указывается слева и передается через сеть первым.
7. Благодарности
Изначальная спецификация синтаксиса ABNF была приведена в RFC 733. Ken L. Harrenstien из SRI International выполнил работу по кодированию для расширенного BNF, позволившему сделать представление более компактным и ясным.
Этот недавний проект проект начался как простая работа по выделению части документа RFC 822, которая неоднократно использовалась в спецификациях, не связанных с электронной почтой, и являлась описанием расширенного варианта BNF. Вместо простого копирования имеющегося текста в отдельный документ рабочая группа предпочла внимательное рассмотрение преимуществ и недостатков существующей спецификации и других спецификаций, выпущенных за последние 15 лет. Это сделало проект более амбициозным, нежели предполагалось в начале. Интересно отметить, что полученный результат не слишком значительно отличается от оригинала, хотя некоторые решения (типа удаления списков - list notation) стали сюрпризом.
Текущая версия спецификации была частью работы группы DRUMS, значительный вклад в которую внесли Jerome Abela, Harald Alvestrand, Robert Elz, Roger Fajman, Aviva Garrett, Tom Harsch, Dan Kohn, Bill McQuillan, Keith Moore, Chris Newman, Pete Resnick и Henning Schulzrinne.
8. Литература
[US-ASCII] Coded Character Set--7-Bit American Standard Code for Information Interchange, ANSI X3.4-1986.
[RFC733] Crocker, D., Vittal, J., Pogran, K., and D. Henderson, "Standard for the Format of ARPA Network Text Message," RFC 733, November 1977.
[RFC822] Crocker, D., "Standard for the Format of ARPA Internet Text Messages", STD 11, RFC 822, August 1982.
9. Контактная информация
David H. Crocker Paul Overell
Internet Mail Consortium Demon Internet Ltd
675 Spruce Dr. Dorking Business Park
Sunnyvale, CA 94086 USA Dorking
Surrey, RH4 1HN
UK Phone: +1 408 246 8253 Fax: +1 408 249 6205 EMail: dcrocker@imc.org paulo@turnpike.com
Перевод на русский язык Николай Малых
10. Полное заявление авторских прав
Copyright (C) The Internet Society (1997). All Rights Reserved.
This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to the Internet Society or other Internet organizations, except as needed for the purpose of developing Internet standards in which case the procedures for copyrights defined in the Internet Standards process must be followed, or as required to translate it into languages other than English.
The limited permissions granted above are perpetual and will not be revoked by the Internet Society or its successors or assigns.
This document and the information contained herein is provided on an "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
|
|||
|
|
|||
|
20network virtual ASCII 21network byte order
|
|||
|
|
|||