source/analysis/astEnvironment.mli

(*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *)

open Ast
open Core
open SharedMemoryKeys

type t

module ParserError : sig
  type t = {
    source_path: SourcePath.t;
    location: Location.t;
    is_suppressed: bool;
    message: string;
  }
  [@@deriving sexp, compare, hash]
end

module ReadOnly : sig
  type t

  val create
    :  ?get_processed_source:(track_dependency:bool -> Reference.t -> Source.t option) ->
    ?get_raw_source:(Reference.t -> (Source.t, ParserError.t) Result.t option) ->
    ?get_source_path:(Reference.t -> SourcePath.t option) ->
    ?all_explicit_modules:(unit -> Reference.t list) ->
    ?is_module_tracked:(Reference.t -> bool) ->
    unit ->
    t

  val get_processed_source : t -> ?track_dependency:bool -> Reference.t -> Source.t option

  val get_raw_source : t -> Reference.t -> (Source.t, ParserError.t) Result.t option

  val get_source_path : t -> Reference.t -> SourcePath.t option

  val get_relative : t -> Reference.t -> string option

  val get_real_path
    :  configuration:Configuration.Analysis.t ->
    t ->
    Reference.t ->
    PyrePath.t option

  val get_real_path_relative
    :  configuration:Configuration.Analysis.t ->
    t ->
    Reference.t ->
    string option

  val all_explicit_modules : t -> Reference.t list

  val is_module_tracked : t -> Reference.t -> bool
end

val module_tracker : t -> ModuleTracker.t

(* Store the environment to saved-state *)
val store : t -> unit

(* Load the environment from saved-state. Taking a `ModuleTracker` parameter just to signal that
   loading an `AstEnvironment` must be done after loading a `ModuleTracker` *)
val load : ModuleTracker.t -> t

val create : ?additional_preprocessing:(Source.t -> Source.t) -> ModuleTracker.t -> t

module UpdateResult : sig
  type t

  val triggered_dependencies : t -> DependencyKey.RegisteredSet.t

  val invalidated_modules : t -> Reference.t list

  val create_for_testing : unit -> t
end

type trigger =
  | Update of ModuleTracker.IncrementalUpdate.t list
  | ColdStart

val update
  :  configuration:Configuration.Analysis.t ->
  scheduler:Scheduler.t ->
  t ->
  trigger ->
  UpdateResult.t

val remove_sources : t -> Reference.t list -> unit

val read_only : t -> ReadOnly.t

val with_additional_preprocessing : additional_preprocessing:(Source.t -> Source.t) option -> t -> t