explicit names macro

Author: Shubham8287

crates/bindings-macro/src/procedure.rs

@@ -1,4 +1,4 @@
-use crate::reducer::{assert_only_lifetime_generics, extract_typed_args};
+use crate::reducer::{assert_only_lifetime_generics, extract_typed_args, generate_explicit_names_impl};
 use crate::sym;
 use crate::util::{check_duplicate, ident_to_litstr, match_meta};
 use proc_macro2::TokenStream;
@@ -32,6 +32,7 @@ impl ProcedureArgs {
 pub(crate) fn procedure_impl(_args: ProcedureArgs, original_function: &ItemFn) -> syn::Result<TokenStream> {
     let func_name = &original_function.sig.ident;
     let vis = &original_function.vis;
+    let explicit_name = _args.name.as_ref();
 
     let procedure_name = ident_to_litstr(func_name);
 
@@ -86,6 +87,8 @@ pub(crate) fn procedure_impl(_args: ProcedureArgs, original_function: &ItemFn) -
         }
     };
 
+    let generate_explicit_names = generate_explicit_names_impl(&procedure_name.value(), func_name, explicit_name);
+
     Ok(quote! {
         const _: () = {
             #generated_describe_function

crates/bindings-macro/src/reducer.rs

@@ -104,6 +104,10 @@ pub(crate) fn reducer_impl(args: ReducerArgs, original_function: &ItemFn) -> syn
 
     let typed_args = extract_typed_args(original_function)?;
 
+    let explicit_name = args.name.as_ref();
+
+    let generate_explicit_names = generate_explicit_names_impl(&reducer_name.value(), func_name, explicit_name);
+
     // Extract all function parameter names.
     let opt_arg_names = typed_args.iter().map(|arg| {
         if let syn::Pat::Ident(i) = &*arg.pat {
@@ -165,5 +169,36 @@ pub(crate) fn reducer_impl(args: ReducerArgs, original_function: &ItemFn) -> syn
             const ARG_NAMES: &'static [Option<&'static str>] = &[#(#opt_arg_names),*];
             const INVOKE: Self::Invoke = #func_name::invoke;
         }
+
+        #generate_explicit_names
     })
 }
+
+pub(crate) fn generate_explicit_names_impl(
+    func_name: &str,
+    func_handle: &Ident,
+    explicit_name: Option<&LitStr>,
+) -> TokenStream {
+    let mut explicit_names_body = Vec::new();
+
+    // Table name
+    if let Some(explicit_name) = explicit_name {
+        explicit_names_body.push(quote! {
+            names.insert_function(
+                #func_name,
+                #explicit_name,
+            );
+        });
+    };
+
+    quote! {
+
+        impl spacetimedb::rt::ExplicitNames for #func_handle {
+            fn explicit_names() -> spacetimedb::spacetimedb_lib::ExplicitNames {
+                let mut names = spacetimedb::spacetimedb_lib::ExplicitNames::default();
+                #(#explicit_names_body)*
+                names
+            }
+        }
+    }
+}

crates/bindings-macro/src/table.rs

@@ -17,7 +17,7 @@ use syn::{parse_quote, Ident, Path, Token};
 
 pub(crate) struct TableArgs {
     access: Option<TableAccess>,
-    _name: Option<LitStr>,
+    name: Option<LitStr>,
     scheduled: Option<ScheduledArg>,
     accessor: Ident,
     indices: Vec<IndexArg>,
@@ -96,7 +96,7 @@ impl TableArgs {
                     accessor = Some(value.parse()?);
                 }
                 sym::name => {
-                    check_duplicate(&accessor, &meta)?;
+                    check_duplicate(&name, &meta)?;
                     let value = meta.value()?;
                     name = Some(value.parse()?);
                 }
@@ -121,7 +121,7 @@ impl TableArgs {
             scheduled,
             accessor,
             indices,
-            _name: name,
+            name,
         })
     }
 }
@@ -714,6 +714,7 @@ pub(crate) fn table_impl(mut args: TableArgs, item: &syn::DeriveInput) -> syn::R
 
     let original_struct_ident = sats_ty.ident;
     let table_ident = &args.accessor;
