tvm_ffi_macros/lib.rs
1/*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19
20use proc_macro::TokenStream;
21use proc_macro_error::proc_macro_error;
22
23mod dispatch;
24mod match_any;
25mod object_macros;
26mod utils;
27
28/// Generate `walk`, `map`, `visit`, or `mutate` dispatch from an inherent impl.
29///
30/// `#[dispatch(visit, policy = expr)]` and `#[dispatch(mutate, policy = expr)]`
31/// use a `ContextPolicy<Self>` or `MutContextPolicy<Self>` for default recursion.
32/// The expression runs at each default descent and may read `self` for configuration;
33/// mutable traversal state stays on `self`. Policy tuples compose as usual.
34#[proc_macro_error]
35#[proc_macro_attribute]
36pub fn dispatch(attr: TokenStream, item: TokenStream) -> TokenStream {
37 dispatch::dispatch(attr, item)
38}
39
40/// Match object-backed values carried by an Any-compatible scrutinee.
41///
42/// The scrutinee may be an owned object handle, `Any`, or `AnyView`. Convert an
43/// already-borrowed object handle to `AnyView` before invoking the macro.
44///
45/// Non-object values skip the typed patterns and use the `_` fallback.
46#[proc_macro_error]
47#[proc_macro]
48pub fn match_any(input: TokenStream) -> TokenStream {
49 match_any::expand(input)
50}
51
52#[proc_macro_error]
53#[proc_macro_derive(Object, attributes(type_key, type_index, type_final))]
54pub fn derive_object(input: TokenStream) -> TokenStream {
55 TokenStream::from(object_macros::derive_object(input))
56}
57
58#[proc_macro_error]
59#[proc_macro_derive(ObjectRef, attributes(type_key, type_index))]
60pub fn derive_object_ref(input: TokenStream) -> TokenStream {
61 TokenStream::from(object_macros::derive_object_ref(input))
62}