src/librustdoc/plugins.rs

   1 // Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 use clean;
  12
  13 use dl = std::unstable::dynamic_lib;
  14 use serialize::json;
  15 use std::string::String;
  16
  17 pub type PluginJson = Option<(String, json::Json)>;
  18 pub type PluginResult = (clean::Crate, PluginJson);
  19 pub type PluginCallback = fn (clean::Crate) -> PluginResult;
  20
  21 /// Manages loading and running of plugins
  22 pub struct PluginManager {
  23     dylibs: Vec<dl::DynamicLibrary> ,
  24     callbacks: Vec<PluginCallback> ,
  25     /// The directory plugins will be loaded from
  26     pub prefix: Path,
  27 }
  28
  29 impl PluginManager {
  30     /// Create a new plugin manager
  31     pub fn new(prefix: Path) -> PluginManager {
  32         PluginManager {
  33             dylibs: Vec::new(),
  34             callbacks: Vec::new(),
  35             prefix: prefix,
  36         }
  37     }
  38
  39     /// Load a plugin with the given name.
  40     ///
  41     /// Turns `name` into the proper dynamic library filename for the given
  42     /// platform. On windows, it turns into name.dll, on OS X, name.dylib, and
  43     /// elsewhere, libname.so.
  44     pub fn load_plugin(&mut self, name: String) {
  45         let x = self.prefix.join(libname(name));
  46         let lib_result = dl::DynamicLibrary::open(Some(&x));
  47         let lib = lib_result.unwrap();
  48         let plugin = unsafe { lib.symbol("rustdoc_plugin_entrypoint") }.unwrap();
  49         self.dylibs.push(lib);
  50         self.callbacks.push(plugin);
  51     }
  52
  53     /// Load a normal Rust function as a plugin.
  54     ///
  55     /// This is to run passes over the cleaned crate. Plugins run this way
  56     /// correspond to the A-aux tag on Github.
  57     pub fn add_plugin(&mut self, plugin: PluginCallback) {
  58         self.callbacks.push(plugin);
  59     }
  60     /// Run all the loaded plugins over the crate, returning their results
  61     pub fn run_plugins(&self, krate: clean::Crate) -> (clean::Crate, Vec<PluginJson> ) {
  62         let mut out_json = Vec::new();
  63         let mut krate = krate;
  64         for &callback in self.callbacks.iter() {
  65             let (c, res) = callback(krate);
  66             krate = c;
  67             out_json.push(res);
  68         }
  69         (krate, out_json)
  70     }
  71 }
  72
  73 #[cfg(target_os="win32")]
  74 fn libname(mut n: String) -> String {
  75     n.push_str(".dll");
  76     n
  77 }
  78
  79 #[cfg(target_os="macos")]
  80 fn libname(mut n: String) -> String {
  81     n.push_str(".dylib");
  82     n
  83 }
  84
  85 #[cfg(not(target_os="win32"), not(target_os="macos"))]
  86 fn libname(n: String) -> String {
  87     let mut i = String::from_str("lib");
  88     i.push_str(n.as_slice());
  89     i.push_str(".so");
  90     i
  91 }