Tagua Parser

Tagua VM is an experimental PHP Virtual Machine written with the Rust language and the LLVM Compiler Infrastructure.

The Virtual Machine is composed of several libraries. This library, Tagua Parser, contains the lexical and syntactic analysers, aka the parser, for the PHP language.

Installing

To install Tagua Parser, you must have Rust (see the Rust installation page) installed. Cargo is the Rust package manager.

To build a release version:

$ cargo build --release

To build a development version:

$ cargo build

If you have SIMD or AVX on your hardware, then, you can respectively use the simd or avx feature as follows:

$ cargo build --release --features simd

Using Docker

If installing Rust on your machine is too much, Docker might be an alternative: It provides everything needed to build, test and run the Tagua Parser.

First, build the Docker image:

$ docker build -t tagua-parser-dev .

Now, it is possible to run a container from this image:

$ docker run --rm -it -v $(pwd):/source tagua-parser-dev

If this command succeeds, you are inside a fresh container. To see if everything is fine, you can start the test suite:

$ cargo test

Contributing

Do whatever you want. Just respect the license and the other contributors. Your favorite tool is going to be:

$ cargo test

to run all the test suites (unit test suites, integration test suites and documentation test suites).

カンバン (Kanban)

In order to get an overview of what needs to be done, what is in progress and what has been recently done, a kanban board is available.

Documentation and help

The documentation is automatically uploaded online at the following address: https://docs.rs/tagua-parser/*/tagua_parser/.

To generate it locally, please, run the following command:

$ cargo doc --open

To get help on IRC, please join the official #taguavm channel on Freenode. Alternatively, there is a mirrored room on Gitter.

License

Tagua VM is under the New BSD License (BSD-3-Clause):

                                New BSD License



Copyright © 2016-2017, Ivan Enderlin.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the name of the Hoa nor the names of its contributors may be
      used to endorse or promote products derived from this software without
      specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.