Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a toplevel stanza #1713

Merged
merged 1 commit into from
Jan 14, 2019
Merged

Add a toplevel stanza #1713

merged 1 commit into from
Jan 14, 2019

Conversation

rgrinberg
Copy link
Member

@rgrinberg rgrinberg commented Dec 24, 2018 •
edited
Loading

As discussed in the retreat, a toplevel stanza is useful.

A couple of points:

  • It's possible to improve this feature further with subsystems. This might be useful to give things like mdx and our toplevel tests first class support.

  • There are some buildable flags that make sense on the toplevel stanza that haven't been included yet. We can include those flags now or perhaps add them later when there's a real need.

@rgrinberg rgrinberg requested review from emillon and a user December 24, 2018 20:13
@avsm
Copy link
Member

avsm commented Dec 31, 2018

Just so I understand this feature's scope, is it a solution to #688? I.e. will the toplevel stanza generate a .top subpackage that installs printers for the toplevel reliably?

@rgrinberg
Copy link
Member Author

@avsm I had not considered that. Thinking about this now, I'm not sure if generating a top subpackage would be so useful. It's not going to be automatically loaded in the toplevel, right?

The point of this PR is to easily construct toplevel executables. This generalizes $ dune utop, and allows us to use any underlying toplevel library. So the motivation is to support things like mdx, and dune's own toplevel test framework. It would be nice if the produced toplevel executables would come with the printers already loaded, but it's not the main goal of this PR.

@avsm
Copy link
Member

avsm commented Dec 31, 2018

That makes sense! I do think it would be useful to automatically and systematically expose a way to have top packages, and load then automatically into dune utop. But that is indeed a different feature.

@rgrinberg
Copy link
Member Author

Okay, I've added some tests for this feature and will shortly add documentation. Since the feature seems to be taken well, I'd like to ask for some feedback on how to extend this feature in a next PR to support user defined/custom toplevels.

What I'd like is a way for users to create their own custom toplevel libraries. The idea being to implement things such as our expect_test.mll library. I see a couple of possibilities:

  • We could let the user specify a main field where they can write the function that will start the toplevel. They'll need to specify the toplevel library in the list of libraries. It's a bit annoying to have to specify this if you're defining several toplevels of the same type however.

  • We could have the user specify a toplevel_library that would be responsible for initializing the toplevel. I'm wondering if this approach will be tricky from the point of side effects. I.e. we want to make sure that Clflags.include is loaded before the library executes.

Other suggestions are welcome.

@ghost
Copy link

ghost commented Jan 10, 2019

The first option seems better to me, and in practice it's unlikely users will define more than one toplevel. Another option would be to make toplevel behave a bit like exeuctable. I.e. you wouldn't need a separate library for the entry point of the toplevel, however that would make it harder to define both a library and a toplevel in the same directory.

BTW, given that we have dune utop, should we make it easy to declare custom utop toplevels? For instance by adding a (utop) field to the toplevel stanza?

ghost
ghost reviewed Jan 10, 2019
View reviewed changes
src/toplevel.ml Outdated Show resolved Hide resolved
@rgrinberg
Copy link
Member Author

BTW, given that we have dune utop, should we make it easy to declare custom utop toplevels? For instance by adding a (utop) field to the toplevel stanza?

Would this be mutually exclusive with setting main? We could also have a kind parameter like this:

type kind =
  | Vanila
  | Utop
  | Custom of string (* main *)

@ghost
Copy link

ghost commented Jan 10, 2019

It would yeah. The kind parameter seems good.

@rgrinberg rgrinberg mentioned this pull request Jan 14, 2019
Closed
@rgrinberg rgrinberg force-pushed the toplevel-stanza branch 2 times, most recently from 9a7faf2 to 8482a76 Compare January 14, 2019 20:41
@rgrinberg
Add a toplevel stanza
47fda75 
Re-implement the utop toplevel on top of it