+    let explicit_table_name = args.name.as_ref().map(|s| s.value());
     let view_trait_ident = format_ident!("{}__view", table_ident);
     let query_trait_ident = format_ident!("{}__query", table_ident);
     let query_cols_struct = format_ident!("{}Cols", original_struct_ident);
@@ -1019,6 +1020,8 @@ pub(crate) fn table_impl(mut args: TableArgs, item: &syn::DeriveInput) -> syn::R
         }
     };
 
+    let explicit_names_impl = generate_explicit_names_impl(&table_name, &tablehandle_ident, &explicit_table_name);
+
     let register_describer_symbol = format!("__preinit__20_register_describer_{table_ident}");
 
     let describe_table_func = quote! {
@@ -1178,6 +1181,8 @@ pub(crate) fn table_impl(mut args: TableArgs, item: &syn::DeriveInput) -> syn::R
 
             #tabletype_impl
 
+            #explicit_names_impl
+
             #[allow(non_camel_case_types)]
             mod __indices {
                 #[allow(unused)]
@@ -1198,3 +1203,32 @@ pub(crate) fn table_impl(mut args: TableArgs, item: &syn::DeriveInput) -> syn::R
 
     Ok(emission)
 }
+
+fn generate_explicit_names_impl(
+    table_name: &str,
+    tablehandle_ident: &Ident,
+    explicit_table_name: &Option<String>,
+) -> TokenStream {
+    let mut explicit_names_body = Vec::new();
+
+    // Table name
+    if let Some(explicit_table_name) = explicit_table_name {
+        explicit_names_body.push(quote! {
+            names.insert_table(
+                #table_name,
+                #explicit_table_name,
+            );
+        });
+    };
+
+    quote! {
+
+        impl spacetimedb::rt::ExplicitNames for #tablehandle_ident {
+            fn explicit_names() -> spacetimedb::spacetimedb_lib::ExplicitNames {
+                let mut names = spacetimedb::spacetimedb_lib::ExplicitNames::default();
+                #(#explicit_names_body)*
+                names
+            }
+        }
+    }
+}

crates/bindings-macro/src/view.rs

@@ -5,11 +5,12 @@ use syn::ext::IdentExt;
 use syn::parse::Parser;
 use syn::{FnArg, ItemFn, LitStr};
 
+use crate::reducer::generate_explicit_names_impl;
 use crate::sym;
 use crate::util::{check_duplicate_msg, match_meta};
 
 pub(crate) struct ViewArgs {
-    _name: Option<LitStr>,
+    name: Option<LitStr>,
     accessor: Ident,
     #[allow(unused)]
     public: bool,
@@ -49,7 +50,7 @@ impl ViewArgs {
         let () = public
             .ok_or_else(|| syn::Error::new(Span::call_site(), "views must be `public`, e.g. `#[view(public)]`"))?;
         Ok(Self {
-            _name: name,
+            name,
             public: true,
             accessor,
         })
@@ -147,6 +148,10 @@ pub(crate) fn view_impl(args: ViewArgs, original_function: &ItemFn) -> syn::Resu
         }
     };
 
+    let explicit_name = args.name.as_ref();
+
+    let generate_explicit_names = generate_explicit_names_impl(&view_name, func_name, explicit_name);
+
     Ok(quote! {
         const _: () = { #generated_describe_function };
 
@@ -196,5 +201,7 @@ pub(crate) fn view_impl(args: ViewArgs, original_function: &ItemFn) -> syn::Resu
                 Some(<#ret_ty as spacetimedb::SpacetimeType>::make_type(ts))
             }
         }
+
+        #generate_explicit_names
     })
 }

crates/bindings/src/rt.rs

@@ -4,7 +4,7 @@ use crate::query_builder::Query;
 use crate::table::IndexAlgo;
 use crate::{sys, AnonymousViewContext, IterBuf, ReducerContext, ReducerResult, SpacetimeType, Table, ViewContext};
 use spacetimedb_lib::bsatn::EncodeError;
