package pfff

  1. Overview
  2. Docs
Tools and APIs for program analysis, code visualization, refactoring

Install 

dune-project
 Dependency

github.com Edit opam file Versions (8)

Authors

  1. Y
    Yoann Padioleau <yoann.padioleau@gmail.com>

Maintainers

  1. Y
    yoann.padioleau@gmail.com

Sources

0.37.1.tar.gz
sha256=d5be49a8ee9d26bff98b902533e0bde59cf1613a6e8f15651492205434f35c0e
md5=637a4f055de86bf02ad372b45e5567a9

doc/pfff-h_program-lang/Database_code/index.html

Module Database_code

type entity_id = int
type entity = {
  1. e_kind : Entity_code.entity_kind;
  2. e_name : string;
  3. e_fullname : string;
  4. e_file : Common.filename;
  5. e_pos : Common2.filepos;
  6. mutable e_number_external_users : int;
  7. mutable e_good_examples_of_use : entity_id list;
  8. e_properties : Entity_code.property list;
}
type database = {
  1. root : Common.dirname;
  2. dirs : (Common.filename * int) list;
  3. files : (Common.filename * int) list;
  4. entities : entity array;
}
val empty_database : unit -> database
val default_db_name : string
val load_database : Common.filename -> database
val save_database : database -> Common.filename -> unit
val merge_databases : database -> database -> database
val alldirs_and_parent_dirs_of_relative_dirs : Common.dirname list -> Common.dirname list
val files_and_dirs_database_from_files : root:Common.dirname -> Common.filename list -> database
val adjust_method_or_field_external_users : verbose:bool -> entity array -> unit
val build_top_k_sorted_entities_per_file : k:int -> entity array -> (Common.filename, entity list) Hashtbl.t
val files_and_dirs_and_sorted_entities_for_completion : threshold_too_many_entities:int -> database -> entity list
val entity_kind_of_highlight_category_def : Highlight_code.category -> Entity_code.entity_kind option
val entity_kind_of_highlight_category_use : Highlight_code.category -> Entity_code.entity_kind option
val is_entity_def_category : Highlight_code.category -> bool
val matching_def_short_kind_kind : Entity_code.entity_kind -> Entity_code.entity_kind -> bool
val matching_use_categ_kind : Highlight_code.category -> Entity_code.entity_kind -> bool
val entity_and_highlight_category_correpondance : entity -> Highlight_code.category -> bool