CHANGES.md 31 KB
Newer Older
1 2
# Changes

3 4 5 6 7 8
## 2018/11/XX

* When a cycle of `%inline` nonterminal symbols is encountered,
  the error message now shows the entire cycle,
  as opposed to just one symbol that participates in the cycle.

9
## 2018/11/13
POTTIER Francois's avatar
POTTIER Francois committed
10 11 12 13 14 15

* In `.mly` files, a new syntax for rules has been introduced, which is
  slightly more pleasant than the old syntax. (A rule is the definition of a
  nonterminal symbol.) The old syntax remains available; the user chooses
  between the two syntaxes on a per-rule basis. The new syntax is fully
  documented in the manual;
16
  [a brief summary of the differences](doc/new-rule-syntax-summary.md)
POTTIER Francois's avatar
POTTIER Francois committed
17 18 19
  with respect to the old syntax is also available.
  **The new syntax is considered experimental**
  and is subject to change in the near future.
POTTIER Francois's avatar
POTTIER Francois committed
20 21 22 23 24

* In the Coq back-end, avoid pattern-matching at type `int31`,
  which will disappear in future versions of Coq.
  Instead, convert `int31` to `Z`, and perform pattern matching in `Z`.
  (Reported by Vincent Laporte, implemented by Jacques-Henri Jourdan.)
25

26 27 28 29 30
* Implement a more economical renaming scheme for OCaml variables
  during the elimination of `%inline` symbols. This leads to slightly
  more readable code (more reasonable variables names, fewer `let`
  bindings).

31 32 33
* Another attempt at removing all trailing spaces in auto-generated
  `.messages` files. (I hope I got it right, this time.)

34 35 36 37 38 39 40 41 42 43
## 2018/10/26

* A new syntactic sugar facility, "token aliases", has been added.
  The declaration of a terminal symbol may also declare an alias,
  which takes the form of a name between double quotes, as in
  `%token PLUS "+"`.
  Thereafter, `"+"` may be used freely in place of `PLUS` throughout
  the grammar. This makes it slightly easier to read grammars.
  (Contributed by Perry E. Metzger.)

44 45 46 47 48 49 50
* Until today, the semicolon character `;` was insignificant: it was
  considered as whitespace by Menhir. It is now accepted only in a
  few specific places, namely: after a declaration; after a rule;
  after a producer. If Menhir suddenly complains about a semicolon,
  just remove it. This change is being made in preparation for
  further syntactic changes.

51
* New flag `--no-dollars`, which disallows the use of `$i` in semantic actions.
52
  The default behavior remains to allow the use of `$i`.
53 54 55 56 57

* When generating OCaml code, include all record fields in record patterns,
  even when bound to a wildcard pattern. Thus, avoid triggering OCaml's
  warning 9.

58
## 2018/10/06
POTTIER Francois's avatar
POTTIER Francois committed
59

60
* Standard library: add `rev`, `flatten`, `append`.
61 62
  Add a link from the manual to `standard.mly` in the repository.

63 64
* Update the manual to explain how to use `dune` and `menhir` together.

POTTIER Francois's avatar
POTTIER Francois committed
65
* Install `.cmxs` files for menhirLib and menhirSdk.
66

67 68 69 70
* Remove all references to `Pervasives` in the generated OCaml code.
  These references were infrequent anyway,
  and `Pervasives` is about to be deprecated in OCaml 4.08, it seems.

71 72
* In `--interpret` mode, print `Ready!` once ready to accept input.

73 74 75 76 77 78
* At verbosity level `-lg 2`, for each nonterminal symbol `N`, display
  a sentence (composed of terminal symbols) of minimal length generated
  by `N`.

* When writing a `.cmly` file, open it in binary mode. This should
  eliminate the failure that was observed under Windows:
79 80 81 82 83
  `output_value: not a binary channel`. (Reported by Bryan Phelps.
  A fix was present in the `mingw` patches for Menhir.)

* Change the logic used in the root `Makefile` to deal with Unix and Windows
  in a uniform way. (Also inspired by the `mingw` patches for Menhir.)
84

85 86 87
* Coq back-end: add a few newlines in the generated file for readability.
  (Suggested by Bernhard Schommer.)

88 89 90
* Remove the trailing space at the end of every sentence in
  auto-generated `.messages` files. (Suggested by Xavier Leroy.)

91 92 93 94 95 96 97 98 99 100
## 2018/09/05

* When `--explain` is enabled, always create a fresh `.conflicts` file
  (wiping out any pre-existing file), even if there are in fact no conflicts.
  This should avoid confusion with outdated `.conflicts` files.

