/usr/lib/ocaml/sexplib/path.mli is in libsexplib-camlp4-dev 113.00.00-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 | (** Path: Module for Substitutions within S-expressions *)
(** {6 Types} *)
(** Type of substitution elements *)
type el =
| Pos of int (** [Pos n] denotes [n]th element in a tuple *)
| Match of string * int
(** [Match (tag, n)] denotes [n]th argument of sum matching [tag] *)
| Rec of string (** [Rec name] denotes the record field having [name] *)
(** Type of substitution paths *)
type t = el list
(** {6 High-level functions} *)
val parse : string -> t
(** [parse str] @return a substitution path represented by string [str].
Syntax:
"." ->
separates path elements; must be present at start of string.
"\[4\]" ->
specifies the 4th element in a tuple.
"some_tag\[4\]" ->
tries to match [some_tag], then denotes its 4th argument.
"name" ->
denotes record field having [name]
Example from test code:
".t.x.B[1]" -> choose record field with name [t], then subfield
[x]. Match this value against [B], and denote its first argument.
@raise Failure if the path is syntactically invalid.
*)
val get : ?path : t -> ?str : string -> Sexp.t -> Sexp.t
(** [get ?path ?str sexp] if [path] is provided, use it as path.
Otherwise, if [str] is provided, parse it as a path. If neither
is provided, assume an empty path. @return the sub-expression from
S-expression [sexp] denoted by the path.
@raise Failure if path is syntactically invalid or if the path
structure clashes with the structure of the data.
*)
val replace : ?path : t -> ?str : string -> Sexp.t -> subst : Sexp.t -> Sexp.t
(** [replace ?path ?str sexp ~subst] like [get], but does not extract
a sub-expression but substitutes it with [subst]. @return resulting
S-expression.
@raise Failure if path is syntactically invalid or if the path
structure clashes with the structure of the data.
*)
val replace_no_path : str : string -> Sexp.t -> subst : Sexp.t -> Sexp.t
(** [replace_no_path ~str sexp ~subst] like [replace], but does not take
optional arguments. [str] must be specified.
@raise Failure if path is syntactically invalid or if the path
structure clashes with the structure of the data.
*)
val subst_path : Sexp.t -> t -> (Sexp.t -> Sexp.t) * Sexp.t
(** [subst_path sexp path] @return the tuple [(subst, sub)], where [subst]
is a function that returns an S-expression in which the subexpression
denoted by [path] in [sexp] has been substituted by its argument.
[sub] is the denoted subexpression. Note that [subst sub = sexp].
@raise Failure if path is syntactically invalid or if the path
structure clashes with the structure of the data.
*)
(** {6 Low-level functions} *)
val extract_pos : int -> Sexp.t -> (Sexp.t option -> Sexp.t) * Sexp.t
(** [extract_pos n sexp] @return the tuple [(subst, sub)], where [subst]
is a function that returns an S-expression in which the subexpression
denoted at position [n] in [sexp], which must be a list, has been
substituted by [value] if the optional argument is [Some value], or
removes the denoted subexpression if the optional argument is [None].
[sub] is the denoted subexpression. Note that [subst (Some sub) =
sexp].
@raise Failure if the position cannot be resolved within the given
S-expression.
*)
val extract_match :
string -> int -> Sexp.t -> (Sexp.t option -> Sexp.t) * Sexp.t
(** [extract_match tag n sexp] @return the tuple [(subst, sub)], where
[subst] is a function that returns an S-expression in which the
subexpression denoted by matching [tag] and taking its [n]th argument
in [sexp] has been substituted by [value] if the argument is [Some
value], or removes the denoted subexpression if the optional argument
is [None]. [sub] is the denoted subexpression. Note that [subst
(Some sub) = sexp].
@raise Failure if the S-expression does not represent a sum tag.
*)
val extract_rec : string -> Sexp.t -> (Sexp.t -> Sexp.t) * Sexp.t
(** [extract_rec name sexp] @return the tuple [(subst, sub)], where
[subst] is a function that returns an S-expression in which the
subexpression denoted by matching field name [name] in [sexp] has
been substituted by its argument. [sub] is the denoted subexpression.
Note that [subst (Some sub) = sexp].
@raise Failure if the S-expression does not represent a record.
*)
|