Skip to content

Commit

Permalink
sql_quote: Implement ToTokens for AST
Browse files Browse the repository at this point in the history
This requires another derive macro, but at this point, why not?

We now have the right infrastructure to do lots of SQL rewriting.
  • Loading branch information
emk committed Oct 22, 2023
1 parent fc8a72c commit 07b33bc
Show file tree
Hide file tree
Showing 7 changed files with 672 additions and 389 deletions.
129 changes: 129 additions & 0 deletions joinery_macros/src/emit.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
//! Implementations of `#[derive(Emit)]` and `#[derive(EmitDefault)]`.

use darling::{util::Flag, FromField};
use proc_macro2::TokenStream as TokenStream2;
use quote::quote;

use crate::field_info::{AttrWithSkip, FieldInfo};

/// The contents of an `#[emit(...)]` attribute, parsing using the
/// [`darling`](https://github.com/TedDriggs/darling) crate.
#[derive(Default, FromField)]
#[darling(default, attributes(emit))]
struct EmitAttr {
/// Should we omit this field from our output?
skip: Flag,
}

impl AttrWithSkip for EmitAttr {
fn skip(&self) -> &Flag {
&self.skip
}
}

pub(crate) fn impl_emit_macro(ast: &syn::DeriveInput) -> TokenStream2 {
let name = &ast.ident;
let (impl_generics, ty_generics, where_clause) = &ast.generics.split_for_impl();
quote! {
impl #impl_generics Emit for #name #ty_generics #where_clause {
fn emit(&self, t: Target, f: &mut TokenWriter<'_>) -> ::std::io::Result<()> {
<#name #ty_generics as EmitDefault>::emit_default(self, t, f)
}
}
}
}

/// [`EmitDefault::emit_default`] should just iterate over the struct or enum,
/// and generate a recursive call to [`Emit::emit`] for each field.
///
/// TODO: If we see `#[emit(skip)]` on a field, we should skip it.
pub(crate) fn impl_emit_default_macro(ast: &syn::DeriveInput) -> TokenStream2 {
let name = &ast.ident;
let (impl_generics, ty_generics, where_clause) = &ast.generics.split_for_impl();
let implementation = emit_default_body(name, &ast.data);
quote! {
impl #impl_generics EmitDefault for #name #ty_generics #where_clause {
fn emit_default(&self, t: Target, f: &mut TokenWriter<'_>) -> ::std::io::Result<()> {
#implementation
}
}
}
}
fn emit_default_body(name: &syn::Ident, data: &syn::Data) -> TokenStream2 {
match data {
syn::Data::Struct(s) => emit_default_body_struct(s),
syn::Data::Enum(e) => emit_default_body_enum(name, e),
syn::Data::Union(_) => panic!("Cannot derive EmitDefault for unions"),
}
}

fn emit_default_body_struct(data: &syn::DataStruct) -> TokenStream2 {
match &data.fields {
syn::Fields::Named(fields) => {
let field_names = FieldInfo::<EmitAttr>::named_iter(fields)
.filter(|f| !f.attr().skip().is_present())
.map(|f| f.struct_field());
quote! {
#( self.#field_names.emit(t, f)?; )*
Ok(())
}
}
syn::Fields::Unnamed(fields) => {
let field_names = FieldInfo::<EmitAttr>::unnamed_iter(fields)
.filter(|f| !f.attr().skip().is_present())
.map(|f| f.struct_field());
quote! {
#( self.#field_names.emit(t, f)?; )*
Ok(())
}
}
syn::Fields::Unit => quote! { Ok(()) },
}
}

fn emit_default_body_enum(name: &syn::Ident, data: &syn::DataEnum) -> TokenStream2 {
let variants = data
.variants
.iter()
.map(|v| emit_default_body_enum_variant(name, v));
quote! {
match self {
#( #variants )*
}
}
}