* Fix several bugs in the treatment of `--strict`. No `.conflicts` file
  was created when `--strict` and `--explain` were both enabled. Also,
  some warnings were not properly turned into errors by `--strict`.

101 102 103 104
## 2018/07/04

* Update the `man` page, which was woefully out of date.

105 106 107 108 109 110 111 112
## 2018/07/03

* New location keywords.
  `$loc` is sugar for the pair `($startpos, $endpos)`.
  `$loc(x)` is sugar for the pair `($startpos(x), $endpos(x))`.
  `$sloc` is sugar for the pair `($symbolstartpos, $endpos)`.
  (Contributed by Nicolás Ojeda Bär.)

113 114 115 116 117 118 119 120
## 2018/06/08

* Add two new parameterized nonterminal symbols, `endrule(X)` and `midrule(X)`,
  to the standard library. These symbols have been available since 2015/02/11
  under the names `anonymous(X)` and `embedded(X)`, but were not yet documented.
  `endrule(X)` and `midrule(X)` are now documented,
  while `anonymous(X)` and `embedded(X)` remain present but are deprecated.

121 122 123 124 125 126 127 128 129 130 131 132 133 134
## 2018/05/30

* In `--coq` mode, Menhir now produces references to `MenhirLib.Grammar`
  instead of just `Grammar`, and similarly for all modules in Menhir's support
  library.

* New command line option `--coq-lib-no-path` to suppress the above behavior
  and retain the previous (now-deprecated) behavior, that is, produce
  unqualified references the modules in Menhir's support library.

* New command line option `--coq-lib-path <path>` to indicate under what name
  (or path) the support library has been installed. Its default value is
  `MenhirLib`.

POTTIER Francois's avatar
POTTIER Francois committed
135 136 137
## 2018/05/23

* New commands `--infer-write-query`, `--infer-read-reply`, and
138 139 140 141 142 143 144 145 146 147 148 149
  `--infer-protocol-supported`. These commands remove the need for Menhir to
  invoke `ocamlc` and `ocamldep` behind the scenes, and make it easier to
  write correct build rules for Menhir projects. The command line options
  `--infer`, `--raw-depend` and `--depend` remain supported, but are no longer
  preferred. (Suggested by Fabrice Le Fessant.)

* Remove the warning that was issued when `%inline` was used but `--infer` was
  turned off. Most people should use a build system that knows how to enable
  OCaml type inference, such as `ocamlbuild` or `dune`.

* New HTML rendering of the manual, available both online and as part of
  Menhir's installation. (Implemented by Gabriel Scherer.)
POTTIER Francois's avatar
POTTIER Francois committed
150

151 152 153 154 155 156
## 2017/12/22

* Add a flag `--unused-precedence-levels` to suppress all warnings about
  useless `%left`, `%right`, `%nonassoc` and `%prec` declarations.
  (Suggested by Zachary Tatlock.)

POTTIER Francois's avatar
POTTIER Francois committed
157 158 159 160
## 2017/12/06

* Fix the termination test that takes place before parameterized symbols are
  expanded away. The previous test was both unsound (it would accept grammars
POTTIER Francois's avatar
POTTIER Francois committed
161 162 163
  whose expansion did not terminate) and incomplete (it would reject grammars
  whose expansion did terminate). The new test is believed to be sound and
  complete. (Thanks to Martin Bodin for prompting us to look into this issue.)
POTTIER Francois's avatar
POTTIER Francois committed
164

POTTIER Francois's avatar
POTTIER Francois committed
165 166 167 168 169
## 2017/11/12

* Documentation: clarify the fact that `%type` declarations should carry types
  whose meaning does not depend on the headers `%{ ... %}`.

170 171 172 173 174 175
## 2017/10/13

* Remove the OCaml version check at installation time, for greater simplicity,
  and because for some reason it did not work properly under Cygwin.
  (Reported by Andrew Appel.)

176 177 178 179 180 181 182
## 2017/09/26

* `Makefile` fix: when determining whether the suffix `.exe` should be used,
  one should test whether the OS is Windows,
  not whether the compiler is MSVC.
  (Suggested by Jonathan Protzenko.)

POTTIER Francois's avatar
POTTIER Francois committed
183 184 185 186 187 188 189 190
## 2017/07/12

* Include the LaTeX sources of the manual in the official `.tar.gz` archive.
  This should allow the manual to be included as part of the Debian package.

