package ocamlformat-lib
OCaml Code Formatter
Install
Dune Dependency
Authors
Maintainers
Sources
ocamlformat-0.26.2.tbz
sha256=2e4f596bf7aa367a844fe83ba0f6b0bf14b2a65179ddc082363fe9793d0375c5
sha512=b03d57462e65b11aa9f78dd5c4548251e8d1c5a1c9662f7502bdb10472aeb9df33c1d407350767a5223fbff9c01d53de85bafacd0274b49abc4b43701b159bee
doc/src/ocamlformat-lib.ocaml_common/warnings.ml.html
Source file warnings.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 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035
(**************************************************************************) (* *) (* OCaml *) (* *) (* Pierre Weis && Damien Doligez, INRIA Rocquencourt *) (* *) (* Copyright 1998 Institut National de Recherche en Informatique et *) (* en Automatique. *) (* *) (* All rights reserved. This file is distributed under the terms of *) (* the GNU Lesser General Public License version 2.1, with the *) (* special exception on linking described in the file LICENSE. *) (* *) (**************************************************************************) (* When you change this, you need to update: - the list 'description' at the bottom of this file - man/ocamlc.m *) type loc = { loc_start: Lexing.position; loc_end: Lexing.position; loc_ghost: bool; } type field_usage_warning = | Unused | Not_read | Not_mutated type constructor_usage_warning = | Unused | Not_constructed | Only_exported_private type t = | Comment_start (* 1 *) | Comment_not_end (* 2 *) (*| Deprecated --> alert "deprecated" *) (* 3 *) | Fragile_match of string (* 4 *) | Ignored_partial_application (* 5 *) | Labels_omitted of string list (* 6 *) | Method_override of string list (* 7 *) | Partial_match of string (* 8 *) | Missing_record_field_pattern of string (* 9 *) | Non_unit_statement (* 10 *) | Redundant_case (* 11 *) | Redundant_subpat (* 12 *) | Instance_variable_override of string list (* 13 *) | Illegal_backslash (* 14 *) | Implicit_public_methods of string list (* 15 *) | Unerasable_optional_argument (* 16 *) | Undeclared_virtual_method of string (* 17 *) | Not_principal of string (* 18 *) | Non_principal_labels of string (* 19 *) | Ignored_extra_argument (* 20 *) | Nonreturning_statement (* 21 *) | Preprocessor of string (* 22 *) | Useless_record_with (* 23 *) | Bad_module_name of string (* 24 *) | All_clauses_guarded (* 8, used to be 25 *) | Unused_var of string (* 26 *) | Unused_var_strict of string (* 27 *) | Wildcard_arg_to_constant_constr (* 28 *) | Eol_in_string (* 29 *) | Duplicate_definitions of string * string * string * string (*30 *) | Module_linked_twice of string * string * string (* 31 *) | Unused_value_declaration of string (* 32 *) | Unused_open of string (* 33 *) | Unused_type_declaration of string (* 34 *) | Unused_for_index of string (* 35 *) | Unused_ancestor of string (* 36 *) | Unused_constructor of string * constructor_usage_warning (* 37 *) | Unused_extension of string * bool * constructor_usage_warning (* 38 *) | Unused_rec_flag (* 39 *) | Name_out_of_scope of string * string list * bool (* 40 *) | Ambiguous_name of string list * string list * bool * string (* 41 *) | Disambiguated_name of string (* 42 *) | Nonoptional_label of string (* 43 *) | Open_shadow_identifier of string * string (* 44 *) | Open_shadow_label_constructor of string * string (* 45 *) | Bad_env_variable of string * string (* 46 *) | Attribute_payload of string * string (* 47 *) | Eliminated_optional_arguments of string list (* 48 *) | No_cmi_file of string * string option (* 49 *) | Unexpected_docstring of bool (* 50 *) | Wrong_tailcall_expectation of bool (* 51 *) | Fragile_literal_pattern (* 52 *) | Misplaced_attribute of string (* 53 *) | Duplicated_attribute of string (* 54 *) | Inlining_impossible of string (* 55 *) | Unreachable_case (* 56 *) | Ambiguous_var_in_pattern_guard of string list (* 57 *) | No_cmx_file of string (* 58 *) | Flambda_assignment_to_non_mutable_value (* 59 *) | Unused_module of string (* 60 *) | Unboxable_type_in_prim_decl of string (* 61 *) | Constraint_on_gadt (* 62 *) | Erroneous_printed_signature of string (* 63 *) | Unsafe_array_syntax_without_parsing (* 64 *) | Redefining_unit of string (* 65 *) | Unused_open_bang of string (* 66 *) | Unused_functor_parameter of string (* 67 *) | Match_on_mutable_state_prevent_uncurry (* 68 *) | Unused_field of string * field_usage_warning (* 69 *) | Missing_mli (* 70 *) ;; (* If you remove a warning, leave a hole in the numbering. NEVER change the numbers of existing warnings. If you add a new warning, add it at the end with a new number; do NOT reuse one of the holes. *) type alert = {kind:string; message:string; def:loc; use:loc} let number = function | Comment_start -> 1 | Comment_not_end -> 2 | Fragile_match _ -> 4 | Ignored_partial_application -> 5 | Labels_omitted _ -> 6 | Method_override _ -> 7 | Partial_match _ -> 8 | Missing_record_field_pattern _ -> 9 | Non_unit_statement -> 10 | Redundant_case -> 11 | Redundant_subpat -> 12 | Instance_variable_override _ -> 13 | Illegal_backslash -> 14 | Implicit_public_methods _ -> 15 | Unerasable_optional_argument -> 16 | Undeclared_virtual_method _ -> 17 | Not_principal _ -> 18 | Non_principal_labels _ -> 19 | Ignored_extra_argument -> 20 | Nonreturning_statement -> 21 | Preprocessor _ -> 22 | Useless_record_with -> 23 | Bad_module_name _ -> 24 | All_clauses_guarded -> 8 (* used to be 25 *) | Unused_var _ -> 26 | Unused_var_strict _ -> 27 | Wildcard_arg_to_constant_constr -> 28 | Eol_in_string -> 29 | Duplicate_definitions _ -> 30 | Module_linked_twice _ -> 31 | Unused_value_declaration _ -> 32 | Unused_open _ -> 33 | Unused_type_declaration _ -> 34 | Unused_for_index _ -> 35 | Unused_ancestor _ -> 36 | Unused_constructor _ -> 37 | Unused_extension _ -> 38 | Unused_rec_flag -> 39 | Name_out_of_scope _ -> 40 | Ambiguous_name _ -> 41 | Disambiguated_name _ -> 42 | Nonoptional_label _ -> 43 | Open_shadow_identifier _ -> 44 | Open_shadow_label_constructor _ -> 45 | Bad_env_variable _ -> 46 | Attribute_payload _ -> 47 | Eliminated_optional_arguments _ -> 48 | No_cmi_file _ -> 49 | Unexpected_docstring _ -> 50 | Wrong_tailcall_expectation _ -> 51 | Fragile_literal_pattern -> 52 | Misplaced_attribute _ -> 53 | Duplicated_attribute _ -> 54 | Inlining_impossible _ -> 55 | Unreachable_case -> 56 | Ambiguous_var_in_pattern_guard _ -> 57 | No_cmx_file _ -> 58 | Flambda_assignment_to_non_mutable_value -> 59 | Unused_module _ -> 60 | Unboxable_type_in_prim_decl _ -> 61 | Constraint_on_gadt -> 62 | Erroneous_printed_signature _ -> 63 | Unsafe_array_syntax_without_parsing -> 64 | Redefining_unit _ -> 65 | Unused_open_bang _ -> 66 | Unused_functor_parameter _ -> 67 | Match_on_mutable_state_prevent_uncurry -> 68 | Unused_field _ -> 69 | Missing_mli -> 70 ;; let last_warning_number = 70 ;; (* Third component of each tuple is the list of names for each warning. The first element of the list is the current name, any following ones are deprecated. The current name should always be derived mechanically from the constructor name. *) let descriptions = [ 1, "Suspicious-looking start-of-comment mark.", ["comment-start"]; 2, "Suspicious-looking end-of-comment mark.", ["comment-not-end"]; 3, "Deprecated synonym for the 'deprecated' alert.", []; 4, "Fragile pattern matching: matching that will remain complete even\n\ \ if additional constructors are added to one of the variant types\n\ \ matched.", ["fragile-match"]; 5, "Partially applied function: expression whose result has function\n\ \ type and is ignored.", ["ignored-partial-application"]; 6, "Label omitted in function application.", ["labels-omitted"]; 7, "Method overridden.", ["method-override"]; 8, "Partial match: missing cases in pattern-matching.", ["partial-match"]; 9, "Missing fields in a record pattern.", ["missing-record-field-pattern"]; 10, "Expression on the left-hand side of a sequence that doesn't have type\n\ \ \"unit\" (and that is not a function, see warning number 5).", ["non-unit-statement"]; 11, "Redundant case in a pattern matching (unused match case).", ["redundant-case"]; 12, "Redundant sub-pattern in a pattern-matching.", ["redundant-subpat"]; 13, "Instance variable overridden.", ["instance-variable-override"]; 14, "Illegal backslash escape in a string constant.", ["illegal-backslash"]; 15, "Private method made public implicitly.", ["implicit-public-methods"]; 16, "Unerasable optional argument.", ["unerasable-optional-argument"]; 17, "Undeclared virtual method.", ["undeclared-virtual-method"]; 18, "Non-principal type.", ["not-principal"]; 19, "Type without principality.", ["non-principal-labels"]; 20, "Unused function argument.", ["ignored-extra-argument"]; 21, "Non-returning statement.", ["nonreturning-statement"]; 22, "Preprocessor warning.", ["preprocessor"]; 23, "Useless record \"with\" clause.", ["useless-record-with"]; 24, "Bad module name: the source file name is not a valid OCaml module name.", ["bad-module-name"]; 25, "Ignored: now part of warning 8.", []; 26, "Suspicious unused variable: unused variable that is bound\n\ \ with \"let\" or \"as\", and doesn't start with an underscore (\"_\")\n\ \ character.", ["unused-var"]; 27, "Innocuous unused variable: unused variable that is not bound with\n\ \ \"let\" nor \"as\", and doesn't start with an underscore (\"_\")\n\ \ character.", ["unused-var-strict"]; 28, "Wildcard pattern given as argument to a constant constructor.", ["wildcard-arg-to-constant-constr"]; 29, "Unescaped end-of-line in a string constant (non-portable code).", ["eol-in-string"]; 30, "Two labels or constructors of the same name are defined in two\n\ \ mutually recursive types.", ["duplicate-definitions"]; 31, "A module is linked twice in the same executable.", ["module-linked-twice"]; 32, "Unused value declaration.", ["unused-value-declaration"]; 33, "Unused open statement.", ["unused-open"]; 34, "Unused type declaration.", ["unused-type-declaration"]; 35, "Unused for-loop index.", ["unused-for-index"]; 36, "Unused ancestor variable.", ["unused-ancestor"]; 37, "Unused constructor.", ["unused-constructor"]; 38, "Unused extension constructor.", ["unused-extension"]; 39, "Unused rec flag.", ["unused-rec-flag"]; 40, "Constructor or label name used out of scope.", ["name-out-of-scope"]; 41, "Ambiguous constructor or label name.", ["ambiguous-name"]; 42, "Disambiguated constructor or label name (compatibility warning).", ["disambiguated-name"]; 43, "Nonoptional label applied as optional.", ["nonoptional-label"]; 44, "Open statement shadows an already defined identifier.", ["open-shadow-identifier"]; 45, "Open statement shadows an already defined label or constructor.", ["open-shadow-label-constructor"]; 46, "Error in environment variable.", ["bad-env-variable"]; 47, "Illegal attribute payload.", ["attribute-payload"]; 48, "Implicit elimination of optional arguments.", ["eliminated-optional-arguments"]; 49, "Absent cmi file when looking up module alias.", ["no-cmi-file"]; 50, "Unexpected documentation comment.", ["unexpected-docstring"]; 51, "Function call annotated with an incorrect @tailcall attribute", ["wrong-tailcall-expectation"]; 52, "Fragile constant pattern.", ["fragile-literal-pattern"]; 53, "Attribute cannot appear in this context.", ["misplaced-attribute"]; 54, "Attribute used more than once on an expression.", ["duplicated-attribute"]; 55, "Inlining impossible.", ["inlining-impossible"]; 56, "Unreachable case in a pattern-matching (based on type information).", ["unreachable-case"]; 57, "Ambiguous or-pattern variables under guard.", ["ambiguous-var-in-pattern-guard"]; 58, "Missing cmx file.", ["no-cmx-file"]; 59, "Assignment to non-mutable value.", ["flambda-assignment-to-non-mutable-value"]; 60, "Unused module declaration.", ["unused-module"]; 61, "Unboxable type in primitive declaration.", ["unboxable-type-in-prim-decl"]; 62, "Type constraint on GADT type declaration.", ["constraint-on-gadt"]; 63, "Erroneous printed signature.", ["erroneous-printed-signature"]; 64, "-unsafe used with a preprocessor returning a syntax tree.", ["unsafe-array-syntax-without-parsing"]; 65, "Type declaration defining a new '()' constructor.", ["redefining-unit"]; 66, "Unused open! statement.", ["unused-open-bang"]; 67, "Unused functor parameter.", ["unused-functor-parameter"]; 68, "Pattern-matching depending on mutable state prevents the remaining \ arguments from being uncurried.", ["match-on-mutable-state-prevent-uncurry"]; 69, "Unused record field.", ["unused-field"]; 70, "Missing interface file.", ["missing-mli"] ] ;; let name_to_number = let h = Hashtbl.create last_warning_number in List.iter (fun (num, _, names) -> List.iter (fun name -> Hashtbl.add h name num) names ) descriptions; fun s -> Hashtbl.find_opt h s ;; (* Must be the max number returned by the [number] function. *) let letter = function | 'a' -> let rec loop i = if i = 0 then [] else i :: loop (i - 1) in loop last_warning_number | 'b' -> [] | 'c' -> [1; 2] | 'd' -> [3] | 'e' -> [4] | 'f' -> [5] | 'g' -> [] | 'h' -> [] | 'i' -> [] | 'j' -> [] | 'k' -> [32; 33; 34; 35; 36; 37; 38; 39] | 'l' -> [6] | 'm' -> [7] | 'n' -> [] | 'o' -> [] | 'p' -> [8] | 'q' -> [] | 'r' -> [9] | 's' -> [10] | 't' -> [] | 'u' -> [11; 12] | 'v' -> [13] | 'w' -> [] | 'x' -> [14; 15; 16; 17; 18; 19; 20; 21; 22; 23; 24; 30] | 'y' -> [26] | 'z' -> [27] | _ -> assert false ;; type state = { active: bool array; error: bool array; alerts: (Misc.Stdlib.String.Set.t * bool); (* false:set complement *) alert_errors: (Misc.Stdlib.String.Set.t * bool); (* false:set complement *) } let current = ref { active = Array.make (last_warning_number + 1) true; error = Array.make (last_warning_number + 1) false; alerts = (Misc.Stdlib.String.Set.empty, false); (* all enabled *) alert_errors = (Misc.Stdlib.String.Set.empty, true); (* all soft *) } let disabled = ref false let without_warnings f = Misc.protect_refs [Misc.R(disabled, true)] f let backup () = !current let restore x = current := x let is_active x = not !disabled && (!current).active.(number x) let is_error x = not !disabled && (!current).error.(number x) let alert_is_active {kind; _} = not !disabled && let (set, pos) = (!current).alerts in Misc.Stdlib.String.Set.mem kind set = pos let alert_is_error {kind; _} = not !disabled && let (set, pos) = (!current).alert_errors in Misc.Stdlib.String.Set.mem kind set = pos let mk_lazy f = let state = backup () in lazy ( let prev = backup () in restore state; try let r = f () in restore prev; r with exn -> restore prev; raise exn ) let set_alert ~error ~enable s = let upd = match s with | "all" -> (Misc.Stdlib.String.Set.empty, not enable) | s -> let (set, pos) = if error then (!current).alert_errors else (!current).alerts in let f = if enable = pos then Misc.Stdlib.String.Set.add else Misc.Stdlib.String.Set.remove in (f s set, pos) in if error then current := {(!current) with alert_errors=upd} else current := {(!current) with alerts=upd} let parse_alert_option s = let n = String.length s in let id_char = function | 'a'..'z' | 'A'..'Z' | '_' | '\'' | '0'..'9' -> true | _ -> false in let rec parse_id i = if i < n && id_char s.[i] then parse_id (i + 1) else i in let rec scan i = if i = n then () else if i + 1 = n then raise (Arg.Bad "Ill-formed list of alert settings") else match s.[i], s.[i+1] with | '+', '+' -> id (set_alert ~error:true ~enable:true) (i + 2) | '+', _ -> id (set_alert ~error:false ~enable:true) (i + 1) | '-', '-' -> id (set_alert ~error:true ~enable:false) (i + 2) | '-', _ -> id (set_alert ~error:false ~enable:false) (i + 1) | '@', _ -> id (fun s -> set_alert ~error:true ~enable:true s; set_alert ~error:false ~enable:true s) (i + 1) | _ -> raise (Arg.Bad "Ill-formed list of alert settings") and id f i = let j = parse_id i in if j = i then raise (Arg.Bad "Ill-formed list of alert settings"); let id = String.sub s i (j - i) in f id; scan j in scan 0 type modifier = | Set (** +a *) | Clear (** -a *) | Set_all (** @a *) type token = | Letter of char * modifier option | Num of int * int * modifier let ghost_loc_in_file name = let pos = { Lexing.dummy_pos with pos_fname = name } in { loc_start = pos; loc_end = pos; loc_ghost = true } let letter_alert tokens = let print_warning_char ppf c = let lowercase = Char.lowercase_ascii c = c in Format.fprintf ppf "%c%c" (if lowercase then '-' else '+') c in let print_modifier ppf = function | Set_all -> Format.fprintf ppf "@" | Clear -> Format.fprintf ppf "-" | Set -> Format.fprintf ppf "+" in let print_token ppf = function | Num (a,b,m) -> if a = b then Format.fprintf ppf "%a%d" print_modifier m a else Format.fprintf ppf "%a%d..%d" print_modifier m a b | Letter(l,Some m) -> Format.fprintf ppf "%a%c" print_modifier m l | Letter(l,None) -> print_warning_char ppf l in let consecutive_letters = (* we are tracking sequences of 2 or more consecutive unsigned letters in warning strings, for instance in '-w "not-principa"'. *) let commit_chunk l = function | [] | [ _ ] -> l | _ :: _ :: _ as chunk -> List.rev chunk :: l in let group_consecutive_letters (l,current) = function | Letter (x, None) -> (l, x::current) | _ -> (commit_chunk l current, []) in let l, on_going = List.fold_left group_consecutive_letters ([],[]) tokens in commit_chunk l on_going in match consecutive_letters with | [] -> None | example :: _ -> let nowhere = ghost_loc_in_file "_none_" in let spelling_hint ppf = let max_seq_len = List.fold_left (fun l x -> Int.max l (List.length x)) 0 consecutive_letters in if max_seq_len >= 5 then Format.fprintf ppf "@ @[Hint: Did you make a spelling mistake \ when using a mnemonic name?@]" else () in let message = Format.asprintf "@[<v>@[Setting a warning with a sequence of lowercase \ or uppercase letters,@ like '%a',@ is deprecated.@]@ \ @[Use the equivalent signed form:@ %t.@]@ \ @[Hint: Enabling or disabling a warning by its mnemonic name \ requires a + or - prefix.@]\ %t@?@]" Format.(pp_print_list ~pp_sep:(fun _ -> ignore) pp_print_char) example (fun ppf -> List.iter (print_token ppf) tokens) spelling_hint in Some { kind="ocaml_deprecated_cli"; use=nowhere; def=nowhere; message } let parse_warnings s = let error () = raise (Arg.Bad "Ill-formed list of warnings") in let rec get_num n i = if i >= String.length s then i, n else match s.[i] with | '0'..'9' -> get_num (10 * n + Char.code s.[i] - Char.code '0') (i + 1) | _ -> i, n in let get_range i = let i, n1 = get_num 0 i in if i + 2 < String.length s && s.[i] = '.' && s.[i + 1] = '.' then let i, n2 = get_num 0 (i + 2) in if n2 < n1 then error (); i, n1, n2 else i, n1, n1 in let rec loop tokens i = if i >= String.length s then List.rev tokens else match s.[i] with | 'A' .. 'Z' | 'a' .. 'z' -> loop (Letter(s.[i],None)::tokens) (i+1) | '+' -> loop_letter_num tokens Set (i+1) | '-' -> loop_letter_num tokens Clear (i+1) | '@' -> loop_letter_num tokens Set_all (i+1) | _ -> error () and loop_letter_num tokens modifier i = if i >= String.length s then error () else match s.[i] with | '0' .. '9' -> let i, n1, n2 = get_range i in loop (Num(n1,n2,modifier)::tokens) i | 'A' .. 'Z' | 'a' .. 'z' -> loop (Letter(s.[i],Some modifier)::tokens) (i+1) | _ -> error () in loop [] 0 let parse_opt error active errflag s = let flags = if errflag then error else active in let action modifier i = match modifier with | Set -> if i = 3 then set_alert ~error:errflag ~enable:true "deprecated" else flags.(i) <- true | Clear -> if i = 3 then set_alert ~error:errflag ~enable:false "deprecated" else flags.(i) <- false | Set_all -> if i = 3 then begin set_alert ~error:false ~enable:true "deprecated"; set_alert ~error:true ~enable:true "deprecated" end else begin active.(i) <- true; error.(i) <- true end in let eval = function | Letter(c, m) -> let lc = Char.lowercase_ascii c in let modifier = match m with | None -> if c = lc then Clear else Set | Some m -> m in List.iter (action modifier) (letter lc) | Num(n1,n2,modifier) -> for n = n1 to Int.min n2 last_warning_number do action modifier n done in let parse_and_eval s = let tokens = parse_warnings s in List.iter eval tokens; letter_alert tokens in match name_to_number s with | Some n -> action Set n; None | None -> if s = "" then parse_and_eval s else begin let rest = String.sub s 1 (String.length s - 1) in match s.[0], name_to_number rest with | '+', Some n -> action Set n; None | '-', Some n -> action Clear n; None | '@', Some n -> action Set_all n; None | _ -> parse_and_eval s end ;; let parse_options errflag s = let error = Array.copy (!current).error in let active = Array.copy (!current).active in let alerts = parse_opt error active errflag s in current := {(!current) with error; active}; alerts (* If you change these, don't forget to change them in man/ocamlc.m *) let defaults_w = "+a-4-7-9-27-29-30-32..42-44-45-48-50-60-66..70";; let defaults_warn_error = "-a+31";; let () = ignore @@ parse_options false defaults_w;; let () = ignore @@ parse_options true defaults_warn_error;; let ref_manual_explanation () = (* manual references are checked a posteriori by the manual cross-reference consistency check in manual/tests*) let[@manual.ref "s:comp-warnings"] chapter, section = 9, 5 in Printf.sprintf "(See manual section %d.%d)" chapter section let message = function | Comment_start -> "this `(*' is the start of a comment.\n\ Hint: Did you forget spaces when writing the infix operator `( * )'?" | Comment_not_end -> "this is not the end of a comment." | Fragile_match "" -> "this pattern-matching is fragile." | Fragile_match s -> "this pattern-matching is fragile.\n\ It will remain exhaustive when constructors are added to type " ^ s ^ "." | Ignored_partial_application -> "this function application is partial,\n\ maybe some arguments are missing." | Labels_omitted [] -> assert false | Labels_omitted [l] -> "label " ^ l ^ " was omitted in the application of this function." | Labels_omitted ls -> "labels " ^ String.concat ", " ls ^ " were omitted in the application of this function." | Method_override [lab] -> "the method " ^ lab ^ " is overridden." | Method_override (cname :: slist) -> String.concat " " ("the following methods are overridden by the class" :: cname :: ":\n " :: slist) | Method_override [] -> assert false | Partial_match "" -> "this pattern-matching is not exhaustive." | Partial_match s -> "this pattern-matching is not exhaustive.\n\ Here is an example of a case that is not matched:\n" ^ s | Missing_record_field_pattern s -> "the following labels are not bound in this record pattern:\n" ^ s ^ "\nEither bind these labels explicitly or add '; _' to the pattern." | Non_unit_statement -> "this expression should have type unit." | Redundant_case -> "this match case is unused." | Redundant_subpat -> "this sub-pattern is unused." | Instance_variable_override [lab] -> "the instance variable " ^ lab ^ " is overridden.\n" ^ "The behaviour changed in ocaml 3.10 (previous behaviour was hiding.)" | Instance_variable_override (cname :: slist) -> String.concat " " ("the following instance variables are overridden by the class" :: cname :: ":\n " :: slist) ^ "\nThe behaviour changed in ocaml 3.10 (previous behaviour was hiding.)" | Instance_variable_override [] -> assert false | Illegal_backslash -> "illegal backslash escape in string." | Implicit_public_methods l -> "the following private methods were made public implicitly:\n " ^ String.concat " " l ^ "." | Unerasable_optional_argument -> "this optional argument cannot be erased." | Undeclared_virtual_method m -> "the virtual method "^m^" is not declared." | Not_principal s -> s^" is not principal." | Non_principal_labels s -> s^" without principality." | Ignored_extra_argument -> "this argument will not be used by the function." | Nonreturning_statement -> "this statement never returns (or has an unsound type.)" | Preprocessor s -> s | Useless_record_with -> "all the fields are explicitly listed in this record:\n\ the 'with' clause is useless." | Bad_module_name (modname) -> "bad source file name: \"" ^ modname ^ "\" is not a valid module name." | All_clauses_guarded -> "this pattern-matching is not exhaustive.\n\ All clauses in this pattern-matching are guarded." | Unused_var v | Unused_var_strict v -> "unused variable " ^ v ^ "." | Wildcard_arg_to_constant_constr -> "wildcard pattern given as argument to a constant constructor" | Eol_in_string -> "unescaped end-of-line in a string constant (non-portable code)" | Duplicate_definitions (kind, cname, tc1, tc2) -> Printf.sprintf "the %s %s is defined in both types %s and %s." kind cname tc1 tc2 | Module_linked_twice(modname, file1, file2) -> Printf.sprintf "files %s and %s both define a module named %s" file1 file2 modname | Unused_value_declaration v -> "unused value " ^ v ^ "." | Unused_open s -> "unused open " ^ s ^ "." | Unused_open_bang s -> "unused open! " ^ s ^ "." | Unused_type_declaration s -> "unused type " ^ s ^ "." | Unused_for_index s -> "unused for-loop index " ^ s ^ "." | Unused_ancestor s -> "unused ancestor variable " ^ s ^ "." | Unused_constructor (s, Unused) -> "unused constructor " ^ s ^ "." | Unused_constructor (s, Not_constructed) -> "constructor " ^ s ^ " is never used to build values.\n\ (However, this constructor appears in patterns.)" | Unused_constructor (s, Only_exported_private) -> "constructor " ^ s ^ " is never used to build values.\n\ Its type is exported as a private type." | Unused_extension (s, is_exception, complaint) -> let kind = if is_exception then "exception" else "extension constructor" in let name = kind ^ " " ^ s in begin match complaint with | Unused -> "unused " ^ name | Not_constructed -> name ^ " is never used to build values.\n\ (However, this constructor appears in patterns.)" | Only_exported_private -> name ^ " is never used to build values.\n\ It is exported or rebound as a private extension." end | Unused_rec_flag -> "unused rec flag." | Name_out_of_scope (ty, [nm], false) -> nm ^ " was selected from type " ^ ty ^ ".\nIt is not visible in the current scope, and will not \n\ be selected if the type becomes unknown." | Name_out_of_scope (_, _, false) -> assert false | Name_out_of_scope (ty, slist, true) -> "this record of type "^ ty ^" contains fields that are \n\ not visible in the current scope: " ^ String.concat " " slist ^ ".\n\ They will not be selected if the type becomes unknown." | Ambiguous_name ([s], tl, false, expansion) -> s ^ " belongs to several types: " ^ String.concat " " tl ^ "\nThe first one was selected. Please disambiguate if this is wrong." ^ expansion | Ambiguous_name (_, _, false, _ ) -> assert false | Ambiguous_name (_slist, tl, true, expansion) -> "these field labels belong to several types: " ^ String.concat " " tl ^ "\nThe first one was selected. Please disambiguate if this is wrong." ^ expansion | Disambiguated_name s -> "this use of " ^ s ^ " relies on type-directed disambiguation,\n\ it will not compile with OCaml 4.00 or earlier." | Nonoptional_label s -> "the label " ^ s ^ " is not optional." | Open_shadow_identifier (kind, s) -> Printf.sprintf "this open statement shadows the %s identifier %s (which is later used)" kind s | Open_shadow_label_constructor (kind, s) -> Printf.sprintf "this open statement shadows the %s %s (which is later used)" kind s | Bad_env_variable (var, s) -> Printf.sprintf "illegal environment variable %s : %s" var s | Attribute_payload (a, s) -> Printf.sprintf "illegal payload for attribute '%s'.\n%s" a s | Eliminated_optional_arguments sl -> Printf.sprintf "implicit elimination of optional argument%s %s" (if List.length sl = 1 then "" else "s") (String.concat ", " sl) | No_cmi_file(name, None) -> "no cmi file was found in path for module " ^ name | No_cmi_file(name, Some msg) -> Printf.sprintf "no valid cmi file was found in path for module %s. %s" name msg | Unexpected_docstring unattached -> if unattached then "unattached documentation comment (ignored)" else "ambiguous documentation comment" | Wrong_tailcall_expectation b -> Printf.sprintf "expected %s" (if b then "tailcall" else "non-tailcall") | Fragile_literal_pattern -> Printf.sprintf "Code should not depend on the actual values of\n\ this constructor's arguments. They are only for information\n\ and may change in future versions. %t" ref_manual_explanation | Unreachable_case -> "this match case is unreachable.\n\ Consider replacing it with a refutation case '<pat> -> .'" | Misplaced_attribute attr_name -> Printf.sprintf "the %S attribute cannot appear in this context" attr_name | Duplicated_attribute attr_name -> Printf.sprintf "the %S attribute is used more than once on this \ expression" attr_name | Inlining_impossible reason -> Printf.sprintf "Cannot inline: %s" reason | Ambiguous_var_in_pattern_guard vars -> let msg = let vars = List.sort String.compare vars in match vars with | [] -> assert false | [x] -> "variable " ^ x | _::_ -> "variables " ^ String.concat "," vars in Printf.sprintf "Ambiguous or-pattern variables under guard;\n\ %s may match different arguments. %t" msg ref_manual_explanation | No_cmx_file name -> Printf.sprintf "no cmx file was found in path for module %s, \ and its interface was not compiled with -opaque" name | Flambda_assignment_to_non_mutable_value -> "A potential assignment to a non-mutable value was detected \n\ in this source file. Such assignments may generate incorrect code \n\ when using Flambda." | Unused_module s -> "unused module " ^ s ^ "." | Unboxable_type_in_prim_decl t -> Printf.sprintf "This primitive declaration uses type %s, whose representation\n\ may be either boxed or unboxed. Without an annotation to indicate\n\ which representation is intended, the boxed representation has been\n\ selected by default. This default choice may change in future\n\ versions of the compiler, breaking the primitive implementation.\n\ You should explicitly annotate the declaration of %s\n\ with [@@boxed] or [@@unboxed], so that its external interface\n\ remains stable in the future." t t | Constraint_on_gadt -> "Type constraints do not apply to GADT cases of variant types." | Erroneous_printed_signature s -> "The printed interface differs from the inferred interface.\n\ The inferred interface contained items which could not be printed\n\ properly due to name collisions between identifiers." ^ s ^ "\nBeware that this warning is purely informational and will not catch\n\ all instances of erroneous printed interface." | Unsafe_array_syntax_without_parsing -> "option -unsafe used with a preprocessor returning a syntax tree" | Redefining_unit name -> Printf.sprintf "This type declaration is defining a new '()' constructor\n\ which shadows the existing one.\n\ Hint: Did you mean 'type %s = unit'?" name | Unused_functor_parameter s -> "unused functor parameter " ^ s ^ "." | Match_on_mutable_state_prevent_uncurry -> "This pattern depends on mutable state.\n\ It prevents the remaining arguments from being uncurried, which will \ cause additional closure allocations." | Unused_field (s, Unused) -> "unused record field " ^ s ^ "." | Unused_field (s, Not_read) -> "record field " ^ s ^ " is never read.\n\ (However, this field is used to build or mutate values.)" | Unused_field (s, Not_mutated) -> "mutable record field " ^ s ^ " is never mutated." | Missing_mli -> "Cannot find interface file." ;; let nerrors = ref 0;; type reporting_information = { id : string ; message : string ; is_error : bool ; sub_locs : (loc * string) list; } let id_name w = let n = number w in match List.find_opt (fun (m, _, _) -> m = n) descriptions with | Some (_, _, s :: _) -> Printf.sprintf "%d [%s]" n s | _ -> string_of_int n let report w = match is_active w with | false -> `Inactive | true -> if is_error w then incr nerrors; `Active { id = id_name w; message = message w; is_error = is_error w; sub_locs = []; } let report_alert (alert : alert) = match alert_is_active alert with | false -> `Inactive | true -> let is_error = alert_is_error alert in if is_error then incr nerrors; let message = Misc.normalise_eol alert.message in (* Reduce \r\n to \n: - Prevents any \r characters being printed on Unix when processing Windows sources - Prevents \r\r\n being generated on Windows, which affects the testsuite *) let sub_locs = if not alert.def.loc_ghost && not alert.use.loc_ghost then [ alert.def, "Definition"; alert.use, "Expected signature"; ] else [] in `Active { id = alert.kind; message; is_error; sub_locs; } exception Errors;; let reset_fatal () = nerrors := 0 let check_fatal () = if !nerrors > 0 then begin nerrors := 0; raise Errors; end; ;; let help_warnings () = List.iter (fun (i, s, names) -> let name = match names with | s :: _ -> " [" ^ s ^ "]" | [] -> "" in Printf.printf "%3i%s %s\n" i name s) descriptions; print_endline " A all warnings"; for i = Char.code 'b' to Char.code 'z' do let c = Char.chr i in match letter c with | [] -> () | [n] -> Printf.printf " %c Alias for warning %i.\n" (Char.uppercase_ascii c) n | l -> Printf.printf " %c warnings %s.\n" (Char.uppercase_ascii c) (String.concat ", " (List.map Int.to_string l)) done; exit 0 ;;
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>