Trabalho Prático de PL

O presente software foi desenvolvido no contexto académico e deve ser utilizado sem qualquer garantia por conta e risco do utilizador.

Autores:

• José Moura [email protected]
• Óscar Silva [email protected]
• Daniel Torres [email protected]

Links Uteis

• GitHub: https://github.com/nargotik/TP2_PL
• Documentação: https://nargotik.github.io/TP2_PL/

Introdução

O objetivo deste trabalho é o de implementar uma ferramenta capaz de ler um documento de texto usando uma determinada sintaxe. A resolução deste trabalho foi dividida em duas partes :

• Análise Léxica para verificar se os caracteres introduzidos fazem parte do alfabeto por nós criado;
• Análise Sintática para verificar se os dados introduzidos seguem as regras gramaticais definidas na gramática por nós criada.

De forma a comprovar os conceitos de analisador léxico e sintático, foi-nos proposta uma série de problemas e de entre essas propostas dadas, deveríamos escolher uma para implementar. A nossa escolha recaiu no problema 2: Linguagem de Desenho de Imagens Raster por nos parecer um enunciado bastante interessante do ponto de vista de comprovar as valências do uso do "par Flex-Bison".

De forma bastante sucinta, este problema propunha a implementação de uma linguagem para a descrição e criação de imagens através da interpretação de um simples documento de texto com determinada sintaxe pré-estabelecida.

Para a realização deste trabalho foram utilizadas as ferramentas abaixo descritas:

• Flex (Versão 2.6.0)
• Bison (Versão 3.0.4)

Estratégia de resolução do Problema

Para resolver tal problema foi-nos sugerido o uso do formato PNM por ser um formato bastante simples a nível de leitura e escrita e com a vantagem de poder ser armazenado em memória usando matrizes. A família PNM possui vários sub-formatos sendo designados por Pn estando n definido entre 1 e 6. As diferenças entre eles baseiam-se na forma como são codificados (ASCII ou Binário) e quais os conjuntos de cores que conseguem armazenar (B&W, 256 cinzentos ou 16M cores).

Nome	P1	P2	P3	P4	P5	P6
Cores	B&W	256 Cinzentos	16M Cores	B&W	256 Cinzentos	16M Cores
Codificação	ASCII	ASCII	ASCII	Binário	Binário	Binário

Face à representação vista na tabela acima, resolvemos utilizar o formato P6 pois o mesmo permite a criação de imagens a 16M Cores, mesmo que a nível de codificação, os pixeis da imagem sejam em binário, usando um byte para representar cada cor.

Definição da linguagem de Desenho

A linguagem de desenho é definida através da interpretação de um conjunto de comandos previamente estabelecidos e devem terminal por ponto e virgula (;). Definiu-se ainda que:

• Os comandos deveriam ser escritos em maiúsculas;
• As variáveis deveriam ser escritas em minúsculas;
• Só se podem usar valores inteiros;
• Um ponto geométrico é definido por dois inteiros separados por uma vírgula;
• Uma área é definida por dois inteiros separados por 'x';
• Uma cor é definida através da representação numérica RGB (três inteiros separados por dois pontos);
• Uma string é delimitada por aspas simples.

1. Gestão de Imagens

Para a gestão das imagens foram definidas os seguintes comandos:

• NEW - Comando que prepara a área de desenho, recebendo como parâmetros o tamanho da área de desenho (p.ex. 800x600) e a cor iniciada (p.ex. 255:0:0).

NEW 800x600 255:0:0;

O parâmetro cor é opcional, sendo que, no caso de ser omitido, a área de desenho é iniciada com a cor branca (255:255:255)

NEW 800x600;

• LOAD - Comando encarregado de carregar um ficheiro .pnm para memória.

LOAD "ficheiro.pnm";

• SAVE - Comando encarregado de guardar uma imagem gerada em memória num ficheiro de imagem P6.

SAVE "ficheiro.pnm";

2. Desenho

