gecko-dev/servo
Xidorn Quan ab54f9a291 servo: Merge #12498 - Support generating bindings for MSVC (from upsuper:msvc-bindgen); r=emilio
<!-- Please describe your changes on the following line: -->

This pull request includes several patches to the binding generating script to make it work with MSVC. The generated files are not updated because they may not be compatible with other platforms which the majority of developers are working on.

Only `regen.py` is modified. The two `.sh` files are not. Those files are very platform-specific and I don't think it's worth to make them work on Windows at all, and my hope is that we can get rid of those files and only use `regen.py`. I imagine the only left steps to get there are:

1. make clang version detectable via `bindgen` so that we get reliable clang version without needing to duplicate the library searching work (which has already been done in `clang-sys`)
2. checkout the git repo inside the python script and run `cargo build` there

BTW, it seems to me nightly Rust is not required to build `bindgen`, and thus we can probably get rid of the `multirust` detection. (Even if we need that, I think we should prefer `rustup` and optionally fallback to `multirust`. I know `rustup` is not yet available on Homebrew, though...)

---
<!-- Thank you for contributing to Servo! Please replace each `[ ]` by `[X]` when the step is complete, and replace `__` with appropriate data: -->
- [X] `./mach build -d` does not report any errors
- [X] `./mach test-tidy` does not report any errors
- [ ] These changes fix #__ (github issue number if applicable).

<!-- Either: -->
- [ ] There are tests for these changes OR
- [X] These changes do not require tests because it is a change to binding generating script

<!-- Pull requests that do not address these steps are welcome, but they will require additional verification as part of the review process. -->

r? @emilio

Source-Repo: https://github.com/servo/servo
Source-Revision: 2ce85f1cddb05689c231b1a17dfd2d374ad48377
2016-07-18 22:34:18 -07:00
..
components servo: Merge #12497 - Update WR to get fix for texture atlas assert (from glennw:wr-update); r=emilio 2016-07-18 18:46:14 -07:00
docs servo: Merge #12266 - Update HACKING_QUICKSTART.md (from tshepang:patch-1); r=nox 2016-07-08 00:51:03 -07:00
etc servo: Merge #12470 - Place apis.html in the same place as css-properties.html (from servo:jdm-patch-2); r=Manishearth 2016-07-16 00:32:21 -07:00
ports servo: Merge #12498 - Support generating bindings for MSVC (from upsuper:msvc-bindgen); r=emilio 2016-07-18 22:34:18 -07:00
python servo: Merge #12484 - Temporary fix for mach test-{wpt, css} issue with wonky paths (from aravind-pg:mach); r=ConnorGBrewster 2016-07-17 19:42:10 -07:00
resources servo: Merge #12364 - Make textarea scrollable (from kilobtye:textarea); r=jdm 2016-07-17 13:52:46 -07:00
support servo: Merge #12447 - All our Cargo.toml files should contain an MPL-2.0 license field (from asajeffrey:license-mpl-2.0); r=frewsxcv 2016-07-14 09:33:18 -07:00
tests servo: Merge #11727 - Integrate service worker manager thread (from creativcoder:swmanager); r=jdm 2016-07-18 09:50:59 -07:00
.gitattributes servo: Merge #6336 - Appease Github's Linguist (from nerith:master); r=Manishearth 2015-06-10 22:30:58 -06:00
.gitignore servo: Merge #10825 - Adding vscode and intellij settings folders to gitignore (from craftytrickster:gitignore-update); r=Ms2ger 2016-04-25 05:09:57 -07:00
.travis.yml servo: Merge #12386 - Build geckolib on travis (from servo:geckolib-travis); r=nox 2016-07-11 06:06:06 -07:00
appveyor.yml servo: Merge #11066 - Remove auto and try branch from appveyor.yml (from UK992:appveyor); r=larsbergstrom 2016-05-07 07:27:18 -07:00
cargo-nightly-build servo: Merge #11177 - Update Cargo to 2016-05-12 (from metajack:cargo-up); r=jdm 2016-05-13 14:11:08 -07:00
CONTRIBUTING.md servo: Merge #10687 - Encourage better documentation patterns (from jdm:docs); r=larsbergstrom 2016-04-19 05:44:00 +05:01
Info.plist servo: Merge #12267 - Don't warn about reopening a crashed Servo window on Mac (from Manishearth:nocrash-plist); r=metajack 2016-07-06 04:42:15 -07:00
LICENSE
mach servo: Merge #11391 - mach: Redirect stderr to /dev/null when locating Python binary (from perlun:fix/be-more-quiet-when-finding-python-binary); r=mbrubeck 2016-05-26 04:16:42 -05:00
PULL_REQUEST_TEMPLATE.md servo: Merge #11383 - Hide unnecessary information in the rendered PR template (from servo:jdm-patch-1); r=mbrubeck 2016-05-26 02:30:48 -05:00
README.md servo: the --android flag is now needed for the package command 2016-07-04 15:58:27 -07:00
rust-nightly-date servo: Merge #11871 - Update Rust to 1.11.0-nightly (ad7fe6521 2016-06-23) (from servo:rustup); r=jdm 2016-06-27 09:47:34 -05:00
rust-stable-version servo: Merge #11945 - Add mach build-stable to build with stable rustc (from gpoesia:master); r=SimonSapin 2016-07-05 07:17:48 -07:00
servobuild.example servo: Merge #11474 - Remove the gonk port (from larsbergstrom:remove_gonk); r=metajack 2016-05-27 19:34:55 -05:00

