matitaB/components/content_pres/cicNotationLexer.ml

   1 (* Copyright (C) 2005, HELM Team.
   2  *
   3  * This file is part of HELM, an Hypertextual, Electronic
   4  * Library of Mathematics, developed at the Computer Science
   5  * Department, University of Bologna, Italy.
   6  *
   7  * HELM is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * HELM is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with HELM; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  20  * MA  02111-1307, USA.
  21  *
  22  * For details, see the HELM World-Wide-Web page,
  23  * http://helm.cs.unibo.it/
  24  *)
  25
  26 (* $Id$ *)
  27
  28 open Printf
  29
  30 exception Error of int * int * string
  31
  32 module StringSet = Set.Make(String)
  33
  34 (* Lexer *)
  35 let regexp number = xml_digit+
  36 let regexp utf8_blank = " " | "\r\n" | "\n" | "\t" | [160] (* this is a nbsp *)
  37 let regexp percentage =
  38   ('-' | "") [ '0' - '9' ] + '%'
  39 let regexp floatwithunit =
  40   ('-' | "") [ '0' - '9' ] + ["."] [ '0' - '9' ] + ([ 'a' - 'z' ] + | "" )
  41 let regexp color = "#" [ '0' - '9' 'a' - 'f' 'A' - 'F' ] [ '0' - '9' 'a' - 'f'
  42 'A' - 'F' ] [ '0' - '9' 'a' - 'f' 'A' - 'F' ] [ '0' - '9' 'a' - 'f' 'A' - 'F' ]
  43 [ '0' - '9' 'a' - 'f' 'A' - 'F' ] [ '0' - '9' 'a' - 'f' 'A' - 'F' ]
  44
  45   (* ZACK: breaks unicode's binder followed by an ascii letter without blank *)
  46 (* let regexp ident_letter = xml_letter *)
  47
  48 let regexp ident_letter = [ 'a' - 'z' 'A' - 'Z' ]
  49
  50   (* must be in sync with "is_ligature_char" below *)
  51 let regexp ligature_char = [ "'`~!?@*()[]<>-+=|:;.,/\"" ]
  52 let regexp ligature = ligature_char ligature_char+
  53
  54 let regexp we_proved = "we" utf8_blank+ "proved"
  55 let regexp we_have = "we" utf8_blank+ "have"
  56 let regexp let_rec = "let" utf8_blank+ "rec"
  57 let regexp let_corec = "let" utf8_blank+  "corec"
  58 let regexp ident_decoration = '\'' | '?' | '`'
  59 let regexp ident_cont = ident_letter | xml_digit | '_'
  60 let regexp ident_start = ident_letter
  61 let regexp ident = ident_letter ident_cont* ident_decoration*
  62 let regexp variable_ident = '_' '_' number
  63 let regexp pident = '_' ident
  64
  65 let regexp uri_step = [ 'a' - 'z' 'A' - 'Z' '0' - '9' '_' '-' ''' ]+
  66
  67 let regexp uri =
  68   ("cic:/" | "theory:/")              (* schema *)
  69 (*   ident ('/' ident)*                  |+ path +| *)
  70   uri_step ('/' uri_step)*            (* path *)
  71   ('.' ident)+                        (* ext *)
  72 (*  ("#xpointer(" number ('/' number)+ ")")?  (* xpointer *) *)
  73   ("(" number (',' number)* ")")?  (* reference spec *)
  74
  75 let regexp qstring = '"' [^ '"']* '"'
  76 let regexp xmarkup = '\005'
  77 let regexp ymarkup = '\006'
  78
  79 let regexp hreftag = xmarkup [ 'A' 'a' ]
  80 let regexp href = "href=\"" uri "\""
  81 let regexp hreftitle = "title=" qstring
  82 let regexp hrefclose = xmarkup "/" [ 'A' 'a' ] ymarkup
  83
  84 let regexp tag_cont = ident_letter | xml_digit | "_" | "-"
  85 let regexp gtagname = [ 'B' - 'Z' 'b' - 'z' ] | ident_letter tag_cont+
  86 let regexp attrname = ident_letter tag_cont*
  87 let regexp gopentag = xmarkup gtagname
  88 let regexp closetag = xmarkup "/" gtagname ymarkup
  89 let regexp attribute = attrname "=" qstring
  90 let regexp generictag =
  91   gopentag (utf8_blank+ attribute)* ymarkup
  92
  93 let regexp tex_token = '\\' ident
  94
  95 let regexp delim_begin = "\\["
  96 let regexp delim_end = "\\]"
  97
  98 let regexp qkeyword = "'" ( ident | pident ) "'"
  99
 100 let regexp implicit = '?'
 101 let regexp placeholder = '%'
 102 let regexp meta = implicit number
 103
 104 let regexp csymbol = '\'' ident
 105
 106 let regexp begin_group = "@{" | "${"
 107 let regexp end_group = '}'
 108 let regexp wildcard = "$_"
 109 let regexp ast_ident = "@" ident
 110 let regexp ast_csymbol = "@" csymbol
 111 let regexp meta_ident = "$" ident
 112 let regexp meta_anonymous = "$_"
 113
 114 let regexp begincomment = "(**" utf8_blank
 115 let regexp beginnote = "(*"
 116 let regexp endcomment = "*)"
 117 (* let regexp comment_char = [^'*'] | '*'[^')']
 118 let regexp note = "|+" ([^'*'] | "**") comment_char* "+|" *)
 119
 120 let level1_layouts =
 121   [ "sub"; "sup";
 122     "below"; "above";
 123     "over"; "atop"; "frac";
 124     "sqrt"; "root"; "mstyle" ; "mpadded"; "maction"
 125
 126   ]
 127
 128 let level1_keywords =
 129   [ "hbox"; "hvbox"; "hovbox"; "vbox";
 130     "break";
 131     "list0"; "list1"; "sep";
 132     "opt";
 133     "term"; "ident"; "number";
 134   ] @ level1_layouts
 135
 136 let level2_meta_keywords =
 137   [ "if"; "then"; "elCicNotationParser.se";
 138     "fold"; "left"; "right"; "rec";
 139     "fail";
 140     "default";
 141     "anonymous"; "ident"; "number"; "term"; "fresh"
 142   ]
 143
 144   (* (string, int) Hashtbl.t, with multiple bindings.
 145    * int is the unicode codepoint *)
 146 let ligatures = Hashtbl.create 23
 147
 148 let _ =
 149   List.iter
 150     (fun (ligature, symbol) -> Hashtbl.add ligatures ligature symbol)
 151     [ ("->", <:unicode<to>>);   ("=>", <:unicode<Rightarrow>>);
 152       (":=", <:unicode<def>>);
 153     ]
 154
 155 let regexp nreference =
 156   "cic:/"                             (* schema *)
 157   uri_step ('/' uri_step)*            (* path *)
 158   '.'
 159   ( "dec"
 160   | "def" "(" number ")"
 161   | "fix" "(" number "," number "," number ")"
 162   | "cfx" "(" number ")"
 163   | "ind" "(" number "," number "," number ")"
 164   | "con" "(" number "," number "," number ")") (* ext + reference *)
 165
 166 let error lexbuf msg =
 167   let begin_cnum, end_cnum = Ulexing.loc lexbuf in
 168   raise (Error (begin_cnum, end_cnum, msg))
 169 let error_at_end lexbuf msg =
 170   let begin_cnum, end_cnum = Ulexing.loc lexbuf in
 171   raise (Error (begin_cnum, end_cnum, msg))
 172
 173 let loc_of_buf lexbuf =
 174   HExtlib.floc_of_loc (Ulexing.loc lexbuf)
 175
 176 let return_with_loc token begin_cnum end_cnum =
 177   let flocation = HExtlib.floc_of_loc (begin_cnum,end_cnum) in
 178    token, flocation
 179
 180 let return lexbuf token =
 181   let begin_cnum, end_cnum = Ulexing.loc lexbuf in
 182     return_with_loc token begin_cnum end_cnum
 183
 184 let return_lexeme lexbuf name = return lexbuf (name, Ulexing.utf8_lexeme lexbuf)
 185
 186 let return_symbol lexbuf s = return lexbuf ("SYMBOL", s)
 187 let return_eoi lexbuf = return lexbuf ("EOI", "")
 188
 189 let remove_quotes s = String.sub s 1 (String.length s - 2)
 190
 191 let mk_lexer token =
 192   let tok_func stream =
 193 (*     let lexbuf = Ulexing.from_utf8_stream stream in *)
 194 (** XXX Obj.magic rationale.
 195  * The problem.
 196  *  camlp5 constraints the tok_func field of Token.glexer to have type:
 197  *    Stream.t char -> (Stream.t 'te * flocation_function)
 198  *  In order to use ulex we have (in theory) to instantiate a new lexbuf each
 199  *  time a char Stream.t is passed, destroying the previous lexbuf which may
 200  *  have consumed a character from the old stream which is lost forever :-(
 201  * The "solution".
 202  *  Instead of passing to camlp5 a char Stream.t we pass a lexbuf, casting it to
 203  *  char Stream.t with Obj.magic where needed.
 204  *)
 205     let lexbuf = Obj.magic stream in
 206     Token.make_stream_and_location
 207       (fun () ->
 208         try
 209           token lexbuf
 210         with
 211         | Ulexing.Error -> error_at_end lexbuf "Unexpected character"
 212         | Ulexing.InvalidCodepoint p ->
 213             error_at_end lexbuf (sprintf "Invalid code point: %d" p))
 214   in
 215   {
 216     Token.tok_func = tok_func;
 217     Token.tok_using = (fun _ -> ());
 218     Token.tok_removing = (fun _ -> ());
 219     Token.tok_match = Token.default_match;
 220     Token.tok_text = Token.lexer_text;
 221     Token.tok_comm = None;
 222   }
 223
 224 let expand_macro lexbuf =
 225   let macro =
 226     Ulexing.utf8_sub_lexeme lexbuf 1 (Ulexing.lexeme_length lexbuf - 1)
 227   in
 228   try
 229     ("SYMBOL", Utf8Macro.expand macro)
 230   with Utf8Macro.Macro_not_found _ ->
 231 (* FG: unexpanded TeX macros are terminated by a space for rendering *)
 232      "SYMBOL", (Ulexing.utf8_lexeme lexbuf ^ " ")
 233
 234 let remove_quotes s = String.sub s 1 (String.length s - 2)
 235 let remove_left_quote s = String.sub s 1 (String.length s - 1)
 236
 237 let rec level2_pattern_token_group counter buffer =
 238   lexer
 239   | end_group ->
 240       if (counter > 0) then
 241         Buffer.add_string buffer (Ulexing.utf8_lexeme lexbuf) ;
 242       snd (Ulexing.loc lexbuf)
 243   | begin_group ->
 244       Buffer.add_string buffer (Ulexing.utf8_lexeme lexbuf) ;
 245       ignore (level2_pattern_token_group (counter + 1) buffer lexbuf) ;
 246       level2_pattern_token_group counter buffer lexbuf
 247   | _ ->
 248       Buffer.add_string buffer (Ulexing.utf8_lexeme lexbuf) ;
 249       level2_pattern_token_group counter buffer lexbuf
 250
 251 let read_unparsed_group token_name lexbuf =
 252   let buffer = Buffer.create 16 in
 253   let begin_cnum, _ = Ulexing.loc lexbuf in
 254   let end_cnum = level2_pattern_token_group 0 buffer lexbuf in
 255     return_with_loc (token_name, Buffer.contents buffer) begin_cnum end_cnum
 256
 257 let handle_keywords lexbuf k name =
 258   let s = Ulexing.utf8_lexeme lexbuf in
 259   if k s then
 260             return lexbuf ("", s)
 261           else
 262             return lexbuf (name, s)
 263 ;;
 264
 265 let rec level2_meta_token =
 266   lexer
 267   | utf8_blank+ -> level2_meta_token lexbuf
 268   | hreftag -> return lexbuf ("ATAG","")
 269   | hrefclose -> return lexbuf ("ATAGEND","")
 270   | generictag
 271   | closetag -> level2_meta_token lexbuf
 272   | ident ->
 273       handle_keywords lexbuf (fun x -> List.mem x level2_meta_keywords) "IDENT"
 274   | variable_ident -> return lexbuf ("IDENT", Ulexing.utf8_lexeme lexbuf)
 275   | pident ->
 276       handle_keywords lexbuf (fun x -> List.mem x level2_meta_keywords) "PIDENT"
 277   | "@{" -> read_unparsed_group "UNPARSED_AST" lexbuf
 278   | ast_ident ->
 279       return lexbuf ("UNPARSED_AST",
 280         remove_left_quote (Ulexing.utf8_lexeme lexbuf))
 281   | ast_csymbol ->
 282       return lexbuf ("UNPARSED_AST",
 283         remove_left_quote (Ulexing.utf8_lexeme lexbuf))
 284   | eof -> return_eoi lexbuf
 285
 286 let rec comment_token acc depth =
 287   lexer
 288   | beginnote ->
 289       let acc = acc ^ Ulexing.utf8_lexeme lexbuf in
 290       comment_token acc (depth + 1) lexbuf
 291   | endcomment ->
 292       let acc = acc ^ Ulexing.utf8_lexeme lexbuf in
 293       if depth = 0
 294       then acc
 295       else comment_token acc (depth - 1) lexbuf
 296   | _ ->
 297       let acc = acc ^ Ulexing.utf8_lexeme lexbuf in
 298       comment_token acc depth lexbuf
 299
 300   (** @param k continuation to be invoked when no ligature has been found *)
 301 let ligatures_token k =
 302   lexer
 303   | ligature ->
 304       let lexeme = Ulexing.utf8_lexeme lexbuf in
 305       (match List.rev (Hashtbl.find_all ligatures lexeme) with
 306       | [] -> (* ligature not found, rollback and try default lexer *)
 307           Ulexing.rollback lexbuf;
 308           k lexbuf
 309       | default_lig :: _ -> (* ligatures found, use the default one *)
 310           return_symbol lexbuf default_lig)
 311   | eof -> return_eoi lexbuf
 312   | _ ->  (* not a ligature, rollback and try default lexer *)
 313       Ulexing.rollback lexbuf;
 314       k lexbuf
 315
 316 module LocalizeOD =
 317   struct
 318     type t = Stdpp.location
 319     let compare = Pervasives.compare
 320   end
 321
 322 module LocalizeEnv = Map.Make (LocalizeOD)
 323
 324 let so_pp = function
 325  | None -> "()"
 326  | Some s -> "*" ^ s
 327 ;;
 328
 329 let update_table loc desc href loctable =
 330   if desc <> None || href <> None
 331     then
 332      (let s,e = HExtlib.loc_of_floc loc in
 333
 334       prerr_endline (Printf.sprintf "*** [%d,%d] \"%s\",\"%s\""
 335         s e (so_pp href) (so_pp desc));
 336
 337       Printf.printf "*** [%d,%d] \"%s\",\"%s\""
 338         s e (so_pp href) (so_pp desc);
 339       LocalizeEnv.add loc (href,desc) loctable)
 340     else loctable
 341 ;;
 342
 343 let level2_ast_token loctable status =
 344   let rec aux desc href in_tag =
 345     lexer
 346     | let_rec -> return lexbuf ("LETREC","")
 347     | let_corec -> return lexbuf ("LETCOREC","")
 348     | we_proved -> return lexbuf ("WEPROVED","")
 349     | we_have -> return lexbuf ("WEHAVE","")
 350     | utf8_blank+ -> ligatures_token (aux desc href in_tag) lexbuf
 351     | meta ->
 352        let s = Ulexing.utf8_lexeme lexbuf in
 353         return lexbuf ("META", String.sub s 1 (String.length s - 1))
 354     | implicit -> return lexbuf ("IMPLICIT", "")
 355     | placeholder -> return lexbuf ("PLACEHOLDER", "")
 356     | hreftag -> aux_attr None None lexbuf
 357     | hrefclose -> return lexbuf ("LEXING_ERROR", Ulexing.utf8_lexeme lexbuf)
 358     (* ignore other tags *)
 359     | generictag
 360     | closetag -> ligatures_token (aux desc href in_tag) lexbuf
 361     | ident -> if in_tag then
 362                  aux_close_tag desc href ("IDENT", Ulexing.utf8_lexeme lexbuf) lexbuf
 363                else handle_keywords lexbuf (fun x -> StringSet.mem x status) "IDENT"
 364     | variable_ident ->
 365                return lexbuf ("IDENT", Ulexing.utf8_lexeme lexbuf)
 366     | pident -> if in_tag then
 367                  aux_close_tag desc href ("PIDENT", Ulexing.utf8_lexeme lexbuf) lexbuf
 368                 else handle_keywords lexbuf (fun x -> StringSet.mem x status) "PIDENT"
 369     | number -> let token = "NUMBER", Ulexing.utf8_lexeme lexbuf
 370                 in
 371                 if in_tag then
 372                   aux_close_tag desc href token lexbuf
 373                 else return lexbuf token
 374     | tex_token -> let token = expand_macro lexbuf
 375                    in
 376                    if in_tag then
 377                      aux_close_tag desc href token lexbuf
 378                    else return lexbuf token
 379     | nreference -> return lexbuf ("NREF", Ulexing.utf8_lexeme lexbuf)
 380     | uri -> return lexbuf ("URI", Ulexing.utf8_lexeme lexbuf)
 381     | qstring ->
 382         return lexbuf ("QSTRING", remove_quotes (Ulexing.utf8_lexeme lexbuf))
 383     | csymbol ->
 384         return lexbuf ("CSYMBOL", remove_left_quote (Ulexing.utf8_lexeme lexbuf))
 385     | "${" -> read_unparsed_group "UNPARSED_META" lexbuf
 386     | "@{" -> read_unparsed_group "UNPARSED_AST" lexbuf
 387     | '(' -> return lexbuf ("LPAREN", "")
 388     | ')' -> return lexbuf ("RPAREN", "")
 389     | meta_ident ->
 390         return lexbuf ("UNPARSED_META",
 391           remove_left_quote (Ulexing.utf8_lexeme lexbuf))
 392     | meta_anonymous -> return lexbuf ("UNPARSED_META", "anonymous")
 393     | beginnote ->
 394         let _comment = comment_token (Ulexing.utf8_lexeme lexbuf) 0 lexbuf in
 395   (*       let comment =
 396           Ulexing.utf8_sub_lexeme lexbuf 2 (Ulexing.lexeme_length lexbuf - 4)
 397         in
 398         return lexbuf ("NOTE", comment) *)
 399         ligatures_token (aux desc href in_tag) lexbuf
 400     | begincomment -> return lexbuf ("BEGINCOMMENT","")
 401     | endcomment -> return lexbuf ("ENDCOMMENT","")
 402     | eof -> return_eoi lexbuf
 403     | _ -> let token = "SYMBOL", (Ulexing.utf8_lexeme lexbuf)
 404            in
 405            if in_tag then
 406              aux_close_tag desc href token lexbuf
 407            else return lexbuf token
 408
 409    and aux_attr desc href = lexer
 410     | utf8_blank+ -> ligatures_token (aux_attr desc href) lexbuf
 411     | href ->
 412         aux_attr desc
 413           (Some (Ulexing.utf8_sub_lexeme lexbuf 6 (Ulexing.lexeme_length lexbuf - 7)))
 414           lexbuf
 415     | hreftitle ->
 416         aux_attr
 417           (Some (Ulexing.utf8_sub_lexeme lexbuf 7 (Ulexing.lexeme_length lexbuf - 8)))
 418           href lexbuf
 419     | ymarkup -> aux desc href true lexbuf
 420     | _ -> return lexbuf ("LEXING_ERROR", Ulexing.utf8_lexeme lexbuf)
 421
 422 (*  and aux_in_tag desc href = lexer
 423     | ident -> loctable :=
 424                  update_table (loc_of_buf lexbuf) desc href !loctable;
 425                handle_keywords lexbuf (fun x -> StringSet.mem x status) "IDENT"
 426     | variable_ident ->
 427                return lexbuf ("IDENT", Ulexing.utf8_lexeme lexbuf)
 428     | pident -> loctable :=
 429                   update_table (loc_of_buf lexbuf) desc href !loctable;
 430                 handle_keywords lexbuf (fun x -> StringSet.mem x status) "PIDENT"
 431     | number -> loctable :=
 432                   update_table (loc_of_buf lexbuf) desc href !loctable;
 433                 return lexbuf ("NUMBER", Ulexing.utf8_lexeme lexbuf)
 434     | tex_token -> loctable :=
 435                      update_table (loc_of_buf lexbuf) desc href !loctable;
 436                    return lexbuf (expand_macro lexbuf)
 437     | _ -> loctable :=
 438              update_table (loc_of_buf lexbuf) desc href !loctable;
 439            return_symbol lexbuf (Ulexing.utf8_lexeme lexbuf)
 440   *)
 441   and aux_close_tag desc href token = lexer
 442     | hrefclose -> loctable := update_table (loc_of_buf lexbuf) desc href !loctable;
 443                    return lexbuf token
 444     | _ -> return lexbuf ("LEXING_ERROR", Ulexing.utf8_lexeme lexbuf)
 445   in aux None None false
 446
 447 let rec level1_pattern_token =
 448   lexer
 449   | utf8_blank+ -> ligatures_token level1_pattern_token lexbuf
 450   | number -> return lexbuf ("NUMBER", Ulexing.utf8_lexeme lexbuf)
 451   | hreftag -> return lexbuf ("ATAG", "")
 452   | hrefclose -> return lexbuf ("ATAGEND","")
 453   | generictag
 454   | closetag -> ligatures_token level1_pattern_token lexbuf
 455   | ident -> handle_keywords lexbuf (fun x -> List.mem x level1_keywords) "IDENT"
 456   | variable_ident -> return lexbuf ("IDENT", Ulexing.utf8_lexeme lexbuf)
 457   | pident->handle_keywords lexbuf (fun x->List.mem x level1_keywords) "PIDENT"
 458   | color -> return lexbuf ("COLOR", Ulexing.utf8_lexeme lexbuf)
 459   | percentage ->
 460       return lexbuf ("PERCENTAGE", Ulexing.utf8_lexeme lexbuf)
 461   | floatwithunit ->
 462       return lexbuf ("FLOATWITHUNIT", Ulexing.utf8_lexeme lexbuf)
 463   | tex_token -> return lexbuf (expand_macro lexbuf)
 464   | qkeyword ->
 465       return lexbuf ("QKEYWORD", remove_quotes (Ulexing.utf8_lexeme lexbuf))
 466   | '(' -> return lexbuf ("LPAREN", "")
 467   | ')' -> return lexbuf ("RPAREN", "")
 468   | eof -> return_eoi lexbuf
 469   | _ -> return_symbol lexbuf (Ulexing.utf8_lexeme lexbuf)
 470
 471 let level1_pattern_token = ligatures_token level1_pattern_token
 472 let level2_ast_token loctable status =
 473   ligatures_token (level2_ast_token loctable status)
 474
 475 (* API implementation *)
 476 type lexers = {
 477         level1_pattern_lexer : (string * string) Token.glexer;
 478         level2_ast_lexer : (string * string) Token.glexer;
 479         level2_meta_lexer : (string * string) Token.glexer
 480 }
 481
 482 let mk_lexers loctable keywords =
 483   let initial_keywords =
 484    [ "CProp"; "Prop"; "Type"; "Set"; "let"; "match";
 485    "with"; "in"; "and"; "to"; "as"; "on"; "return"; "done" ]
 486   in
 487   let status =
 488     List.fold_right StringSet.add (initial_keywords @ keywords) StringSet.empty
 489   in
 490   {
 491         level1_pattern_lexer = mk_lexer level1_pattern_token;
 492         level2_ast_lexer = mk_lexer (level2_ast_token loctable status);
 493         level2_meta_lexer = mk_lexer level2_meta_token
 494   }
 495 ;;