Crate wayland_scanner

Wayland scanner crate

This crate is a rust equivalent of the wayland-scanner tool from the official wayland C library.

You can use in your build script to generate the rust code for any wayland protocol file, to use alongside the wayland_client and wayland_server crate to build your applications.

How to use this crate

This crate is to be used in a build script. It provides you two functions, generate_code and generate_interfaces. They'll allow you to generate the code to use with the wayland_client or wayland_server crates for any XML wayland protocol file (NB: you don't need to do it for the core protocol, which is already included in both crates).

First, have the XML files you want to use in your project, somewhere the build script will be able to read them.

Then, you'll need to invoke both generate_interfaces and generate_code for each of these files.

A sample build script:

extern crate wayland_scanner;

use std::env::var;
use std::path::Path;

use wayland_scanner::{Side, generate_code, generate_interfaces};

fn main() {
    // Location of the xml file, relative to the `Cargo.toml`
    let protocol_file = "./my_protocol.xml";

    // Target directory for the generate files
    let out_dir_str = var("OUT_DIR").unwrap();
    let out_dir = Path::new(&out_dir_str);

    generate_code(
        protocol_file,
        out_dir.join("my_protocol_api.rs"),
        Side::Client, // Replace by `Side::Server` for server-side code
    );

    // interfaces are the same for client and server
    generate_interfaces(
        protocol_file,
        out_dir.join("my_protocol_interfaces.rs")
    );
}

The above example will output two .rs files in the OUT_DIR defined by cargo. Then, you'll need to include these two generated files (using the macro of the same name) to make this code available in your crate.

// The generated code will import stuff from wayland_sys
extern crate wayland_sys;
extern crate wayland_client;

// Re-export only the actual code, and then only use this re-export
// The `generated` module below is just some boilerplate to properly isolate stuff
// and avoid exposing internal details.
//
// You can use all the types from my_procol as if they went from `wayland_client::protocol`.
pub use generated::client as my_protocol;

mod generated {
    // The generated code tends to trigger a lot of warnings
    // so we isole it into a very permissive module
    #![allow(dead_code,non_camel_case_types,unused_unsafe,unused_variables)]
    #![allow(non_upper_case_globals,non_snake_case,unused_imports)]

    pub mod interfaces {
        // include the interfaces, they just need to be accessible to the generated code
        // so this module is `pub` so that it can be imported by the other one.
        include!(concat!(env!("OUT_DIR"), "/my_protocol_interfaces.rs"));
    }

    pub mod client {
        // These import are mandatory, and need to by `pub`, because
        // submodules in the generated code will try to import them.
        // Hopefully someday pub(restricted) and friends will
        // allow for a cleaner way to do that
        #[doc(hidden)] pub use wayland_client::{Proxy, Handler, EventQueueHandle, RequestResult};
        // Replace the above line with this for server-side:
        // #[doc(hidden)] pub use wayland_server::{Resource, Handler, EventLoopHandle, EventResult};
        #[doc(hidden)] pub use super::interfaces;
        // If you protocol interacts with objects from other protocols, you'll need to import
        // their modules, like so:
        #[doc(hidden)] pub use wayland_client::protocol::{wl_surface, wl_region};
        include!(concat!(env!("OUT_DIR"), "/my_protocol_code.rs"));
    }
}

Enums

Side	Side to generate

Functions

generate_code	Generate the code for a protocol
generate_interfaces	Generate the interfaces for a protocol