LRijkstra.ml 44.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
(* The purpose of this algorithm is to find, for each pair of a state [s]
   and a terminal symbol [z] such that looking at [z] in state [s] causes
   an error, a minimal path (starting in some initial state) that actually
   triggers this error. *)

(* This is potentially useful for grammar designers who wish to better
   understand the properties of their grammar, or who wish to produce a
   list of all possible syntax errors (or, at least, one syntax error in
   each automaton state where an error may occur). *)

(* The problem seems rather tricky. One might think that it suffices to
   compute shortest paths in the automaton, and to use [Analysis.minimal] to
   replace each non-terminal symbol in a path with a minimal word that this
   symbol generates. One can indeed do so, but this yields only a lower bound
   on the actual shortest path to the error at [s, z]. Indeed, two
   difficulties arise:

   - Some states have a default reduction. Thus, they will not trigger
     an error, even though they should. The error is triggered in some
     other state, after reduction takes place.

   - If the grammar has conflicts, conflict resolution removes some
     (shift or reduce) actions, hence may suppress the shortest path. *)

25 26 27 28 29 30 31 32 33 34 35
(* We explicitly choose to ignore the [error] token. Thus, we disregard any
   reductions or transitions that take place when the lookahead symbol is
   [error]. As a result, any state whose incoming symbol is [error] is found
   unreachable. It would be too complicated to have to create a first error in
   order to be able to take certain transitions or drop certain parts of the
   input. *)

