Source file clang__utils.ml

[%%metapackage "metapp"]
[%%metadir "config/.clangml_config.objs/byte"]
[%%metaload "config/clangml_config.cmxs"]

open Clang__bindings

open Clang__types

[%%meta Metapp.Stri.of_list (
  if Clangml_config.version >= { major = 3; minor = 5; subminor = 0 } then
    []
  else [%str
    type cxerrorcode =
      | Failure
      | Crashed
      | InvalidArguments
      | ASTReadError
    (** Error codes introduced in clang 3.5, declared here for compatibility.
        Only {!constr:Failure} will be used. *)

    let parse_translation_unit2 index filename command_line_args unsaved_files
        options : (cxtranslationunit, cxerrorcode) result =
      match
        parse_translation_unit index filename command_line_args unsaved_files
          options
      with
      | None -> Error Failure
      | Some tu -> Ok tu
    (** Compatibility wrapper for [parse_translation_unit2].
        In case of error, [Error Failure] will be returned. *)])]

[%%meta Metapp.Stri.of_list (
 if Clangml_config.version >= { major = 3; minor = 6; subminor = 0 } then [%str
   let predefined_expr_get_function_name cursor _decl =
     ext_predefined_expr_get_function_name cursor]
 else [%str
   let predefined_expr_get_function_name cursor decl =
     ext_predefined_expr_compute_name
       (ext_predefined_expr_get_ident_kind cursor) decl])]

[%%meta Metapp.Stri.of_list (
  if Clangml_config.version >= { major = 3; minor = 7; subminor = 0 } then
    []
  else [%str
    let type_visit_fields ty visitor =
      visit_children (ty |> get_type_declaration) (fun cur _parent ->
        match get_cursor_kind cur with
        | FieldDecl ->
            begin
              match visitor cur with
              | Break -> Break
              | Continue -> Continue
            end
        | _ -> Continue)])]

let iter_visitor f visitor =
  let exn_ref = ref (None : exn option) in
  visitor begin fun cur ->
    try
      f cur;
      true
    with exn ->
      exn_ref := Some exn;
      false
  end;
  match !exn_ref with
  | None -> ()
  | Some exn -> raise exn

let iter_child_visit_result_visitor
      (visit_fun :
         _ -> (cxcursor -> cxcursor -> cxchildvisitresult) -> bool) f c =
  iter_visitor f begin fun f ->
    ignore (visit_fun c begin fun cur _par ->
      if f cur then
        Continue
      else
        Break
    end)
  end

let iter_visitor_result_visitor
      (visit_fun : _ -> (_ -> cxvisitorresult) -> bool) f c =
  iter_visitor f begin fun f ->
    ignore (visit_fun c begin fun cur ->
      if f cur then
        Continue
      else
        Break
    end)
  end

let list_of_iter_filter_map (f : _ -> _ option) iter =
  let accu = ref [] in
  iter (fun item ->
    match f item with
    | None -> ()
    | Some item -> accu := item :: !accu);
  List.rev !accu

let list_of_iter_map f iter =
  let accu = ref [] in
  iter (fun item -> accu := f item :: !accu);
  List.rev !accu

let list_of_iter iter = list_of_iter_map Fun.id iter

let iter_children f c =
  iter_child_visit_result_visitor visit_children f c

let list_of_children_filter_map f c =
  list_of_iter_filter_map f (fun f -> iter_children f c)

let list_of_children_map f c =
  list_of_iter_map f (fun f -> iter_children f c)

let list_of_children c =
  list_of_iter (fun f -> iter_children f c)

let iter_decl_attributes f c =
  iter_child_visit_result_visitor ext_decl_visit_attributes f c

let iter_cxxrecorddecl_bases f c =
  iter_child_visit_result_visitor ext_cxxrecord_decl_visit_bases f c

let option_cursor_bind f cursor : 'a option =
  if cursor_is_null cursor || get_cursor_kind cursor = InvalidCode then
    None
  else
    f cursor

