Module Core.ContextSource

Context - Storage for flow-insensitive information

The context is a heterogeneous key-value map that stores non-semantical information, such as a description of the program being currently analyzed, the callstack, etc.

For instance, to create a new kind of entries for storing strings, first generate a new context key:

  module K = GenContextKey
      (struct
        type 'a t = string
        let print pp fmt s = fprintf fmt "string: %s" s
      end)
  let string_key = K.key

Then, given a context 'a ctx, you can add/remove elements as follows:

  let ctx'  = add_ctx string_key "a" ctx in
  let ctx'' = remove_ctx string_key ctx'

Note that the context can contain the abstract state. For instance, to store a cache of input/output states for each function, you can do:

  module K = GenContextKey
      (struct
        type 'a t = (string*'a flow*'a post) list
        let print pp fmt cache =
          fprintf fmt "functions I/O cache:@,  @[<v>%a@]"
            (pp_print_list
              ~pp_sep:(fun fmt () -> fprintf fmt "@,")
              (fun (f,input,output) ->
                 fprintf "%s:@, input:@[%a]@, output:@[%a@]"
                   f
                   (Flow.print pp) input
                   (Post.print pp) output
              )
            ) cache
      end)
  let cache_key = K.key