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 type transform_mode =
  48   | Include
  49   | Exclude
  50
  51 exception Error of error_code * string * string * string
  52
  53 type path = string
  54
  55 type value = string
  56
  57 external create : string -> string option -> flag list -> t
  58   = "ocaml_augeas_create"
  59 external close : t -> unit
  60   = "ocaml_augeas_close"
  61 external get : t -> path -> value option
  62   = "ocaml_augeas_get"
  63 external exists : t -> path -> bool
  64   = "ocaml_augeas_exists"
  65 external insert : t -> ?before:bool -> path -> string -> unit
  66   = "ocaml_augeas_insert"
  67 external rm : t -> path -> int
  68   = "ocaml_augeas_rm"
  69 external matches : t -> path -> path list
  70   = "ocaml_augeas_match"
  71 external count_matches : t -> path -> int
  72   = "ocaml_augeas_count_matches"
  73 external save : t -> unit
  74   = "ocaml_augeas_save"
  75 external load : t -> unit
  76   = "ocaml_augeas_load"
  77 external set : t -> path -> value option -> unit
  78   = "ocaml_augeas_set"
  79 external transform : t -> string -> string -> transform_mode -> unit
  80   = "ocaml_augeas_transform"
  81 external source : t -> path -> path option
  82   = "ocaml_augeas_source"
  83
  84 let () =
  85   Callback.register_exception "Augeas.Error" (Error (AugErrInternal, "", "", ""))