let option_cursor_map f cursor : 'a option =
  option_cursor_bind (fun x -> Some (f x)) cursor

let option_cursor cursor : 'a option =
  option_cursor_map Fun.id cursor

exception Cursor of cxcursor

let first_child c : cxcursor option =
  try
    iter_children (fun c -> raise (Cursor c)) c;
    None
  with Cursor c ->
    Some c

let last_child c =
  let last = ref (get_null_cursor ()) in
  iter_children (fun c -> last := c) c;
  option_cursor !last

let iter_type_fields f ty =
  iter_visitor_result_visitor type_visit_fields f ty

let list_of_type_fields ty =
  list_of_iter (fun f -> iter_type_fields f ty)

let iter_decl_context f c =
  iter_child_visit_result_visitor ext_decl_context_visit_decls f c

let list_of_decl_context_map f c =
  list_of_iter_map f (fun f -> iter_decl_context f c)

let list_of_decl_context c =
  list_of_iter (fun f -> iter_decl_context f c)

let iter_indirect_field_decl_chain f c =
  iter_child_visit_result_visitor ext_indirect_field_decl_visit_chain f c

let list_of_indirect_field_decl_chain_map f c =
  list_of_iter_map f (fun f -> iter_indirect_field_decl_chain f c)

let list_of_indirect_field_decl_chain c =
  list_of_iter (fun f -> iter_indirect_field_decl_chain f c)

let iter_cxxconstructor_initializers f c =
  iter_visitor_result_visitor ext_cxxconstructor_decl_visit_initializers f c

let list_of_cxxconstructor_initializers_map f c =
  list_of_iter_map f (fun f -> iter_cxxconstructor_initializers f c)

let list_of_cxxconstructor_initializers c =
  list_of_cxxconstructor_initializers_map Fun.id c

let seq_of_diagnostics tu =
  let count = get_num_diagnostics tu in
  let rec next i () =
    if i < count then
      Seq.Cons (get_diagnostic tu i, next (succ i))
    else
      Seq.Nil in
  next 0

let concrete_of_cxsourcelocation kind location =
  let concrete_location_of_triple (filename, line, column) =
    { filename; line; column } in
  let concrete_location_of_quadruple (file, line, column, _offset) =
    { filename = get_file_name file; line; column } in
  match kind with
  | Expansion ->
      concrete_location_of_quadruple (get_expansion_location location)
  | Presumed ->
      concrete_location_of_triple (get_presumed_location location)
  | Instantiation ->
      concrete_location_of_quadruple (get_instantiation_location location)
  | Spelling ->
      concrete_location_of_quadruple (get_spelling_location location)
  | File ->
      concrete_location_of_quadruple (get_file_location location)

let string_of_severity (severity : cxdiagnosticseverity) : string =
  match severity with
  | Ignored -> "ignored"
  | Note -> "note"
  | Warning -> "warning"
  | Error -> "error"
  | Fatal -> "fatal error"

let pp_concrete_location ?(options = Display_source_location.default)
    ?(ranges = fun () -> []) fmt concrete_location =
  let { filename; line; column } = concrete_location in
  Format.fprintf fmt "@[%s:%d:" filename line;
  if options.column then
    Format.fprintf fmt "%d:" column;
  if options.ranges then
    begin
      let ranges = ranges () in
      if ranges <> [] then
        begin
          ranges |> List.iter (fun (start, end_) ->
            Format.fprintf fmt "@[{%d:%d-%d:%d}@]"
              start.line start.column end_.line end_.column);
          Format.fprintf fmt ":"
        end;
    end;
  Format.fprintf fmt "@]"

