File: pa_deriving_Json.mli

package info (click to toggle)
js-of-ocaml 2.2-2
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 7,612 kB
  • ctags: 10,589
  • sloc: ml: 36,459; makefile: 665; lisp: 41; sh: 14; ruby: 4; perl: 4
file content (49 lines) | stat: -rw-r--r-- 1,848 bytes parent folder | download | duplicates (2)
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
(* Js_of_ocaml
 * http://www.ocsigen.org
 * Copyright Hugo Heuzard 2014.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, with linking exception;
 * either version 2.1 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*)

(** Deriving_json syntax extension (based on the {i deriving} library).
    @see <https://github.com/ocsigen/deriving> the source code of {i deriving}
    @see <http://code.google.com/p/deriving/> the documentation of the original {i deriving} library by Jeremy Yallop.
*)

(**
[type typ = .. deriving (Json)] with generate
{[module Json_typ : sig
  type a = typ
  val to_string : a -> string
  val from_string : string -> a
  ...
end]}
*)

open Pa_deriving_common
open Defs

val register_predefs : Type.qname -> Type.qname -> unit
(** [register_predefs typeA typeB] tells the syntax extension
    that [typeB] is an alias for [typeA].
    The extension syntax will then use the deriving_json implementation
    of [typeB] in place of [typeA]'s one.

    Important note: TypeB does NOT HAVE TO actually exists.

    In practive, you may need to use this in the following cases:
     - use deriving_json on types from external libraries that do not use deriving
     - use deriving_json on abstract types
*)