Segundo o enunciado, todas as primitivas de desenho deverão aceitar um último parâmetro com a cor a ser usada para desenhar. No entanto pode ser definida uma cor "por omissão", sendo que essa será definida pelo comando COLOR.

• COLOR - Comando responsável por definir a cor padrão caso os comandos não possuam uma cor definida nos seus parâmetros.

COLOR 128:128:128;

• POINT - Comando responsável por desenhar um ponto nas coordenadas x,y indicadas.

POINT 4,100;

Opcionalmente podemos ainda definir a cor que deve ser usada para o ponto.

POINT 4,100 255:128:0;

• LINE - Comando responsável converter dois pontos recebidos em uma reta e em desenhá-la.

LINE 4,100 4,200; // Utilizando cor padrão
LINE 4,100 4,200 255:128:0; // Utilizando uma cor específica

• RECT - Comando responsável por desenhar quadrados. Aceita como parâmetros dois pontos opostos.

RECT 5,10 10,20; // Utilizando cor padrão
RECT 5,10 10,20 255:128:0; // Utilizando uma cor específica

Aceita ainda como parâmetros o ponto que se encontra na posição do canto superior esquerdo e as dimensões do quadrado.

RECT 5,10 10x20; // Utilizando cor padrão
RECT 5,10 10x20 255:128:0; // Utilizando uma cor específica

• RECTFILL - Comando similar ao anterior, no entanto possui a capacidade de pintar de determinada cor (a padrão ou uma especifica).

// Utilizando cor padrão
RECTFILL 5,10 10,20;
RECTFILL 5,10 10x20;
// Utilizando uma cor específica
RECTFILL 5,10 10,20 255:128:0; 
RECTFILL 5,10 10x20 255:128:0;

• CIRC - Comando responsável por desenhar círculos. Para desenhar aceita como parâmetros um ponto fixo que funcionará como centro e um raio.

CIRC 5,10 100; // Utilizando cor padrão
CIRC 5,10 100 255:128:0; // Utilizando uma cor específica

• CIRCFILL - Comando similar ao anterior, no entanto possui a capacidade de pintar de determinada cor (a padrão ou uma específica).

CIRCFILL 5,10 100; // Utilizando cor padrão
CIRCFILL 5,10 100 255:128:0; // Utilizando uma cor específica

• POLYLINE - Comando responsável por desenhar linhas entre os pontos passados como parâmetros.

POLYLINE 5,10 10,10 10,15; // Utilizando cor padrão
POLYLINE 5,10 10,10 10,15 255:128:0; // Utilizando uma cor específica

3. Variáveis e Expressões

Como se pode verificar, muitos dos parâmetros que na secção anterior foram apresentados são definições de pontos geométricos e códigos RGB para as cores a aplicar na instrução. Face a esse facto, podemos então definir variáveis que permitirão armazenar os dados referentes aos pontos geométricos ou ao código RGB da cor.

A sua atribuição é similar ao utilizado na linguagem C, utilizando-se o caráter '='. Tal como em C, a atribuição de dados a uma variável pode ser do tipo numérico ou outra variável.

raio = 2;
diametro = raio;

Salienta-se o facto que os caracteres "x" "y" "z" não podem ser usados como variáveis pois no contexto do problema serão usados como delineadores de instruções.

Uma outra funcionalidade bastante importante na geração imagens é o facto de podermos criar imagens com pontos aleatórios. Para tal, foi necessário utilizar a função RAND nativa do C para gerar pontos aleatórios na área de desenho, sendo que o valor apresentado após o termo RAND é o valor máximo admitido.

a = RAND 10;

No exemplo acima apresentado, a variável a pode tomar valores entre 0 e 10, inclusive.

É também muito importante que a linguagem de desenho aceite iterar várias vezes a mesma instrução. Para tal, é necessário aplicar o conceito de ciclos. Foi desenvolvido então um ciclo for muito similar ao aplicado em linguagens imperativas, no entanto com ligeiras nuances.

FOR i IN [10..20] DO ... END FOR;

Utilização/Compilação