(* We never work with the terminal symbol [#] either. This symbol never
   appears in the maps returned by [Lr1.transitions] and [Lr1.reductions].
   Thus, in principle, we work with ``real'' terminal symbols only. However,
   we encode [any] as [#] -- see below. *)
36

37
(* NOTE: THIS FILE IS COMPILED WITH -noassert BY DEFAULT. If you would like
38 39
   the assertions to be tested at runtime, change that in the file _tags.
   The performance impact of the assertions is about 10%. *)
40

41 42 43
(* ------------------------------------------------------------------------ *)

(* To delay the side effects performed by this module, we wrap everything in
POTTIER Francois's avatar
POTTIER Francois committed
44
   in a big functor. The functor also serves to pass a verbosity parameter. *)
45

46
module Run (X : sig val verbose: bool end) = struct
47

48
open Grammar
49

50 51 52
let start =
  Unix.((times()).tms_utime)

53 54
(* ------------------------------------------------------------------------ *)

55 56
(* Because of our encoding of terminal symbols as 8-bit characters, this
   algorithm supports at most 256 terminal symbols. *)
57 58

let () =
59
  if Terminal.n > 256 then
60
    Error.error [] (Printf.sprintf
61
      "--list-errors supports at most 256 terminal symbols.\n\
62 63 64 65 66
       The grammar has %d terminal symbols." Terminal.n
    )

(* ------------------------------------------------------------------------ *)

67 68 69 70 71
(* Build a module that represents words as (hash-consed) strings. Note:
   this functor application has a side effect (it allocates memory, and
   more importantly, it may fail). *)

module W = Terminal.Word(struct end)
72

73 74
(* ------------------------------------------------------------------------ *)

75 76
(* The [error] token may appear in the maps returned by [Lr1.transitions]
   and [Lr1.reductions], so we sometimes need to explicitly check for it. *)
77

78
let non_error z =
79
  not (Terminal.equal z Terminal.error)
80

81 82 83 84
(* We introduce a pseudo-terminal symbol [any]. It is used in several places
   later on, in particular in the field [fact.lookahead], to encode the
   absence of a lookahead hypothesis -- i.e., any terminal symbol will do. *)

85 86 87 88 89
(* We choose to encode [any] as [#]. There is no risk of confusion, since we
   do not use [#] anywhere. Thus, the assertion [Terminal.real z] implies
   [z <> any]. *)

let any =
90
  Terminal.sharp
91

92 93
(* ------------------------------------------------------------------------ *)

94 95 96 97 98
(* We begin with a number of auxiliary functions that provide information
   about the LR(1) automaton. These functions could perhaps be moved to a
   separate module. We keep them here, for the moment, because they are not
   used anywhere else. *)

POTTIER Francois's avatar
POTTIER Francois committed
99 100 101
(* [reductions_on s z] is the list of reductions permitted in state [s] when
   the lookahead symbol is [z]. This is a list of zero or one elements. This
   does not take default reductions into account. *)
102

POTTIER Francois's avatar
POTTIER Francois committed
103
let reductions_on s z : Production.index list =
104
  assert (Terminal.real z);
105 106 107 108 109
  try
    TerminalMap.find z (Lr1.reductions s)
  with Not_found ->
    []

110 111 112
(* [has_reduction s z] tells whether state [s] is willing to reduce some
   production (and if so, which one) when the lookahead symbol is [z]. It
   takes a possible default reduction into account. *)
113 114

let has_reduction s z : Production.index option =
115
  assert (Terminal.real z);
116 117 118 119
  match Invariant.has_default_reduction s with
  | Some (prod, _) ->
      Some prod
  | None ->
POTTIER Francois's avatar
POTTIER Francois committed
120
      match reductions_on s z with
121 122 123 124 125 126
      | prod :: prods ->
          assert (prods = []);
          Some prod
      | [] ->
          None

127 128 129 130 131 132 133 134 135
(* [can_reduce s prod] indicates whether state [s] is able to reduce
   production [prod] (either as a default reduction, or as a normal
   reduction). *)

let can_reduce s prod =
  match Invariant.has_default_reduction s with
  | Some (prod', _) when prod = prod' ->
      true
  | _ ->
136
      TerminalMap.fold (fun z prods accu ->
137 138
        (* A reduction on [#] is always a default reduction. (See [lr1.ml].) *)
        assert (not (Terminal.equal z Terminal.sharp));
139
        accu || non_error z && List.mem prod prods
140 141
      ) (Lr1.reductions s) false

142 143
(* [causes_an_error s z] tells whether state [s] will initiate an error on the
   lookahead symbol [z]. *)
144

145
let causes_an_error s z : bool =
146
  assert (Terminal.real z);
147 148 149 150
  match Invariant.has_default_reduction s with
  | Some _ ->
      false
  | None ->
POTTIER Francois's avatar
POTTIER Francois committed
151
      reductions_on s z = [] &&
152 153
      not (SymbolMap.mem (Symbol.T z) (Lr1.transitions s))

154
(* [foreach_terminal f] applies the function [f] to every terminal symbol in
155
   turn, except [error] and [#]. *)
156

157 158
let foreach_terminal =
  Terminal.iter_real
159

160 161 162
(* [foreach_terminal_not_causing_an_error s f] applies the function [f] to
   every terminal symbol [z] such that [causes_an_error s z] is false. This
   could be implemented in a naive manner using [foreach_terminal] and
POTTIER Francois's avatar
POTTIER Francois committed
163
   [causes_an_error]. This implementation is significantly more efficient. *)
164

165 166 167
let foreach_terminal_not_causing_an_error s f =
  match Invariant.has_default_reduction s with
  | Some _ ->
168
      (* There is a default reduction. No symbol causes an error. *)
169 170
      foreach_terminal f
  | None ->
171 172 173
      (* Enumerate every terminal symbol [z] for which there is a
         reduction. *)
      TerminalMap.iter (fun z _ ->
174 175 176
        (* A reduction on [#] is always a default reduction. (See [lr1.ml].) *)
        assert (not (Terminal.equal z Terminal.sharp));
        if non_error z then
177
          f z
178
      ) (Lr1.reductions s);
179 180
      (* Enumerate every terminal symbol [z] for which there is a
         transition. *)
181 182
      SymbolMap.iter (fun sym _ ->
        match sym with
183
        | Symbol.T z ->
184 185
            assert (not (Terminal.equal z Terminal.sharp));
            if non_error z then
186
              f z
187 188 189 190
        | Symbol.N _ ->
            ()
      ) (Lr1.transitions s)

191
(* Let us say a state [s] is solid if its incoming symbol is a terminal symbol
POTTIER Francois's avatar
POTTIER Francois committed
192 193
   (or if it has no incoming symbol at all, i.e., it is an initial state). It
   is fragile if its incoming symbol is a non-terminal symbol. *)
194 195 196 197 198

let is_solid s =
  match Lr1.incoming_symbol s with
  | None
  | Some (Symbol.T _) ->
POTTIER Francois's avatar
POTTIER Francois committed
199
    true
200
  | Some (Symbol.N _) ->
POTTIER Francois's avatar
POTTIER Francois committed
201
    false
202

203 204
(* ------------------------------------------------------------------------ *)

POTTIER Francois's avatar
POTTIER Francois committed
205 206 207 208 209 210 211 212 213
(* Suppose [s] is a state that carries an outgoing edge labeled with a
   non-terminal symbol [nt]. We are interested in finding out how this edge
   can be taken. In order to do that, we must determine how, by starting in
   [s], one can follow a path that corresponds to (the right-hand side of) a
   production [prod] associated with [nt]. There are in general several such
   productions. The paths that they determine in the automaton form a "star".
   We represent the star rooted at [s] as a trie. For every state [s], the
   star rooted at [s] is constructed in advance, before the algorithm runs.
   While the algorithm runs, a point in the trie (that is, a sub-trie) tells
POTTIER Francois's avatar
Typo.  
POTTIER Francois committed
214
   us where we come from, where we are, and which production(s) we are hoping
POTTIER Francois's avatar
POTTIER Francois committed
215 216
   to reduce in the future. *)

217 218 219
let grammar_uses_error =
  ref false

220 221 222
module Trie : sig

  type trie
223 224 225 226

  (* [star s] creates a (new) trie whose source is [s], populated with its
     branches. (There is one branch for every production [prod] associated
     with every non-terminal symbol [nt] for which [s] carries an outgoing
227
     edge.) If the star turns out to be trivial then [None] is returned. *)
228 229
  val star: Lr1.node -> trie option

230 231 232 233
  (* After [star s] has been called, [size (Lr1.number s)] reports the size
     of the trie that has been constructed for state [s]. *)
  val size: int -> int

234 235 236 237
  (* After [star] has been called a number of times, [cumulated_size()]
     reports the total size of the tries that have been constructed. *)
  val cumulated_size: unit -> int

238 239 240 241 242 243 244 245
  (* Every (sub-)trie has a unique identity. (One can think of it as its
     address.) [compare] compares the identity of two tries. This can be
     used, e.g., to set up a map whose keys are tries. *)
  val compare: trie -> trie -> int

  (* [source t] returns the source state of the (sub-)trie [t]. This is
     the root of the star of which [t] is a sub-trie. In other words, this
     tells us "where we come from". *)
246
  val source: trie -> Lr1.node
POTTIER Francois's avatar
POTTIER Francois committed
247 248

  (* [current t] returns the current state of the (sub-)trie [t]. This is
249 250
     the root of the sub-trie [t]. In other words, this tells us "where
     we are". *)
POTTIER Francois's avatar
POTTIER Francois committed
251
  val current: trie -> Lr1.node
252

253 254 255 256 257
  (* [accepts prod t] tells whether the current state of the trie [t] is
     the end of a branch associated with production [prod]. If so, this
     means that we have successfully followed a path that corresponds to
     the right-hand side of production [prod]. *)
  val accepts: Production.index -> trie -> bool
258

259 260 261 262 263 264 265 266
  (* [step sym t] is the immediate sub-trie of [t] along the symbol [sym].
     This function raises [Not_found] if [t] has no child labeled [sym]. *)
  val step: Symbol.t -> trie -> trie

  (* [verbose()] outputs debugging & performance information. *)
  val verbose: unit -> unit

end = struct
267

268 269
  (* A trie has the following structure. *)

270
  type trie = {
271 272 273
    (* A unique identity, used by [compare]. The trie construction code
       ensures that these numbers are indeed unique: see [fresh], [insert],
       [star]. *)
274
    identity: int;
275
    (* The root state of this star: "where we come from". *)
276
    source: Lr1.node;
277
    (* The current state, i.e., the root of this sub-trie: "where we are". *)
POTTIER Francois's avatar
POTTIER Francois committed
278
    current: Lr1.node;
279 280 281
    (* The productions that we can reduce in the current state. In other
       words, if this list is nonempty, then the current state is the end
       of one (or several) branches. It can nonetheless have children. *)
282
    productions: Production.index list;
283 284
    (* The children, or sub-tries. *)
    transitions: trie SymbolMap.t
285
  }
286

287
  (* This counter is used by [mktrie] to produce unique identities. *)
288 289
  let c = ref 0

290
  (* This smart constructor creates a new trie with a unique identity. *)
POTTIER Francois's avatar
POTTIER Francois committed
291
  let mktrie source current productions transitions =
292
    let identity = Misc.postincrement c in
POTTIER Francois's avatar
POTTIER Francois committed
293
    { identity; source; current; productions; transitions }
294

295 296
  exception DeadBranch

297
  let rec insert w prod t =
298 299
    match w with
    | [] ->
POTTIER Francois's avatar
POTTIER Francois committed
300
        (* We check whether the current state [t.current] is able to reduce
301 302 303 304 305
           production [prod]. (If [prod] cannot be reduced, the reduction
           action must have been suppressed by conflict resolution.) If not,
           then this branch is dead. This test is superfluous (i.e., it would
           be OK to conservatively assume that [prod] can be reduced) but
           allows us to build a slightly smaller star in some cases. *)
POTTIER Francois's avatar
POTTIER Francois committed
306
        if can_reduce t.current prod then
307 308 309 310 311 312
          (* We consume (update) the trie [t], so there is no need to allocate
             a new stamp. (Of course we could allocate a new stamp, but I prefer
             to be precise.) *)
          { t with productions = prod :: t.productions }
        else
          raise DeadBranch
313
    | (Symbol.T t) :: _ when Terminal.equal t Terminal.error ->
314
         grammar_uses_error := true;
315
         raise DeadBranch
316
    | a :: w ->
POTTIER Francois's avatar
POTTIER Francois committed
317
        (* Check if there is a transition labeled [a] out of [t.current]. If
318 319
           there is, we add a child to the trie [t]. If there isn't, then it
           must have been removed by conflict resolution. (Indeed, it must be
320 321 322
           present in a canonical automaton.) We could in this case return an
           unchanged sub-trie. We can do slightly better: we abort the whole
           insertion, so as to return an unchanged toplevel trie. *)
POTTIER Francois's avatar
POTTIER Francois committed
323
        match SymbolMap.find a (Lr1.transitions t.current) with
324
        | successor ->
325 326 327 328 329 330 331 332
            (* Find our child at [a], or create it. *)
            let t' =
              try
                SymbolMap.find a t.transitions
              with Not_found ->
                mktrie t.source successor [] SymbolMap.empty
            in
            (* Update the child [t']. *)
333
            let t' = insert w prod t' in
334 335
            (* Update [t]. Again, no need to allocate a new stamp. *)
            { t with transitions = SymbolMap.add a t' t.transitions }
336
        | exception Not_found ->
337
            raise DeadBranch
338

339 340 341 342 343
  (* [insert prod t] inserts a new branch, corresponding to production
     [prod], into the trie [t]. This function consumes its argument,
     which should no longer be used afterwards. *)
  let insert prod t =
    let w = Array.to_list (Production.rhs prod) in
344 345 346 347 348 349
    let save = !c in
    try
      insert w prod t
    with DeadBranch ->
      c := save;
      t
350

351 352 353 354
  (* [fresh s] creates a new empty trie whose source is [s]. *)
  let fresh source =
    mktrie source source [] SymbolMap.empty

355 356 357
  (* The star at [s] is obtained by starting with a fresh empty trie and
     inserting into it every production [prod] whose left-hand side [nt]
     is the label of an outgoing edge at [s]. *)
358 359 360 361 362 363 364 365 366
  let star s =
    SymbolMap.fold (fun sym _ accu ->
      match sym with
      | Symbol.T _ ->
          accu
      | Symbol.N nt ->
          Production.foldnt nt accu insert
    ) (Lr1.transitions s) (fresh s)

367 368 369 370 371 372 373
  (* A trie [t] is nontrivial if it has at least one branch, i.e., contains at
     least one sub-trie whose [productions] field is nonempty. Trivia: a trie
     of size greater than 1 is necessarily nontrivial, but the converse is not
     true: a nontrivial trie can have size 1. (This occurs if all productions
     have zero length.) *)
  let trivial t =
    t.productions = [] && SymbolMap.is_empty t.transitions
374

375 376
  (* Redefine [star] to include a [nontrivial] test and to record the size of
     the newly built trie. *)
377 378 379 380

  let size =
    Array.make Lr1.n (-1)

381
  let star s =
382
    let initial = !c in
383
    let t = star s in
384 385
    let final = !c in
    size.(Lr1.number s) <- final - initial;
386
    if trivial t then None else Some t
387

388 389 390 391
  let size s =
    assert (size.(s) >= 0);
    size.(s)

392 393 394
  let cumulated_size () =
    !c

POTTIER Francois's avatar
POTTIER Francois committed
395
  let compare t1 t2 =
396
    Pervasives.compare t1.identity t2.identity
397

398 399 400
  let source t =
    t.source

POTTIER Francois's avatar
POTTIER Francois committed
401 402
  let current t =
    t.current
403

404 405 406
  let accepts prod t =
    List.mem prod t.productions

407
  let step a t =
408
    SymbolMap.find a t.transitions (* careful: may raise [Not_found] *)
409

410
  let verbose () =
411
    Printf.eprintf "Cumulated star size: %d\n%!" (cumulated_size())
412

413 414
end

POTTIER Francois's avatar
POTTIER Francois committed
415 416
(* ------------------------------------------------------------------------ *)

POTTIER Francois's avatar
POTTIER Francois committed
417 418 419 420 421 422
(* The main algorithm, [LRijkstra], accumulates facts. A fact is a triple of a
   position (that is, a sub-trie), a word, and a lookahead assumption. Such a
   fact means that this position can be reached, from the source state
   [Trie.source fact.position], by consuming [fact.word], under the assumption
   that the next input symbol is [fact.lookahead]. *)

423 424
(* We allow [fact.lookahead] to be [any] so as to indicate that this fact does
   not have a lookahead assumption. *)
POTTIER Francois's avatar
POTTIER Francois committed
425

426
type fact = {
427
  position: Trie.trie;
428
  word: W.word;
429
  lookahead: Terminal.t (* may be [any] *)
430 431
}

432 433
(* Accessors. *)

434
let source fact =
435
  Trie.source fact.position
436

POTTIER Francois's avatar
POTTIER Francois committed
437
let current fact =
438
  Trie.current fact.position
439

440 441
(* Two invariants reduce the number of facts that we consider:

442 443 444
   1. If [fact.lookahead] is a real terminal symbol [z] (i.e., not [any]),
      then [z] does not cause an error in the current state [current fact].
      It would be useless to consider a fact that violates this property;
POTTIER Francois's avatar
POTTIER Francois committed
445 446 447
      this cannot possibly lead to a successful reduction. In practice,
      this refinement allows reducing the number of facts that go through
      the queue by a factor of two.
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465

   2. [fact.lookahead] is [any] iff the current state [current fact] is
      solid. This sounds rather reasonable (when a state is entered
      by shifting, it is entered regardless of which symbol follows)
      and simplifies the implementation of the sub-module [T].

*)

let invariant1 fact =
  fact.lookahead = any || not (causes_an_error (current fact) fact.lookahead)

let invariant2 fact =
  (fact.lookahead = any) = is_solid (current fact)

(* [compatible z a] checks whether the terminal symbol [a] satisfies the
   lookahead assumption [z] -- which can be [any]. *)

let compatible z a =
466 467
  assert (non_error z);
  assert (Terminal.real a);
468 469
  z = any || z = a

POTTIER Francois's avatar
POTTIER Francois committed
470
(* ------------------------------------------------------------------------ *)
471

472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
(* As in Dijkstra's algorithm, a priority queue contains the facts that await
   examination. The length of [fact.word] serves as the priority of a fact.
   This guarantees that we discover shortest paths. (We never insert into the
   queue a fact whose priority is less than the priority of the last fact
   extracted out of the queue.) *)

(* [LowIntegerPriorityQueue] offers very efficient operations (essentially
   constant time, for a small constant). It exploits the fact that priorities
   are low nonnegative integers. *)

module Q = LowIntegerPriorityQueue

let q =
  Q.create()

(* In principle, there is no need to insert the fact into the queue if [T]
   already stores a comparable fact. We could perform this test in [add].
   However, a quick experiment suggests that this is not worthwhile. The run
   time augments (because membership in [T] is tested twice, upon inserting
   and upon extracting) and the memory consumption does not seem to go down
   significantly. *)

let add fact =
POTTIER Francois's avatar
POTTIER Francois committed
495
  (* [fact.lookahead] can be [any], but cannot be [error] *)
496
  assert (non_error fact.lookahead);
497 498
  assert (invariant1 fact);
  assert (invariant2 fact);
499 500 501
  (* The length of [fact.word] serves as the priority of this fact. *)
  Q.add q fact (W.length fact.word)

POTTIER Francois's avatar
POTTIER Francois committed
502 503
(* ------------------------------------------------------------------------ *)

504 505 506
(* Construct the [star] of every state [s]. Initialize the priority queue. *)

let () =
POTTIER Francois's avatar
POTTIER Francois committed
507
  (* For every state [s]... *)
508
  Lr1.iter (fun s ->
POTTIER Francois's avatar
POTTIER Francois committed
509
    (* If the trie rooted at [s] is nontrivial...*)
510
    match Trie.star s with
POTTIER Francois's avatar
POTTIER Francois committed
511 512 513 514 515 516 517 518 519 520
    | None ->
        ()
    | Some position ->
        (* ...then insert an initial fact into the priority queue. *)
        (* In order to respect invariants 1 and 2, we must distinguish two
           cases. If [s] is solid, then we insert a single fact, whose
           lookahead assumption is [any]. Otherwise, we must insert one
           initial fact for every terminal symbol [z] that does not cause
           an error in state [s]. *)
        let word = W.epsilon in
521
        if is_solid s then
POTTIER Francois's avatar
POTTIER Francois committed
522
          add { position; word; lookahead = any }
523 524
        else
          foreach_terminal_not_causing_an_error s (fun z ->
POTTIER Francois's avatar
POTTIER Francois committed
525
            add { position; word; lookahead = z }
526
          )
POTTIER Francois's avatar
POTTIER Francois committed
527 528 529
  );
  if X.verbose then
    Trie.verbose()
530

531 532 533 534 535 536 537
(* Produce a warning if the grammar uses the [error] pseudo-token. *)

let () =
  if !grammar_uses_error then
    Error.warning []
      "--list-errors ignores all productions that involve the error token."

538 539
(* ------------------------------------------------------------------------ *)

540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
(* The module [T] maintains a set of known facts. *)

(* Three aspects of a fact are of particular interest:
   - its position [position], given by [fact.position];
   - its first symbol [a], given by [W.first fact.word fact.lookahead];
   - its lookahead assumption [z], given by [fact.lookahead].

   For every triple of [position], [a], and [z], we store at most one fact,
   (whose word has minimal length). Indeed, we are not interested in keeping
   track of several words that produce the same effect. Only the shortest such
   word is of interest.
   
   Thus, the total number of facts accumulated by the algorithm is at most
   [T.n^2], where [T] is the total size of the tries that we have constructed,
   and [n] is the number of terminal symbols. (This number can be quite large.
   [T] can be in the tens of thousands, and [n] can be over one hundred. These
   figures lead to a theoretical upper bound of 100M. In practice, for T=25K
   and n=108, we observe that the algorithm gathers about 7M facts.) *)
558

559
module T : sig
560 561

  (* [register fact] registers the fact [fact]. It returns [true] if this fact
POTTIER Francois's avatar
POTTIER Francois committed
562 563
     is new, i.e., no fact concerning the same triple of [position], [a], and
     [z] was previously known. *)
564 565
  val register: fact -> bool

POTTIER Francois's avatar
POTTIER Francois committed
566
  (* [query current z f] enumerates all known facts whose current state is
567 568
     [current] and whose lookahead assumption is compatible with [z]. The
     symbol [z] must a real terminal symbol, i.e., cannot be [any]. *)
569
  val query: Lr1.node -> Terminal.t -> (fact -> unit) -> unit
570

571 572 573
  (* [size()] returns the number of facts currently stored in the set. *)
  val size: unit -> int

574
  (* [verbose()] outputs debugging & performance information. *)
575
  val verbose: unit -> unit
576

577
end = struct
578

579 580 581 582 583 584 585 586 587 588 589
  (* We need to query the set of facts in two ways. In [register], we must test
     whether a proposed triple of [position], [a], [z] already appears in the
     set. In [query], we must find all facts that match a pair [current, z],
     where [current] is a state. (Note that [position] determines [current], but
     the converse is not true: a position contains more information besides the
     current state.)

     To address these needs, we use a two-level table. The first level is a
     matrix indexed by [current] and [z]. At the second level, we find sets of
     facts, where two facts are considered equal if they have the same triple of
     [position], [a], and [z]. In fact, we know at this level that all facts
590 591 592 593 594 595
     have the same [z] component, so only [position] and [a] are compared.

     Because our facts satisfy invariant 2, [z] is [any] if and only if the
     state [current fact] is solid. This means that we are wasting quite a
     lot of space in the matrix (for a solid state, the whole line is empty,
     except for the [any] column). *)
596

597
  (* The level-2 sets. *)
598 599

  module M =
600
    MySet.Make(struct
601 602
      type t = fact
      let compare fact1 fact2 =
603
        assert (fact1.lookahead = fact2.lookahead);
604
        let c = Trie.compare fact1.position fact2.position in
605
        if c <> 0 then c else
606 607 608
        let z = fact1.lookahead in
        let a1 = W.first fact1.word z
        and a2 = W.first fact2.word z in
609
        (* note: [a1] and [a2] can be [any] here *)
610 611
        Terminal.compare a1 a2
    end)
612

613 614 615
  (* The level-1 matrix. *)

  let table =
616
    Array.make (Lr1.n * Terminal.n) M.empty
617

POTTIER Francois's avatar
POTTIER Francois committed
618
  let index current z =
619
    Terminal.n * (Lr1.number current) + Terminal.t2i z
620

621 622
  let count = ref 0

623
  let register fact =
POTTIER Francois's avatar
POTTIER Francois committed
624
    let current = current fact in
625
    let z = fact.lookahead in
POTTIER Francois's avatar
POTTIER Francois committed
626
    let i = index current z in
627 628 629 630 631 632 633 634 635 636 637 638
    let m = table.(i) in
    (* We crucially rely on the fact that [M.add] guarantees not to
       change the set if an ``equal'' fact already exists. Thus, a
       later, longer path is ignored in favor of an earlier, shorter
       path. *)
    let m' = M.add fact m in
    m != m' && begin
      incr count;
      table.(i) <- m';
      true
    end

POTTIER Francois's avatar
POTTIER Francois committed
639
  let query current z f =
640 641 642 643 644
    assert (not (Terminal.equal z any));
    (* If the state [current] is solid then the facts that concern it are
       stored in the column [any], and all of them are compatible with [z].
       Otherwise, they are stored in all columns except [any], and only
       those stored in the column [z] are compatible with [z]. *)
645
    let i = index current (if is_solid current then any else z) in
646 647
    let m = table.(i) in
    M.iter f m
648

649 650 651
  let size () =
    !count

652
  let verbose () =
653
    Printf.eprintf "T stores %d facts.\n%!" (size())
654

655 656
end

POTTIER Francois's avatar
POTTIER Francois committed
657 658
(* ------------------------------------------------------------------------ *)

659 660
(* The module [E] is in charge of recording the non-terminal edges that we have
   discovered, or more precisely, the conditions under which these edges can be
POTTIER Francois's avatar
POTTIER Francois committed
661 662 663 664 665 666 667 668 669 670 671 672
   taken.
   
   It maintains a set of quadruples [s, nt, w, z], where such a quadruple means
   that in the state [s], the outgoing edge labeled [nt] can be taken by
   consuming the word [w], under the assumption that the next symbol is [z].

   Again, the terminal symbol [a], given by [W.first w z], plays a role. For
   each quadruple [s, nt, a, z], we store at most one quadruple [s, nt, w, z].
   Thus, internally, we maintain a mapping of [s, nt, a, z] to [w].

   For greater simplicity, we do not allow [z] to be [any] in [register] or
   [query]. Allowing it would complicate things significantly, it seems. *)
673 674 675 676

module E : sig

  (* [register s nt w z] records that, in state [s], the outgoing edge labeled
677
     [nt] can be taken by consuming the word [w], if the next symbol is [z].
POTTIER Francois's avatar
POTTIER Francois committed
678 679
     It returns [true] if this information is new, i.e., if the underlying
     quadruple [s, nt, a, z] is new. The symbol [z] cannot be [any]. *)
680
  val register: Lr1.node -> Nonterminal.t -> W.word -> Terminal.t -> bool
681

POTTIER Francois's avatar
POTTIER Francois committed
682 683 684 685 686 687 688
  (* [query s nt a z] enumerates all words [w] such that, in state [s], the
     outgoing edge labeled [nt] can be taken by consuming the word [w], under
     the assumption that the next symbol is [z], and the first symbol of the
     word [w.z] is [a]. The symbol [a] can be [any]. The symbol [z] cannot be
     [any]. *)
  val query: Lr1.node -> Nonterminal.t -> Terminal.t -> Terminal.t ->
             (W.word -> unit) -> unit
689

690 691 692
  (* [size()] returns the number of edges currently stored in the set. *)
  val size: unit -> int

POTTIER Francois's avatar
POTTIER Francois committed
693
  (* [verbose()] outputs debugging & performance information. *)
694
  val verbose: unit -> unit
695

696 697
end = struct

698 699 700 701 702 703 704 705 706 707
  (* At a high level, we must implement a mapping of [s, nt, a, z] to [w]. In
     practice, we can implement this specification using any combination of
     arrays, hash tables, balanced binary trees, and perfect hashing (i.e.,
     packing several of [s], [nt], [a], [z] in one word.) Here, we choose to
     use an array, indexed by [s], of hash tables, indexed by a key that packs
     [nt], [a], and [z] in one word. According to a quick experiment, the
     final population of the hash table [table.(index s)] seems to be roughly
     [Terminal.n * Trie.size s]. We note that using an initial capacity
     of 0 and relying on the hash table's resizing mechanism has a significant
     cost, which is why we try to guess a good initial capacity. *)
708

709
  module H = Hashtbl
710

POTTIER Francois's avatar
POTTIER Francois committed
711 712
  let table =
    Array.init Lr1.n (fun i ->
713 714 715
      let size = Trie.size i in
      H.create (if size = 1 then 0 else Terminal.n * size)
    )
716 717 718

  let index s =
    Lr1.number s
719

720
  let pack nt a z : int =
POTTIER Francois's avatar
POTTIER Francois committed
721
    (* We rely on the fact that we have at most 256 terminal symbols. *)
722 723 724
    (Nonterminal.n2i nt lsl 16) lor
    (Terminal.t2i a lsl 8) lor
    (Terminal.t2i z)
725

726 727
  let count = ref 0

728
  let register s nt w z =
729
    assert (Terminal.real z);
730
    let i = index s in
731
    let m = table.(i) in
732
    let a = W.first w z in
POTTIER Francois's avatar
POTTIER Francois committed
733
    (* Note that looking at [a] in state [s] cannot cause an error. *)
734
    assert (not (causes_an_error s a));
735 736 737 738
    let key = pack nt a z in
    if H.mem m key then
      false
    else begin
739
      incr count;
740
      H.add m key w;
741 742
      true
    end
743

744
  let rec query s nt a z f =
745
    assert (Terminal.real z);
POTTIER Francois's avatar
POTTIER Francois committed
746 747
    if Terminal.equal a any then begin
      (* If [a] is [any], we query the table for every real symbol [a].
748 749 750 751 752 753
         We can limit ourselves to symbols that do not cause an error
         in state [s]. Those that do certainly do not have an entry;
         see the assertion in [register] above. *)
      foreach_terminal_not_causing_an_error s (fun a ->
        query s nt a z f
      )
POTTIER Francois's avatar
POTTIER Francois committed
754 755 756 757 758 759 760 761
    end
    else begin
      let i = index s in
      let m = table.(i) in
      let key = pack nt a z in
      match H.find m key with
      | w -> f w
      | exception Not_found -> ()
762
    end
763

764 765 766
  let size () =
    !count

767
  let verbose () =
768
    Printf.eprintf "E stores %d edges.\n%!" (size())
769

770 771
end

POTTIER Francois's avatar
POTTIER Francois committed
772 773
(* ------------------------------------------------------------------------ *)

POTTIER Francois's avatar
POTTIER Francois committed
774 775 776 777 778 779 780
(* [new_edge s nt w z] is invoked when we discover that in the state [s], the
   outgoing edge labeled [nt] can be taken by consuming the word [w], under
   the assumption that the next symbol is [z]. We check whether this quadruple
   already exists in the set [E]. If not, then we add it, and we compute its
   consequences, in the form of new facts, which we insert into the priority
   queue for later examination. *)

781
let new_edge s nt w z =
782
  assert (Terminal.real z);
783
  if E.register s nt w z then
784
    let sym = Symbol.N nt in
POTTIER Francois's avatar
POTTIER Francois committed
785 786 787 788
    (* Query [T] for existing facts which could be extended by following
       this newly discovered edge. They must be facts whose current state
       is [s] and whose lookahead assumption is compatible with [a]. For
       each such fact, ... *)
789
    T.query s (W.first w z) (fun fact ->
790
      assert (compatible fact.lookahead (W.first w z));
POTTIER Francois's avatar
POTTIER Francois committed
791
      (* ... try to take one step in the trie along an edge labeled [nt]. *)
792 793
      match Trie.step sym fact.position with
      | position ->
POTTIER Francois's avatar
POTTIER Francois committed
794 795 796 797 798 799
          (* This takes up to a new state whose incoming symbol is [nt].
             Hence, this state is not solid. In order to satisfy invariant 2,
             we must create fact whose lookahead assumption is not [any].
             That's fine, since our lookahead assumption is [z]. In order to
             satisfy invariant 1, we must check that [z] does not cause an
             error in this state. *)
800
          assert (not (is_solid (Trie.current position)));
801
          if not (causes_an_error (Trie.current position) z) then
POTTIER Francois's avatar
POTTIER Francois committed
802 803
            let word = W.append fact.word w in
            add { position; word; lookahead = z }
804
      | exception Not_found ->
POTTIER Francois's avatar
POTTIER Francois committed
805 806 807
          (* Could not take a step in the trie. This means this branch
             leads nowhere of interest, and was pruned when the trie
             was constructed. *)
808
          ()
809
    )
810

POTTIER Francois's avatar
POTTIER Francois committed
811 812
(* ------------------------------------------------------------------------ *)

POTTIER Francois's avatar
POTTIER Francois committed
813 814
(* [new_fact fact] is invoked when we discover a new fact (i.e., one that was
   not previously known). It studies the consequences of this fact. These
815 816 817
   consequences are of two kinds:

   - As in Dijkstra's algorithm, the new fact can be viewed as a newly
POTTIER Francois's avatar
POTTIER Francois committed
818 819 820 821 822 823 824 825 826
     discovered vertex. We study its (currently known) outgoing edges,
     and enqueue new facts in the priority queue.

   - Sometimes, a fact can also be viewed as a newly discovered edge. This is
     the case when the word that took us from [fact.source] to [fact.current]
     represents a production of the grammar and [fact.current] is willing to
     reduce this production. We record the existence of this edge, and
     re-inspect any previously discovered vertices which are interested in
     this outgoing edge. *)
827

POTTIER Francois's avatar
POTTIER Francois committed
828
let new_fact fact =
829

POTTIER Francois's avatar
POTTIER Francois committed
830
  let current = current fact in
831

POTTIER Francois's avatar
POTTIER Francois committed
832 833 834
  (* 1. View [fact] as a vertex. Examine the transitions out of [current].
     For every transition labeled by a symbol [sym] and into a state
     [target], ... *)
835
  
POTTIER Francois's avatar
POTTIER Francois committed
836 837 838
  Lr1.transitions current |> SymbolMap.iter (fun sym target ->
    (* ... try to follow this transition in the trie [fact.position],
       down to a child which we call [position]. *)
839
    match Trie.step sym fact.position, sym with
POTTIER Francois's avatar
POTTIER Francois committed
840 841 842 843 844 845 846

    | exception Not_found ->

        (* Could not take a step in the trie. This means this transition
           leads nowhere of interest. *)
        ()

847
    | position, Symbol.T t ->
POTTIER Francois's avatar
POTTIER Francois committed
848 849 850 851 852 853
          
        (* 1a. The transition exists in the trie, and [sym] is in fact a
           terminal symbol [t]. We note that [t] cannot be the [error] token,
           because the trie does not have any edges labeled [error]. *)
        assert (Lr1.Node.compare (Trie.current position) target = 0);
        assert (is_solid target);
854
        assert (non_error t);
855

POTTIER Francois's avatar
POTTIER Francois committed
856 857 858 859 860 861 862 863 864 865 866
        (* If the lookahead assumption [fact.lookahead] is compatible with
           [t], then we derive a new fact, where one more edge has been taken,
           and enqueue this new fact for later examination. *)
        
        (* The state [target] is solid, i.e., its incoming symbol is terminal.
           This state is always entered without consideration for the next
           lookahead symbol. Thus, we can use [any] as the lookahead assumption
           in the new fact that we produce. If we did not have [any], we would
           have to produce one fact for every possible lookahead symbol. *)

        if compatible fact.lookahead t then
867
          let word = W.append fact.word (W.singleton t) in
868
          add { position; word; lookahead = any }
869

870
    | position, Symbol.N nt ->
871

POTTIER Francois's avatar
POTTIER Francois committed
872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890
        (* 1b. The transition exists in the trie, and [sym] is in fact a
           nonterminal symbol [nt]. *)
         assert (Lr1.Node.compare (Trie.current position) target = 0);
         assert (not (is_solid target));

        (* We need to know how this nonterminal edge can be taken. We query
           [E] for a word [w] that allows us to take this edge. In general,
           the answer depends on the terminal symbol [z] that comes *after*
           this word: we try all such symbols. We must make sure that the
           first symbol of the word [w.z] satisfies the lookahead assumption
           [fact.lookahead]; this is ensured by passing this information to
           [E.query]. *)

        (* It could be the case that, due to a default reduction, the answer
           to our query does not depend on [z], and we are wasting work.
           However, allowing [z] to be [any] in [E.query], and taking 
           advantage of this to increase performance, seems difficult. *)

        foreach_terminal_not_causing_an_error target (fun z ->
POTTIER Francois's avatar
POTTIER Francois committed
891
          E.query current nt fact.lookahead z (fun w ->
892
            assert (compatible fact.lookahead (W.first w z));
POTTIER Francois's avatar
POTTIER Francois committed
893 894
            let word = W.append fact.word w in
            add { position; word; lookahead = z }
895 896
          )
        )
897

POTTIER Francois's avatar
POTTIER Francois committed
898
  );
899 900

  (* 2. View [fact] as a possible edge. This is possible if the path from
POTTIER Francois's avatar
POTTIER Francois committed
901 902
     [fact.source] to the [current] state represents a production [prod] and
     [current] is willing to reduce this production. Then, reducing [prod]
903 904
     takes us all the way back to [fact.source]. Thus, this production gives
     rise to an edge labeled [nt] -- the left-hand side of [prod] -- out of
POTTIER Francois's avatar
POTTIER Francois committed
905
     [fact.source]. *)
906

POTTIER Francois's avatar
POTTIER Francois committed
907 908 909 910 911 912 913 914 915 916
  let z = fact.lookahead in
  if not (Terminal.equal z any) then begin

    (* 2a. The lookahead assumption [z] is a real terminal symbol. We check
       whether [current] is willing to reduce some production [prod] on [z],
       and whether the sub-trie [fact.position] accepts [prod], which means
       that this reduction takes us back to the root of the trie. If so, we
       have discovered a new edge. *)

    match has_reduction current z with
917
    | Some prod when Trie.accepts prod fact.position ->
POTTIER Francois's avatar
POTTIER Francois committed
918
        new_edge (source fact) (Production.nt prod) fact.word z
919 920
    | _ ->
        ()
POTTIER Francois's avatar
POTTIER Francois committed
921

922 923
  end
  else begin
POTTIER Francois's avatar
POTTIER Francois committed
924 925 926 927 928

    (* 2b. The lookahead assumption is [any]. We must consider every pair
       [prod, z] such that the [current] state can reduce [prod] on [z]
       and [fact.position] accepts [prod]. *)

929 930 931
    match Invariant.has_default_reduction current with
    | Some (prod, _) ->
        if Trie.accepts prod fact.position then
POTTIER Francois's avatar
POTTIER Francois committed
932 933
          (* [new_edge] does not accept [any] as its 4th parameter, so we
             must iterate over all terminal symbols. *)
934
          foreach_terminal (fun z ->
POTTIER Francois's avatar
POTTIER Francois committed
935
            new_edge (source fact) (Production.nt prod) fact.word z
936 937 938
          )
    | None ->
       TerminalMap.iter (fun z prods ->
939
         if non_error z then
940 941
           let prod = Misc.single prods in
           if Trie.accepts prod fact.position then
POTTIER Francois's avatar
POTTIER Francois committed
942
             new_edge (source fact) (Production.nt prod) fact.word z
943
       ) (Lr1.reductions current)
POTTIER Francois's avatar
POTTIER Francois committed
944

945
  end
946

POTTIER Francois's avatar
POTTIER Francois committed
947 948
(* ------------------------------------------------------------------------ *)

POTTIER Francois's avatar
POTTIER Francois committed
949
(* The main loop of the algorithm. *)
950

951 952 953 954 955
(* [level] is the length of [fact.word] for the facts that we are examining
   at the moment. [extracted] counts how many facts we have extracted out of
   the priority queue. [considered] counts how many of these were found to
   be new, and subsequently passed to [new_fact]. *)

POTTIER Francois's avatar
POTTIER Francois committed
956 957
let level, extracted, considered =
  ref 0, ref 0, ref 0
POTTIER Francois's avatar
POTTIER Francois committed
958

POTTIER Francois's avatar
POTTIER Francois committed
959
let done_with_level () =
960 961 962 963 964 965 966
  Printf.eprintf "Done with level %d.\n" !level;
  W.verbose();
  T.verbose();
  E.verbose();
  Printf.eprintf "Q stores %d facts.\n" (Q.cardinal q);
  Printf.eprintf "%d facts extracted out of Q, of which %d considered.\n%!"
    !extracted !considered
967

POTTIER Francois's avatar
POTTIER Francois committed
968
let () =
POTTIER Francois's avatar
POTTIER Francois committed
969 970 971
  Q.repeat q (fun fact ->
    incr extracted;
    if T.register fact then begin
972
      if X.verbose && W.length fact.word > !level then begin
POTTIER Francois's avatar
POTTIER Francois committed
973 974 975 976 977 978 979
        done_with_level();
        level := W.length fact.word;
      end;
      incr considered;
      new_fact fact
    end
  );
980 981
  if X.verbose then
    done_with_level();
POTTIER Francois's avatar
POTTIER Francois committed
982
  Time.tick "Running LRijkstra"
983

984 985
(* ------------------------------------------------------------------------ *)

986 987 988 989 990
(* The following code validates the fact that an error can be triggered in
   state [s'] by beginning in the initial state [s] and reading the
   sequence of terminal symbols [w]. We use this for debugging purposes. *)

let fail msg =
991
  Printf.eprintf "LRijkstra: internal error: %s.\n%!" msg;
992 993 994
  false

let validate s s' w : bool =
995
  let open ReferenceInterpreter in
996
  match
997
    check_error_path (Lr1.nt_of_entry s) (W.elements w)
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
  with
  | OInputReadPastEnd ->
      fail "input was read past its end"
  | OInputNotFullyConsumed ->
      fail "input was not fully consumed"
  | OUnexpectedAccept ->
      fail "input was unexpectedly accepted"
  | OK state ->
      Lr1.Node.compare state s' = 0 ||
      fail (
        Printf.sprintf "error occurred in state %d instead of %d"
          (Lr1.number state)
          (Lr1.number s')
      )

(* ------------------------------------------------------------------------ *)

1015 1016 1017 1018 1019 1020 1021
(* We now wish to determine, given a state [s'] and a terminal symbol [z], a
   minimal path that takes us from some entry state to state [s'] with [z] as
   the next (unconsumed) symbol. *)

(* This can be formulated as a search for a shortest path in a graph. The
   graph is not just the automaton, though. It is a (much) larger graph whose
   vertices are pairs [s, z] and whose edges are obtained by querying the
1022 1023 1024
   module [E] above. For this purpose, we use Dijkstra's algorithm,
   unmodified. Experiments show that the running time of this phase is
   typically 10x shorter than the running time of the main loop above. *)
1025

1026
module A = Astar.Make(struct
1027

1028 1029 1030
  (* A vertex is a pair [s, z], where [z] is a real terminal symbol. *)
  type node =
      Lr1.node * Terminal.t
1031

1032 1033
  let equal (s'1, z1) (s'2, z2) =
    Lr1.Node.compare s'1 s'2 = 0 && Terminal.compare z1 z2 = 0
1034

1035 1036
  let hash (s, z) =
    Hashtbl.hash (Lr1.number s, z)
1037

1038 1039 1040
  (* An edge is labeled with a word. *)
  type label =
    W.word
1041

1042 1043 1044 1045 1046 1047 1048
  (* We search forward from every [s, z], where [s] is an initial state. *)
  let sources f =
    foreach_terminal (fun z ->
      ProductionMap.iter (fun _ s ->
        f (s, z)
      ) Lr1.entry
    )
1049

1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
  (* The successors of [s, z] are defined as follows. *)
  let successors (s, z) edge =
    assert (Terminal.real z);
    (* For every transition out of [s], labeled [sym], leading to [s']... *)
    Lr1.transitions s |> SymbolMap.iter (fun sym s' ->
      match sym with
      | Symbol.T t ->
          if Terminal.equal z t then
            (* If [sym] is the terminal symbol [z], then this transition
               matches our lookahead assumption, so we can take it. For
               every [z'], we have an edge to [s', z'], labeled with the
               singleton word [z]. *)
            let w = W.singleton z in
            foreach_terminal (fun z' ->
              edge w 1 (s', z')
            )
      | Symbol.N nt ->
          (* If [sym] is a nonterminal symbol [nt], then we query [E]
             in order to find out which (minimal) words [w] allow us
             to take this transition. We must again try every [z'],
             and must respect the constraint that the first symbol
             of the word [w.z'] is [z]. For every [z'] and [w] that
             fulfill these requirements, we have an edge to [s', z'],
             labeled with the word [w]. *)
         foreach_terminal (fun z' ->
           E.query s nt z z' (fun w ->
             edge w (W.length w) (s', z')
1077
           )
1078 1079
         )
    )
1080

1081 1082 1083 1084 1085 1086 1087 1088 1089
  (* Algorithm A*, used with a zero estimate, is Dijkstra's algorithm.
     We have experimented with a non-zero estimate, but the performance
     increase was minimal. *)
  let estimate _ =
    0

end)

(* ------------------------------------------------------------------------ *)
1090

1091 1092
(* [explored] counts how many graph nodes we have discovered during the
   search. *)
1093

1094 1095
let explored =
  ref 0
1096

1097 1098 1099 1100 1101 1102 1103 1104 1105
(* [data] can be viewed as a set of triples [nt, s', w], meaning that an error
   can be triggered in state [s'] by beginning in the initial state that
   corresponds to [nt] and by reading the sequence of terminal symbols [w]. We
   store at most one such triple for every state [s'], so we organize [data]
   as a mapping of [s'] to the pair [s, w]. *)

let data : (Nonterminal.t * W.word) Lr1.NodeMap.t ref =
  ref Lr1.NodeMap.empty

1106 1107 1108 1109 1110
(* [reachable] is a set of all reachable states. *)

let reachable =
  ref Lr1.NodeSet.empty

1111 1112 1113 1114 1115
(* Perform the forward search. *)

let _, _ =
  A.search (fun ((s', z), path) ->
    incr explored;
1116
    reachable := Lr1.NodeSet.add s' !reachable;
1117 1118 1119 1120 1121
    (* If [z] causes an error in state [s'] and this is the first time
       we are able to trigger an error in this state, ... *)
    if causes_an_error s' z && not (Lr1.NodeMap.mem s' !data) then begin
      (* Reconstruct the initial state [s] and the word [w] that lead
         to this error. *)
1122 1123
      let (s, _), ws = A.reverse path in
      let w = List.fold_right W.append ws (W.singleton z) in
1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143
      (* Check that the reference interpreter confirms our finding. *)
      assert (validate s s' w);
      (* Store this new data. *)
      let nt = Lr1.nt_of_entry s in
      data := Lr1.NodeMap.add s' (nt, w) !data;
      (* As we go, display the data. This leads to sorting the output
         by increasing word sizes. *)
      Printf.printf
        "An error in state %d can be obtained as follows.\n\
         Start symbol: %s\n\
         Input length: %d\n\
         Input sentence:\n\
         %s\n\n%!"
        (Lr1.number s')
        (Nonterminal.print false nt)
        (W.length w)
        (W.print w)
      (* TEMPORARY print a concrete version of the input sentence, too *)
      (* this requires a mechanism for printing a terminal symbol under a
         concrete form *)
1144
    end
1145
  )
1146 1147

let () =
1148
  Time.tick "Forward search";
1149 1150 1151
  if X.verbose then begin
    Printf.eprintf
      "%d graph nodes expl