let pp_diagnostic ?(options = Diagnostic_display_options.default) fmt
    diagnostic =
  begin match options.source_location with
  | None -> ()
  | Some options ->
      let location =
        concrete_of_cxsourcelocation options.kind
          (get_diagnostic_location diagnostic) in
      let ranges () =
        let get_range i =
          let range = get_diagnostic_range diagnostic i in
          let start =
            concrete_of_cxsourcelocation options.kind (get_range_start range) in
          let end_ =
            concrete_of_cxsourcelocation options.kind (get_range_end range) in
          (start, end_) in
        let keep_range (start, end_) =
          start.filename = end_.filename &&
          start.filename = location.filename in
        List.init (get_diagnostic_num_ranges diagnostic) get_range |>
        List.filter keep_range in
      pp_concrete_location ~options ~ranges fmt location;
      Format.pp_print_space fmt ()
  end;
  let severity =
    string_of_severity (get_diagnostic_severity diagnostic) in
  let text = get_diagnostic_spelling diagnostic in
  let text =
    if text = "" then
      "<no diagnostic text>"
    else
      text in
  Format.fprintf fmt "%s:@ %s" severity text;
  let notes =
    if options.option then
      let option_name, _disable = get_diagnostic_option diagnostic in
      if option_name = "" then
        []
      else
        [option_name]
    else
      [] in
  let notes =
    if options.category_id then
      let category_id = get_diagnostic_category diagnostic in
      notes @ [string_of_int category_id]
    else
      notes in
  let notes =
    if options.category_name then
      let category_name = get_diagnostic_category_text diagnostic in
      notes @ [category_name]
    else
      notes in
  if notes <> [] then
    Format.fprintf fmt "[%a]"
      (Format.pp_print_list ~pp_sep:(fun fmt () -> Format.fprintf fmt ",@ ")
         Format.pp_print_string)
      notes

let format_diagnostics ?pp ?(options = Diagnostic_display_options.default)
    severities fmt tu =
  let filter diagnostics =
    List.mem (get_diagnostic_severity diagnostics) severities in
  let sequence = Seq.filter filter (seq_of_diagnostics tu) in
  match sequence () with
  | Nil -> ()
  | Cons (hd, tl) ->
      let format_all_diagnostics fmt () =
        let format_diagnostic diagnostic =
          Format.fprintf fmt "@[%a@]@ " (pp_diagnostic ~options) diagnostic in
        format_diagnostic hd;
        tl |> Seq.iter format_diagnostic in
      match pp with
      | None -> Format.fprintf fmt "@[<v>%a@]" format_all_diagnostics ()
      | Some pp -> pp format_all_diagnostics fmt ()

let error : cxdiagnosticseverity list = [Error; Fatal]

let warning_or_error = Warning :: error

let not_ignored_diagnostics = Note :: warning_or_error

let all_diagnostics = Ignored :: not_ignored_diagnostics

let seq_exists pred seq =
  (* "let exception" is OCaml >=4.04.0 only *)
  let module M = struct exception Exists end in
  try
    seq |> Seq.iter begin fun d ->
      if pred d then
        raise M.Exists
    end;
    false
  with M.Exists ->
    true

let has_severity l tu =
  seq_of_diagnostics tu |> seq_exists begin fun d ->
    List.mem (get_diagnostic_severity d) l
  end

(* is_integer, is_unsigned_integer, is_signed_integer and is_floating_point
   are implemented as Type::{isInteger, isUnsignedInteger, isSignedInteger,
   isFloatingPoint} in Type.h. *)
let is_unsigned_integer (ty : cxtypekind) =
  match ty with
  | Bool | Char_U | UChar | Char16 | Char32 | UShort | UInt | ULong | ULongLong
  | UInt128 -> true
  | _ -> false

let is_signed_integer (ty : cxtypekind) =
  match ty with
  | Char_S | SChar | WChar | Short | Int | Long | LongLong | Int128 -> true
  | _ -> false

let is_integer (ty : cxtypekind) =
  is_unsigned_integer ty || is_signed_integer ty