Para compilar as aplicações necessárias simplesmente é necessário efectuar o comando:

$ make

O executavel será criado na pasta bin e pode ser executado da seguinte forma:

$ ./bin/imageraster < examples/example[...]txt

Estrutura do Flex

O Flex é um software desenvolvido com o intuito de permitir a análise léxica de um determinado conjunto de dados através do reconhecimento de sequências de caracteres ("tokens") definidas pelo programador.

Um ficheiro de Flex é composto por três zonas delimitadas por %%

A primeira parte, o preâmbulo, é o local onde se faz a inclusão das bibliotecas e da definição de conjuntos de caracteres.

%{
 #include "../src/commands.h"
 #include "../include/grammar.tab.h"
%}

No ficheiro por nós desenvolvido, o preâmbulo é constituído pela inclusão da biblioteca com a definição das funções necessárias para a criação de um software de desenho de imagens em Raster. É também definida no preâmbulo o ficheiro grammar.tab.h que informa ao analisador léxico que o Flex vai ser usado em conjunto com o Bison.

A segunda parte, o corpo, é a zona na qual estão definidas as expressões regulares, assim como as ações semânticas que poderão ser despoletadas aquando do eventual reconhecimento de um token.

%%

NEW|new     { return NEW; }
LOAD|load     { return LOAD; }
LINE|line     { return LINE; }
SAVE|save     { return SAVE; }
COLOR|color     { return COLOR; }
POINT|point     { return POINT; }
RECT|rect     { return RECT; }
RECTFILL|rectfill     { return RECTFILL; }
CIRC|circ     { return CIRC; }
POLYLINE|polyline     { return POLYLINE; }
FOR|for     { return FOR; }
IN|in     { return IN; }
DO|do     { return DO; }
END|end     { return END; }
\.\.    { return TO; }

RAND|rand     { return RAND; }

\; { return EOC; }

x { return CRUZ; }

[0-9]+      { yylval.num = atoi(yytext); return INT; }

[a-v]+([0-9]+)?    { yylval.str = strdup(yytext); return VAR_NAME; }

\"[1-9a-zA-Z\.]+\"    { yylval.str = strdup(yytext+1); return FILE_NAME; }



[ \t\n\r]   {}
.           { return yytext[0]; }

%%

Na nossa implementação, o corpo é constituído por expressões regulares que permitem reconhecer em Ignore Case Sensitive as diversas instruções e caracteres especiais utilizados pela nossa implementação de desenho de imagens em Rasper. Se for reconhecido algum dos tokens definidos no lexer.l, é retornado para o programa a devida função de C a ser invocada para tratar aquele comando.

A terceira parte é destinada para as funções adicionais necessárias para o bom funcionamento do analisador léxico.

int yywrap() { return 1; }

Nesta implementação, foi definida a função yywrap() que retorna 1 e que passa a informação ao analisador léxico que estamos na presença de EOF (End Of File).

Estrutura do Bison

O Bison é um software desenvolvido com o intuito de permitir gerar automaticamente programas para análise sintática. Possui como entrada a declaração de uma gramática, que especifica uma linguagem e gera como saída o parser dessa linguagem. O parser gerado pelo Bison permite validar os argumentos lá introduzidos permitindo assim, averiguar se os mesmos seguem a lógica sintática definida na nossa gramática.

De forma similar ao que acontece na estrutura de ficheiro do Flex, um ficheiro de Bison é também composto por três zonas delimitadas por %%

A primeira parte, o preâmbulo, é o local onde se faz a inclusão das bibliotecas a serem utilizadas.

%{
  #include <stdio.h>
  #include <string.h>
  #include "../src/commands.h"
  int yylex();
  int yyerror(char*);
  #define DEBUG 1
%}

No ficheiro por nós desenvolvido, o preâmbulo é constituído pela inclusão da biblioteca com a definição das funções necessárias para a criação de um software de desenho de imagens em Raster. É também incluído no preâmbulo a biblioteca commands.h que informa ao analisador sintático que as funções que concretizam as instruções definidas na gramática estão concretizadas nessa biblioteca.

