Copying everything to a new trunk directory.

git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/menhir@320 0f8b5475-4b4e-0410-85a8-ee3154a6bfe7

AUTHORS

+Franois Pottier <Francois.Pottier@inria.fr>
+Yann Rgis-Gianas <Yann.Regis-Gianas@pps.jussieu.fr>

CHANGES

+2013/01/16:
+"menhir --depend" was broken since someone added new whitespace in the output
+of ocamldep. Fixed.
+
+2012/12/19:
+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.
+
+2012/08/25:
+Performance improvements in the computation of various information
+about the automaton (module [Invariant]). The improvements will be
+noticeable only for very large automata.
+
+2012/06/07:
+The option --log-grammar 3 (and above) now causes the FOLLOW sets for
+*terminal* symbols to be computed and displayed.
+
+2012/05/25:
+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.
+
+2012/01/23:
+
+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.
+
+2012/01/09:
+Changes in the (undocumented) Coq back-end so as to match the ESOP 2012
+paper.
+
+2011/10/19:
+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:
+- the executable file name is either menhir or menhir.exe
+- the object file suffix is either .o or .obj
+
+2011/10/19:
+Added --strict, which causes many warnings about the grammar and about the
+automaton to be considered errors.
+
+2011/10/19:
+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.
+
+2011/10/06:
+With the -lg 1 switch, Menhir now indicates whether the grammar is SLR(1).
+
+2011/05/24:
+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.
+
+2011/04/28:
+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!
+
+2011/04/07:
+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.
+
+2011/04/05:
+Fixed a bug in the type inference module (for parameterized non-terminals)
+which would cause an infinite loop.
+
+2011/01/24:
+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.
+
+2009/06/18:
+Makefile changes: build and install only the bytecode version of menhirLib
+when TARGET=byte is set.
+
+2009/02/06:
+Fixed ocamldep.wrapper to avoid quoting the name of the ocaml command.
+This is hoped to fix a compilation problem under MinGW.
+
+2009/02/04:
+A Makefile fix to avoid a problem under Windows/Cygwin.
+Renamed the ocaml-check-version script so as to avoid a warning.
+
+2008/09/05:
+Ocaml summer project: added --interpret, --table, and --suggest-*.
+
+2008/08/06:
+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.
+
+2008/08/06:
+Removed code sharing.
+
+2008/06/20:
+Removed an incorrect assertion that caused failures (lr1.ml, line 134).
+
+2007/12/05:
+Disabled code sharing by default, as it is currently broken. (See Yann's
+message; assertion failure at runtime.)
+
+2007/12/01:
+Added an optimization to share code among states that have identical
+outgoing transition tables.
+
+2007/08/30:
+Small Makefile change: create an executable file for check-ocaml-version in
+order to work around the absence of dynamic loading on some platforms.
+
+2007/05/20:
+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.
+
+2007/05/18:
+Added --follow-construction to help understand the construction of the
+LR(1) automaton (very verbose).
+
+2007/05/11:
+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.
+
+2007/03/22:
+Makefile improvements (check for PREFIX; bootstrap in bytecode now
+also available). Slight changes to OMakefile.shared.
+
+2007/02/15:
+Portability fix in Makefile and Makefile.shared (avoided "which").
+
+2006/12/15:
+Portability fix in Makefile.shared (replaced "&>" with "2>&1 >").
+
+2006/06/23:
+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.
+
+2006/06/16:
+Fixed bug that would cause positions to become invalid after %inlining.
+
+2006/06/15:
+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).
+
+2006/06/12:
+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.
+
+2006/05/05:
+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.
+
+2006/04/21:
+Fixed problem that allowed generating incorrect but apparently well-typed
+Objective Caml code when a semantic action was ill-typed and --infer was
+omitted.
+
+2006/03/29:
+Improved conflict reports by factoring out maximal common derivation contexts.
+
+2006/03/28:
+Fixed bug that could arise when explaining a conflict in a non-LALR(1) grammar.
+
+2006/03/27:
+Changed count of reduce/reduce conflicts to allow a comparison with ocamlyacc's diagnostics.
+When refusing to resolve a conflict, report all diagnostics before dying.
+
+2006/03/18:
+Added display of FOLLOW sets when using --log-grammar 2.
+Added --graph option.
+Fixed behavior of --depend option.
+
+2006/01/06:
+Removed reversed lists from the standard library.
+

