caml-list - the Caml user's mailing list
 help / Atom feed
From: Ivan Gotovchits <ivg@ieee.org>
To: Jun Inoue <jun.lambda@gmail.com>
Cc: caml list <caml-list@inria.fr>
Subject: Re: [Caml-list] Type That's Concrete From Within A Library Abstract From Without
Date: Thu, 26 Apr 2018 11:06:21 -0400
Message-ID: <CALdWJ+ybpxNYtp3Pu75pWL_F=0=TfVGx8k0mBXbmJb+_QSSmLw@mail.gmail.com> (raw)
In-Reply-To: <CA+ZA8QzuJg8iZC=aktSNKhnJuHU0ghVOuCV5X05t+5D2bJd5xA@mail.gmail.com>

[-- Attachment #1: Type: text/plain, Size: 2678 bytes --]

Hi Jun,

You can achieve this by implying an extra layer of indirection, i.e., by
having two levels of interfaces. For example,

   * A.ml - implementation of module A
   * A.mli - private interface of module A
   * B.ml  - implementation of module B that may rely on anything in A.mli
   * Std.ml - a set of modules that you would like to import, e.g., `module
A = A`, `module B = B`
   * Std.mli - public interface specification


Next, you deploy `std.cmxa` and `std.cmi` but keep `a.cmi` and `b.cmi` to
yourself. This will prevent users from accessing your private modules A and
B directly. (In oasis you can use PrivateModules stanza for this)

Now you will have `Std.A` and `Std.B` that exposes as much as you want. Not
sure whether it will work with the `-pack`, but you can use this approach
instead of it. This is how we address the same issue in [BAP][1]

Cheers,
Ivan

[1]: https://github.com/BinaryAnalysisPlatform/bap


On Thu, Apr 26, 2018 at 10:18 AM, Jun Inoue <jun.lambda@gmail.com> wrote:

> Dear list,
>
> Is there a way to make a type concrete inside a library, yet opaque to
> library users, preferably in a way that works with -pack?  This is a
> nagging issue in our sundials package
> (http://inria-parkas.github.io/sundialsml/).
>
> Basically, we have a type declared in one module of the library that
> is pattern-matched upon in other modules, like:
>
> (* private.ml *)
> type opaque_type = Foo | Bar
>
> (* public.ml *)
> let f : opaque_type -> int = function
>   | Foo -> 0
>   | Bar -> 1
>
> There are a few constraints:
> - We don't want users to be able to pattern-match on opaque_type.
> - We need multiple modules in the library to pattern-match on
> opaque-type (so moving opaque_typ e to public.ml is not an option).
> - To avoid namespace pollution, we want to pack the whole library
> (with ocamlc -pack) as a single Sundials module, so the user sees a
> Sundials.Public module instead of just Public.
>
> Is this possible?  Right now, we just collect public.cmo and
> private.cmo into sundials.cma and throw away private.cmi.  But this
> doesn't work with packing:
>
> $ ocamlc -pack -o sundials.cmo private.cmo public.cmo
>
> demands that there be a private.cmi.
>
> --
> Jun Inoue
>
> --
> Caml-list mailing list.  Subscription management and archives:
> https://sympa.inria.fr/sympa/arc/caml-list
> Beginner's list: http://groups.yahoo.com/group/ocaml_beginners
> Bug reports: http://caml.inria.fr/bin/caml-bugs
>

-- 
Caml-list mailing list.  Subscription management and archives:
https://sympa.inria.fr/sympa/arc/caml-list
Beginner's list: http://groups.yahoo.com/group/ocaml_beginners
Bug reports: http://caml.inria.fr/bin/caml-bugs

[-- Attachment #2: Type: text/html, Size: 3843 bytes --]

  parent reply index

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-04-26 14:18 Jun Inoue
2018-04-26 14:28 ` Malcolm Matalka
2018-04-26 15:04 ` Nicolás Ojeda Bär
2018-04-26 15:14   ` Nicolás Ojeda Bär
2018-07-06  8:08   ` Timothy Bourke
2018-07-06  8:44     ` Gabriel Scherer
2018-07-06  9:05       ` Timothy Bourke
2018-04-26 15:06 ` Ivan Gotovchits [this message]
2018-04-27  5:49   ` Jun Inoue
2018-04-27  6:06     ` Jacques Garrigue
2018-04-27  8:53       ` Jun Inoue
2018-04-27 11:21         ` Elie Canonici Merle
2018-04-29 10:39         ` Mikhail Mandrykin

Reply instructions:

You may reply publically to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='CALdWJ+ybpxNYtp3Pu75pWL_F=0=TfVGx8k0mBXbmJb+_QSSmLw@mail.gmail.com' \
    --to=ivg@ieee.org \
    --cc=caml-list@inria.fr \
    --cc=jun.lambda@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

caml-list - the Caml user's mailing list

Archives are clonable: git clone --mirror https://inbox.ocaml.org/caml-list

AGPL code for this site: git clone https://public-inbox.org/ public-inbox