[%%meta Metapp.Stri.of_list ((new Metapp.filter)#structure [%str
let is_floating_point (ty : cxtypekind) =
  match ty with
  | Float | Double | LongDouble -> true
  | Float128
      [@if [%meta Metapp.Exp.of_bool
        (Clangml_config.version >= { major = 3; minor = 9; subminor = 0 })]] ->
      true
  | Half [@if [%meta Metapp.Exp.of_bool (Clangml_config.version.major >= 5)]] ->
      true
  | Float16
      [@if [%meta Metapp.Exp.of_bool (Clangml_config.version.major >= 6)]] ->
      true
  | _ -> false])]

let get_bits ~signed =
  if signed then
    ext_int_get_min_signed_bits
  else
    ext_int_get_active_bits

let int64_of_cxint_opt ?(signed = true) cxint =
  if get_bits ~signed cxint <= 64 then
    let result =
      if signed then
        ext_int_get_sext_value64 cxint
      else
        ext_int_get_zext_value64 cxint in
    Some result
  else
    None

let int64_of_cxint ?(signed = true) cxint =
  if get_bits ~signed cxint <= 64 then
    if signed then
      ext_int_get_sext_value64 cxint
    else
      ext_int_get_zext_value64 cxint
  else
    invalid_arg "int64_of_cxint"

let int_of_cxint_opt ?(signed = true) cxint : int option =
  (* The result type is always signed, therefore the bit sign is lost when
     storing an unsigned value. *)
  let sign_bit = if signed then 0 else 1 in
  let bits = get_bits ~signed cxint in
  if bits > Sys.int_size - sign_bit then
    None
  else
    let result =
      if bits <= 32 - sign_bit then
        if signed then
          ext_int_get_sext_value cxint
        else
          ext_int_get_zext_value cxint
      else
        let result =
          if signed then
            ext_int_get_sext_value64 cxint
          else
            ext_int_get_zext_value64 cxint in
        Int64.to_int result in
    Some result

let int_of_cxint ?(signed = true) cxint =
  match int_of_cxint_opt ~signed cxint with
  | Some result -> result
  | None -> invalid_arg "int_of_cxint"

let string_of_cxint ?(signed = true) cxint =
  ext_int_to_string cxint 10 signed

let float_of_cxfloat_opt cxfloat =
  match ext_float_get_semantics cxfloat with
  | IEEEsingle -> Some (ext_float_convert_to_float cxfloat)
  | IEEEdouble -> Some (ext_float_convert_to_double cxfloat)
  | _ -> None

let float_of_cxfloat cxfloat =
  match ext_float_get_semantics cxfloat with
  | IEEEsingle -> ext_float_convert_to_float cxfloat
  | IEEEdouble -> ext_float_convert_to_double cxfloat
  | _ -> invalid_arg "float_of_cxfloat"

let string_of_cxfloat cxfloat =
  ext_float_to_string cxfloat

let string_of_cxerrorcode cxerrorcode =
  match cxerrorcode with
  | Failure -> "generic error code, no further details are available"
  | Crashed -> "libclang crashed while performing the requested operation"
  | InvalidArguments -> "the arguments violate the function contract"
  | ASTReadError -> "an AST deserialization error has occurred"

(* From CompilerInvocation.cpp:ParseFrontendArgs *)

let string_of_language language =
  match language with
  | C -> "c"
  | OpenCL -> "cl"
  | CUDA -> "cuda"
  | HIP -> "hip"
  | CXX -> "c++"
  | ObjC -> "objective-c"
  | ObjCXX -> "objective-c++"
  | RenderScript -> "renderscript"

let language_of_string s =
  match s with
  | "c" | "C" -> C
  | "cl" -> OpenCL
  | "cuda" -> CUDA
  | "hip" -> HIP
  | "c++" | "C++" | "cpp" | "CPP" | "cxx"| "CXX" -> CXX
  | "objective-c" | "objc" -> ObjC
  | "objective-c++" | "objc++" | "objcpp" -> ObjCXX
  | "renderscript" -> RenderScript
  | _ -> invalid_arg "language_of_string"

let language_of_string_opt s =
  try
    Some (language_of_string s)
  with Invalid_argument _ ->
    None