GNUmakefile

+# -------------------------------------------------------------------------
+
+# This is the development Makefile. It is used for compiling
+# development versions and for creating the distributed package.
+# This Makefile is not distributed.
+
+SHELL := bash
+
+.PHONY: test bootstrap all package check export godi clean
+
+# -------------------------------------------------------------------------
+
+# Compiling.
+
+all:
+	$(MAKE) $(MFLAGS) -C src -f GNUmakefile
+
+# -------------------------------------------------------------------------
+
+# Bootstraping.
+
+bootstrap:
+	$(MAKE) $(MFLAGS) -C src -f GNUmakefile bootstrap
+
+# -------------------------------------------------------------------------
+
+# Testing.
+
+test:
+	$(MAKE) -C bench
+
+# -------------------------------------------------------------------------
+
+# Cleaning up.
+
+clean:
+	@ for i in bench demos src ; do \
+	  $(MAKE) $(MFLAGS) -C $$i $@ ; \
+	done
+	$(MAKE) $(MFLAGS) -rs -C doc $@
+
+# -------------------------------------------------------------------------
+
+# Prevent the built-in bash cd from displaying information.
+
+export CDPATH=
+
+# Distribution.
+# The version number is automatically set to the current date.
+
+DATE     := $(shell /bin/date +%Y%m%d)
+PACKAGE  := menhir-$(DATE)
+CURRENT  := $(shell pwd)
+TARBALL  := $(CURRENT)/$(PACKAGE).tar.gz
+HEADACHE := headache
+SRCHEAD  := $(CURRENT)/header
+LIBHEAD  := $(CURRENT)/lgpl-header
+
+# GODI settings. We assume $(GODI_HOME) is defined and points
+# to the host machine's GODI installation.
+
+GODINAME := godi/godi-menhir
+GODIWORK := /home/fpottier/dev/godi-build
+GODISVN  := $(GODIWORK)/trunk/$(GODINAME)
+GODIH    := $(GODI_HOME)/build/$(GODINAME)
+GODIPACK := $(GODIWORK)/pack
+GODIMAP  := $(GODIPACK)/release.4.00.map
+GODIURL  := https://godirepo.camlcity.org/godi_admin
+GODIVA   := $(GODI_HOME)/bin/godiva
+
+# A list of files to copy without changes to the package.
+#
+# This does not include the src/ and doc/ directories, which require
+# special treatment.
+
+DISTRIBUTED_FILES := AUTHORS CHANGES INSTALLATION LICENSE Makefile Makefile.arch demos
+
+# Some source files carry the "library" license, while others carry
+# the regular "source code" license.
+
+LIBFILES := \
+  src/standard.mly \
+  src/infiniteArray.{ml,mli} \
+  src/packedIntArray.{ml,mli} \
+  src/rowDisplacement.{ml,mli} \
+  src/engineTypes.ml \
+  src/engine.{ml,mli} \
+  src/tableFormat.ml \
+  src/tableInterpreter.{ml,mli} \
+  src/convert.{ml,mli}
+
+package: clean
+# Create a directory to store the distributed files temporarily.
+	@ rm -fr $(PACKAGE)
+	@ mkdir -p $(PACKAGE)/src
+	@ cp -fr $(DISTRIBUTED_FILES) $(PACKAGE)
+	@ cp -fr src/*.ml{,i,y,l} src/Makefile src/META $(PACKAGE)/src
+	@ $(MAKE) -C $(PACKAGE)/demos clean
+# Insert headers.
+	@ echo "-> Inserting headers."
+	@ cd $(PACKAGE) && find . -regex ".*\.ml\(i\|y\|l\)?" \
+	    -exec $(HEADACHE) -h $(SRCHEAD) "{}" ";"
+	@ cd $(PACKAGE) && for file in $(LIBFILES) ; do \
+	    $(HEADACHE) -h $(LIBHEAD) $$file ; \
+	  done
+# Set the version number into the files that mention it. These
+# include version.ml, version.tex, META.
+	@ echo "-> Setting version to $(DATE)."
+	@ echo let version = \"$(DATE)\" > $(PACKAGE)/src/version.ml
+	@ echo version = \"$(DATE)\" >> $(PACKAGE)/src/META
+# Copy and compile the documentation.
+	@ echo "-> Generating the documentation."
+	@ cp -r doc $(PACKAGE)
+	@ echo '\gdef\menhirversion{$(DATE)}' > $(PACKAGE)/doc/version.tex
+	@ make -rs -C $(PACKAGE)/doc clean pdf
+	@ mv $(PACKAGE)/doc/main.pdf $(PACKAGE)/manual.pdf
+	@ mv $(PACKAGE)/doc/menhir.1 $(PACKAGE)/
+	@ rm -rf $(PACKAGE)/doc
+# Create the API documentation.
+	@ $(MAKE) -C src api
+# Create the tarball.
+	@ echo "-> Tarball creation."
+	tar --exclude=.svn -cvz -f $(TARBALL) $(PACKAGE)
+	@ echo "-> Package $(PACKAGE).tar.gz is ready."
+
+check:
+	@ echo "-> Checking the package ..."
+# Create a temporary directory; extract, build, and install the
+# package into it; run the test suite using the installed binary.
+	@ TEMPDIR=`mktemp -d /tmp/menhir-test.XXXXXX` && { \
+	echo "   * Extracting. " && \
+	(cd $$TEMPDIR && tar xfz $(TARBALL)) && \
+	echo "   * Compiling and installing." && \
+	mkdir $$TEMPDIR/install && \
+	(cd $(PACKAGE) \
+		&& make PREFIX=$$TEMPDIR/install USE_OCAMLFIND=false all install \
+	) > $$TEMPDIR/install.log 2>&1 \
+		|| (cat $$TEMPDIR/install.log; exit 1) && \
+	echo "   * Running the test suite." && \
+	$(MAKE) MENHIR=$$TEMPDIR/install/bin/menhir test > $$TEMPDIR/test.log 2>&1 \
+		|| (cat $$TEMPDIR/test.log; exit 1) && \
+	rm -fr $$TEMPDIR ; }
+	@ echo "-> Package $(PACKAGE) seems ready for distribution!"
+
+# -------------------------------------------------------------------------
+
+# Copying to my Web site.
+
+RSYNC   := scp -p -B -C
+TARGET  := yquem.inria.fr:public_html/menhir/
+PAGE    := /home/fpottier/dev/page
+
+export:
+# Copier l'archive et la doc vers yquem.
+	$(RSYNC) $(TARBALL) $(TARGET)
+	$(RSYNC) $(PACKAGE)/manual.pdf $(TARGET)
+	$(RSYNC) CHANGES $(TARGET)
+# Copier l'API vers la page Web.
+	cd src && $(RSYNC) convert.mli.html $(TARGET)
+# Mettre  jour la page Web de Menhir avec le nouveau numro de version.
+	cd $(PAGE) && \
+	  sed --in-place=.bak "s/menhir-[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]/$(PACKAGE)/" menhir.xml && \
+	  $(MAKE) export && \
+	  cvs commit -m "Updated Menhir's version number."
+
+# -------------------------------------------------------------------------
+
+# Creating a GODI package.
+
+# This entry assumes that "make package" and "make export" have been
+# run on the same day. It must have sufficient rights to write into
+# the local GODI hierarchy.
+
+godi:
+	@ if [ `whoami` != "root" ] ; then \
+	  echo "make godi must be run with root privileges. Try running ./godi" ; \
+	  exit 1 ; \
+	fi
+	@ sed -e s/VERSION/$(DATE)/ < spec.godiva > $(GODISVN)/spec.godiva
+	@ cd $(GODIWORK) && svn up
+	@ cd $(GODISVN) && \
+          $(GODIVA) -refetch -localbase $(GODI_HOME) spec.godiva && \
+	  rsync -v -r $(GODIH)/ $(GODISVN) && \
+	  chown -R fpottier $(GODISVN)
+	@ echo "Do you wish to proceed and commit changes to GODI (yes or no)?"
+	@ read answer && if [ "$$answer" != "yes" ] ; then \
+	  echo Aborting. ; \
+	  exit 1 ; \
+	fi
+	@ cd $(GODISVN) && \
+	  svn commit -m "Changes to Menhir package." && \
+	  export revision=`svn info Makefile | sed -n 's/^R.vision \?: \([0-9]\+\)$$/\1/p'` && \
+	  echo Revision is now $$revision. && \
+	  for map in $(GODIMAP) ; do \
+	    sed --in-place=.bak "s/^\(.*menhir[^0-9]*\)[0-9]\+$$/\1$$revision/" $$map ; \
+	  done
+	@ echo Here are my changes to the release maps:
+	@ cd $(GODIPACK) && svn diff --diff-cmd diff -x "-C0"
+	@ echo "Do you wish to proceed and commit changes to GODI (yes or no)?"
+	@ read answer && if [ "$$answer" != "yes" ] ; then \
+	  echo Aborting. ; \
+	  exit 1 ; \
+	fi
+	@ cd $(GODIPACK) && svn commit -m "Updated release map for Menhir."
+	@ echo "You may now open GODI's release tool at"
+	@ echo "        $(GODIURL)"
+	@ echo "and proceed as directed. I will try to open this URL for you."
+	@ case $$OSTYPE in \
+	(linux*) \
+	  su fpottier -c "firefox $(GODIURL)" ;; \
+	(*) \
+	  open $(GODIURL) ;; \
+	esac

HOWTO

+This HOWTO is intended for new Menhir developers, and should explain how
+things work.
+
+For the moment, there is not much information in it.
+
+BUILD INSTRUCTIONS
+------------------
+
+There are two ways of building Menhir: either from scratch, or incrementally.
+
+Building from scratch is performed via the public Makefile, and requires
+defining the PREFIX variable, even if no installation is performed:
+
+  make PREFIX=/usr/local -f Makefile
+
+This is a two-stage process, in which a first version of menhir is built
+using ocamlyacc, and a second version of menhir is built using the menhir
+executable produced by the first stage.
+
+Building incrementally is useful when working on the code. In that case,
+one wishes to recompile incrementally, without going through the bootstrap
+process. This works only if a menhir executable already exists in the src/
+subdirectory. This is done simply by typing:
+
+  make
+
+(or, equivalently, make -f GNUmakefile).
+

INSTALLATION

+REQUIREMENTS
+
+You need Objective Caml 3.09 or later and GNU make.
+
+HOW TO INSTALL
+
+If you wish to install via ocamlfind, make sure that ocamlfind is in
+your PATH. (Remember that prefixing a command with sudo affects its
+PATH.)
+
+Run the following command:
+
+  make PREFIX=/usr/local install
+
+If your machine does not have the native code Objective Caml compiler
+(ocamlopt), but does have the bytecode compiler (ocamlc), then instead
+of the above command, use:
+
+  make PREFIX=/usr/local TARGET=byte all install
+
+The value of the PREFIX variable can be changed to control where
+the software, the standard library, and the documentation should
+be stored. These files are copied to the following places:
+
+  $PREFIX/bin/
+  $PREFIX/share/menhir/
+  $PREFIX/doc/menhir/
+
+The support library, MenhirLib, is either installed via ocamlfind, if
+available, or placed within $PREFIX/share/menhir. Menhir's --suggest
+options help determine where and how it was installed.
+
+The documentation includes a reference manual and a number of demos.
+

Makefile

+# This is the main Makefile that is shipped as part of the source package.
+# Keep in mind that the hierarchy that is shipped is not identical to the
+# hierarchy within the svn repository: some sub-directories are not shipped;
+# the documentation is pre-built.
+
+# The hierarchy that is shipped includes:
+#   demos
+#   menhir.1
+#   manual.pdf
+#   src
+#   Makefile (this one)
+
+# ----------------------------------------------------------------------------
+
+# By default, we attempt to use ocamlfind (if present in the PATH), but it it
+# is possible to prevent that externally by setting USE_OCAMLFIND to false.
+
+ifndef USE_OCAMLFIND
+  USE_OCAMLFIND = ocamlfind ocamlc -v >/dev/null 2>&1
+endif
+
+# ----------------------------------------------------------------------------
+
+# A few settings differ on Windows versus Unix.
+
+include Makefile.arch
+
+# ----------------------------------------------------------------------------
+# Installation paths.
+
+# TEMPORARY GODIVA and Linux do not agree on the standard paths...
+
+ifndef PREFIX
+  $(error Please define PREFIX)
+endif
+
+bindir          := ${PREFIX}/bin
+docdir		:= ${PREFIX}/share/doc/menhir
+libdir	        := ${PREFIX}/share/menhir
+mandir          := ${PREFIX}/share/man/man1
+MANS            := menhir.1
+DOCS            := manual.pdf demos
+MLYLIB          := src/standard.mly
+
+# -------------------------------------------------------------------------
+
+# Building menhirLib.
+
+ifeq ($(TARGET),byte)
+MENHIRLIB       := menhirLib.cmi menhirLib.cmo
+else
+MENHIRLIB       := menhirLib.cmi menhirLib.cmo menhirLib.cmx menhirLib.$(OBJ)
+endif
+
+# ----------------------------------------------------------------------------
+# Compilation.
+
+# Installation time settings are recorded within src/installation.ml.
+# This file is recreated every time so as to avoid becoming stale.
+
+.PHONY: all install uninstall
+
+all:
+	rm -f src/installation.ml
+	echo "let libdir = \"${libdir}\"" > src/installation.ml
+	if $(USE_OCAMLFIND) ; then \
+	  echo "let ocamlfind = true" >> src/installation.ml ; \
+	else \
+	  echo "let ocamlfind = false" >> src/installation.ml ; \
+	fi
+	$(MAKE) $(MFLAGS) -C src -f Makefile
+	$(MAKE) $(MFLAGS) -C src -f Makefile $(MENHIRLIB)
+
+# ----------------------------------------------------------------------------
+# Installation.
+
+install: all
+	mkdir -p $(bindir)
+	mkdir -p $(libdir)
+	mkdir -p $(docdir)
+	mkdir -p $(mandir)
+	install src/$(MENHIREXE) $(bindir)
+	install -m 644 $(MLYLIB) $(libdir)
+	cp -r $(DOCS) $(docdir)
+	cp -r $(MANS) $(mandir)
+	@cd src && if $(USE_OCAMLFIND) ; then \
+	  echo Installing MenhirLib via ocamlfind. ; \
+	  ocamlfind install menhirLib META $(MENHIRLIB) ; \
+	else \
+	  echo Installing MenhirLib manually. ; \
+	  install -m 644 $(MENHIRLIB) $(libdir) ; \
+	fi
+
+uninstall:
+	rm -rf $(bindir)/$(MENHIREXE)
+	rm -rf $(libdir)
+	rm -rf $(docdir)
+	rm -rf $(mandir)/$(MANS)
+	@if $(USE_OCAMLFIND) ; then \
+	  echo Un-installing MenhirLib via ocamlfind. ; \
+	  ocamlfind remove menhirLib ; \
+	fi

Makefile.arch

+# If ocaml reports that Sys.os_type is Unix, we assume Unix, otherwise
+# we assume Windows.
+
+ifeq "$(shell rm -f ./o.ml && echo print_endline Sys.os_type > ./o.ml && ocaml ./o.ml && rm -f ./o.ml)" "Unix"
+MENHIREXE    := menhir
+OBJ          := o
+else
+MENHIREXE    := menhir.exe
+OBJ          := obj
+endif

TODO

+* when a parse error occurs, decorate the exception with the automaton state
+  that was reached? this would allow some people to produce better error
+  messages (Pippijn van Steenhoven). Incompatible change?
+
+* BUG: le Makefile ne fonctionne pas avec -j (email de Florent Hivert)
+
+* projet amusant: si l'automatique est canonique et si on n'a pas trop
+  optimisé le contenu de la pile, alors en cas d'erreur, on doit pouvoir
+  analyser le contenu de la pile pour produire un suffixe de l'entrée qui
+  aurait conduit à une acceptation. Ça trouerait le C** comme message
+  d'explication!
+
+* Les fichiers dans examples/ ne devraient pas être sous QPL mais libres...
+
+* BUG: la directive $type<...> nt donne lieu à un message d'erreur bizarre
+  si le non-terminal nt n'existe pas. (Jacques-Henri.)
+
+* On pourrait rendre moins restrictif le critère qui garantit la terminaison
+  de l'expansion des non-terminaux paramétrés. Il suffirait de vérifier que
+  les paramètres effectifs sont toujours des atomes (symboles terminaux ou
+  non-terminaux), non? (Jacques-Henri.)
+
+* les positions fournies par menhir ne sont pas les mêmes fournies par