Module Clang__.Clang__utils

parse_file ?index ?command_line_args ?unsaved_files ?options filename parses file filename and returns its translation unit. This function is equivalent to Clang.parse_translation_unit2, with, by default, a fresh index (created by Clang.create_index true true), an empty list for command_line_args and unsaved_files, and default options (obtained by Clang.default_editing_translation_unit_options). See also Clang.Ast.parse_file which returns a pattern-matchable representation of the AST.

Equivalent to parse_file but returns a result instead of raising Failure _ if parsing fails.

parse_string ?index ?filename ?command_line_args ?unsaved_files ?options contents parses string contents and returns its translation unit. This function calls Clang.parse_file with an unsaved file called filename (by default, <string>.c) with contents: this unsaved file is consed to the list unsaved_files (by default, an empty list). Note that filename should have the .cpp suffix to parse C++ code (for instance, <string>.cpp). See also Clang.Ast.parse_string which returns a pattern-matchable representation of the AST.

Equivalent to parse_string but returns a result instead of raising Failure _ if parsing fails.

iter_children f cur calls f over all the direct child nodes of cur.

list_of_children cur returns the list of all the direct child nodes of cur.

iter_type_fields f ty calls f over all the declaration nodes of the fields belonging to the record type ty (either a struct or union). See also Clang.Type.iter_fields for a higher-level interface.

list_of_type_fields f ty returns the list of all the declaration nodes of the fields belonging to the record type ty (either a struct or union).

iter_decl_context f c calls f over all the declaration nodes of declaration context c.

list_of_decl_context f ty returns the list of all the declaration nodes of declaration context c.

list_of_iter iter calls iter f and returns all the values which f has been applied to.

Integer or floating point types

is_integer ty returns true if ty is a built-in integer type.

is_unsigned_integer ty returns true if ty is a built-in integer type that is unsigned.

is_signed_integer ty returns true if ty is a built-in integer type that is signed.

is_floating_point ty returns true if ty is a built-in floating-point type.

int64_of_cxint_opt ~signed x returns Some i if x is representable as a 64-bit integer value i, or None otherwise. signed specifies if x is signed (default: true).

int64_of_cxint x returns i if x is representable as a 64-bit integer value i, or raises Invalid_argument _ otherwise. signed specifies if x is signed (default: true).

int_of_cxint_opt x returns Some i if x is representable as an integer value i, or None otherwise. signed specifies if x is signed (default: true).

int_of_cxint x returns i if x is representable as an integer value i, or raises Invalid_argument _ otherwise. signed specifies if x is signed (default: true).

string_of_cxint f is an alias for Clang__bindings.ext_int_to_string, radix 10. signed specifies if x is signed (default: true).

float_of_cxfloat_opt x returns Some f if x is a floating-point value with either IEEE single or double semantics, or None otherwise.

float_of_cxfloat x returns f if x is a floating-point value with either IEEE single or double semantics, or raises Invalid_argument _ otherwise.

string_of_cxfloat f is an alias for Clang__bindings.ext_float_to_string.

string_of_cxerrorcode ec returns a message describing ec.

seq_of_diagnostics tu returns the diagnostics (notes, warnings, errors, ...) produced for the given translation unit

concrete_of_cxsourcelocation kind location returns the concrete location associated to location. kind selects whether Clang.get_presumed_location (which ignores # line directive) or Clang.get_expansion_location (which honors # line directive) is called.

string_of_severity severity returns a string describing the severity: this string is used as prefix for the diagnostic in pp_diagnostic.

pp_diagnostic ?options fmt diag formats diagnostic diag, mimicking Clang__bindings.format_diagnostic behavior. Clang__types.Display_source_location.t.kind supports various location kinds whereas Clang__bindings.format_diagnostic only displays spelling locations.

format_diagnostics ?pp severities fmt tu formats the diagnostics produced for the given translation unit. Only the diagnostics, the severity of which is listed in severities are displayed. If there is a printer given in pp, then this printer is called once if and only if there is at least one diagnostic to display, and pp should call the printer passed in its first argument to display the diagnostics. In the case there is no diagnostic to display, nothing is printed.

error contains the severities Error and Fatal.

warning_or_error contains the severities Warning, Error and Fatal.

not_ignored_diagnostics contains the severities Note, Warning, Error and Fatal.

all_diagnostics contains the severities Ignored, Note, Warning, Error and Fatal.

has_severity l tu returns whether the translation unit tu produced a diagnostic, the severity of which belongs to l.

cursor_get_translation_unit cursor returns the translation unit associated to cursor.

sourcelocation_get_translation_unit location returns the translation unit associated to location.