Import Upstream version 20180207

[hcoop/debian/mlton.git] / mlyacc / examples / fol / README

fol/README

This is a sample parser for first-order logic.   The grammar
was contributed by Frank Pfenning.

The parser is defined by the files

  fol.lex       (* defines lexer *)
  fol.grm       (* defines grammar *)
  link.sml      (* constructs basic parser structures *)
  absyn.sml     (* a trivial abstract syntax *)
  interface.sml (* interface to lexer and parser properties *)
  parse.sml     (* driver functions *)
  fol.mlb       (* ML Basis file *)

To compile this example, type the following commands

  mllex fol.lex
  mlyacc fol.grm
  mlton fol.mlb

in this directory.  They will invoke ml-lex and ml-yacc to process the
lexer specification fol.lex and the grammar specification fol.grm
respectively.  Then they will compile the resulting SML source files

  fol.lex.sml
  fol.grm.sig
  fol.grm.sml

and the other sml source files.

The end result of loading these files is a structure Parse containing
the following top-level driver functions:

  val prog_parse : string -> Absyn.absyn
   (* parse a program from a string *)

  val query_parse : string -> Absyn.absyn
   (* parse a query from a string *)

  val file_parse : string -> Absyn.absyn
   (* parse a program in a file *)

  val top_parse : unit -> Absyn.absyn
   (* parse a query from the standard input *)


The file list.fol is a sample input file that can be parsed using
the file_parse function:

  - Parse.file_parse "list.fol";


NOTE: The ML Basis file sources.cm mentions the ml-yacc library
(ml-yacc-lib.cm). MLton's search path should be configured so that this
library will be found.  This should normally be the case if MLton is
properly installed.