Attach parser location information to AST nodes.
[goals.git] / src / lexer.mll
1 (* Goalfile lexer
2  * Copyright (C) 2019 Richard W.M. Jones
3  * Copyright (C) 2019 Red Hat Inc.
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18  *)
19
20 {
21 open Lexing
22 open Parser
23
24 open Printf
25
26 exception SyntaxError of string
27
28 let new_line lexbuf =
29   let pos = lexbuf.lex_curr_p in
30   lexbuf.lex_curr_p <-
31     { pos with pos_bol = lexbuf.lex_curr_pos; pos_lnum = pos.pos_lnum + 1 }
32 }
33
34 let white = [' ' '\t']+
35 let newline = '\r' | '\n' | "\r\n"
36 let comment = '#' (_#'\n')*
37 let id = ['a'-'z' 'A'-'Z' '_'] ['a'-'z' 'A'-'Z' '0'-'9' '_']*
38
39 rule read =
40     parse
41     | white
42     | comment { read lexbuf }
43     | newline { new_line lexbuf; read lexbuf }
44     | ","     { COMMA }
45     | ":"     { COLON }
46     | "="     { EQUALS }
47     | "("     { LEFT_PAREN }
48     | ")"     { RIGHT_PAREN }
49     | "["     { LEFT_ARRAY }
50     | "]"     { RIGHT_ARRAY }
51     | '"'     { read_string (Ast.Substs.create ()) lexbuf }
52     | "{"     { read_code (Ast.Substs.create ()) (ref 1) lexbuf }
53     | "goal"  { GOAL }
54     | "let"   { LET }
55     | id      { ID (Lexing.lexeme lexbuf) }
56     | _       { raise (SyntaxError ("unexpected character: " ^
57                                     Lexing.lexeme lexbuf)) }
58     | eof     { EOF }
59
60 (* Parse "STRING" literal with %-substitutions. *)
61 and read_string buf =
62     parse
63     | '\\' '"'
64               { Ast.Substs.add_char buf '"'; read_string buf lexbuf }
65     | '\\' 'a'
66               { Ast.Substs.add_char buf '\007'; read_string buf lexbuf }
67     | '\\' 'b'
68               { Ast.Substs.add_char buf '\008'; read_string buf lexbuf }
69     | '\\' 't'
70               { Ast.Substs.add_char buf '\009'; read_string buf lexbuf }
71     | '\\' 'n'
72               { Ast.Substs.add_char buf '\010'; read_string buf lexbuf }
73     | '\\' 'v'
74               { Ast.Substs.add_char buf '\011'; read_string buf lexbuf }
75     | '\\' 'f'
76               { Ast.Substs.add_char buf '\012'; read_string buf lexbuf }
77     | '\\' 'r'
78               { Ast.Substs.add_char buf '\013'; read_string buf lexbuf }
79     | '\\' '\\'
80               { Ast.Substs.add_char buf '\\'; read_string buf lexbuf }
81     | '"'     { STRING (Ast.Substs.get buf) }
82     | newline { Ast.Substs.add_char buf '\n';
83                 new_line lexbuf; read_string buf lexbuf }
84     | '%' '%' { Ast.Substs.add_char buf '%'; read_string buf lexbuf }
85     | '%' id  { let id = Lexing.lexeme lexbuf in
86                 let len = String.length id in
87                 Ast.Substs.add_var buf (String.sub id 1 (len-1));
88                 read_string buf lexbuf }
89     | '%' _   { raise (SyntaxError ("illegal character in %-substitution: " ^
90                                     Lexing.lexeme lexbuf)) }
91     | [^ '"' '\\' '\r' '\n' '%' ]+
92               { Ast.Substs.add_string buf (Lexing.lexeme lexbuf);
93                 read_string buf lexbuf }
94     | _       { raise (SyntaxError ("illegal character in string: " ^
95                                       Lexing.lexeme lexbuf)) }
96     | eof     { raise (SyntaxError ("unterminated string")) }
97
98 (* Parse { CODE } literal with %-substitutions.
99  *
100  * Note the range of %-substitutions possible is larger than
101  * for strings.
102  *)
103 and read_code buf level =
104     parse
105     | '{'     { incr level; read_code buf level lexbuf }
106     | '}'     { decr level;
107                 if !level = 0 then CODE (Ast.Substs.get buf)
108                 else (
109                   Ast.Substs.add_char buf '}';
110                   read_code buf level lexbuf
111                 ) }
112     | newline { Ast.Substs.add_char buf '\n';
113                 new_line lexbuf; read_code buf level lexbuf }
114     | '%' '%' { Ast.Substs.add_char buf '%'; read_code buf level lexbuf }
115     | '%' '@' { Ast.Substs.add_var buf "@"; read_code buf level lexbuf }
116     | '%' '<' { Ast.Substs.add_var buf "<"; read_code buf level lexbuf }
117     | '%' '^' { Ast.Substs.add_var buf "^"; read_code buf level lexbuf }
118     | '%' id  { let id = Lexing.lexeme lexbuf in
119                 let len = String.length id in
120                 Ast.Substs.add_var buf (String.sub id 1 (len-1));
121                 read_code buf level lexbuf }
122     | '%' _   { raise (SyntaxError ("illegal character in %-substitution: " ^
123                                       Lexing.lexeme lexbuf)) }
124     | [^ '{' '}' '\r' '\n' '%' ]+
125               { Ast.Substs.add_string buf (Lexing.lexeme lexbuf);
126                 read_code buf level lexbuf }
127     | _       { raise (SyntaxError ("illegal character in code section: " ^
128                                       Lexing.lexeme lexbuf)) }
129     | eof     { raise (SyntaxError ("unterminated code section")) }