caml-list - the Caml user's mailing list
 help / color / mirror / Atom feed
From: Gabriel Scherer <gabriel.scherer@gmail.com>
To: "Richard W.M. Jones" <rich@annexia.org>
Cc: caml users <caml-list@inria.fr>
Subject: Re: [Caml-list] #use is not textual inclusion
Date: Sat, 29 Feb 2020 10:09:51 +0100	[thread overview]
Message-ID: <CAPFanBFcX2gLbdBVt=k+S6P79x2VpSH3CURQmecauR6xgJm=Ww@mail.gmail.com> (raw)
In-Reply-To: <20200229085319.GD11122@rich.annexia.org>

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

I think that your example is rejected not because of the semantics of #use,
but because toplevel directives in general are parsed at the level of
toplevel *phrases*, and not possibly-in-depth structure items. In other
words, a toplevel script is a sequence of structure items or toplevel
directives, but directives are not (nestable) structure items. The
documentation seems correct -- consistent with this behavior.

I see a way to do what you want using #mod_use, but it is a bit indirect
because #mod_use does not directly support signature checking:

    module type Foo_sig = sig ... end
    #mod_use "implementation.ml";;
    module Foo = (Implementation : Foo_sig);;

This approach defines a suitably restricted Foo, but it also exposes the
Implementation module in the rest of the scope. You can avoid this if you
use the same .ml name as the module name you want, so that shadowing hides
the implementation module

    module type Foo_sig = sig ... end
    #mod_use "foo.ml <http://implementation.ml>";;
    module Foo = (Foo : Foo_sig);;


On Sat, Feb 29, 2020 at 9:54 AM Richard W.M. Jones <rich@annexia.org> wrote:

> I was trying to break up a large ocaml interpreted script:
>
>   https://github.com/libguestfs/libnbd/blob/master/generator/generator
>
> The script contains sections like:
>
>   module Foo : sig
>   (* type signature *)
>   end = struct
>   (* very long implementation *)
>   end
>
> and it would be convenient for me to move the implementations into
> separate files.  However this doesn't work:
>
>   module Foo : sig
>   (* type signature *)
>   end = struct
>   #use "implementation.ml"  (* with or without ;; here *)
>   end
>
> So I guess #use only works for top level statements, which surprised
> me and contradicts the documentation here too:
>
>
> https://caml.inria.fr/pub/docs/manual-ocaml/toplevel.html#s%3Atoplevel-directives
>
> I could move the whole module definition to the file, but then I would
> lose the advantage of hiding the implementation while keeping the
> signature visible in the main file.
>
> Given the constraint that we can't use ocamlc or cppo (because of
> minimal build dependencies), are there any alternatives?  My first
> thought was C's cpp, but it seems impossible to get that working with
> #!/usr/bin/env and preserve the "scriptiness" of being able to just do
> ./generator/generator to run it.
>
> Rich.
>

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

  reply	other threads:[~2020-02-29  9:06 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-02-29  8:53 Richard W.M. Jones
2020-02-29  9:09 ` Gabriel Scherer [this message]
2020-02-29 10:32   ` Richard W.M. Jones

Reply instructions:

You may reply publicly 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='CAPFanBFcX2gLbdBVt=k+S6P79x2VpSH3CURQmecauR6xgJm=Ww@mail.gmail.com' \
    --to=gabriel.scherer@gmail.com \
    --cc=caml-list@inria.fr \
    --cc=rich@annexia.org \
    /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
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).