Signed-off-by: Rudi Grinberg <rudi.grinberg@gmail.com>
@rgrinberg
Copy link
Member Author

Docs & Issue to track the issue above are added.

@rgrinberg rgrinberg merged commit 6eae7f7 into ocaml:master Jan 14, 2019
rgrinberg added a commit to rgrinberg/opam-repository that referenced this pull request Feb 12, 2019
@rgrinberg
[new release] dune (1.7.0)
674b1ed 
CHANGES:

- Second step of the deprecation of jbuilder: the `jbuilder` binary
  now emits a warning on every startup and both `jbuilder` and `dune`
  emit warnings when encountering `jbuild` files (ocaml/dune#1752, @diml)

- Change the layout of build artifacts inside _build. The new layout enables
  optimizations that depend on the presence of `.cmx` files of private modules
  (ocaml/dune#1676, @bobot)

- Fix merlin handling of private module visibility (ocaml/dune#1653 @bobot)

- unstable-fmt: use boxes to wrap some lists (ocaml/dune#1608, fix ocaml/dune#1153, @emillon,
  thanks to @rgrinberg)

- skip directories when looking up programs in the PATH (ocaml/dune#1628, fixes
  ocaml/dune#1616, @diml)

- Use `lsof` on macOS to implement `--stats` (ocaml/dune#1636, fixes ocaml/dune#1634, @xclerc)

- Generate `dune-package` files for every package. These files are installed and
  read instead of `META` files whenever they are available (ocaml/dune#1329, @rgrinberg)

- Fix preprocessing for libraries with `(include_subdirs ..)` (ocaml/dune#1624, fix ocaml/dune#1626,
  @nojb, @rgrinberg)

- Do not generate targets for archive that don't match the `modes` field.
  (ocaml/dune#1632, fix ocaml/dune#1617, @rgrinberg)

- When executing actions, open files lazily and close them as soon as
  possible in order to reduce the maximum number of file descriptors
  opened by Dune (ocaml/dune#1635, ocaml/dune#1643, fixes ocaml/dune#1633, @jonludlam, @rgrinberg,
  @diml)

- Reimplement the core of Dune using a new generic memoization system
  (ocaml/dune#1489, @rudihorn, @diml)

- Replace the broken cycle detection algorithm by a state of the art
  one from [this paper](https://doi.org/10.1145/2756553) (ocaml/dune#1489,
  @rudihorn)

- Get the correct environment node for multi project workspaces (ocaml/dune#1648,
  @rgrinberg)

- Add `dune compute` to call internal memoized functions (ocaml/dune#1528,
  @rudihorn, @diml)

- Add `--trace-file` option to trace dune internals (ocaml/dune#1639, fix ocaml/dune#1180, @emillon)

- Add `--no-print-directory` (borrowed from GNU make) to suppress
  `Entering directory` messages. (ocaml/dune#1668, @dra27)

- Remove `--stats` and track fd usage in `--trace-file` (ocaml/dune#1667, @emillon)

- Add virtual libraries feature and enable it by default (ocaml/dune#1430 fixes ocaml/dune#921,
  @rgrinberg)

- Fix handling of Control+C in watch mode (ocaml/dune#1678, fixes ocaml/dune#1671, @diml)

- Look for jsoo runtime in the same dir as the `js_of_ocaml` binary
  when the ocamlfind package is not available (ocaml/dune#1467, @nojb)

- Make the `seq` package available for OCaml >= 4.07 (ocaml/dune#1714, @rgrinberg)

- Add locations to error messages where a rule fails to generate targets and
  rules that require files outside the build/source directory. (ocaml/dune#1708, fixes
  ocaml/dune#848, @rgrinberg)

- Let `Configurator` handle `sizeof` (in addition to negative numbers).
  (ocaml/dune#1726, fixes ocaml/dune#1723, @Chris00)

- Fix an issue causing menhir generated parsers to fail to build in
  some cases. The fix is to systematically use `-short-paths` when
  calling `ocamlc -i` (ocaml/dune#1743, fix ocaml/dune#1504, @diml)

- Never raise when printing located errors. The code that would print the
  location excerpts was prone to raising. (ocaml/dune#1744, fix ocaml/dune#1736, @rgrinberg)

- Add a `dune upgrade` command for upgrading jbuilder projects to Dune
  (ocaml/dune#1749, @diml)

- When automatically creating a `dune-project` file, insert the
  detected name in it (ocaml/dune#1749, @diml)

- Add `(implicit_transitive_deps <bool>)` mode to dune projects. When this mode
  is turned off, transitive dependencies are not accessible. Only listed
  dependencies are directly accessible. (ocaml/dune#1734, ocaml/dune#430, @rgrinberg, @hnrgrgr)

- Add `toplevel` stanza. This stanza is used to define toplevels with libraries
  already preloaded. (ocaml/dune#1713, @rgrinberg)

- Generate `.merlin` files that account for normal preprocessors defined using a
  subset of the `action` language. (ocaml/dune#1768, @rgrinberg)

- Emit `(orig_src_dir <path>)` metadata in `dune-package` for dune packages
  built with `--store-orig-source-dir` command line flag (also controlled by
  `DUNE_STORE_ORIG_SOURCE_DIR` env variable). This is later used to generate
  `.merlin` with `S`-directives pointed to original source locations and thus
  allowing merlin to see those. (ocaml/dune#1750, @andreypopp)

- Improve the behavior of `dune promote` when the files to be promoted have been
  deleted. (ocaml/dune#1775, fixes ocaml/dune#1772, @diml)

- unstable-fmt: preserve comments (ocaml/dune#1766, @emillon)

- Pass flags correctly when using `staged_pps` (ocaml/dune#1779, fixes ocaml/dune#1774, @diml)

- Fix an issue with the use of `(mode promote)` in the menhir
  stanza. It was previously causing intermediate *mock* files to be
  promoted (ocaml/dune#1783, fixes ocaml/dune#1781, @diml)

- unstable-fmt: ignore files using OCaml syntax (ocaml/dune#1784, @emillon)

- Configurator: Add `which` function to replace the `which` command line utility
  in a cross platform way. (ocaml/dune#1773, fixes ocaml/dune#1705, @Chris00)

- Make configurator append paths to `$PKG_CONFIG_PATH` on macOS. Previously it
  was prepending paths and thus `$PKG_CONFIG_PATH` set by users could have been
  overridden by homebrew installed libraries (ocaml/dune#1785, @andreypopp)

- Disallow c/cxx sources that share an object file in the same stubs archive.
  This means that `foo.c` and `foo.cpp` can no longer exist in the same library.
  (ocaml/dune#1788, @rgrinberg)

- Forbid use of `%{targets}` (or `${@}` in jbuild files) inside
  preprocessing actions
  (ocaml/dune#1812, fixes ocaml/dune#1811, @diml)

- Add `DUNE_PROFILE` environment variable to easily set the profile. (ocaml/dune#1806,
  @rgrinberg)

- Deprecate the undocumented `(no_keep_locs)` field. It was only
  necessary until virtual libraries were supported (ocaml/dune#1822, fix ocaml/dune#1816,
  @diml)

- Rename `unstable-fmt` to `format-dune-file` and remove its `--inplace` option.
  (ocaml/dune#1821, @emillon).

- Autoformatting: `(using fmt 1.1)` will also format dune files (ocaml/dune#1821, @emillon).

- Autoformatting: record dependencies on `.ocamlformat-ignore` files (ocaml/dune#1824,
  fixes ocaml/dune#1793, @emillon)
@rgrinberg rgrinberg mentioned this pull request Feb 12, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@emillon emillon emillon approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rgrinberg @avsm @emillon