-use spacetimedb_lib::db::raw_def::v10::RawModuleDefV10Builder;
+use spacetimedb_lib::db::raw_def::v10::{ExplicitNameEntry, ExplicitNames as RawExplicitNames, RawModuleDefV10Builder};
 pub use spacetimedb_lib::db::raw_def::v9::Lifecycle as LifecycleReducer;
 use spacetimedb_lib::db::raw_def::v9::{RawIndexAlgorithm, TableType, ViewResultHeader};
 use spacetimedb_lib::de::{self, Deserialize, DeserializeOwned, Error as _, SeqProductAccess};
@@ -141,7 +141,7 @@ pub trait AnonymousView<'de, A: Args<'de>, T: ViewReturn> {
 }
 
 /// A trait for types that can *describe* a callable function such as a reducer or view.
-pub trait FnInfo {
+pub trait FnInfo: ExplicitNames {
     /// The type of function to invoke.
     type Invoke;
 
@@ -735,6 +735,8 @@ pub fn register_table<T: Table>() {
         }
 
         table.finish();
+
+        module.inner.add_explicit_names(T::explicit_names());
     })
 }
 
@@ -762,6 +764,8 @@ pub fn register_reducer<'a, A: Args<'a>, I: FnInfo<Invoke = ReducerFn>>(_: impl
             module.inner.add_reducer(I::NAME, params);
         }
         module.reducers.push(I::INVOKE);
+
+        module.inner.add_explicit_names(I::explicit_names());
     })
 }
 
@@ -777,6 +781,8 @@ where
         let ret_ty = <Ret as SpacetimeType>::make_type(&mut module.inner);
         module.inner.add_procedure(I::NAME, params, ret_ty);
         module.procedures.push(I::INVOKE);
+
+        module.inner.add_explicit_names(I::explicit_names());
     })
 }
 
@@ -794,6 +800,8 @@ where
             .inner
             .add_view(I::NAME, module.views.len(), true, false, params, return_type);
         module.views.push(I::INVOKE);
+
+        module.inner.add_explicit_names(I::explicit_names());
     })
 }
 
@@ -811,6 +819,8 @@ where
             .inner
             .add_view(I::NAME, module.views_anon.len(), true, true, params, return_type);
         module.views_anon.push(I::INVOKE);
+
+        module.inner.add_explicit_names(I::explicit_names());
     })
 }
 
@@ -1273,3 +1283,9 @@ pub(crate) fn read_bytes_source_as<T: DeserializeOwned + 'static>(source: BytesS
     bsatn::from_slice::<T>(&buf)
         .unwrap_or_else(|err| panic!("Failed to BSATN-deserialize `{}`: {err:#?}", std::any::type_name::<T>()))
 }
+
+pub trait ExplicitNames {
+    fn explicit_names() -> RawExplicitNames {
+        RawExplicitNames::default()
+    }
+}

crates/bindings/src/table.rs

@@ -1,4 +1,4 @@
-use crate::{bsatn, sys, DeserializeOwned, IterBuf, Serialize, SpacetimeType, TableId};
+use crate::{bsatn, rt::ExplicitNames, sys, DeserializeOwned, IterBuf, Serialize, SpacetimeType, TableId};
 use core::borrow::Borrow;
 use core::convert::Infallible;
 use core::fmt;
@@ -17,7 +17,7 @@ pub use spacetimedb_primitives::{ColId, IndexId};
 ///
 /// To get a `TableHandle`
 // TODO: should we rename this `TableHandle`? Documenting this, I think that's much clearer.
-pub trait Table: TableInternal {
+pub trait Table: TableInternal + ExplicitNames {
     /// The type of rows stored in this table.
     type Row: SpacetimeType + Serialize + DeserializeOwned + Sized + 'static;
 

crates/lib/Cargo.toml

@@ -53,6 +53,7 @@ enum-map = { workspace = true, optional = true }
 # For the 'proptest' feature.
 proptest = { workspace = true, optional = true }
 proptest-derive = { workspace = true, optional = true }
+spacetimedb-data-structures.workspace = true
 
 [dev-dependencies]
 spacetimedb-sats = { path = "../sats", features = ["test"] }