* Mention [Obelisk](https://github.com/Lelio-Brun/Obelisk),
  a pretty-printer for `.mly` files, in the manual.

191 192 193 194 195
## 2017/06/07

* Removed an undeclared dependency of MenhirSdk on Unix. (Reported and fixed
  by Frédéric Bour.)

POTTIER Francois's avatar
POTTIER Francois committed
196 197 198 199 200 201 202 203
## 2017/05/09

* Menhir now always places OCaml line number directives in the generated `.ml`
  file. (Until now, this was done only when `--infer` was off.) Thus, if a
  semantic action contains an `assert` statement, the file name and line
  number information carried by the `Assert_failure` exception should now be
  correct. (Reported by Helmut Brandl.)

204
## 2017/04/18
POTTIER Francois's avatar
POTTIER Francois committed
205

POTTIER Francois's avatar
POTTIER Francois committed
206 207
* Changed Menhir's license from QPL to GPLv2.
  MenhirLib remains under LGPLv2, with a linking exception.
208

POTTIER Francois's avatar
POTTIER Francois committed
209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
* Moved the repository to
  [gitlab.inria.fr](https://gitlab.inria.fr/fpottier/menhir/).

* Introduced a new command line switch, `--cmly`, which causes Menhir to
  create a `.cmly` file, containing a description of the grammar and
  automaton. (Suggested by Frédéric Bour.)

* Introduced a new library, MenhirSdk, which allows reading a `.cmly` file.
  The purpose of this library is to allow external tools to take advantage
  of the work performed by Menhir's front-end. (Suggested by Frédéric Bour.)

* Introduced new syntax for attributes in a `.mly` file. Attributes are
  ignored by Menhir's back-ends, but are written to `.cmly` files, thus
  can be exploited by external tools via MenhirSdk. (Suggested by Frédéric Bour.)

224 225 226
* The definition of a `%public` nonterminal symbol can now be split into several
  parts within a single `.mly` file. (This used to be permitted only over
  multiple `.mly` files.) (Suggested by Frédéric Bour.)
227

POTTIER Francois's avatar
POTTIER Francois committed
228 229 230 231 232 233 234 235 236
* New functions in the incremental API:
  `shifts`, `acceptable`, `current_state_number`.

* New functions in the incremental API and inspection API:
  `top`, `pop`, `pop_many`, `get`, `equal`,
  `force_reduction`, `feed`, `input_needed`,
  `state_has_default_reduction`,
  `production_index`, `find_production`.
  (Suggested by Frédéric Bour.)
237

238 239 240 241 242
* New module `MenhirLib.ErrorReports`. This module is supposed to offer
  auxiliary functions that help produce good syntax error messages.
  This module does not yet contain much functionality and is expected
  to evolve in the future.

243 244 245 246
* Incompatible change in the incremental API: the type `env` becomes `'a env`.

* Incompatible change in the incremental API: the function
  `has_default_reduction` is renamed `env_has_default_reduction`.
247

248 249 250 251 252
* The type `stack` and the function `stack` in the incremental API are
  deprecated. The new functions `top` and `pop` can be used instead to
  inspect the parser's stack. The module `MenhirLib.General` is deprecated
  as well. Deprecated functionality will be removed in the future.

POTTIER Francois's avatar
POTTIER Francois committed
253 254 255 256 257
* Incompatible change in the incremental API: the type of the function
  `print_stack` in the result signature of the functor
  `MenhirLib.Printers.Make` changes to `'a env -> unit`.
   (Anyway, as of now, `MenhirLib.Printers` remains undocumented.)

POTTIER Francois's avatar
POTTIER Francois committed
258 259 260
* Improved the syntax error message that is displayed when a `.mly` file
  is incorrect: the previous and next token are shown.

261 262
* Fixed a bug where the module name `Basics` was shadowed (that is, if the user's
  project happened to contain a toplevel module by this name, then it could not
POTTIER Francois's avatar
POTTIER Francois committed
263
  be referred to from a `.mly` file). (Reported by François Thiré.)
264

265
## 2017/01/01
266 267 268 269 270

* Add `$MENHIR_STDLIB` as a way of controlling where Menhir looks for the file
  `standard.mly`. This environment variable overrides the installation-time
  default setting, and is itself overridden by the `--stdlib` command line
  switch. (Requested by Jonathan Protzenko.)
POTTIER Francois's avatar
POTTIER Francois committed
271

272 273 274
* `Makefile` fix: filter out `'\r'` in the output of `menhir --suggest-ocamlfind`,
  so that the `Makefile` works when Menhir is compiled as a Windows executable.
  (Suggested by Jonathan Protzenko.)
275

276
## 2016/12/01
277 278 279

* Updated the Coq back-end for compatibility with Coq 8.6.
  (Jacques-Henri Jourdan.)
POTTIER Francois's avatar
POTTIER Francois committed
280

281
## 2016/11/15
282 283 284 285 286 287

* Fix in `--only-preprocess-for-ocamlyacc` mode: avoid printing newline characters
  inside a `%type` declaration, as this is forbidden by `ocamlyacc`. (Reported by
  Kenji Maillard.)
* Fix in `--only-preprocess-for-ocamlyacc` mode: avoid variable capture caused by
  `ocamlyacc` internally translating `$i` to `_i`. (Reported by Kenji Maillard.)
288

289
## 2016/09/01
290 291 292 293 294

* New command line switch `--only-preprocess-for-ocamlyacc`, supposed to print the
  grammar in a form that `ocamlyacc` can accept. As of now, this feature is
  incomplete (in particular, support for Menhir's position keywords is missing),
  untested, and undocumented. It could be removed in the future.
POTTIER Francois's avatar
POTTIER Francois committed
295

296
## 2016/08/26
297 298

* Fixes in the output of `--only-preprocess`:
299 300 301 302
  * The order of productions is now preserved.
      (It was not. This matters if there are reduce/reduce conflicts.)
  * `%parameter` directives are now printed. (They were not).
  * `%on_error_reduce` directives are now printed. (They were not.)
303

304
## 2016/08/25
305 306 307 308

* `Makefile` fix, undoing a change made on 2016/03/03, which caused installation
  to fail under (some versions of?) Windows where dynamic linking is not
  supported. (Reported by Andrew Appel.)
309

310
## 2016/08/05
311 312 313 314 315

* `%on_error_reduce` declarations now have implicit priority levels, so as to
  tell Menhir what to do when two such declarations are applicable.
  Also, the well-formedness checks on `%type` and `%on_error_reduce` declarations
  have been reinforced.
POTTIER Francois's avatar
POTTIER Francois committed
316

317
## 2016/06/23
318 319 320 321 322 323

* A small change in the generated code (both in the code and table back-ends) so
  as to avoid OCaml's warning 41. The warning would arise (when compiling a
  generated parser with OCaml 4.03) because Menhir's exception `Error` has the
  same name as the data constructor `Error` in OCaml's pervasive library.
  (Reported by Bernhard Schommer.)
324

325
## 2016/05/18
326 327 328 329 330

* Anonymous rules now work also when used inside a parameterized rule.
  (This did not work until now.) When an anonymous rule is hoisted out
  of a parameterized rule, it may itself become parameterized. Menhir
  parameterizes it only over the parameters that it actually needs.
331

332
## 2016/05/04
333 334 335 336 337

* In the Coq backend, split the largest definitions into smaller
  ones. This circumvents a limitation of vm_compute on 32 bit
  machines. This also enables us to perform sharing between
  definitions, so that the generated files are much smaller.
Jacques-Henri Jourdan's avatar
Jacques-Henri Jourdan committed
338

339
## 2016/04/10
340 341 342

* When printing a grammar (which is done by the `--only-preprocess` options),
  remove the leading bar `|`, for compatibility with `yacc` and `bison`.
POTTIER Francois's avatar
POTTIER Francois committed
343

344
## 2016/03/11
345 346 347 348 349

* In the code back-end, generate type annotations when extracting a semantic
  value out of the stack. When working with a semantic value of some function
  type, OCaml would incorrectly warn that this function does not use its
  argument. This warning should now be gone.
350

351
## 2016/03/03
352 353 354

* Makefile changes, so as to support `ocamlbuild` 4.03, which seems to have
  stricter hygiene rules than previous versions.
POTTIER Francois's avatar
POTTIER Francois committed
355

356
## 2015/12/30
357 358 359 360

* Prevented an incorrect installation that would take place if `USE_OCAMLFIND`
  was given during `make all` but not during `make install`. Added a command
  line directive `--suggest-ocamlfind`.
361

362
## 2015/11/11
363 364 365 366

* Fixed a severe bug in Menhir 20151110 which (when using the code back-end)
  could cause a generated parser to crash. Thanks to ygrek for reporting the
  bug.
POTTIER Francois's avatar
POTTIER Francois committed
367

368
* The code produced by version `XXXXXXXX` of `menhir --table` can now be linked only
369 370 371
  against a matching version of MenhirLib. If an incorrect version of MenhirLib
  is installed, the OCaml compiler should complain that
  `MenhirLib.StaticVersion.require_XXXXXXXX` is undefined.
372

373
## 2015/11/10
374 375 376

* Optimized the computation of `$symbolstartpos`, based on a couple of assumptions
  about the lexer. (See the manual.)
POTTIER Francois's avatar
POTTIER Francois committed
377

378
## 2015/11/04
379 380 381 382 383

* Modified the treatment of `%inline` so that the positions that are computed are
  the same, regardless of whether `%inline` is used. This property did not hold
  until now. It now does. Of course, this means that the positions computed by
  the new Menhir are not the same as those computed by older versions of Menhir.
POTTIER Francois's avatar
POTTIER Francois committed
384

385 386 387
* Fixed a bug in the treatment of `%inline` that would lead to an incorrect
  position being computed when the caller and callee had a variable by the
  same name.
POTTIER Francois's avatar
POTTIER Francois committed
388

389 390 391 392 393 394 395 396
* Modified Menhir so as to compute the start and end positions in the exact same
  way as `ocamlyacc`. (There used to be a difference in the treatment of epsilon
  productions.) Of course, this means that the positions computed by the new
  Menhir are not the same as those computed by older versions of Menhir. Added
  the keyword `$symbolstartpos` so as to simulate `Parsing.symbol_start_pos()`
  in the `ocamlyacc` world. The keyword `$startpos` sometimes produces a position
  that is too far off to the left; `$symbolstartpos` produces a more accurate
  position.
POTTIER Francois's avatar
POTTIER Francois committed
397

398 399 400
* Incompatible change of the incremental API: instead of a unit argument, the
  entry points (which are named after the start symbols) now require an initial
  position, which typically should be `lexbuf.lex_curr_p`.
401

402
## 2015/11/03
403 404 405

* Fix-fix-and-re-fix the `Makefile` in an attempt to allow installation under
  opam/Windows. Thanks to Daniel Weil for patient explanations and testing.
406

407
## 2015/10/29
408 409 410 411 412 413

* MenhirLib is now installed in both binary and source forms.
  `menhir --suggest-menhirLib` reports where MenhirLib is installed.
  This can be used to retrieve a snapshot of MenhirLib in source form
  and include it in your project (if you wish to use `--table` mode, yet
  do not wish to have a dependency on MenhirLib).
414

415
## 2015/10/26
416 417 418 419

* Allow `--list-errors` to work on 32-bit machines (with low hard limits).
  This should fix a problem whereby the 2015/10/23 release could not
  bootstrap on a 32-bit machine.
420

421
## 2015/10/23
422 423 424 425 426 427 428 429 430

* New declaration `%on_error_reduce foo`, where `foo` is a nonterminal symbol.
  This modifies the automaton as follows. In every state where a production of
  the form `foo -> ...` is ready to be reduced, every error action is replaced
  with a reduction of this production. (If there is a conflict between several
  productions that could be reduced in this manner, nothing is done.) This does
  not affect the language that is accepted by the automaton, but delays the
  detection of an error: more reductions take place before the error is
  detected.
POTTIER Francois's avatar
POTTIER Francois committed
431

432 433 434 435
* Fixed a bug whereby Menhir would warn about a useless `%prec` declaration,
  even though it was useful. This would happen when the declaration was
  duplicated (by inlining or by macro-expansion) and some but not all of
  the copies were useful.
436

437
* Added `has_default_reduction` to the incremental API.
438

439 440 441 442
* Modified the meaning of `--canonical` to allow default reductions to take
  place. This implies no loss of precision in terms of lookahead sets,
  and should allow gaining more contextual information when a syntax
  error is encountered. (It should also lead to a smaller automaton.)
443

444 445 446 447 448 449 450 451 452 453 454 455 456 457
* A brand new set of tools to work on syntax errors.
* New command `--list-errors`, which produces a list of input sentences which
  are representative of all possible syntax errors. (Costly.)
* New command `--interpret-error`, which confirms that one particular input
  sentence ends in a syntax error, and prints the number of the state in
  which this error occurs.
* New command `--compile-errors`, which compiles a list of erroneous sentences
  (together with error messages) to OCaml code.
* New command `--compare-errors`, which compares two lists of erroneous sentences
  to check if they cover the same error states.
* New command `--update-errors`, which updates the auto-generated comments in
  a list of erroneous sentences.
* New command `--echo-errors`, which removes all comments and messages from
  a list of erroneous sentences, and echoes just the sentences.
POTTIER Francois's avatar
POTTIER Francois committed
458

459
## 2015/10/16
460 461

* Additions to the incremental API.
462 463 464 465 466 467 468
  * A `supplier` is a function that produces tokens on demand.
  * `lexer_lexbuf_to_supplier` turns a lexer and a lexbuf into a supplier.
  * `loop` is a ready-made made main parsing loop.
  * `loop_handle` is a variant that lets the user do her own error handling.
  * `loop_handle_undo` is a variant that additionally allows undoing the last
    few "spurious" reductions.
  * `number` maps a state of the LR(1) automaton to its number.
469 470 471 472

* Incompatible change of the incremental API: renamed the type `'a result`
  to `'a checkpoint`. This is a better name anyway, and should help avoid
  confusion with the type `'a result` introduced in OCaml 4.03.
473

474
## 2015/10/12
475 476

* Avoid using `$(shell pwd)` in `Makefile`, for better Windows compatibility.
477

478
## 2015/10/05
479 480 481

* Fixed a bug where inconsistent OCaml code was generated when `--table`
  and `--external-tokens` were used together. (Reported by Darin Morrison.)
482

483 484
* In `--infer` mode, leave the `.ml` file around (instead of removing it) if
  `ocamlc` fails, so we have a chance to understand what's wrong.
485

486
## 2015/09/21
487 488 489

* Re-established some error messages concerning the mis-use of `$i` which
  had disappeared on 2015/06/29.
POTTIER Francois's avatar
POTTIER Francois committed
490

491
## 2015/09/11
492 493 494 495 496

* Fixed the mysterious message that would appear when a nonterminal symbol
  begins with an uppercase letter and `--infer` is turned on. Clarified the
  documentation to indicate that a (non-start) nonterminal symbol can begin
  with an uppercase letter, but this is not recommended.
497

498
## 2015/08/27
499 500 501 502 503 504

* New option `--inspection` (added last January, documented only now). This
  generates an inspection API which allows inspecting the automaton's stack,
  among other things. This API can in principle be used to write custom code
  for error reporting, error recovery, etc. It is not yet mature and may
  change in the future.
505

506
## 2015/07/20
507 508

* Added the command line options `--unused-token <symbol>` and `--unused-tokens`.
509

510
## 2015/06/29
511 512 513 514 515

* Changed the treatment of the positional keywords `$i`. They are now
  rewritten into variables of the form `_i` where `i` is an integer.
  Users are advised not to use variables of this form inside semantic
  actions.
Yann Régis-Gianas's avatar
Yann Régis-Gianas committed
516

517
## 2015/02/11
518 519 520 521 522

* Added support for anonymous rules. This allows writing, e.g.,
  `list(e = expression SEMI { e })`
  whereas previously one should have written
  `list(terminated(e, SEMI))`.
523

524
## 2015/02/09
525 526

* Moved all of the demos to `ocamlbuild` (instead of `make`).
527

528
## 2015/01/18
529 530 531

* Incompatible change of the incremental API.
  The incremental API now exposes shift events too.
532

533
## 2015/01/16
534 535 536 537

* Fixed a couple bugs in `Makefile` and `src/Makefile` which would cause
  compilation and installation to fail with `TARGET=byte`. (Reported
  by Jérémie Courrèges-Anglas and Daniel Dickman.)
538

539
## 2015/01/01
540 541 542

* Incompatible change of the incremental API.
  The entry point `main_incremental` is now named `Incremental.main`.
543

544
## 2014/12/29
545 546

* Incompatible change of the incremental API.
547 548 549 550 551
  * The API now exposes reduction events.
  * The type `'a result` is now private.
  * The type `env` is no longer parameterized.
  * `handle` is renamed to `resume`.
  * `offer` and `resume` now expect a result, not an environment.
552

553
## 2014/12/22
554 555

* Documented the Coq back-end (designed and implemented by Jacques-Henri Jourdan).
556

557
## 2014/12/15
558 559

* New incremental API (in `--table` mode only), inspired by Frédéric Bour.
POTTIER Francois's avatar
POTTIER Francois committed
560

561
## 2014/12/11
562

563 564 565 566 567 568 569
* Menhir now reports an error if one of the start symbols produces
  either the empty language or the singleton language {epsilon}.

* Although some people out there actually define a start symbol that recognizes
  {epsilon} (and use it as a way of initializing or re-initializing some global
  state), this is considered bad style. Furthermore, by ruling out this case, we
  are able to simplify the table back-end a little bit.
570

571
## 2014/12/12
572 573

* A speed improvement in the code back-end.
POTTIER Francois's avatar
POTTIER Francois committed
574

575
## 2014/12/08
576 577

* Menhir now requires OCaml 4.02 (instead of 3.09).
578

579
## 2014/12/02
580 581 582

* Removed support for the `$previouserror` keyword.
* Removed support for `--error-recovery` mode.
583

584
## 2014/02/18
585

586 587 588 589
* In the Coq backend, use `'` instead of `_` as separator in identifiers.
  Also, correct a serious bug that was inadvertently introduced on
  2013/03/01 (r319).

590
## 2014/02/14
591 592 593

* Lexer fix so as to support an open variant type `[> ...]` within
  a `%type<...>` declaration.
594

595
## 2013/12/16
596 597 598 599 600

* Updated the `Makefile` so that `install` no longer depends on `all`.

* Updated the demos so that the lexer does not invoke `exit 0`
  when encoutering `eof`. (This should be more intuitive.)
fpottier's avatar
fpottier committed
601

602
## 2013/09/11
603 604 605

* Fixed a newline conversion problem that would prevent Menhir from
  building on Windows when using ocaml 4.01.
606

607
## 2013/03/02
608 609 610

* Switched to ocamlbuild. Many thanks to Daniel Weil for offering
  very useful guidance.
fpottier's avatar
fpottier committed
611

612
## 2013/01/16
613 614 615

* `menhir --depend` was broken since someone added new whitespace in the output
  of `ocamldep`. Fixed.
616

617
## 2012/12/19
618 619 620 621

* Fixed a compilation problem that would arise when a file produced
  by Menhir on a 64-bit platform was compiled by ocaml on a 32-bit
  platform.
622

623
## 2012/08/25
624 625 626 627

* Performance improvements in the computation of various information
  about the automaton (module `Invariant`). The improvements will be
  noticeable only for very large automata.
628

629
## 2012/06/07
630 631 632

* The option `--log-grammar 3` (and above) now causes the `FOLLOW` sets for
  terminal symbols to be computed and displayed.
633

634
## 2012/05/25
635 636 637 638 639

* Added the flag `--canonical`, which causes Menhir to produce a canonical LR(1)
  automaton in the style of Knuth. This means that no merging of states takes
  place during the construction of the automaton, and that no default reductions
  are allowed.
640

641
## 2012/01/23
642 643 644 645 646 647

* Fixed a bug whereby a `%nonassoc` declaration was not respected. This
  declaration requests that a shift/reduce conflict be reduced in favor of
  neither shifting nor reducing, that is, a syntax error must occur. However,
  due to an unforeseen interaction with the default reduction mechanism, this
  declaration was sometimes ignored and reduction would take place.
648

649
## 2012/01/09
650 651 652

* Changes in the (undocumented) Coq back-end so as to match the ESOP 2012
  paper.
653

654
## 2011/10/19
655 656 657

* The `Makefile` now tests whether Unix or Windows is used (the test is performed
  by evaluating `Sys.os_type` under `ocaml`) and changes a couple settings accordingly:
658 659
  * the executable file name is either `menhir` or `menhir.exe`
  * the object file suffix is either `.o` or `.obj`
660 661 662

* Added `--strict`, which causes many warnings about the grammar and about the
  automaton to be considered errors.
663

664 665 666 667 668 669
* The `#` annotations that are inserted in the generated `.ml` file now retain their
  full path. (That is, we no longer use `Filename.basename`.) This implies that
  the `#` annotations depend on how Menhir is invoked
  -- e.g., `menhir foo/bar.mly` and `cd foo && menhir bar.mly` will produce different
  results. Nevertheless, this seems reasonable and useful (e.g., in conjunction
  with `ocamlbuild` and a hierarchy of files). Thanks to Daniel Weil.
670

671
## 2011/10/06
672 673

* With the `-lg 1` switch, Menhir now indicates whether the grammar is SLR(1).
674

675
## 2011/05/24
676 677 678 679

* Removed the lock in `ocamldep.wrapper`. It is the responsibility of the user
  to avoid interferences with other processes (or other instances of the script)
  that create and/or remove files.
680

681
## 2011/04/28
682 683 684 685 686

* The (internal) computation of the automaton's invariant was broken and has
  been fixed. Surprisingly, this does not seem to affect the generated code,
  (which was correct,) so no observable bug is fixed. Hopefully no bug is
  introduced!
687

688
## 2011/04/07
689 690 691 692

* The grammar description files (`.mly`) are now read in up front and stored in
  memory while they are parsed. This allows us to avoid the use of `pos_in` and
  `seek_in`, which do not work correctly when CRLF conversion is being performed.
693

694
## 2011/04/05
695 696 697

* Fixed a bug in the type inference module (for parameterized non-terminals)
  which would cause an infinite loop.
698

699
## 2011/01/24
700 701 702 703 704

* Fixed a bug that would cause an assertion failure in the generated parser
  in some situations where the input stream was incorrect and the grammar
  involved the error token. The fix might cause grammars that use the error
  token to behave differently (hopefully more accurately) as of now.
705

706
## 2009/06/18
707 708 709

* `Makefile` changes: build and install only the bytecode version of MenhirLib
  when `TARGET=byte` is set.
710

711
## 2009/02/06
712 713 714

* Fixed `ocamldep.wrapper` to avoid quoting the name of the `ocaml` command.
  This is hoped to fix a compilation problem under MinGW.
715

716
## 2009/02/04
717 718 719

* A `Makefile` fix to avoid a problem under Windows/Cygwin.
* Renamed the `ocaml-check-version` script so as to avoid a warning.
720

721
## 2008/09/05
722 723

* Ocaml summer project: added `--interpret`, `--table`, and `--suggest-*`.
724

725
## 2008/08/06
726 727 728

* Fixed a problem that would cause the code inliner to abort when a semantic
  value and a non-terminal symbol happened to have the same name.
729

730
* Removed code sharing.
731

732
## 2008/06/20
733 734

* Removed an incorrect assertion that caused failures (`lr1.ml`, line 134).
735

736
## 2007/12/05
737 738 739

* Disabled code sharing by default, as it is currently broken. (See Yann's
  message; assertion failure at runtime.)
740

741
## 2007/12/01
742 743 744

* Added an optimization to share code among states that have identical
  outgoing transition tables.
745

746
## 2007/08/30
747 748 749

* Small `Makefile` change: create an executable file for `check-ocaml-version` in
  order to work around the absence of dynamic loading on some platforms.
750

751
## 2007/05/20
752 753 754 755

* Made a fundamental change in the construction of the LR(1) automaton
  in order to eliminate a bug that could lead to spurious conflicts --
  thanks to Ketti for submitting a bug report.
756

757
## 2007/05/18
758 759 760

* Added `--follow-construction` to help understand the construction of the
  LR(1) automaton (very verbose).
761

762
## 2007/05/11
763 764 765 766 767

* Code generation: more explicit qualifications with `Pervasives` so as
  to avoid capture when the user redefines some of the built-in operators,
  such as `(+)`.
* Added a new demo (`calc-param`) that shows how to use `%parameter`.
768

769
## 2007/03/22
770 771 772

* `Makefile` improvements (check for `PREFIX`; bootstrap in bytecode now
  also available). Slight changes to `OMakefile.shared`.
773

774
## 2007/02/15
775 776

* Portability fix in `Makefile` and `Makefile.shared` (avoided `which`).
777

778
## 2006/12/15
779 780

* Portability fix in `Makefile.shared` (replaced `&>` with `2>&1 >`).
781

782
## 2006/06/23
783 784 785 786

* Made a slight restriction to Pager's criterion so as to never introduce
  fake conflict tokens (see `Lr0.compatible`). This might help make conflict
  explanations more accurate in the future.
787

788
## 2006/06/16
789 790

* Fixed bug that would cause positions to become invalid after inlining.
791

792
## 2006/06/15
793 794 795 796

* Fixed `--depend` to be more lenient when analyzing `ocamldep`'s output.
* Added `--raw-depend` which transmits `ocamldep`'s output unchanged (for
  use in conjunction with `omake`).
797

798
## 2006/06/12
799 800 801 802 803 804 805 806 807 808

* Fixed bug that would cause `--only-preprocess` to print `%token` declarations
  also for pseudo-tokens.
* Fixed bug that caused some precedence declarations to be incorrectly
  reported as useless.
* Improved things so that useless pseudo-tokens now also cause warnings.
* Fixed bug that would cause `%type` directives for terminal symbols to
  be incorrectly accepted.
* Fixed bug that would occur when a semantic action containing `$i` keywords
  was inlined.
809

810
## 2006/05/05
811 812 813

* Fixed problem that caused some end-of-stream conflicts not to be reported.
* Fixed Pager's compatibility criterion to avoid creating end-of-stream conflicts.
814

815
## 2006/04/21
816 817 818 819

* Fixed problem that allowed generating incorrect but apparently well-typed
  Objective Caml code when a semantic action was ill-typed and `--infer` was
  omitted.
820

821
## 2006/03/29
822 823

* Improved conflict reports by factoring out maximal common derivation contexts.
824

825
## 2006/03/28
826 827

* Fixed bug that could arise when explaining a conflict in a non-LALR(1) grammar.
828

829
## 2006/03/27
830

831 832
* Changed count of reduce/reduce conflicts to allow a comparison
  with `ocamlyacc`'s diagnostics.
833
* When refusing to resolve a conflict, report all diagnostics before dying.
834

835
## 2006/03/18
836 837 838 839

* Added display of `FOLLOW` sets when using `--log-grammar 2`.
* Added `--graph` option.
* Fixed behavior of `--depend` option.
840

841
## 2006/01/06
842 843

* Removed reversed lists from the standard library.