Enhance the Augeas.Error exception
[ocaml-augeas.git] / augeas.ml
1 (* Augeas OCaml bindings
2  * Copyright (C) 2008 Red Hat Inc., Richard W.M. Jones
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  *
18  * $Id: augeas.ml,v 1.2 2008/05/06 10:48:20 rjones Exp $
19  *)
20
21 type t
22
23 type flag =
24   | AugSaveBackup
25   | AugSaveNewFile
26   | AugTypeCheck
27   | AugNoStdinc
28   | AugSaveNoop
29   | AugNoLoad
30
31 type error_code =
32   | AugErrInternal
33   | AugErrPathX
34   | AugErrNoMatch
35   | AugErrMMatch
36   | AugErrSyntax
37   | AugErrNoLens
38   | AugErrMXfm
39   | AugErrNoSpan
40   | AugErrMvDesc
41   | AugErrCmdRun
42   | AugErrBadArg
43   | AugErrLabel
44   | AugErrCpDesc
45   | AugErrUnknown of int
46
47 exception Error of error_code * string * string * string
48
49 type path = string
50
51 type value = string
52
53 external create : string -> string option -> flag list -> t
54   = "ocaml_augeas_create"
55 external close : t -> unit
56   = "ocaml_augeas_close"
57 external get : t -> path -> value option
58   = "ocaml_augeas_get"
59 external exists : t -> path -> bool
60   = "ocaml_augeas_exists"
61 external insert : t -> ?before:bool -> path -> string -> unit
62   = "ocaml_augeas_insert"
63 external rm : t -> path -> int
64   = "ocaml_augeas_rm"
65 external matches : t -> path -> path list
66   = "ocaml_augeas_match"
67 external count_matches : t -> path -> int
68   = "ocaml_augeas_count_matches"
69 external save : t -> unit
70   = "ocaml_augeas_save"
71 external load : t -> unit
72   = "ocaml_augeas_load"
73
74 let () =
75   Callback.register_exception "Augeas.Error" (Error (AugErrInternal, "", "", ""))