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

//! Source generator command-line utility.
//!
//! Utility to do in-place source generation for Rust code. Takes a list of source generators to
//! run and applies them to all crates that have [`sourcegen`] dependency.
//!
//! [`sourcegen`]: http://crates.io/crates/sourcegen
use crate::error::{SourcegenError, SourcegenErrorKind};
use failure::{Error, ResultExt};
use proc_macro2::TokenStream;
use std::collections::{BTreeSet, HashMap};
use std::path::Path;

mod error;
mod generate;
mod mods;
#[cfg(not(feature = "disable_normalize_doc_attributes"))]
mod normalize;
mod region;
mod rustfmt;
pub mod tokens;

/// Trait to be implemented by source generators.
pub trait SourceGenerator {
    /// Generate struct definition. Return `None` if no changes are necessary.
    fn generate_struct(
        &self,
        _args: syn::AttributeArgs,
        _item: &syn::ItemStruct,
    ) -> Result<Option<TokenStream>, Error> {
        Ok(None)
    }

    /// Generate enum definition. Return `None` if no changes are necessary.
    fn generate_enum(
        &self,
        _args: syn::AttributeArgs,
        _item: &syn::ItemEnum,
    ) -> Result<Option<TokenStream>, Error> {
        Ok(None)
    }

    /// Generate trait definition. Return `None` if no changes are necessary.
    fn generate_trait(
        &self,
        _args: syn::AttributeArgs,
        _item: &syn::ItemTrait,
    ) -> Result<Option<TokenStream>, Error> {
        Ok(None)
    }

    /// Generate module. Return `None` if no changes are necessary.
    fn generate_mod(
        &self,
        _args: syn::AttributeArgs,
        _item: &syn::ItemMod,
    ) -> Result<Option<TokenStream>, Error> {
        Ok(None)
    }

    /// Generate the whole file. Return `None` if no changes are necessary.
    fn generate_file(
        &self,
        _args: syn::AttributeArgs,
        _file: &syn::File,
    ) -> Result<Option<TokenStream>, Error> {
        Ok(None)
    }
}

pub(crate) type GeneratorsMap<'a> = HashMap<&'a str, &'a dyn SourceGenerator>;

/// Parameters for the source generation tool
#[derive(Default, Clone)]
pub struct SourcegenParameters<'a> {
    /// Root cargo manifest file to start from. If not given, the default is to use `Cargo.toml` in
    /// the current directory.
    pub manifest: Option<&'a Path>,
    /// List of generators to run. Each entry is a pair of generator name and trait object
    /// implementing the generator.
    pub generators: &'a [(&'a str, &'a dyn SourceGenerator)],
    /// List of packages to generate code for. If not given, the default is to generate code for
    /// all of the packages.
    pub packages: BTreeSet<String>,

    #[doc(hidden)]
    pub __must_use_default: (),
}

/// Main entry point to the source generator toolkit.
pub fn run_sourcegen(parameters: &SourcegenParameters) -> Result<(), SourcegenError> {
    let generators = parameters
        .generators
        .iter()
        .cloned()
        .collect::<GeneratorsMap>();

    let mut cmd = cargo_metadata::MetadataCommand::new();
    if let Some(manifest) = parameters.manifest {
        cmd.manifest_path(manifest);
    } else {
        let path = std::env::current_dir().context(SourcegenErrorKind::MetadataError)?;
        let manifest = path.join("Cargo.toml");
        cmd.manifest_path(&manifest);
    }
    let metadata = cmd.exec().context(SourcegenErrorKind::MetadataError)?;

    // Make sure all package names are valid
    let mut invalid = parameters.packages.clone();
    for p in &metadata.packages {
        invalid.remove(&p.name);
    }
    if !invalid.is_empty() {
        let names = invalid.into_iter().collect::<Vec<_>>().join(", ");
        return Err(SourcegenErrorKind::InvalidPackageNames(names).into());
    }

    let packages = metadata
        .packages
        .into_iter()
        .filter(|p| parameters.packages.is_empty() || parameters.packages.contains(&p.name))
        // Only take local projects
        .filter(|p| p.source.is_none())
        // FIXME: should we look at "rename", too?
        .filter(|p| p.dependencies.iter().any(|dep| dep.name == "sourcegen"));

    for package in packages {
        eprintln!("Generating source code in crate '{}'", package.name);
        for target in &package.targets {
            let parent_path = target
                .src_path
                .parent()
                .ok_or(SourcegenErrorKind::MetadataError)?;
            let mod_resolver = crate::mods::ModResolver::new(parent_path);
            self::generate::process_source_file(&target.src_path, &generators, &mod_resolver)?;
        }
    }
    Ok(())
}

pub use crate::generate::process_single_file;