sourcegen_cli/
lib.rs

1//! Source generator command-line utility.
2//!
3//! Utility to do in-place source generation for Rust code. Takes a list of source generators to
4//! run and applies them to all crates that have [`sourcegen`] dependency.
5//!
6//! [`sourcegen`]: http://crates.io/crates/sourcegen
7use crate::error::{SourcegenError, SourcegenErrorKind};
8use proc_macro2::TokenStream;
9use std::collections::{BTreeSet, HashMap};
10use std::path::Path;
11
12mod error;
13mod generate;
14mod mods;
15#[cfg(not(feature = "disable_normalize_doc_attributes"))]
16mod normalize;
17mod region;
18mod rustfmt;
19pub mod tokens;
20
21/// Trait to be implemented by source generators.
22pub trait SourceGenerator {
23    /// Generate struct definition. Return `None` if no changes are necessary.
24    fn generate_struct(
25        &self,
26        _args: syn::AttributeArgs,
27        _item: &syn::ItemStruct,
28    ) -> Result<Option<TokenStream>, anyhow::Error> {
29        Ok(None)
30    }
31
32    /// Generate enum definition. Return `None` if no changes are necessary.
33    fn generate_enum(
34        &self,
35        _args: syn::AttributeArgs,
36        _item: &syn::ItemEnum,
37    ) -> Result<Option<TokenStream>, anyhow::Error> {
38        Ok(None)
39    }
40
41    /// Generate trait definition. Return `None` if no changes are necessary.
42    fn generate_trait(
43        &self,
44        _args: syn::AttributeArgs,
45        _item: &syn::ItemTrait,
46    ) -> Result<Option<TokenStream>, anyhow::Error> {
47        Ok(None)
48    }
49
50    /// Generate module. Return `None` if no changes are necessary.
51    fn generate_mod(
52        &self,
53        _args: syn::AttributeArgs,
54        _item: &syn::ItemMod,
55    ) -> Result<Option<TokenStream>, anyhow::Error> {
56        Ok(None)
57    }
58
59    /// Generate the whole file. Return `None` if no changes are necessary.
60    fn generate_file(
61        &self,
62        _args: syn::AttributeArgs,
63        _file: &syn::File,
64    ) -> Result<Option<TokenStream>, anyhow::Error> {
65        Ok(None)
66    }
67}
68
69pub(crate) type GeneratorsMap<'a> = HashMap<&'a str, &'a dyn SourceGenerator>;
70
71/// Parameters for the source generation tool
72#[derive(Default, Clone)]
73pub struct SourcegenParameters<'a> {
74    /// Root cargo manifest file to start from. If not given, the default is to use `Cargo.toml` in
75    /// the current directory.
76    pub manifest: Option<&'a Path>,
77    /// List of generators to run. Each entry is a pair of generator name and trait object
78    /// implementing the generator.
79    pub generators: &'a [(&'a str, &'a dyn SourceGenerator)],
80    /// List of packages to generate code for. If not given, the default is to generate code for
81    /// all of the packages.
82    pub packages: BTreeSet<String>,
83
84    #[doc(hidden)]
85    pub __must_use_default: (),
86}
87
88/// Main entry point to the source generator toolkit.
89pub fn run_sourcegen(parameters: &SourcegenParameters) -> Result<(), SourcegenError> {
90    let generators = parameters
91        .generators
92        .iter()
93        .cloned()
94        .collect::<GeneratorsMap>();
95
96    let mut cmd = cargo_metadata::MetadataCommand::new();
97    if let Some(manifest) = parameters.manifest {
98        cmd.manifest_path(manifest);
99    } else {
100        let path = std::env::current_dir().context(SourcegenErrorKind::MetadataError)?;
101        let manifest = path.join("Cargo.toml");
102        cmd.manifest_path(&manifest);
103    }
104    let metadata = cmd.exec().context(SourcegenErrorKind::MetadataError)?;
105
106    // Make sure all package names are valid
107    let mut invalid = parameters.packages.clone();
108    for p in &metadata.packages {
109        invalid.remove(&p.name);
110    }
111    if !invalid.is_empty() {
112        let names = invalid.into_iter().collect::<Vec<_>>().join(", ");
113        return Err(SourcegenErrorKind::InvalidPackageNames(names).into());
114    }
115
116    let packages = metadata
117        .packages
118        .into_iter()
119        .filter(|p| parameters.packages.is_empty() || parameters.packages.contains(&p.name))
120        // Only take local projects
121        .filter(|p| p.source.is_none())
122        // FIXME: should we look at "rename", too?
123        .filter(|p| p.dependencies.iter().any(|dep| dep.name == "sourcegen"));
124
125    for package in packages {
126        eprintln!("Generating source code in crate '{}'", package.name);
127        for target in &package.targets {
128            let parent_path = target
129                .src_path
130                .parent()
131                .ok_or(SourcegenErrorKind::MetadataError)?;
132            let mod_resolver = crate::mods::ModResolver::new(parent_path);
133            self::generate::process_source_file(&target.src_path, &generators, &mod_resolver)?;
134        }
135    }
136    Ok(())
137}
138
139pub use crate::generate::process_single_file;
140use anyhow::Context;
sourcegen_cli/lib.rs

sourcegen_cli/
lib.rs
