package js_of_ocaml-compiler
Compiler from OCaml bytecode to JavaScript
Install
Dune Dependency
Authors
Maintainers
Sources
js_of_ocaml-5.9.0.tbz
sha256=daf2c7811df906fe4a8e59cd6973ccf0bdbe4a7d0e1f1fd17c9584bd0b438594
sha512=67d8f647e453f3855aff556afee0ce4524a7833852343f90271ee7c540e40c3dead0fc728acb667fcf7df69068a7c9521db809d2d0dfa5a1a0b31d0f1b60d566
doc/src/js_of_ocaml-compiler/linker.ml.html
Source file linker.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 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
(* Js_of_ocaml compiler * http://www.ocsigen.org/js_of_ocaml/ * Copyright (C) 2010 Jérôme Vouillon * Laboratoire PPS - CNRS Université Paris Diderot * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation, with linking exception; * either version 2.1 of the License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *) open! Stdlib type 'a pack = | Ok of 'a | Pack of string let unpack = function | Ok x -> x | Pack x -> Marshal.from_string x 0 let pack = function | Pack _ as x -> x | Ok x -> Pack (Marshal.to_string x []) let to_stringset utf8_string_set = Javascript.IdentSet.fold (fun x acc -> match x with | S { name = Utf8 x; _ } -> StringSet.add x acc | V _ -> acc) utf8_string_set StringSet.empty let loc pi = match pi with | { Parse_info.src = Some src; line; _ } | { Parse_info.name = Some src; line; _ } -> Printf.sprintf "%s:%d" src line | _ -> "unknown location" let error s = Format.ksprintf (fun s -> failwith s) s module Arity : sig val find : Javascript.program -> name:string -> int option end = struct let rec find p ~name = match p with | [] -> None | ( Javascript.Function_declaration (Javascript.S { Javascript.name = Utf8 n; _ }, (_, { list; rest = None }, _, _)) , _ ) :: _ when String.equal name n -> Some (List.length list) | _ :: rem -> find rem ~name end module Named_value : sig val find_all : Javascript.program -> StringSet.t end = struct class traverse_and_find_named_values all = object inherit Js_traverse.iter as self method expression x = let open Javascript in (match x with | ECall (EVar (S { name = Utf8 "caml_named_value"; _ }), _, [ Arg (EStr (Utf8 v)) ], _) -> all := StringSet.add v !all | _ -> ()); self#expression x end let find_all code = let all = ref StringSet.empty in let p = new traverse_and_find_named_values all in p#program code; !all end module Check = struct class check_and_warn name pi = object inherit Js_traverse.free as super method merge_info from = let def = from#get_def in let use = from#get_use in let diff = Javascript.IdentSet.diff def use in let diff = Javascript.IdentSet.fold (fun x acc -> match x with | S { name = Utf8_string.Utf8 s; _ } -> if String.is_prefix s ~prefix:"_" || String.equal s name then acc else s :: acc | V _ -> acc) diff [] in (match diff with | [] -> () | l -> warn "WARN unused for primitive %s at %s:@. %s@." name (loc pi) (String.concat ~sep:", " l)); super#merge_info from end let primitive ~name pi ~code ~requires ~has_flags = let free = if Config.Flag.warn_unused () then new check_and_warn name pi else new Js_traverse.free in let _code = free#program code in let freename = to_stringset free#get_free in let freename = List.fold_left requires ~init:freename ~f:(fun freename x -> StringSet.remove x freename) in let freename = StringSet.diff freename Reserved.keyword in let freename = StringSet.diff freename Reserved.provided in let freename = StringSet.remove Global_constant.global_object freename in let freename = if has_flags then StringSet.remove "FLAG" freename else freename in if StringSet.mem Global_constant.old_global_object freename then warn "warning: %s: 'joo_global_object' is being deprecated, please use `globalThis` \ instead@." (loc pi); let freename = StringSet.remove Global_constant.old_global_object freename in let defname = to_stringset free#get_def in if not (StringSet.mem name defname) then warn "warning: primitive code does not define value with the expected name: %s (%s)@." name (loc pi); if not (StringSet.is_empty freename) then ( warn "warning: free variables in primitive code %S (%s)@." name (loc pi); warn "vars: %s@." (String.concat ~sep:", " (StringSet.elements freename))) end module Fragment = struct type provides = { parse_info : Parse_info.t ; name : string ; kind : Primitive.kind ; kind_arg : Primitive.kind_arg list option ; arity : int option ; named_values : StringSet.t } type fragment_ = { provides : provides option ; requires : string list ; has_macro : bool ; version_constraint_ok : bool ; weakdef : bool ; always : bool ; code : Javascript.program pack ; conditions : bool StringMap.t ; fragment_target : Target_env.t option ; aliases : StringSet.t } let allowed_flags = List.fold_left ~f:(fun m (k, v) -> StringMap.add k v m) ~init:StringMap.empty [ "js-string", Config.Flag.use_js_string ; "effects", Config.Flag.effects ; ( "wasm" , fun () -> match Config.target () with | `JavaScript -> false | `Wasm -> true ) ] type t = | Always_include of Javascript.program pack | Fragment of fragment_ let provides = function | Always_include _ -> [] | Fragment { provides = Some p; _ } -> [ p.name ] | Fragment _ -> [] let analyze (t : t) : t = match t with | Always_include _ -> t | Fragment { provides = None; _ } -> t | Fragment ({ provides = Some ({ parse_info = pi ; name ; kind = _ ; kind_arg = _ ; arity = _ ; named_values = _ } as provides) ; _ } as fragment) -> let code, has_flags = Macro.f ~flags:false (unpack fragment.code) in let named_values = Named_value.find_all code in let arity = Arity.find code ~name in Check.primitive ~has_flags ~name pi ~code ~requires:fragment.requires; let provides = Some { provides with named_values; arity } in Fragment { fragment with code = Ok code; provides; has_macro = has_flags } let version_match = List.for_all ~f:(fun (op, str) -> op Ocaml_version.(compare current (split str)) 0) let parse_from_lex ~filename lex = let program, _ = try Parse_js.parse' lex with Parse_js.Parsing_error pi -> let name = match pi with | { Parse_info.src = Some x; _ } | { Parse_info.name = Some x; _ } -> x | _ -> "??" in error "cannot parse file %S (orig:%S from l:%d, c:%d)@." filename name pi.Parse_info.line pi.Parse_info.col in let res = List.map program ~f:(fun (annot, code) -> match annot with | [] -> Always_include (Ok code) | annot -> let initial_fragment : fragment_ = { provides = None ; requires = [] ; version_constraint_ok = true ; weakdef = false ; always = false ; has_macro = false ; code = Ok code ; conditions = StringMap.empty ; fragment_target = None ; aliases = StringSet.empty } in let fragment = List.fold_left annot ~init:initial_fragment ~f:(fun (fragment : fragment_) ((_, a), pi) -> match a with | `Provides (name, kind, ka) -> { fragment with provides = Some { parse_info = pi ; name ; kind ; kind_arg = ka ; arity = None ; named_values = StringSet.empty } } | `Requires mn -> { fragment with requires = mn @ fragment.requires } | `Version l -> { fragment with version_constraint_ok = fragment.version_constraint_ok && version_match l } | `Weakdef -> { fragment with weakdef = true } | `Always -> { fragment with always = true } | `Alias name -> { fragment with aliases = StringSet.add name fragment.aliases } | `If name when Option.is_some (Target_env.of_string name) -> if Option.is_some fragment.fragment_target then Format.eprintf "Duplicated target_env in %s\n" (loc pi); { fragment with fragment_target = Target_env.of_string name } | (`Ifnot v | `If v) when not (StringMap.mem v allowed_flags) -> Format.eprintf "Unkown flag %S in %s\n" v (loc pi); fragment | (`Ifnot v | `If v) as i -> if StringMap.mem v fragment.conditions then Format.eprintf "Duplicated %s in %s\n" v (loc pi); let b = match i with | `If _ -> true | `Ifnot _ -> false in { fragment with conditions = StringMap.add v b fragment.conditions }) in Fragment fragment) in List.map ~f:analyze res let parse_builtin builtin = let filename = Builtins.File.name builtin in let content = Builtins.File.content builtin in match Builtins.File.fragments builtin with | None -> let lex = Parse_js.Lexer.of_string ~filename content in parse_from_lex ~filename lex | Some fragments -> Marshal.from_string fragments 0 let parse_string string = let filename = "<string>" in let lex = Parse_js.Lexer.of_string ~filename string in parse_from_lex ~filename lex let parse_file f = let file = match Findlib.find [] f with | Some file -> Fs.absolute_path file | None -> error "cannot find file '%s'. @." f in let lex = Parse_js.Lexer.of_file file in parse_from_lex ~filename:file lex let pack = function | Always_include x -> Always_include (pack x) | Fragment f -> Fragment { f with code = pack f.code } end (* exception May_not_return let all_return p = let open Javascript in let rec loop_st = function | [] -> raise May_not_return | [Return_statement (Some _), _] -> () | [Return_statement None, _] -> raise May_not_return | [If_statement(_,th,el), _] -> loop_st [th]; (match el with | None -> raise May_not_return | Some x -> loop_st [x]) | [Do_while_statement(st,_), _] -> loop_st [st] | [While_statement(_,st), _] -> loop_st [st] | [For_statement (_,_,_,st), _] -> loop_st [st] | [Switch_statement (_,l,def), _] -> List.iter (fun (_,sts) -> loop_st sts) l | [Try_statement(b,_,_),_] -> loop_st b | [Throw_statement _, _] -> () | x::xs -> loop_st xs in let rec loop_sources = function | [] -> raise May_not_return | [(Statement x, loc)] -> loop_st [(x, loc)] | [_] -> raise May_not_return | x::xs -> loop_sources xs in let rec loop_all_sources = function | [] -> () | Statement x :: xs -> loop_all_sources xs | Function_declaration(_,_,b,_) :: xs -> loop_sources b; loop_all_sources xs in try loop_all_sources p; true with May_not_return -> false *) type always_required' = { ar_filename : string ; ar_program : Javascript.program pack ; ar_requires : string list } type always_required = { filename : string ; program : Javascript.program ; requires : string list } type state = { ids : IntSet.t ; always_required_codes : always_required list ; codes : (Javascript.program pack * bool) list ; missing : StringSet.t ; include_ : string -> bool } type output = { runtime_code : Javascript.program ; always_required_codes : always_required list } type provided = { id : int ; pi : Parse_info.t ; filename : string ; weakdef : bool ; target_env : Target_env.t } let always_included = ref [] let provided = Hashtbl.create 31 let provided_rev = Hashtbl.create 31 let code_pieces = Hashtbl.create 31 let reset () = always_included := []; Hashtbl.clear provided; Hashtbl.clear provided_rev; Hashtbl.clear code_pieces; Primitive.reset (); Generate.init () let list_all ?from () = let include_ = match from with | None -> fun _ _ -> true | Some l -> fun fn _nm -> List.mem fn ~set:l in Hashtbl.fold (fun nm p set -> if include_ p.filename nm then StringSet.add nm set else set) provided StringSet.empty let load_fragment ~target_env ~filename (f : Fragment.t) = match f with | Always_include code -> always_included := { ar_filename = filename; ar_program = code; ar_requires = [] } :: !always_included; `Ok | Fragment { provides ; requires ; version_constraint_ok ; weakdef ; always ; code ; fragment_target ; aliases ; has_macro ; conditions } -> ( let should_ignore = StringMap.exists (fun flag b -> not (Bool.equal b (StringMap.find flag Fragment.allowed_flags ()))) conditions in if (not version_constraint_ok) || should_ignore then `Ignored else match provides with | None -> if not (StringSet.is_empty aliases) then error "Found JavaScript code with neither `//Alias` and not `//Provides` in \ file %S@." filename; if always then ( always_included := { ar_filename = filename; ar_program = code; ar_requires = requires } :: !always_included; `Ok) else error "Found JavaScript code with neither `//Provides` nor `//Always` in file \ %S@." filename | Some { parse_info = pi; name; kind; kind_arg = ka; arity; named_values } -> let fragment_target = Option.value ~default:Target_env.Isomorphic fragment_target in let exists = try `Exists (Hashtbl.find provided name) with Not_found -> `New in let is_updating = match exists, (target_env : Target_env.t), (fragment_target : Target_env.t) with (* permit default, un-annotated symbols *) | `New, _, Isomorphic -> true (* permit env specializations *) | `New, Nodejs, Nodejs | `New, Browser, Browser | `Exists { target_env = Isomorphic; _ }, Nodejs, Nodejs | `Exists { target_env = Isomorphic; _ }, Browser, Browser -> true (* ignore non target matched envs *) | (`Exists _ | `New), Isomorphic, (Browser | Nodejs) | (`Exists _ | `New), Browser, Nodejs | (`Exists _ | `New), Nodejs, Browser -> false (* Ignore env unspecializations *) | `Exists { target_env = Nodejs; _ }, Nodejs, Isomorphic | `Exists { target_env = Browser; _ }, Browser, Isomorphic -> false (* The following are impossible *) | `Exists { target_env = Nodejs; _ }, Browser, _ | `Exists { target_env = Browser; _ }, Nodejs, _ | `Exists { target_env = Nodejs | Browser; _ }, Isomorphic, _ -> assert false (* collision detected *) | `Exists ({ target_env = Nodejs; _ } as p), Nodejs, Nodejs | `Exists ({ target_env = Isomorphic; _ } as p), Nodejs, Isomorphic | `Exists ({ target_env = Browser; _ } as p), Browser, Browser | `Exists ({ target_env = Isomorphic; _ } as p), Browser, Isomorphic | `Exists ({ target_env = Isomorphic; _ } as p), Isomorphic, Isomorphic -> if p.weakdef then true else ( warn "warning: overriding primitive %S\n old: %s\n new: %s@." name (loc p.pi) (loc pi); true) in if not is_updating then `Ignored else let () = () in let id = Hashtbl.length provided in Primitive.register name kind ka arity; StringSet.iter Primitive.register_named_value named_values; Hashtbl.add provided name { id; pi; filename; weakdef; target_env = fragment_target }; Hashtbl.add provided_rev id (name, pi); Hashtbl.add code_pieces id (code, has_macro, requires); StringSet.iter (fun alias -> Primitive.alias alias name) aliases; `Ok) let check_deps () = let provided = list_all () in Hashtbl.iter (fun id (code, _has_macro, requires) -> match code with | Ok code -> ( let traverse = new Js_traverse.free in let _js = traverse#program code in let free = to_stringset traverse#get_free in let requires = List.fold_right requires ~init:StringSet.empty ~f:StringSet.add in let real = StringSet.inter free provided in let missing = StringSet.diff real requires in if not (StringSet.is_empty missing) then try let name, ploc = Hashtbl.find provided_rev id in warn "code providing %s (%s) may miss dependencies: %s\n" name (loc ploc) (String.concat ~sep:", " (StringSet.elements missing)) with Not_found -> (* there is no //Provides for this piece of code *) (* FIXME handle missing deps in this case *) ()) | Pack _ -> (* We only have [Pack] for the builtin runtime, which has been checked already (before it was embedded *) ()) code_pieces let load_file ~target_env filename = List.iter (Fragment.parse_file filename) ~f:(fun frag -> let (`Ok | `Ignored) = load_fragment ~target_env ~filename frag in ()) let load_fragments ~target_env ~filename l = List.iter l ~f:(fun frag -> let (`Ok | `Ignored) = load_fragment ~target_env ~filename frag in ()); check_deps () let load_files ~target_env l = List.iter l ~f:(fun filename -> load_file ~target_env filename); check_deps () (* resolve *) let rec resolve_dep_name_rev state path nm = match Hashtbl.find provided nm with | x -> if state.include_ x.filename then resolve_dep_id_rev state path x.id else { state with missing = StringSet.add nm state.missing } | exception Not_found -> { state with missing = StringSet.add nm state.missing } and resolve_dep_id_rev state path id = if IntSet.mem id state.ids then ( if List.memq id ~set:path then error "circular dependency: %s" (String.concat ~sep:", " (List.map path ~f:(fun id -> fst (Hashtbl.find provided_rev id)))); state) else let path = id :: path in let code, has_macro, req = Hashtbl.find code_pieces id in let state = { state with ids = IntSet.add id state.ids } in let state = List.fold_left req ~init:state ~f:(fun state nm -> resolve_dep_name_rev state path nm) in let state = { state with codes = (code, has_macro) :: state.codes } in state let proj_always_required { ar_filename; ar_requires; ar_program } = { filename = ar_filename; requires = ar_requires; program = unpack ar_program } let init ?from () = let include_ = match from with | None -> fun _ -> true | Some l -> fun fn -> List.mem fn ~set:l in { ids = IntSet.empty ; always_required_codes = List.rev (List.filter_map !always_included ~f:(fun x -> if include_ x.ar_filename then Some (proj_always_required x) else None)) ; codes = [] ; include_ ; missing = StringSet.empty } let do_check_missing state = if not (StringSet.is_empty state.missing) then error "missing dependency '%s'@." (StringSet.choose state.missing) let resolve_deps ?(check_missing = true) state used = (* link the special files *) let missing, state = StringSet.fold (fun nm (missing, visited) -> if Hashtbl.mem provided nm then missing, resolve_dep_name_rev visited [] nm else StringSet.add nm missing, visited) used (StringSet.empty, state) in if check_missing then do_check_missing state; state, missing let link ?(check_missing = true) program (state : state) = let always, always_required = List.partition ~f:(function | { requires = []; _ } -> false | _ -> true) state.always_required_codes in let state = List.fold_left always ~init:state ~f:(fun (state : state) always -> let state = List.fold_left always.requires ~init:state ~f:(fun state nm -> resolve_dep_name_rev state [] nm) in { state with codes = (Ok always.program, false) :: state.codes }) in if check_missing then do_check_missing state; let codes = List.map state.codes ~f:(fun (x, has_macro) -> let c = unpack x in if has_macro then let c, _ = Macro.f ~flags:true c in c else c) in let runtime = List.flatten (List.rev (program :: codes)) in { runtime_code = runtime; always_required_codes = always_required } let all state = IntSet.fold (fun id acc -> try let name, _ = Hashtbl.find provided_rev id in name :: acc with Not_found -> acc) state.ids [] let missing state = StringSet.elements state.missing let origin ~name = try let x = Hashtbl.find provided name in x.pi.Parse_info.src with Not_found -> None
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>