ABNF++: um gerador de parser ABNF
O compilador ABNF é um aplicativo desenvolvido no IFSC que gera um parser a partir de uma gramática. O parser se apresenta como uma classe C++ capaz de identificar e decompor texto de entrada de acordo com um conjunto de regras gerado com base na gramática especificada. Por exemplo, ao compilar esta especificação de gramática ABNF:
header="E-mail: " %d60 nome %d62 WSP email CRLF
email=1*16ALPHA %d64 1*8(1*16ALPHA ".") 1*16ALPHA
nome=*6(1*16ALPHA WSP) 1*16ALPHA
... são gerados estes arquivos:
- parser_default.h: declaração da classe Parser_default
- parser_default.cpp: implementação da classe Parser_default
A classe Parser_default contém a tabela de regras finais do parser. Uma regra final corresponde a uma linha completa de texto identificada pelo parser, enquanto uma regra intermediária corresponde a um trecho do texto identificado. O parser procura identificar uma regra final que corresponda integralmente a uma linha de texto. No exemplo acima existe uma regra final chamada header e duas regras intermediárias chamadas email e nome. Regras finais sempre terminam com CRLF (a sequência \r\n). Assim, o Parser_default do exemplo consegue identificar apenas linhas de texto que estejam no formato definido pela regra header. Além disso, ele consegue decompô-las em sequências de caracteres dadas pelas regras intermediárias email e nome.
Instalação
O compilador ABNF deve ser instalado a partir do seguinte arquivo:
Instale-o com o seguinte comando executado em um terminal:
sudo dpkg -i abnfparser_1.0_all.deb
Uso do compilador
O programa gen_abnf compila uma gramática ABNF, gerando um parser sob medida para a especificação. A execução do compilador sem argumentos, ou com a opção -h, apresenta uma ajuda:
$ gen_abnf
Uso: /usr/local/bin/gen_abnf [-n name][-d dir] rules_file | -h
-n: nomeia arquivos de codigo e classe usando "name" (default="default")
-d: grava arquivos de codigo no subdiretorio "dir"
-h: mostra esta ajuda
rules_file: arquivo com regras ABNF
As opções do compilador seguem descritas abaixo em maiores detalhes:
- -n: especifica o nome do parser a ser criado. O compilador gera um parser chamado Parser_<nome>. Por exemplo, se o nome informado for teste, a classe gerada será Parser_teste.
- -d: informa o diretório onde devem ser criados os arquivos de código-fonte do parser. Por default é o diretório atual.
A compilação de uma aplicação que use o parser deve seguir as orientações apresentadas pelo gerador do parser. Basicamente devem-se incluir opções de compilação para que o compilador g++ encontre a biblioteca ABNFParser. Essa biblioteca contém a API usada pelo parser. O exemplo a seguir mostra como compilar uma aplicação.
- Escreva um arquivo de texto com a gramática ABNF:
header="E-mail: " nome WSP %d60 email %d62 CRLF email=1*16ALPHA %d64 1*8(1*16ALPHA ".") 1*16ALPHA nome=1*16ALPHA *3(WSP 1*16ALPHA)
- Gere o parser usando o programa gen_abnf. Neste exemplo, o parser tem o sufixo teste:
$ gen_abnf -n teste abnf.txt Criou arquivos de codigo "./parser_teste.h" e "./parser_teste.cpp" Para compilar seu projeto, inclua estas opcoes: "-I/usr/local/include -L/usr/local/lib -labnf -lpcre++"
- Escreva sua aplicação que usa o parser:
#include <iostream> #include "parser_teste.h" int main() { Parser_teste parser; ABNFRule * r = (ABNFRule*)parser.match("E-mail: Dona Bilica <bilica@oioio.com.br>\r\n"); cout << "Nome da regra ativada: " << r->get_name() << endl; cout << "Texto que ativou a regra: " << r->get_match() << endl; Token * email = r->get_token("email"); Token * nome = r->get_token("nome"); cout << "Nome: " << nome->get_match() << endl; cout << "E-mail: " << email->get_match() << endl; }
- Compile sua aplicação com o compilador g++, passando as opções indicadas no passo 2:
g++ -o teste teste.cpp parser_teste.cpp -I/usr/local/include -L/usr/local/lib -labnf -lpcre++
- Execute sua aplicação:
$ ./teste Nome da regra ativada: header Texto que ativou a regra: E-mail: Dona Bilica <bilica@oioio.com.br> Nome: Dona Bilica E-mail: bilica@oioio.com.br
API do parser
A API do parser ABNF possui as seguintes classes C++:
- Parser_name: o parser gerado pelo compilador.
- ABNFParser: classe base para o parser, contendo a interface para seu uso.
- ABNFSimpleToken: classe que representa uma regra composta por uma string. Esse tipo de regra é ativado quando essa string for idêntica ao início do texto fornecido.
- ABNFToken: classe que representa uma regra composta por uma expressão regular. Esse tipo de regra é ativado quando essa expressão regular corresponder ao início do texto fornecido.
- ABNFRule: classe que representa uma sequência de uma ou mais regras quaisquer. Esse tipo de regra é ativado quando cada regra da sequência for ativada sucessivamente com o texto fornecido.
- ABNFRepRule: classe que representa uma regra qualquer que pode repetir. Esse tipo de regra é ativado quando a regra embutida for ativada repetidamente com o texto fornecido, de acordo com a faixa de repetições especificada.
- ABNFAltRule: classe que representa um conjunto de regras alternativas. Esse tipo de regra é ativado quando ao menos uma das regras for ativada, de acordo com a faixa de repetições especificada.