Add compat module. (#4)

README.md

@@ -45,6 +45,21 @@ Please note that `dune install` installs the file under the same local directory
 This option is meant to be used when packaging the library for distributions using binary packages such
 as debian or ubuntu packages, RPM package etc.
 
+## Migration form 1.x.x
+
+The library's API was update and cleaned up in its version `2.0.0` as part of the migration to support OCaml `5.0.0`. As a 
+consequence, modules depending on the old library are now incompatible with the new library.
+
+If you were previously using the `CamomileLibraryDefault` module, all you should have to do is
+use the new top-level `Camomile` module.
+
+If you were previously using the configuration functor to define your own library, you should be able to
+use the new `Camomile.Make` functor available at top-level as well.
+
+Otherwise, you can check the `compat/` directory of this repository. It contains a simple compatibility
+library that you should be able to re-use in your code. We do, however, recommend simply updating your 
+code to the new API. It really shouldn't be too hard!
+
 ## Using libraries
 
 ### Configuration

camomile.opam

@@ -1,6 +1,6 @@
 # This file is generated by dune, edit dune-project instead
 opam-version: "2.0"
-version: "2.0.0"
+version: "2.0.1"
 synopsis: "A Unicode library"
 description: """
 Camomile is a Unicode library for OCaml. Camomile provides Unicode character

compat/camomileDefaultConfig.ml

@@ -0,0 +1 @@
+include Camomile.DefaultConfig

compat/camomileDefaultConfig__.ml

@@ -0,0 +1 @@
+module InstallConfig = CamomileDefaultConfig__InstallConfig

compat/camomileDefaultConfig__InstallConfig.ml

@@ -0,0 +1 @@
+let share_dir = Filename.dirname Camomile.DefaultConfig.datadir

compat/camomileLibrary.ml

@@ -0,0 +1,15 @@
+[@@@ocaml.deprecated
+"this module is deprecated, please update to the most recent camomile API"]
+
+include Camomile
+module CharEncoding = CamomileLib.CharEncoding
+module UCharInfo = CamomileLib.UCharInfo
+module UNF = CamomileLib.UNF
+module UCol = CamomileLib.UCol
+module CaseMap = CamomileLib.CaseMap
+module UReStr = CamomileLib.UReStr
+module StringPrep = CamomileLib.StringPrep
+
+module ConfigInt = struct
+  module type Type = CamomileLib.Config.Type
+end

compat/camomileLibraryDefault.ml

@@ -0,0 +1,2 @@
+module Config = CamomileDefaultConfig
+module Camomile = Camomile

compat/camomileLibraryDyn.ml

@@ -0,0 +1 @@
+include CamomileLibraryDefault

compat/dune

@@ -0,0 +1,9 @@
+(env
+ (dev
+  (flags
+   (:standard -w -3))))
+
+(library
+ (name camomileCompat)
+ (libraries camomile camomile.lib)
+ (wrapped false))

dune-project

@@ -2,7 +2,7 @@
 (using dune_site 0.1)
 
 (name camomile)
-(version 2.0.0)
+(version 2.0.1)
 
 (generate_opam_files true)
 (license "LGPL-2.0-or-later WITH OCaml-LGPL-linking-exception")

src/charmaps/dune.inc

@@ -1,5 +1,6 @@
 
 (install
+ (package camomile)
  (section (site (camomile charmaps)))
  (files
    ANSI_X3%2E110-1983.mar

src/charmaps/dune_gen.ml

@@ -74,6 +74,7 @@ let () =
   let pr fmt = Printf.bprintf buf (fmt ^^ "\n") in
   pr "";
   pr "(install";
+  pr " (package camomile)";
   pr " (section (site (camomile charmaps)))";
   pr " (files";
   List.iter to_install ~f:(fun fn -> pr "   %s" fn);

src/database/dune

@@ -1,4 +1,5 @@
 (install
+ (package camomile)
  (section
   (site
    (camomile database)))

src/locales/dune.inc

@@ -1,6 +1,7 @@
 
 
 (install
+ (package camomile)
  (section (site (camomile locales)))
  (files
    af.mar

src/locales/dune_gen.ml

@@ -21,6 +21,7 @@ let () =
     {|
 
 (install
+ (package camomile)
  (section (site (camomile locales)))
  (files
    %s

src/mappings/dune

@@ -5,6 +5,7 @@
  (libraries str toolslib camomileLib))
 
 (install
+ (package camomile)
  (section
   (site
    (camomile mappings)))

test/tester/dune

@@ -16,7 +16,14 @@
   uCS4_test
   uReStr_test
   uTF16_test)
- (libraries stdlib-random.v4 unix str camomile camomile.lib blender tester_lib))
+ (libraries
+  stdlib-random.v4
+  unix
+  str
+  camomile
+  camomile.lib
+  blender
+  tester_lib))
 
 (rule
  (alias runtest)