The Servo Parallel Browser Engine Project

Linux Build Status Windows Build Status

Servo is a prototype web browser engine written in the Rust language. It is currently developed on 64bit OS X, 64bit Linux, and Android.

Servo welcomes contribution from everyone. See CONTRIBUTING.md and HACKING_QUICKSTART.md for help getting started.

Visit the Servo Project page for news and guides.

Prerequisites

On OS X (homebrew):

brew install automake pkg-config python cmake
pip install virtualenv

On OS X (MacPorts):

sudo port install python27 py27-virtualenv cmake

On OS X 10.11 (El Capitan), you also have to install openssl:

brew install openssl
brew link --force openssl

On Debian-based Linuxes:

sudo apt-get install git curl freeglut3-dev autoconf \
    libfreetype6-dev libgl1-mesa-dri libglib2.0-dev xorg-dev \
    gperf g++ build-essential cmake virtualenv python-pip \
    libssl-dev libbz2-dev libosmesa6-dev libxmu6 libxmu-dev \
    libglu1-mesa-dev libgles2-mesa-dev libegl1-mesa-dev libdbus-1-dev

If you are on Ubuntu 14.04 and encountered errors on installing these dependencies involving libcheese, see #6158 for a workaround.

If virtualenv does not exist, try python-virtualenv.

On Fedora:

sudo dnf install curl freeglut-devel libtool gcc-c++ libXi-devel \
    freetype-devel mesa-libGL-devel mesa-libEGL-devel glib2-devel libX11-devel libXrandr-devel gperf \
    fontconfig-devel cabextract ttmkfdir python python-virtualenv python-pip expat-devel \
    rpm-build openssl-devel cmake bzip2-devel libXcursor-devel libXmu-devel mesa-libOSMesa-devel \
    dbus-devel

On Arch Linux:

sudo pacman -S --needed base-devel git python2 python2-virtualenv python2-pip mesa cmake bzip2 libxmu glu pkg-config

On Gentoo Linux:

sudo emerge net-misc/curl media-libs/freeglut \
    media-libs/freetype media-libs/mesa dev-util/gperf \
    dev-python/virtualenv dev-python/pip dev-libs/openssl \
    x11-libs/libXmu media-libs/glu x11-base/xorg-server

On Windows:

Download Python for Windows here. This is required for the SpiderMonkey build on Windows.

Install MSYS2 from here. After you have done so, open an MSYS shell window and update the core libraries and install new packages:

pacman -Su
pacman -Sy git mingw-w64-x86_64-toolchain mingw-w64-x86_64-freetype \
    mingw-w64-x86_64-icu mingw-w64-x86_64-nspr mingw-w64-x86_64-ca-certificates \
    mingw-w64-x86_64-expat mingw-w64-x86_64-cmake tar diffutils patch \
    patchutils make python2-setuptools
easy_install-2.7 pip virtualenv

Open a new MSYS shell window as Administrator and remove the Python binaries (they are not compatible with our mach driver script yet, unfortunately):

cd /mingw64/bin
mv python2.exe python2-mingw64.exe
mv python2.7.exe python2.7-mingw64.exe

Now, open a MINGW64 (not MSYS!) shell window, and you should be able to build servo as usual!

Cross-compilation for Android:

Pre-installed Android tools are needed. See wiki for details

The Rust compiler

Servo's build system automatically downloads a Rust compiler to build itself. This is normally a specific revision of Rust upstream, but sometimes has a backported patch or two. If you'd like to know which nightly build of Rust we use, see rust-nightly-date.

Building

Servo is built with Cargo, the Rust package manager. We also use Mozilla's Mach tools to orchestrate the build and other tasks.

Normal build

To build Servo in development mode. This is useful for development, but the resulting binary is very slow.

git clone https://github.com/servo/servo
cd servo
./mach build --dev
./mach run tests/html/about-mozilla.html

For benchmarking, performance testing, or real-world use, add the --release flag to create an optimized build:

./mach build --release
./mach run --release tests/html/about-mozilla.html

Building for Android target

git clone https://github.com/servo/servo
cd servo

export ANDROID_SDK="/path/to/sdk"
export ANDROID_NDK="/path/to/ndk"
export ANDROID_TOOLCHAIN="/path/to/toolchain"
export PATH="$PATH:/path/to/toolchain/bin"

./mach build --release --android
./mach package --release --android

Rather than setting the ANDROID_* environment variables every time, you can also create a .servobuild file and then edit it to contain the correct paths to the Android SDK/NDK tools:

cp servobuild.example .servobuild
# edit .servobuild

Running

Use ./mach run [url] to run Servo. Also, don't miss the info on the browserhtml page on how to run the Browser.html full tech demo (it provides a more browser-like experience than just browsing a single URL with servo).

Commandline Arguments

  • -p INTERVAL turns on the profiler and dumps info to the console every INTERVAL seconds
  • -s SIZE sets the tile size for painting; defaults to 512
  • -z disables all graphical output; useful for running JS / layout tests

Keyboard Shortcuts

  • Ctrl-- zooms out
  • Ctrl-= zooms in
  • Alt+left arrow goes backwards in the history
  • Alt+right arrow goes forwards in the history
  • Esc exits servo

Developing

There are lots of mach commands you can use. You can list them with ./mach --help.

The generated documentation can be found on http://doc.servo.org/servo/index.html