let suffix_of_language language =
  match language with
  | C -> ".c"
  | OpenCL -> ".cl"
  | CUDA -> ".cuda"
  | HIP -> ".hip"
  | CXX -> ".cpp"
  | ObjC -> ".m"
  | ObjCXX -> ".mm"
  | RenderScript -> ".renderscript"

let extern_of_language language =
  match language with
  | C -> "C"
  | CXX -> "C++"
  | _ -> invalid_arg "extern_of_language"

let parse_file_res
    ?(index = create_index ~exclude_declarations_from_pch:true
      ~display_diagnostics:true)
    ?(command_line_args = []) ?(unsaved_files = [])
    ?(options = default_editing_translation_unit_options ()) filename =
  parse_translation_unit2 index filename (Array.of_list command_line_args)
    (Array.of_list unsaved_files) options

let parse_file ?index ?command_line_args ?unsaved_files ?options
    filename =
  match
    parse_file_res ?index ?command_line_args ?unsaved_files ?options
      filename
  with
  | Ok cxtranslationunit -> cxtranslationunit
  | Error cxerrorcode -> failwith (string_of_cxerrorcode cxerrorcode)

let parse_string_res ?index ?(filename = "<string>.c")
    ?command_line_args ?(unsaved_files = [])
    ?options contents =
  parse_file_res ?index ?command_line_args
    ~unsaved_files:({ filename; contents } :: unsaved_files)
    ?options filename

let parse_string ?index ?filename ?command_line_args ?unsaved_files
    ?options contents =
  match
    parse_string_res ?index ?filename ?command_line_args
      ?unsaved_files ?options contents
  with
  | Ok cxtranslationunit -> cxtranslationunit
  | Error cxerrorcode -> failwith (string_of_cxerrorcode cxerrorcode)

let string_of_cxx_access_specifier specifier =
  match specifier with
  | CXXInvalidAccessSpecifier ->
      invalid_arg "string_of_cxx_access_specifier"
  | CXXPublic -> "public"
  | CXXProtected -> "protected"
  | CXXPrivate -> "private"

let cursor_get_translation_unit cursor =
  Obj.obj (Obj.field (Obj.repr cursor) 1)

let sourcelocation_get_translation_unit cursor =
  Obj.obj (Obj.field (Obj.repr cursor) 1)

let binary_of_overloaded_operator_kind kind =
  match kind with
  | Plus -> Add
  | Minus -> Sub
  | Star -> Mul
  | Slash -> Div
  | Percent -> Rem
  | Amp -> And
  | Pipe -> Or
  | Equal  -> Assign
  | Less -> LT
  | Greater -> GT
  | PlusEqual -> AddAssign
  | MinusEqual -> SubAssign
  | StarEqual -> MulAssign
  | SlashEqual -> DivAssign
  | PercentEqual -> RemAssign
  | AmpEqual -> AndAssign
  | PipeEqual -> OrAssign
  | LessLess -> Shl
  | GreaterGreater -> Shr
  | LessLessEqual -> ShlAssign
  | GreaterGreaterEqual -> ShrAssign
  | EqualEqual -> EQ
  | ExclaimEqual -> NE
  | LessEqual -> LE
  | GreaterEqual -> GE
  | AmpAmp -> LAnd
  | PipePipe -> LOr
  | Comma -> Comma
  | ArrowStar -> PtrMemD
  | _ -> invalid_arg "binary_of_overloaded_operator_kind"

let rec extract_prefix_from_list'
    (p : 'a -> 'b option) (accu : 'b list) (list : 'a list)
    : 'b list * 'a list =
  match
    match list with
    | [] -> (None : _ option), []
    | hd :: tl ->
        match p hd with
        | None -> None, list
        | (Some _) as y -> y, tl
  with
  | Some x, tl -> extract_prefix_from_list' p (x :: accu) tl
  | None, tl -> List.rev accu, tl

let extract_prefix_from_list p list =
  extract_prefix_from_list' p [] list