Merge commit '051bc08d23df0930be5e959645c50dd0cdf411d4'

coolreader18 · Aug 29, 2017 · 8f69572 · 8f69572
2 parents 344fbed + 051bc08
commit 8f69572
Show file tree

Hide file tree

Showing 685 changed files with 59,062 additions and 8 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,10 +1,11 @@
-# Generated by Cargo
-# will have compiled files and executables
+*.pyc
+**/*.rs.bk
+*.swp
+*.swo
+tags
 /target/
-
-# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
-# More information here http://doc.crates.io/guide.html#cargotoml-vs-cargolock
 Cargo.lock
-
-# These are backup files generated by rustfmt
-**/*.rs.bk
+.*.rustfmt
+cretonne.dbg*
+.mypy_cache
+rusty-tags.*
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,18 @@
+language: rust
+rust:
+    - stable
+    - beta
+dist: trusty
+sudo: false
+addons:
+    apt:
+        packages:
+            - python3-pip
+install:
+    - pip3 install --user --upgrade mypy flake8
+    - travis_wait ./check-rustfmt.sh --install
+script: ./test-all.sh
+cache:
+    cargo: true
+    directories:
+        - $HOME/.cache/pip
diff --git a/Cargo.toml b/Cargo.toml
@@ -0,0 +1,26 @@
+[package]
+name = "cretonne-tools"
+authors = ["The Cretonne Project Developers"]
+version = "0.0.0"
+description = "Binaries for testing the Cretonne library"
+license = "Apache-2.0"
+documentation = "https://cretonne.readthedocs.io/"
+repository = "https://github.com/stoklund/cretonne"
+publish = false
+
+[[bin]]
+name = "cton-util"
+path = "src/cton-util.rs"
+
+[dependencies]
+cretonne = { path = "lib/cretonne" }
+cretonne-reader = { path = "lib/reader" }
+cretonne-frontend = { path = "lib/frontend" }
+wasm2cretonne-util = { path = "lib/wasm2cretonne-util" }
+filecheck = { path = "lib/filecheck" }
+docopt = "0.8.0"
+serde = "1.0.8"
+serde_derive = "1.0.8"
+num_cpus = "1.5.1"
+
+[workspace]
diff --git a/LICENSE b/LICENSE
@@ -1,3 +1,4 @@
+
                                  Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/

diff --git a/README.rst b/README.rst
@@ -0,0 +1,74 @@
+=======================
+Cretonne Code Generator
+=======================
+
+Cretonne is a low-level retargetable code generator. It translates a
+target-independent intermediate language into executable machine code.
+
+*This is a work in progress that is not yet functional.*
+
+.. image:: https://readthedocs.org/projects/cretonne/badge/?version=latest
+    :target: https://cretonne.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+.. image:: https://travis-ci.org/stoklund/cretonne.svg?branch=master
+    :target: https://travis-ci.org/stoklund/cretonne
+    :alt: Build Status
+
+Cretonne is designed to be a code generator for WebAssembly with these design
+goals:
+
+No undefined behavior
+    Cretonne does not have a `nasal demons clause <http://www.catb.org/jargon/html/N/nasal-demons.html>`_, and it won't generate code
+    with unexpected behavior if invariants are broken.
+Portable semantics
+    As far as possible, Cretonne's input language has well-defined semantics
+    that are the same on all target architectures. The semantics are usually
+    the same as WebAssembly's.
+Fast sandbox verification
+    Cretonne's input language has a safe subset for sandboxed code. No advanced
+    analysis is required to verify memory safety as long as only the safe
+    instructions are used. The safe instruction set is expressive enough to
+    implement WebAssembly.
+Scalable performance
+    Cretonne can be configured to generate code as quickly as possible, or it
+    can generate very good code at the cost of slower compile times.
+Predictable performance
+    When optimizing, Cretonne focuses on adapting the target-independent IL to
+    the quirks of the target architecture. There are no advanced optimizations
+    that sometimes work, sometimes fail.
+
+Building Cretonne
+-----------------
+
+Cretonne is using the Cargo package manager format. First, ensure you have
+installed a current stable rust (stable, beta, and nightly should all work, but
+only stable and beta are tested consistently). Then, change the working
+directory to your clone of cretonne and run::
+
+    cargo build
+
+This will create a *target/debug* directory where you can find the generated
+binary.
+
+To build the optimized binary for release::
+
+    cargo build --release
+
+You can then run tests with::
+
+    ./test-all.sh
+
+Building the documentation
+--------------------------
+
+To build the Cretonne documentation, you need the `Sphinx documentation
+generator <http://www.sphinx-doc.org/>`_::
+
+    $ pip install sphinx sphinx-autobuild sphinx_rtd_theme
+    $ cd cretonne/docs
+    $ make html
+    $ open _build/html/index.html
+
+We don't support Sphinx versions before 1.4 since the format of index tuples
+has changed.
diff --git a/check-rustfmt.sh b/check-rustfmt.sh
@@ -0,0 +1,35 @@
+#!/bin/bash
+#
+# Usage: check-rustfmt.sh [--install]
+#
+# Check that the desired version of rustfmt is installed.
+#
+# Rustfmt is still immature enough that its formatting decisions can change
+# between versions. This makes it difficult to enforce a certain style in a
+# test script since not all developers will upgrade rustfmt at the same time.
+# To work around this, we only verify formatting when a specific version of
+# rustfmt is installed.
+#
+# Exits 0 if the right version of rustfmt is installed, 1 otherwise.
+#
+# With the --install option, also tries to install the right version.
+
+# This version should always be bumped to the newest version available.
+VERS="0.8.4"
+
+if cargo install --list | grep -q "^rustfmt v$VERS"; then
+    exit 0
+fi
+
+if [ "$1" != "--install" ]; then
+    echo "********************************************************************"
+    echo "*  Please install rustfmt v$VERS to verify formatting.             *"
+    echo "*  If a newer version of rustfmt is available, update this script. *"
+    echo "********************************************************************"
+    echo "$0 --install"
+    sleep 1
+    exit 1
+fi
+
+echo "Installing rustfmt v$VERS."
+cargo install --force --vers="$VERS" rustfmt
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1 @@
+_build
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,196 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXABUILD  = sphinx-autobuild
+PAPER         =
+BUILDDIR      = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  applehelp  to make an Apple Help Book"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+	@echo "  coverage   to run coverage check of the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+autohtml: html
+	$(SPHINXABUILD) -z ../lib/cretonne/meta --ignore '.*.sw?' -b html -E $(ALLSPHINXOPTS) $(BUILDDIR)/html
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/cretonne.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/cretonne.qhc"
+
+applehelp:
+	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
+	@echo
+	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
+	@echo "N.B. You won't be able to view it unless you put it in" \
+	      "~/Library/Documentation/Help or install it in your application" \
+	      "bundle."
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/cretonne"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/cretonne"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+coverage:
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
+	@echo "Testing of coverage in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/coverage/python.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."