The Servo Browser Engine
Find a file
Delan Azabani 2778beeb7a
winit: initial minibrowser (#29976)
* winit: add minibrowser feature that depends on egui{,-winit}

* winit: carve out some space at the top of headed windows

* winit: minimal toolbar and egui/winit integration (but no painting)

* winit: try to paint with egui_glow (doesn’t work yet)

* winit: add comment about toolbar size

* Add framebuffer object, set it as glow's target

* compositing: clear only the viewport, not the whole framebuffer

* plumb the actual size of the egui toolbar to webrender

* fix formatting

* winit: fix crash when fbo is zero

* winit: don’t bother binding the framebuffer object

* winit: remove unsafe and get toolbar_height

* winit: location field should reflect the current top-level url

* [NFC] winit: move Minibrowser out of App::run

* winit: clean up toolbar height code

* winit: make App own the Minibrowser if any

* winit: make the go button work

* winit:make the location field reflect the current top-level url

* winit: allow enabling minibrowser from command line

* winit: tell compositor to repaint WR and flush when we repaint

* winit: fix bug where location field edits would get overridden

* winit: borrow the minibrowser once in App::handle_events

* winit: address todo about viewport origin coordinates

* winit: fix some minor problems with comments and errors

* winit: update location field once per HistoryChanged event

* winit: rename Window::set_toolbar_size to set_toolbar_height

* winit: take toolbar height into account in hit testing

* winit: pass egui only relevant CursorMoved events

* winit: scratch that, coalesce minibrowser updates instead

* ensure both minibrowser and WR are repainted on every frame

* compositing: only skip framebuffer clear in external present mode

* winit: destroy egui glow Painter when shutting down

* winit: clean up and fix license lint

* fix duplicate versions lint by downgrading bytemuck_derive

was egui_glow ^0.22.0 (0.22.0)
→ egui/bytemuck ^0.22.0 (0.22.0)
→ epaint/bytemuck ^0.22.0 (0.22.0)
→ bytemuck ^1.7.2 (1.13.1)
→ bytemuck_derive ^1.4 (1.4.1)
→ syn ^2.0.1 (2.0.28)

now lock has bytemuck_derive 1.4.0
→ syn ^1.0.99 (1.0.103)

* fix duplicate versions lint by disabling egui-winit/links

(we don’t need support for hyperlinks in our use of egui)

* squelch duplicate versions lint by excluding clipboard-win

* winit: fix compile warnings

* winit: make gleam an optional dependency under /minibrowser

* winit: remove cargo feature, since it’s not really optional

* winit: extract Minibrowser and related code to separate module

* winit: remove unnecessary trailing comma

* winit: simplify the ServoUrl serialisation optimisation

---------

Co-authored-by: atbrakhi <atbrakhi@igalia.com>
2023-08-15 08:08:50 +00:00
.cargo Support building UWP with native UWP rustc target. 2019-10-12 10:19:26 -04:00
.github Make the --release/--dev more consistent and less surprising (#30091) 2023-08-14 10:21:29 +00:00
.vscode Update suggested Rust vscode extension. 2022-08-03 20:08:24 +08:00
components winit: initial minibrowser (#29976) 2023-08-15 08:08:50 +00:00
docs docs: Fix sample command in COMMAND_LINE_ARGS doc (#30082) 2023-08-09 13:43:13 +00:00
etc Support mac wpt builds (#29867) 2023-08-11 17:26:15 +00:00
ports winit: initial minibrowser (#29976) 2023-08-15 08:08:50 +00:00
python Run same tests for layout-2020 and layout-2013 (#30092) 2023-08-15 00:28:32 +00:00
resources Switch to rustls and webpki-roots (#30025) 2023-08-08 14:00:10 +00:00
support Switch to rustls and webpki-roots (#30025) 2023-08-08 14:00:10 +00:00
tests Run same tests for layout-2020 and layout-2013 (#30092) 2023-08-15 00:28:32 +00:00
third_party Fix warnings in vendored WebRender 2023-07-06 14:39:19 +02:00
.clang-format Run test-tidy on Windows 2019-11-21 09:56:39 +01:00
.flake8 Standalone Flake8 config 2023-06-23 16:24:35 +02:00
.gitattributes Explicitly declare image files to be binaries in .gitattributes, so as to avoid crlf-munging 2019-07-05 09:00:56 -05:00
.gitignore Remove lzma path workaround for MacOS (#30053) 2023-08-01 11:11:46 +00:00
.hgignore Add .hgignore file 2017-02-03 18:42:52 -08:00
.mailmap Update Tetsuharu OHZEKI's entry in mailmap 2019-11-15 00:46:45 +09:00
Cargo.lock winit: initial minibrowser (#29976) 2023-08-15 08:08:50 +00:00
Cargo.toml Remove dependency on surfman-chains (#30090) 2023-08-11 14:24:10 +00:00
CLOBBER Add clobber mechanism 2017-05-08 16:19:56 +02:00
CONTRIBUTING.md Update link to CoC 2023-05-19 19:09:45 +02:00
dependencyci.yml Don't report smallbitvec as an error. 2017-10-16 11:38:34 -04:00
Info.plist remove bhtml 2018-02-11 08:02:39 +01:00
LICENSE Update MPL license to https (part 1) 2018-11-19 14:46:43 +01:00
mach mach: fix exit status on NixOS (#30079) 2023-08-08 09:09:27 +00:00
mach.bat Make mach.bat request Python 3 2021-05-22 18:27:10 +09:00
PULL_REQUEST_TEMPLATE.md Minor pull request template cleanup 2018-12-08 13:11:37 -08:00
README.md Remove UWP / Hololens support 2023-07-05 09:12:09 +02:00
rust-toolchain.toml Make rustup a requirement and switch to rust-toolchain.toml (#30056) 2023-08-01 14:44:57 +00:00
rustfmt.toml Vendor the current version of WebRender 2023-07-03 17:55:17 +02:00
servo-tidy.toml winit: initial minibrowser (#29976) 2023-08-15 08:08:50 +00:00
servobuild.example Make rustup a requirement and switch to rust-toolchain.toml (#30056) 2023-08-01 14:44:57 +00:00

The Servo Parallel Browser Engine Project

Servo is a prototype web browser engine written in the Rust language. It is currently developed on 64-bit macOS, 64-bit Linux, 64-bit Windows, 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.

Build Setup

If these instructions fail or you would like to install dependencies manually, try the manual build setup.

macOS

  • Install Xcode
  • Install Homebrew
  • Run curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
  • Run pip install virtualenv
  • Run ./mach bootstrap
    Note: This will install the recommended version of GStreamer globally on your system.

Linux

  • Run curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
  • Install Python and virtualenv
    • Debian-like: Run sudo apt install python3-virtualenv python3-pip
    • Fedora: Run sudo dnf install python3 python3-virtualenv python3-pip python3-devel
    • Arch: Run sudo pacman -S --needed python python-virtualenv python-pip
    • Gentoo: Run sudo emerge dev-python/virtualenv dev-python/pip
  • Run ./mach bootstrap

Windows

  • Download and run rustup-init.exe then follow the onscreen instructions.
  • Install chocolatey
  • Run mach bootstrap
  • This will install CMake, Git, Ninja, Python and the Visual Studio 2019 Build Tools via choco in an Administrator console. It can take quite a while.
  • If you already have Visual Studio 2019 installed, this may not install all necessary components. Please follow the Visual Studio 2019 installation instructions in the manual setup.
  • Run refreshenv

See also Windows Troubleshooting Tips.

Cloning the Repo

Your CARGO_HOME needs to point to (or be in) the same drive as your Servo repository (See #28530).

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

Building

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

On Unix systems:

./mach [command] [arguments]

On Windows Commandline:

mach.bat [command] [arguments]

The examples below will use Unix, but the same applies to Windows.

The Rust compiler

Servo's build system uses rustup.rs to automatically download a Rust compiler. This is a specific version of Rust Nightly determined by the rust-toolchain file.

Normal build

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

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

Release build

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

Checking for build errors, without building

If youre making changes to one crate that cause build errors in another crate, consider this instead of a full build:

./mach check

It will run cargo check, which runs the analysis phase of the compiler (and so shows build errors if any) but skips the code generation phase. This can be a lot faster than a full build, though of course it doesnt produce a binary you can run.

Building for Android target

For ARM (armv7-linux-androideabi, most phones):

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

For x86 (typically for the emulator):

./mach build --release --target i686-linux-android
./mach package --release --target i686-linux-android

Running

Run Servo with the command:

./servo [url] [arguments] # if you run with nightly build
./mach run [url] [arguments] # if you run with mach

# For example
./mach run https://www.google.com

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
  • -Z help displays useful output to debug servo

Keyboard Shortcuts

  • Ctrl+L opens URL prompt (Cmd+L on Mac)
  • Ctrl+R reloads current page (Cmd+R on Mac)
  • Ctrl+- zooms out (Cmd+- on Mac)
  • Ctrl+= zooms in (Cmd+= on Mac)
  • Alt+left arrow goes backwards in the history (Cmd+left arrow on Mac)
  • Alt+right arrow goes forwards in the history (Cmd+right arrow on Mac)
  • Esc or Ctrl+Q exits Servo (Cmd+Q on Mac)

Runtime dependencies

Linux

  • GStreamer >=1.16
  • gst-plugins-bad >=1.16

Developing

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

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