libs/ast_generic/AST_generic_helpers.mli

Rama main · réplica de lectura del repositorio original.

val str_of_ident : AST_generic.ident -> string

(* expr conversions *)

exception NotAnExpr

(* A parameter that a call fills implicitly, outside its positional
 * arguments: a Scala `using` parameter ([AST_generic.using_tag]). *)
val is_context_param : AST_generic.parameter -> bool

(* An argument that fills a context parameter, as `x` in Scala's
 * `f(using x)` ([AST_generic.using_tag]). *)
val is_context_arg : AST_generic.argument -> bool

(* A [PatList] / [PatConstructor] holds "map pairs" when every element is
 * one of these: a [PatKeyVal], possibly wrapped by Elixir's map-pair tag. *)
val is_map_pair_pattern : AST_generic.pattern -> bool

(* The tag of a Java switch rule (`case 1 -> s`) among the cases of its
 * branch. *)
val is_switch_rule_arrow : AST_generic.case -> bool

(* A non-empty list of map pairs ([is_map_pair_pattern]). *)
val is_map_pair_list : AST_generic.pattern list -> bool

(* The [PatKeyVal] of a map pair, without Elixir's map-pair tag. *)
val unwrap_map_pair_pattern : AST_generic.pattern -> AST_generic.pattern

(* A map pattern: its entries and brackets, tagged "MapPattern", so that an
 * empty map or a map of only `...` is not a list pattern; with [~closed],
 * tagged "ClosedMapPattern": it matches only a map with no other keys. *)
val map_pattern :
  ?closed:bool ->
  AST_generic.pattern list AST_generic.bracket -> AST_generic.pattern

val is_closed_map_pattern : AST_generic.pattern -> bool

(* The bracketed entries of a map pattern built by [map_pattern]. *)
val map_pattern_entries :
  AST_generic.pattern -> AST_generic.pattern list AST_generic.bracket option

val expr_to_pattern : AST_generic.expr -> AST_generic.pattern

(* This executes some simplifications, such as not producing
   ExprStmt (StmtExpr ...)
*)
val expr_to_stmt : AST_generic.expr -> AST_generic.stmt

(* may raise NotAnExpr *)
val pattern_to_expr : AST_generic.pattern -> AST_generic.expr

(* may raise NotAnExpr *)
val argument_to_expr : AST_generic.argument -> AST_generic.expr
val expr_to_type : AST_generic.expr -> AST_generic.type_
val expr_to_class_parent : AST_generic.expr -> AST_generic.class_parent
val expr_to_entity_name_opt : AST_generic.expr -> AST_generic.entity_name option

val entity_of_pattern:
  ?attrs:AST_generic.attribute list -> AST_generic.pattern -> AST_generic.entity

(* should avoid; used mainly during expr->condition migration for If/While/..*)
val cond_to_expr : AST_generic.condition -> AST_generic.expr

(* stmt conversions *)

val vardef_to_assign :
  AST_generic.entity * AST_generic.variable_definition -> AST_generic.expr

(* only translates an assign to a vardef if we definitely have a name on the LHS *)
val assign_to_vardef_opt :
  AST_generic.expr * AST_generic.tok * AST_generic.expr ->
  AST_generic.stmt option

val funcdef_to_lambda :
  AST_generic.entity * AST_generic.function_definition ->
  AST_generic.resolved_name option ->
  AST_generic.expr

val funcbody_to_stmt : AST_generic.function_body -> AST_generic.stmt

(* name building *)

val name_of_id : ?case_insensitive:bool -> ?hidden:bool -> AST_generic.ident -> AST_generic.name

val name_of_ids :
  ?name_top:Tok.t -> ?case_insensitive:bool -> ?hidden:bool -> AST_generic.dotted_ident -> AST_generic.name

val name_of_ids_with_opt_typeargs :
  (AST_generic.ident * AST_generic.type_arguments option) list ->
  AST_generic.name

val add_id_opt_type_args_to_name :
  AST_generic.name ->
  AST_generic.ident * AST_generic.type_arguments option ->
  AST_generic.name

val add_type_args_to_name :
  AST_generic.name -> AST_generic.type_arguments -> AST_generic.name

val add_type_args_opt_to_name :
  AST_generic.name -> AST_generic.type_arguments option -> AST_generic.name

(* takes in a suffix, and then its name *)
val add_suffix_to_name :
  AST_generic.ident -> AST_generic.name -> AST_generic.name

(* Tries to re-interpreted a DotAccess expression a.b.c as an IdQualified. *)
val name_of_dot_access : AST_generic.expr -> AST_generic.name option

val name_of_entity_name :
  AST_generic.entity_name -> AST_generic.name option

(* name conversions *)

(* You should avoid this function! *)
val dotted_ident_of_name : AST_generic.name -> AST_generic.dotted_ident

(* misc *)

val id_of_name : AST_generic.name -> AST_generic.ident * AST_generic.id_info
val name_is_global : AST_generic.resolved_name_kind -> bool

val parameter_to_catch_exn_opt :
  AST_generic.parameter -> AST_generic.catch_exn option

val ctype_of_literal : AST_generic.literal -> AST_generic.const_type
val opt_to_label_ident : AST_generic.ident option -> AST_generic.label_ident

val reorder_fields_in_class_definition :
  AST_generic.class_definition -> AST_generic.class_definition

val has_keyword_attr :
  AST_generic.keyword_attribute -> AST_generic.attribute list -> bool

val abstract_for_comparison_any : AST_generic.any -> AST_generic.any
(** Abstract away position and svalue for comparison
 * with polymorphic operators.
*)

val is_associative_operator : AST_generic.operator -> bool
(** Test whether an operator is suitable for associative-matching.  *)

val ac_matching_nf :
  AST_generic.operator ->
  AST_generic.argument list ->
  AST_generic.expr list option
(** [ac_matching_nf op args] converts the operands [args] of an
 * AC-operator [op] to a normal form (NF) better suited for AC-matching.
 * Essentially, we flatten out all [op]-operations. Note that this is not
 * a canonical form (i.e., it is not a unique representation).
 * E.g.
 *    ac_matching_nf And [a; Call(Op And, [b; c])] = Some [a; b; c]
 * The function returns [None] if [op] is not an AC-operator. It also
 * returns [None] if the operands have an unexpected shape (see code),
 * in which case we just log an error and skip AC-matching (rather
 * than crashing). *)

val undo_ac_matching_nf :
  Tok.t ->
  AST_generic.operator ->
  AST_generic.expr list ->
  AST_generic.expr option
(** [undo_ac_matching_nf tok op args_nf] folds [args_nf] using [op]
 * (in a sense, it "undoes" [ac_matching_nf]). Here [tok] is the token of
 * the operand [op] in the source file. Note that this does not remember
 * the original grouping of the operands!
 * E.g.
 *    undo_ac_matching_nf tok And [a; b; c] = Call(Op And, [Call(Op And, [a; b]); c])
 *)

(* Sets the e_range on the expression based on the left and right tokens
 * provided. No-op if either has a fake location. *)
val set_e_range : Tok.t -> Tok.t -> AST_generic.expr -> unit

(* Sets the e_range on the expression to the range defined by the given anys.
 * Noop if no location information for the anys is available (including if the
 * any list is empty). *)
val set_e_range_with_anys : AST_generic.any list -> AST_generic.expr -> unit
val ii_of_any : AST_generic.any -> Tok.t list
val info_of_any : AST_generic.any -> Tok.t

(* may raise NoTokenLocation *)
val first_info_of_any : AST_generic.any -> Tok.t
val range_of_tokens_unsafe : Tok.t list -> Tok_range.t
val range_of_tokens : Tok.t list -> Tok_range.t option
val range_of_any_opt : AST_generic.any -> (Tok.location * Tok.location) option

val nearest_any_of_pos :
  AST_generic.program ->
  int ->
  (AST_generic.any * (Tok.location * Tok.location)) option

val fix_token_locations_any :
  (Tok.location -> Tok.location) -> AST_generic.any -> AST_generic.any

val fix_token_locations_program :
  (Tok.location -> Tok.location) -> AST_generic.program -> AST_generic.program

val add_semicolon_to_last_var_def_and_convert_to_stmts :
  AST_generic.sc ->
  (AST_generic.entity * AST_generic.variable_definition) list ->
  AST_generic.stmt list

val add_semicolon_to_last_def_and_convert_to_stmts :
  AST_generic.sc -> AST_generic.definition list -> AST_generic.stmt list

val ident_of_parameter_opt : AST_generic.parameter -> AST_generic.ident option

val any_of_function_body : AST_generic.function_body -> AST_generic.any