aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar René Kijewski <kijewski@library.vetmed.fu-berlin.de>2022-03-10 08:44:35 +0100
committerLibravatar Dirkjan Ochtman <dirkjan@ochtman.nl>2022-03-23 19:37:10 +0100
commit4c0388d11e1bafb85250b649ff610d3f9c7f9452 (patch)
treef6c9313c30c2475a5bc729bb57148342e11aedec
parent944d591121865c7c6856c91bfe9d2e91b2d5ff44 (diff)
downloadaskama-4c0388d11e1bafb85250b649ff610d3f9c7f9452.tar.gz
askama-4c0388d11e1bafb85250b649ff610d3f9c7f9452.tar.bz2
askama-4c0388d11e1bafb85250b649ff610d3f9c7f9452.zip
Reduce askama_derive to a single re-export
All the hard work in askama_derive was actually done in askama_shared. This PR removes the back-and-forth interaction between the two crates. Now askama_derive is a single re-export of `#[derive(Template)]` which has to be done in a proc_macro crate. This most likely means that askama_derive is "final", unless another derive template needs to be introduced in the future.
Diffstat (limited to '')
-rw-r--r--askama_derive/Cargo.toml2
-rw-r--r--askama_derive/src/lib.rs100
-rw-r--r--askama_shared/src/derive.rs105
-rw-r--r--askama_shared/src/lib.rs2
4 files changed, 108 insertions, 101 deletions
diff --git a/askama_derive/Cargo.toml b/askama_derive/Cargo.toml
index 0900ac7..c152219 100644
--- a/askama_derive/Cargo.toml
+++ b/askama_derive/Cargo.toml
@@ -14,5 +14,3 @@ proc-macro = true
[dependencies]
askama_shared = { version = "0.12.1", path = "../askama_shared", default-features = false }
-proc-macro2 = "1"
-syn = "1"
diff --git a/askama_derive/src/lib.rs b/askama_derive/src/lib.rs
index d04ef72..b41fa6a 100644
--- a/askama_derive/src/lib.rs
+++ b/askama_derive/src/lib.rs
@@ -2,107 +2,9 @@
#![deny(elided_lifetimes_in_paths)]
#![deny(unreachable_pub)]
-use askama_shared::heritage::{Context, Heritage};
-use askama_shared::input::{Print, Source, TemplateInput};
-use askama_shared::parser::{parse, Expr, Node};
-use askama_shared::{generator, get_template_source, read_config_file, CompileError, Config};
use proc_macro::TokenStream;
-use std::collections::HashMap;
-use std::path::PathBuf;
-
#[proc_macro_derive(Template, attributes(template))]
pub fn derive_template(input: TokenStream) -> TokenStream {
- let ast: syn::DeriveInput = syn::parse(input).unwrap();
- match build_template(&ast) {
- Ok(source) => source.parse().unwrap(),
- Err(e) => e.into_compile_error().into(),
- }
-}
-
-/// Takes a `syn::DeriveInput` and generates source code for it
-///
-/// Reads the metadata from the `template()` attribute to get the template
-/// metadata, then fetches the source from the filesystem. The source is
-/// parsed, and the parse tree is fed to the code generator. Will print
-/// the parse tree and/or generated source according to the `print` key's
-/// value as passed to the `template()` attribute.
-fn build_template(ast: &syn::DeriveInput) -> Result<String, CompileError> {
- let config_toml = read_config_file()?;
- let config = Config::new(&config_toml)?;
- let input = TemplateInput::new(ast, &config)?;
- let source: String = match input.source {
- Source::Source(ref s) => s.clone(),
- Source::Path(_) => get_template_source(&input.path)?,
- };
-
- let mut sources = HashMap::new();
- find_used_templates(&input, &mut sources, source)?;
-
- let mut parsed = HashMap::new();
- for (path, src) in &sources {
- parsed.insert(path.as_path(), parse(src, input.syntax)?);
- }
-
- let mut contexts = HashMap::new();
- for (path, nodes) in &parsed {
- contexts.insert(*path, Context::new(input.config, path, nodes)?);
- }
-
- let ctx = &contexts[input.path.as_path()];
- let heritage = if !ctx.blocks.is_empty() || ctx.extends.is_some() {
- Some(Heritage::new(ctx, &contexts))
- } else {
- None
- };
-
- if input.print == Print::Ast || input.print == Print::All {
- eprintln!("{:?}", parsed[input.path.as_path()]);
- }
-
- let code = generator::generate(&input, &contexts, heritage.as_ref())?;
- if input.print == Print::Code || input.print == Print::All {
- eprintln!("{}", code);
- }
- Ok(code)
-}
-
-fn find_used_templates(
- input: &TemplateInput<'_>,
- map: &mut HashMap<PathBuf, String>,
- source: String,
-) -> Result<(), CompileError> {
- let mut dependency_graph = Vec::new();
- let mut check = vec![(input.path.clone(), source)];
- while let Some((path, source)) = check.pop() {
- for n in parse(&source, input.syntax)? {
- match n {
- Node::Extends(Expr::StrLit(extends)) => {
- let extends = input.config.find_template(extends, Some(&path))?;
- let dependency_path = (path.clone(), extends.clone());
- if dependency_graph.contains(&dependency_path) {
- return Err(format!(
- "cyclic dependecy in graph {:#?}",
- dependency_graph
- .iter()
- .map(|e| format!("{:#?} --> {:#?}", e.0, e.1))
- .collect::<Vec<String>>()
- )
- .into());
- }
- dependency_graph.push(dependency_path);
- let source = get_template_source(&extends)?;
- check.push((extends, source));
- }
- Node::Import(_, import, _) => {
- let import = input.config.find_template(import, Some(&path))?;
- let source = get_template_source(&import)?;
- check.push((import, source));
- }
- _ => {}
- }
- }
- map.insert(path, source);
- }
- Ok(())
+ askama_shared::derive_template(input.into()).into()
}
diff --git a/askama_shared/src/derive.rs b/askama_shared/src/derive.rs
new file mode 100644
index 0000000..04b3ba0
--- /dev/null
+++ b/askama_shared/src/derive.rs
@@ -0,0 +1,105 @@
+use std::collections::HashMap;
+use std::path::PathBuf;
+
+use proc_macro2::TokenStream;
+
+use crate::heritage::{Context, Heritage};
+use crate::input::{Print, Source, TemplateInput};
+use crate::parser::{parse, Expr, Node};
+use crate::{generator, get_template_source, read_config_file, CompileError, Config};
+
+/// The actual implementation for askama_derive::Template
+pub fn derive_template(input: TokenStream) -> TokenStream {
+ let ast: syn::DeriveInput = syn::parse2(input).unwrap();
+ match build_template(&ast) {
+ Ok(source) => source.parse().unwrap(),
+ Err(e) => e.into_compile_error(),
+ }
+}
+
+/// Takes a `syn::DeriveInput` and generates source code for it
+///
+/// Reads the metadata from the `template()` attribute to get the template
+/// metadata, then fetches the source from the filesystem. The source is
+/// parsed, and the parse tree is fed to the code generator. Will print
+/// the parse tree and/or generated source according to the `print` key's
+/// value as passed to the `template()` attribute.
+fn build_template(ast: &syn::DeriveInput) -> Result<String, CompileError> {
+ let config_toml = read_config_file()?;
+ let config = Config::new(&config_toml)?;
+ let input = TemplateInput::new(ast, &config)?;
+ let source: String = match input.source {
+ Source::Source(ref s) => s.clone(),
+ Source::Path(_) => get_template_source(&input.path)?,
+ };
+
+ let mut sources = HashMap::new();
+ find_used_templates(&input, &mut sources, source)?;
+
+ let mut parsed = HashMap::new();
+ for (path, src) in &sources {
+ parsed.insert(path.as_path(), parse(src, input.syntax)?);
+ }
+
+ let mut contexts = HashMap::new();
+ for (path, nodes) in &parsed {
+ contexts.insert(*path, Context::new(input.config, path, nodes)?);
+ }
+
+ let ctx = &contexts[input.path.as_path()];
+ let heritage = if !ctx.blocks.is_empty() || ctx.extends.is_some() {
+ Some(Heritage::new(ctx, &contexts))
+ } else {
+ None
+ };
+
+ if input.print == Print::Ast || input.print == Print::All {
+ eprintln!("{:?}", parsed[input.path.as_path()]);
+ }
+
+ let code = generator::generate(&input, &contexts, heritage.as_ref())?;
+ if input.print == Print::Code || input.print == Print::All {
+ eprintln!("{}", code);
+ }
+ Ok(code)
+}
+
+fn find_used_templates(
+ input: &TemplateInput<'_>,
+ map: &mut HashMap<PathBuf, String>,
+ source: String,
+) -> Result<(), CompileError> {
+ let mut dependency_graph = Vec::new();
+ let mut check = vec![(input.path.clone(), source)];
+ while let Some((path, source)) = check.pop() {
+ for n in parse(&source, input.syntax)? {
+ match n {
+ Node::Extends(Expr::StrLit(extends)) => {
+ let extends = input.config.find_template(extends, Some(&path))?;
+ let dependency_path = (path.clone(), extends.clone());
+ if dependency_graph.contains(&dependency_path) {
+ return Err(format!(
+ "cyclic dependecy in graph {:#?}",
+ dependency_graph
+ .iter()
+ .map(|e| format!("{:#?} --> {:#?}", e.0, e.1))
+ .collect::<Vec<String>>()
+ )
+ .into());
+ }
+ dependency_graph.push(dependency_path);
+ let source = get_template_source(&extends)?;
+ check.push((extends, source));
+ }
+ Node::Import(_, import, _) => {
+ let import = input.config.find_template(import, Some(&path))?;
+ let source = get_template_source(&import)?;
+ check.push((import, source));
+ }
+ _ => {}
+ }
+ }
+ map.insert(path, source);
+ }
+ Ok(())
+}
diff --git a/askama_shared/src/lib.rs b/askama_shared/src/lib.rs
index 8a336bb..5a8facd 100644
--- a/askama_shared/src/lib.rs
+++ b/askama_shared/src/lib.rs
@@ -13,9 +13,11 @@ use proc_macro2::{Span, TokenStream};
#[cfg(feature = "serde")]
use serde::Deserialize;
+pub use crate::derive::derive_template;
pub use crate::input::extension_to_mime_type;
pub use askama_escape::MarkupDisplay;
+mod derive;
mod error;
pub use crate::error::{Error, Result};
pub mod filters;