package clangml
OCaml bindings for Clang API
Install
Dune Dependency
Authors
Maintainers
Sources
clangml.4.8.0.tar.gz
sha512=493f3693b445268a589c98315d918d0633bd2e76eba34067023d502b10957c1f6bbce3b0c1799c81e06eb3ec6f16158cbafb964228fdb3e303aa74cd57c125b1
doc/src/clangml_ppx/clangml_ppx.ml.html
Source file clangml_ppx.ml
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
[%%metapackage metapp] let placeholder_hashtbl_sz = 17 type antiquotation = { antiquotation_type : Ppx_lexer.antiquotation_type; placeholder : string; payload : Ppxlib.payload Location.loc; pos_begin : int; pos_end : int; } let extract_antiquotations s = let code_buffer = Buffer.create (String.length s) in let antiquotations_ref = ref [] in let antiquotation_count_ref = ref 0 in let lexbuf = Lexing.from_string s in let rec copy_to_result () = let start_pos = lexbuf.lex_curr_p.pos_cnum in let has_antiquotation = Ppx_lexer.main lexbuf in let read_code_length = lexbuf.lex_start_p.pos_cnum - start_pos in Buffer.add_substring code_buffer s start_pos read_code_length; match has_antiquotation with | None -> () | Some antiquotation_type -> let lbracket_count_ref = ref 0 in let pattern, (token_buf : Parser.token option) = match Lexer.token lexbuf with | QUESTION -> true, None | token -> false, Some token in let token_buf_ref = ref token_buf in let lexer lexbuf : Parser.token = let token = match !token_buf_ref with | None -> Lexer.token lexbuf | Some token_buf -> token_buf_ref := None; token_buf in match token with | LBRACKET | LBRACKETAT | LBRACKETATAT | LBRACKETATATAT | LBRACKETPERCENT | LBRACKETPERCENTPERCENT -> incr lbracket_count_ref; token | RBRACKET -> let lbracket_count = !lbracket_count_ref in if lbracket_count = 0 then EOF else begin lbracket_count_ref := lbracket_count - 1; token end | _ -> token in let loc_start = lexbuf.lex_curr_p in let payload : Ppxlib.payload = if pattern then begin let pattern = Ppxlib.Selected_ast.Of_ocaml.copy_pattern (Parser.parse_pattern lexer lexbuf) in PPat (pattern, None) end else begin let structure = Ppxlib.Selected_ast.Of_ocaml.copy_structure (Parser.implementation lexer lexbuf) in PStr structure end in let loc_end = lexbuf.lex_curr_p in let loc = { Location.loc_start; loc_end; loc_ghost = false } in let payload = { Location.loc; txt = payload } in let index = !antiquotation_count_ref in antiquotation_count_ref := succ index; let placeholder = Printf.sprintf "__antiquotation_%d" index in let placeholder_code = match antiquotation_type with | Typename -> placeholder | Decl -> Printf.sprintf "int %s;" placeholder | Expression antiquotation_type -> Printf.sprintf "(\"%s\", (%s) 0)" placeholder antiquotation_type in Buffer.add_char code_buffer ' '; let pos_begin = Buffer.length code_buffer in Buffer.add_string code_buffer placeholder_code; let pos_end = Buffer.length code_buffer in Buffer.add_char code_buffer ' '; antiquotations_ref := { antiquotation_type; placeholder; payload; pos_begin; pos_end } :: !antiquotations_ref; copy_to_result () in copy_to_result (); Buffer.contents code_buffer, List.rev !antiquotations_ref type kind = | Expr | Qual_type | Decl | Stmt | Translation_unit let kind_of_string s = match s with | "expr" | "e" -> Expr | "qual_type" | "type" | "t" -> Qual_type | "decl" | "d" -> Decl | "stmt" | "s" -> Stmt | "translation_unit" | "tu" -> Translation_unit | _ -> invalid_arg "kind_of_string" module String_hashtbl = Hashtbl.Make (struct type t = string let equal = ( = ) let hash = Hashtbl.hash end) type arguments = { preamble : string list; standard : Clang.clang_ext_langstandards option; return_type : string option; } let empty_arguments = { preamble = []; standard = None; return_type = None; } let find_and_remove table ident = let result = String_hashtbl.find_opt table ident in if result <> None then String_hashtbl.remove table ident; result let is_empty table = String_hashtbl.length table = 0 type extension = | Quotation of { language : Clang.language; payload : Ppxlib.payload; loc : Location.t; } | If_standard of { name : string; expr : Ppxlib.expression; loc : Location.t; } let begin_ppx_code = "__begin_ppx_code" let end_ppx_code = "__end_ppx_code" let rec extract_items_aux (accu : Clang.Decl.t list) (items : Clang.Decl.t list) : Clang.Decl.t list = match items with | [] -> assert false | { desc = Function { name = IdentifierName name; _ }; _ } :: tl when name = end_ppx_code -> List.rev accu | hd :: tl -> extract_items_aux (hd :: accu) tl let rec extract_items (items : Clang.Decl.t list) : Clang.Decl.t list = match items with | [] -> assert false | { desc = Function { name = IdentifierName name; _ }; _ } :: tl when name = begin_ppx_code -> extract_items_aux [] tl | _ :: tl -> extract_items tl type mapper = { expression : Ppxlib.expression -> Ppxlib.expression; pattern : Ppxlib.pattern -> Ppxlib.pattern; payload : Ppxlib.payload -> Ppxlib.payload; } module type TargetS = sig include Metapp.ValueS val get_mapper : mapper -> t -> t end module Make (Target : TargetS) = struct module Lift = Refl.Lift.Make (Target) let extract_payload language (mapper : mapper) ~loc (payload : Ppxlib.payload) = let kind, arguments, code = match match payload with | PStr [%str - [%e? { pexp_desc = Pexp_apply ( { pexp_desc = Pexp_ident { txt = Lident kind; loc = kind_loc }; _}, args); _ }]] -> let kind = try kind_of_string kind with Invalid_argument _ -> Location.raise_errorf ~loc:kind_loc "unknown kind" in let code, rev_args = match List.rev args with | [] -> Location.raise_errorf ~loc "Code expected" | (_, code) :: rev_args -> Metapp.string_of_arbitrary_expression code, rev_args in let handle_arg arguments (_, (arg : Ppxlib.expression)) = let loc = arg.pexp_loc in match arg with | [%expr return [%e? arg ]] -> if arguments.return_type <> None then Location.raise_errorf ~loc "Return type already given"; { arguments with return_type = Some (Metapp.string_of_arbitrary_expression arg) } | [%expr standard [%e? arg ]] -> if arguments.standard <> None then Location.raise_errorf ~loc "Standard already given"; let arg = arg |> Metapp.string_of_arbitrary_expression in let standard = match Refl.of_string_opt [%refl: Clang.Standard.t] arg with | None -> arg |> Clang.ext_lang_standard_of_name | Some standard -> Clang.Standard.to_clang standard in if standard = InvalidLang then Location.raise_errorf ~loc "Unknown standard: %s" arg; { arguments with standard = Some standard } | _ -> let arg = Metapp.string_of_arbitrary_expression arg in { arguments with preamble = arg :: arguments.preamble } in let arguments = List.fold_left handle_arg empty_arguments rev_args in Some (kind, arguments, code) | _ -> None with | Some (kind, arguments, code) -> kind, arguments, code | None -> Location.raise_errorf ~loc "ClangML quotations have to be of the form [%%c-kind {| code |}]" in let code, antiquotations = extract_antiquotations code in let buffer = Buffer.create (String.length code) in antiquotations |> List.iter ( fun { antiquotation_type; placeholder; _ } -> match antiquotation_type with | Typename -> Buffer.add_string buffer (Printf.sprintf "typedef void *%s;" placeholder); | Decl | Expression _ -> ()); let return_type = match arguments.return_type with | None -> "void" | Some return_type -> return_type in let function_declaration = Printf.sprintf "%s f(void) {" return_type in let placeholder_hashtbl = String_hashtbl.create placeholder_hashtbl_sz in let hook : type a . a Lift.hook_fun = fun refl lifter x -> match match refl, x with | Clang.Ast.Refl_expr, { desc = BinaryOperator { lhs = { desc = StringLiteral { bytes } }; kind = Comma; rhs = { desc = Cast { operand = { desc = IntegerLiteral (Int 0); _ }; _ }; _ }}; _} -> find_and_remove placeholder_hashtbl bytes | Clang.Ast.Refl_decl, ( { desc = Var { var_name = ident; var_type = { desc = BuiltinType Int }}} | { desc = Field { name = ident; qual_type = { desc = BuiltinType Int }}}) -> find_and_remove placeholder_hashtbl ident | Clang.Ast.Refl_qual_type, _ (* { desc = Typedef { name = IdentifierName ident }} *) -> (* Circumvent OCaml <4.06.1 bug: #7661, #1459 *) begin match x with | { desc = Typedef { name = IdentifierName ident }} -> find_and_remove placeholder_hashtbl ident | _ -> None end | _ -> None with | Some loc_payload -> Metapp.with_loc Target.of_payload loc_payload | None -> match refl with | Clang.Ast.Refl_opaque_type_loc -> Target.choice (fun () -> [%expr None]) (fun () -> [%pat? _]) | Clang.Ast.Refl_opaque_cxtype -> Target.choice (fun () -> [%expr get_cursor_type (get_null_cursor ())]) (fun () -> [%pat? _]) | Clang.Ast.Refl_opaque_decoration -> Target.choice (fun () -> [%expr Custom { location = None; qual_type = None }]) (fun () -> [%pat? _]) | _ -> lifter x in let hook = { Lift.hook } in let prelude, postlude, (extraction : Clang.Ast.translation_unit -> Target.t) = match kind with | Expr -> function_declaration, ";}", begin fun ast -> match List.rev ast.desc.items with | { desc = Function { body = Some { desc = Compound stmts; _}; _}; _} :: _ -> begin match List.rev stmts with | { desc = Expr item; _ } :: _ -> Lift.lift ~hook [%refl: Clang.Ast.expr] [] item | _ -> assert false end | _ -> assert false end | Stmt -> function_declaration, "}", begin fun ast -> match List.rev ast.desc.items with | { desc = Function { body = Some { desc = Compound [item]; _}; _}; _} :: _ -> Lift.lift ~hook [%refl: Clang.Ast.stmt] [] item | _ -> assert false end | Qual_type -> "void f(void) { void *x; (", ") x; }", begin fun ast -> match List.rev ast.desc.items with | { desc = Function { body = Some { desc = Compound [_; { desc = Expr { desc = Cast { qual_type; _ }; _}; _}]; _}; _}; _} :: _ -> Lift.lift ~hook [%refl: Clang.Ast.qual_type] [] qual_type | _ -> assert false end | Decl -> "", "", begin fun ast -> Lift.lift ~hook [%refl: Clang.Ast.decl] [] begin match ast.desc.items with | result :: _ -> result | _ -> assert false end end | Translation_unit -> "", "", begin fun ast -> Lift.lift ~hook [%refl: Clang.Ast.translation_unit] [] ast end in arguments.preamble |> List.iter (fun s -> Buffer.add_string buffer s; Buffer.add_char buffer ';'); Buffer.add_string buffer (Printf.sprintf "void %s();" begin_ppx_code); Buffer.add_string buffer prelude; Buffer.add_string buffer code; Buffer.add_string buffer postlude; Buffer.add_string buffer (Printf.sprintf "void %s();" end_ppx_code); let code = Buffer.contents buffer in let command_line_args = [Clang.Command_line.language language] in let command_line_args = match arguments.standard with | None -> command_line_args | Some standard -> Clang.Command_line.standard_of_clang standard :: command_line_args in let command_line_args = List.map Clang.Command_line.include_directory (Clang.default_include_directories ()) @ command_line_args in let ast = Clang.Ast.parse_string ~command_line_args code in let ast = { ast with desc = { ast.desc with items = extract_items ast.desc.items }} in Clang.Ast.format_diagnostics Clang.error Format.err_formatter ast ~pp:begin fun pp fmt () -> Format.fprintf fmt "@[%a@]@[Compiling quotation code:@ %s@]@ %a@." Location.print_loc loc code pp () end; if Clang.Ast.has_severity Clang.error ast then Location.raise_errorf ~loc "clang error while compiling quotation code"; antiquotations |> List.iter begin fun antiquotation -> String_hashtbl.add placeholder_hashtbl antiquotation.placeholder { antiquotation.payload with txt = mapper.payload antiquotation.payload.txt } end; let result = extraction ast in if not (is_empty placeholder_hashtbl) then Format.eprintf "Warning:@ in@ \"%s\",@ the@ following@ placeholder@ remains:@ %s" code (String.concat ", " (placeholder_hashtbl |> String_hashtbl.to_seq |> Seq.map fst |> List.of_seq)); result let mapper (mapper : mapper) (t : Target.t) = match Option.bind (Target.destruct_extension t) (fun e -> match e with | (({ loc; txt = "if" }, payload), _) -> begin match payload with | PStr [%str standard [%e? name] available [%e? expr]] -> Some (If_standard { name = Metapp.string_of_arbitrary_expression name; expr; loc }) | _ -> None end | (({ loc; txt }, payload), _) -> begin match Clang.language_of_string txt with | exception (Invalid_argument _) -> None | language -> Some (Quotation { language; loc; payload }) end) with | None -> Target.get_mapper mapper t | Some (Quotation { language; loc; payload }) -> extract_payload language mapper ~loc payload | Some (If_standard { name; expr; loc }) -> if name |> Clang.ext_lang_standard_of_name = InvalidLang then Target.of_unit () else let t = Target.choice (fun () -> expr) (fun () -> failwith "\"if standard\" not available in patterns") in Target.get_mapper mapper t end module MapperExp = Make (struct include Metapp.Exp let get_mapper mapper = mapper.expression end) module MapperPat = Make (struct include Metapp.Pat let get_mapper mapper = mapper.pattern end) let ppx_pattern_mapper = object (self) inherit Ppxlib.Ast_traverse.map as super method! expression = MapperExp.mapper { expression = super#expression; pattern = super#pattern; payload = super#payload } method! pattern = MapperPat.mapper { expression = super#expression; pattern = super#pattern; payload = super#payload } end let () = Ppxlib.Driver.register_transformation "clangml.ppx" ~preprocess_impl:ppx_pattern_mapper#structure
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>