1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
// Copyright (c) 2013-2014 Sandstorm Development Group, Inc. and contributors
// Licensed under the MIT License:
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//! # Cap'n Proto Schema Compiler Plugin Library
//!
//! This library allows you to do [Cap'n Proto code generation]
//! (https://capnproto.org/otherlang.html#how-to-write-compiler-plugins) within
//! a Cargo build. You still need the `capnp` binary (implemented in C++).
//! (If you use a package manager, try looking for a package called
//! `capnproto`.)
//!
//! In your Cargo.toml:
//!
//! ```ignore
//! [package]
//! build = "build.rs"
//!
//! [build-dependencies]
//! capnpc = "0.9"
//! ```
//!
//! In your build.rs:
//!
//! ```ignore
//! extern crate capnpc;
//!
//! fn main() {
//! capnpc::CompilerCommand::new()
//! .src_prefix("schema")
//! .file("schema/foo.capnp")
//! .file("schema/bar.capnp")
//! .run().expect("schema compiler command");
//! }
//! ```
//!
//! This will be equivalent to executing the shell command
//!
//! ```ignore
//! capnp compile -orust:$OUT_DIR --src-prefix=schema schema/foo.capnp schema/bar.capnp
//! ```
//!
extern crate capnp;
/// Code generated from [schema.capnp]
/// (https://github.com/sandstorm-io/capnproto/blob/master/c%2B%2B/src/capnp/schema.capnp).
pub mod schema_capnp;
pub mod codegen;
pub mod codegen_types;
mod pointer_constants;
pub mod schema;
use std::path::{Path, PathBuf};
#[derive(Copy, Clone)]
pub enum RustEdition {
Rust2015,
Rust2018
}
fn run_command(mut command: ::std::process::Command, edition: RustEdition) -> ::capnp::Result<()> {
let mut p = command.spawn()?;
::codegen::generate_code(p.stdout.take().unwrap(),
::std::path::Path::new(&::std::env::var("OUT_DIR").unwrap()), edition)?;
let exit_status = p.wait()?;
if !exit_status.success() {
Err(::capnp::Error::failed(format!("Non-success exit status: {}", exit_status)))
} else {
Ok(())
}
}
/// A builder object for schema compiler commands.
pub struct CompilerCommand {
files: Vec<PathBuf>,
src_prefixes: Vec<PathBuf>,
import_paths: Vec<PathBuf>,
no_standard_import: bool,
rust_edition: RustEdition,
}
impl CompilerCommand {
/// Creates a new, empty command.
pub fn new() -> CompilerCommand {
CompilerCommand {
files: Vec::new(),
src_prefixes: Vec::new(),
import_paths: Vec::new(),
no_standard_import: false,
rust_edition: RustEdition::Rust2015,
}
}
/// Adds a file to be compiled.
pub fn file<'a, P>(&'a mut self, path: P) -> &'a mut CompilerCommand
where P: AsRef<Path>,
{
self.files.push(path.as_ref().to_path_buf());
self
}
/// Adds a --src-prefix flag. For all files specified for compilation that start
/// with `prefix`, removes the prefix when computing output filenames.
pub fn src_prefix<'a, P>(&'a mut self, prefix: P) -> &'a mut CompilerCommand
where P: AsRef<Path>,
{
self.src_prefixes.push(prefix.as_ref().to_path_buf());
self
}
/// Adds an --import_path flag. Adds `dir` to the list of directories searched
/// for absolute imports.
pub fn import_path<'a, P>(&'a mut self, dir: P) -> &'a mut CompilerCommand
where P: AsRef<Path>,
{
self.import_paths.push(dir.as_ref().to_path_buf());
self
}
/// Adds the --no-standard-import flag, indicating that the default import paths of
/// /usr/include and /usr/local/include should not bet included.
pub fn no_standard_import<'a>(&'a mut self) -> &'a mut CompilerCommand {
self.no_standard_import = true;
self
}
/// Sets the Rust edition of the generated code.
pub fn edition(&mut self, rust_edition: RustEdition) -> &mut Self {
self.rust_edition = rust_edition;
self
}
/// Runs the command.
pub fn run(&mut self) -> ::capnp::Result<()> {
let mut command = ::std::process::Command::new("capnp");
command.arg("compile").arg("-o").arg("-");
if self.no_standard_import {
command.arg("--no-standard-import");
}
for import_path in &self.import_paths {
command.arg(&format!("--import-path={}", import_path.display()));
}
for src_prefix in &self.src_prefixes {
command.arg(&format!("--src-prefix={}", src_prefix.display()));
}
for file in &self.files {
command.arg(&format!("{}", file.display()));
}
command.stdout(::std::process::Stdio::piped());
command.stderr(::std::process::Stdio::inherit());
run_command(command, self.rust_edition).map_err(|error| {
::capnp::Error::failed(format!(
"Error while trying to execute `capnp compile`: {}. \
Please verify that version 0.5.2 or higher of the capnp executable \
is installed on your system. See https://capnproto.org/install.html",
error))})
}
}