fn emit_default_body_enum_variant(name: &syn::Ident, variant: &syn::Variant) -> TokenStream2 {
let variant_name = &variant.ident;
match &variant.fields {
syn::Fields::Named(fields) => {
let fields = FieldInfo::<EmitAttr>::named_iter(fields).collect::<Vec<_>>();
let patterns = fields.iter().map(|f| f.enum_pattern());
let field_names = fields
.iter()
.filter(|f| !f.attr().skip().is_present())
.map(|f| f.enum_name());
quote! {
#name::#variant_name { #(#patterns),* } => {
#( #field_names.emit(t, f)?; )*
Ok(())
}
}
}
syn::Fields::Unnamed(fields) => {
let fields = FieldInfo::<EmitAttr>::unnamed_iter(fields).collect::<Vec<_>>();
let patterns = fields.iter().map(|f| f.enum_pattern());
let field_names = fields
.iter()
.filter(|f| !f.attr().skip().is_present())
.map(|f| f.enum_name());
quote! {
#name::#variant_name( #(#patterns),* ) => {
#( #field_names.emit(t, f)?; )*
Ok(())
}
}
}
syn::Fields::Unit => quote! { Ok(()) },
}
}
105 changes: 105 additions & 0 deletions joinery_macros/src/field_info.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
//! Information about a field in a `struct` or `enum` with a `#[derive(..)]`
//! attribute.

use std::borrow::Cow;

use darling::{util::Flag, FromField};
use proc_macro2::{Span, TokenStream as TokenStream2};
use quote::quote;
use syn::{spanned::Spanned, Field, Ident};

pub(crate) trait AttrWithSkip: Default + FromField + 'static {
/// Should we skip this field?
fn skip(&self) -> &Flag;
}

/// Information we have about a field. Needed to generate the correct code.
pub(crate) enum FieldInfo<'a, Attr: AttrWithSkip> {
/// A named field, such a `struct S { foo: Foo }`.
Named { ident: &'a Ident, attr: Attr },
/// An unnamed field, such as `struct S(Foo)`.
Unnamed {
index: usize,
span: Span,
attr: Attr,
},
}

impl<'a, Attr: AttrWithSkip> FieldInfo<'a, Attr> {
/// Collect info about named fields.
pub(crate) fn named_iter(
fields: &'a syn::FieldsNamed,
) -> impl Iterator<Item = FieldInfo<'a, Attr>> + 'a {
fields.named.iter().map(Self::named)
}

/// Collect info about unnamed fields.
pub(crate) fn unnamed_iter(
fields: &'a syn::FieldsUnnamed,
) -> impl Iterator<Item = FieldInfo<'a, Attr>> + 'a {
fields
.unnamed
.iter()
.enumerate()
.map(|(i, f)| Self::unnamed(i, f))
}

/// Collect info about a named field.
fn named(f: &'a Field) -> Self {
Self::Named {
ident: f.ident.as_ref().expect("field should be named"),
attr: Attr::from_field(f).unwrap_or_default(),
}
}

/// Collect info about an unnamed field.
fn unnamed(index: usize, f: &'a Field) -> Self {
Self::Unnamed {
index,
span: f.span(),
attr: Attr::from_field(f).unwrap_or_default(),
}
}

pub(crate) fn attr(&self) -> &Attr {
match self {
Self::Named { attr, .. } => attr,
Self::Unnamed { attr, .. } => attr,
}
}

/// How to name this field when accessing it as a struct field.
pub(crate) fn struct_field(&self) -> TokenStream2 {
match self {
Self::Named { ident, .. } => quote! { #ident },
Self::Unnamed { index, span, .. } => {
let index = syn::Index {
index: *index as u32,
span: *span,
};
quote! { #index }
}
}
}

/// How to name this field when accessing inside a `match` arm.
pub(crate) fn enum_name(&self) -> Cow<'_, Ident> {
match self {
Self::Named { ident, .. } => Cow::Borrowed(ident),
Self::Unnamed { index, span, .. } => {
Cow::Owned(syn::Ident::new(&format!("f{}", index), *span))
}
}
}

/// How to name this field when using it as a pattern in a `match` arm.
pub(crate) fn enum_pattern(&self) -> TokenStream2 {
let name = self.enum_name();
match (self, self.attr().skip().is_present()) {
(Self::Named { .. }, true) => quote! { #name: _ },
(Self::Named { .. }, false) => quote! { #name },
(Self::Unnamed { .. }, true) => quote! { _ },
(Self::Unnamed { .. }, false) => quote! { #name },
}
}
}
Loading

0 comments on commit 07b33bc

Please sign in to comment.