São ainda definidos outros blocos de código que dizem respeito a outras declarações.

%union {
   int num;
   Command *cmd; // both a single command or a command list
   Value *val;
   Dimension *dim;
   Colour *col;
   Point *pt;
   char *str;  // used for variable names
}

%token NEW LOAD SAVE COLOR POINT RECT RECTFILL CIRC POLYLINE EOC LINE RAND CRUZ FOR IN DO END TO ATTRIB ATTRIB_RAND
%token<str> VAR_VALUE VAR_NAME FILE_NAME
%token<num> INT

%type<cmd> instructionList instruction
%type<dim> v_dimension
%type<col> v_colour
%type<pt> v_point v_points_multiple v_points_two
%type<val> value

%start program;
%expect 1

Na nossa implementação foram necessárias usar algumas definições extra que têm como objetivo o seguinte:

• %union - Permite definir a estrutura que o lexer vai usar para transmitir esse conjunto de dados para o analisador;
• %token - Permite definir símbolos que representam os valores que serão retornados pelo lexer e que correspondem a símbolos terminais em produções;
• %type - Permite especificar nomes para símbolos não terminais em produções;
• %start - Indica ao Bison qual é o símbolo não terminal onde a gramática deve iniciar.

A segunda parte, o corpo, é a zona na qual estão definidas as produções e o respetivo código a ser invocado caso a regra sintática seja correspondida.

program : instructionList { Run($1); }
        ;

instructionList : instruction { $$ = $1; }
                | instruction instructionList
                       { $$ = insertCommand($2,$1); }
                ;

(...)

v_dimension : value CRUZ value {
                $$ = parseDimension($1,$3);
};

v_colour  : value ':' value ':' value {
                $$ = parseColour($1, $3, $5);
};

v_point : value ',' value {
                $$ = parsePoint(NULL,$1,$3);
};

v_points_multiple : v_point {
          $$ = $1;
      }
      | v_points_multiple v_point {
          $2->next = $1;
          $$ = $2;
      }
      ;
v_points_two : v_point v_point {
        $1->next = $2;
        $$ = $1;
};


value : INT  {  Value* v = (Value*)malloc(sizeof(Value));
               v->val = $1;
               v->var = NULL;
               $$ = v; }
     | VAR_NAME {
               Value *v = (Value*)malloc(sizeof(Value));
               v->var = $1;
               $$ = v; }
     ;

Na nossa implementação, o corpo é constituído pelas produções que permitem verificar se a sintaxe usada no ficheiro de texto permite criar a imagem. Em caso afirmativo são invocadas as funções necessárias para a criação da imagem. Em caso contrário a imagem não será criada.

A terceira parte é destinada para as funções adicionais necessárias para o bom funcionamento do analisador sintático.

int yyerror(char* msg) { printf("Error: %s\n", msg); return 0; }

Nesta implementação, foi definida a função yyerror() que retorna o código do erro para o utilizador, caso algum erro se verifique. Caso contrário retorna um 0.

Resultados obtidos

Após a concretização de todas as funções e comandos necessários para a resolução do problema, se for executado o comando abaixo descrito obteremos a imagem PNM (P6) que esperávamos.

$ ./bin/imageraster < examples/example[...]txt

Seguem abaixo alguns exemplos gerados:

Conclusão

A título de conclusão, podemos verificar que um compilador é um componente bastante complexo, na medida em todo o progresso de análise léxica e sintática regem-se por regras bastante bem definidas.

Concluímos ainda que a junção Flex-Bison permite simular muito bem qual o WorkFlow que o compilador utiliza de cada vez que necessita de verificar os dados que a ele são submetidos.

Verificámos ainda que o processo de análise sintática é muito mais complexa do que a análise léxica e que a definição de uma gramática deve ser o mais objetiva possível de forma a impedir situações de erros derivados a ambiguidades do analisador sintático.

Bibliografia / Referências

• GitHub Flex
• Bison Lecture