(**************************************************************************)
(*                                                                        *)
(*                                 OCaml                                  *)
(*                                                                        *)
(*            Gabriel Scherer, projet Parsifal, INRIA Saclay              *)
(*                                                                        *)
(*   Copyright 2017 Institut National de Recherche en Informatique et     *)
(*     en Automatique.                                                    *)
(*                                                                        *)
(*   All rights reserved.  This file is distributed under the terms of    *)
(*   the GNU Lesser General Public License version 2.1, with the          *)
(*   special exception on linking described in the file LICENSE.          *)
(*                                                                        *)
(**************************************************************************)

(** Rewrite paths for reproducible builds

  {b Warning:} this module is unstable and part of
  {{!Compiler_libs}compiler-libs}.

*)

type path = string

type path_prefix = string

type error_message = string

type ('a, 'b) result =
  | Ok of 'a
  | Error of 'b

val encode_prefix : path_prefix -> string

val decode_prefix : string -> (path_prefix, error_message) result

type pair =
  { target : path_prefix
  ; source : path_prefix
  }

val encode_pair : pair -> string

val decode_pair : string -> (pair, error_message) result

type map = pair option list

val encode_map : map -> string

val decode_map : string -> (map, error_message) result

val rewrite_opt : map -> path -> path option
(** [rewrite_opt map path] tries to find a source in [map]
    that is a prefix of the input [path]. If it succeeds,
    it replaces this prefix with the corresponding target.
    If it fails, it just returns [None]. *)

val rewrite : map -> path -> path

val flip : map -> map

val get_build_path_prefix_map : unit -> map option
