1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
use std::{borrow::Cow, collections::HashSet};
use indexmap::{IndexMap, IndexSet};
use rustdoc_types::{Crate, Id, Impl, Item, ItemEnum, StructKind};
use crate::{Arg, ArgType, ArgWrapperType, Args, Config, Newtype, PrettyWriter};
pub static WRAPPER_PREFIX: &str = "Lua";
#[derive(Debug)]
pub struct WrappedItem<'a> {
pub wrapper_name: String,
pub wrapped_type: &'a String,
pub path_components: Cow<'a, [String]>,
pub source: &'a Crate,
pub config: &'a Newtype,
pub item: &'a Item,
/// The items coming from all trait implementations
pub impl_items: IndexMap<&'a str, Vec<(&'a Impl, &'a Item)>>,
pub implemented_traits: IndexSet<String>,
pub self_impl: Option<&'a Impl>,
pub crates: &'a [Crate],
/// If this type has some things which are "static" this is set to true later
pub has_global_methods: bool,
}
impl WrappedItem<'_> {
/// Writes full type path inline corresponding to `Reflect::type_name` of each type
///
/// As:
/// ```rust,ignore
///
/// this
/// |
/// |..........|
/// my_type_path::Type : Value :
/// UnaryOps( ...
/// ```
pub fn write_inline_full_path(&self, writer: &mut PrettyWriter, _: &Args) {
if self.config.import_path.is_empty() {
writer.write_inline(&self.path_components.join("::"));
} else {
writer.write_inline(&self.config.import_path);
}
}
/// Writes the docstring for the type over multiple lines
///
/// As:
/// ```rust,ignore
///
/// /// generated docstring
/// /// here
/// my_macro_key : Value :
/// UnaryOps(
/// ...
/// )
/// +
/// ...
/// ```
pub fn write_type_docstring(&self, writer: &mut PrettyWriter, _: &Args) {
let strings = if let Some(d) = &self.config.doc {
d.to_string()
} else {
self.item.docs.as_ref().cloned().unwrap_or_default()
};
writer.set_prefix("///".into());
strings.lines().for_each(|l| {
writer.write_line(l);
});
writer.clear_prefix();
}
/// Writes the docstring for the given auto method over multiple lines
///
/// As:
/// ```rust,ignore
///
///
/// my_macro_key : Value :
/// Methods(
/// /// generated docstring
/// /// here
/// my_method(usize) -> u32
/// )
/// +
/// ...
/// ```
pub fn write_method_docstring(&self, id: &Id, writer: &mut PrettyWriter, _: &Args) {
writer.set_prefix("///".into());
self.source
.index
.get(id)
.unwrap()
.docs
.as_ref()
.cloned()
.unwrap_or_else(|| "".to_owned())
.lines()
.for_each(|l| {
writer.write_line(l);
});
writer.clear_prefix();
}
/// Writes the contents of the impl block for this wrapper
///
/// As:
///
/// ```rust,ignore
/// impl {
/// ... // this!
/// }
/// ```
pub fn write_impl_block_body(&self, writer: &mut PrettyWriter, _: &Args) {
self.config.lua_methods.iter().for_each(|v| {
writer.write_postfixed_line(v, ";");
})
}
/// Generates all derive flags for the type,
///
/// Returns additional imports necessary for the generated methods
///
/// ```rust,ignore
/// my_type::Type : Value:
/// ... // flags go here
/// ```
pub fn write_derive_flags_body(
&mut self,
config: &Config,
writer: &mut PrettyWriter,
args: &Args,
) {
if self.implemented_traits.contains("Clone") {
// this flag requires cloning
writer.write_line("Clone +");
}
if self.implemented_traits.contains("Debug") {
// this flag requires cloning
writer.write_line("Debug +");
}
let mut used_method_identifiers: HashSet<&str> = HashSet::default();
writer.write_line("Methods");
writer.open_paren();
let mut has_global_methods = false;
self.impl_items
.iter()
.flat_map(|(_, items)| items.iter())
.for_each(|(impl_, v)| {
// only select trait methods are allowed
if let Some(trait_) = &impl_.trait_ {
if self
.config
.traits
.iter()
.any(|f| {
trait_.name == f.name
})
{
// keep going
} else {
return;
}
};
let (decl, generics) = match &v.inner {
ItemEnum::Function(f) => (&f.decl, &f.generics),
_ => return,
};
let mut errors = Vec::default();
let mut inner_writer = PrettyWriter::new();
self.write_method_docstring(&v.id, &mut inner_writer, args);
inner_writer.write_inline(v.name.as_ref().unwrap());
inner_writer.write_inline("(");
let mut is_global_method = true;
decl.inputs
.iter()
.enumerate()
.for_each(|(i, (declaration_name, tp))| {
let arg_type: Result<ArgType, _> = tp.try_into();
if let Ok(arg_type) = arg_type {
// if the underlying ident is self, we shouldn't wrap it when printing it
// if type is unknown no wrapper exists
let wrapper_type: Option<ArgWrapperType> = ArgWrapperType::with_config(self.wrapped_type, &arg_type, config);
match wrapper_type {
Some(w) => {
inner_writer.write_inline(&Arg::new(arg_type, w).to_string())
}
None => {
inner_writer.write_inline(&format!("<invalid: {arg_type}>"));
errors.push(format!("Unsupported argument {}, not a wrapped type or primitive", arg_type));
return;
}
};
if declaration_name != "self" && i + 1 != decl.inputs.len() {
inner_writer.write_inline(",");
} else if declaration_name == "self" {
is_global_method = false;
// macro needs to recognize the self receiver
inner_writer.write_inline(":");
}
} else {
errors.push(format!("Unsupported argument, Not a simple type: {}.", arg_type.unwrap_err()))
};
});
if is_global_method {
has_global_methods = true;
}
inner_writer.write_inline(")");
if let Some(tp) = &decl.output{
let arg_type: Result<ArgType, _> = tp.try_into();
if let Ok(arg_type) = arg_type {
if let ArgType::Ref { .. } = arg_type {
errors.push("references are not supported as return types".to_owned());
return;
}
// if the underlying ident is self, we shouldn't wrap it when printing it
// if type is unknown, no wrapper type exists
let wrapper_type: Option<ArgWrapperType> = ArgWrapperType::with_config(self.wrapped_type, &arg_type, config);
match wrapper_type {
Some(w) => {
inner_writer.write_inline(" -> ");
inner_writer.write_inline(&Arg::new(arg_type, w).to_string());
}
None => {
errors.push(format!("Unsupported argument, not a wrapped type or primitive {arg_type}"));
inner_writer.write_inline(&format!("<invalid: {arg_type}>"));
}
}
} else {
errors.push(format!("Unsupported argument, not a simple type: {}", arg_type.unwrap_err()))
}
};
if !generics.params.is_empty() {
errors.push("Generics on the method".to_owned());
}
if !errors.is_empty() {
if args.print_errors {
writer.set_prefix("// ".into());
writer.write_line(&format!("Exclusion reason: {}", errors.join(",")));
writer.extend(inner_writer);
writer.clear_prefix();
writer.newline();
}
} else {
used_method_identifiers.insert(v.name.as_deref().unwrap());
inner_writer.write_inline(",");
writer.extend(inner_writer);
writer.newline();
}
});
self.has_global_methods = has_global_methods;
writer.close_paren();
writer.write_line("+ Fields");
writer.open_paren();
if let ItemEnum::Struct(struct_) = &self.item.inner {
if let StructKind::Plain {
fields,
fields_stripped: _,
} = &struct_.kind
{
fields
.iter()
.map(|field_| self.source.index.get(field_).unwrap())
.filter_map(|field_| match &field_.inner {
ItemEnum::StructField(type_) => {
Some((field_.name.as_ref().unwrap(), type_, field_))
}
_ => None,
})
.filter_map(|(name, type_, field_)| {
let arg_type: ArgType = type_.try_into().ok()?;
let base_ident = arg_type
.base_ident() // resolve self
.unwrap_or(self.wrapped_type.as_str());
// if the underlying ident is self, we shouldn't wrap it when printing it
let wrapper: ArgWrapperType = arg_type
.is_self()
.then_some(ArgWrapperType::None)
.or_else(|| {
config
.primitives
.contains(base_ident)
.then_some(ArgWrapperType::Raw)
})
.or_else(|| {
config
.types
.contains_key(base_ident)
.then_some(ArgWrapperType::Wrapped)
})
// we allow this since we later resolve unknown types to be resolved as ReflectedValues
.unwrap_or(ArgWrapperType::None);
let arg = Arg::new(arg_type, wrapper);
let mut reflectable_type = arg.to_string();
// if we do not have an appropriate wrapper and this is not a primitive or it's not public
// we need to go back to the reflection API
if arg.wrapper == ArgWrapperType::None {
if field_.attrs.iter().any(|attr| attr == "#[reflect(ignore)]") {
return None;
}
reflectable_type = "Raw(ReflectedValue)".to_owned();
}
if let Some(docs) = &field_.docs {
writer.set_prefix("/// ".into());
docs.lines().for_each(|line| {
writer.write_line(line);
});
writer.clear_prefix();
};
// add underscore if a method with same name exists
used_method_identifiers
.contains(name.as_str())
.then(|| writer.write_line(&format!("#[rename(\"_{name}\")]")));
writer.write_no_newline(name);
writer.write_inline(": ");
writer.write_inline(&reflectable_type);
writer.write_inline(",");
writer.newline();
Some(())
})
.for_each(drop);
}
};
writer.close_paren();
static BINARY_OPS: [(&str, &str); 5] = [
("add", "Add"),
("sub", "Sub"),
("div", "Div"),
("mul", "Mul"),
("rem", "Rem"),
];
writer.write_line("+ BinOps");
writer.open_paren();
BINARY_OPS.into_iter().for_each(|(op, rep)| {
if let Some(items) = self.impl_items.get(op) {
items
.iter()
.filter_map(|(impl_, item)| Some((impl_, item, (&impl_.for_).try_into().ok()?)))
.filter(|(_, _, self_type): &(&&Impl, &&Item, ArgType)| {
let base_ident =
self_type.base_ident().unwrap_or(self.wrapped_type.as_str());
let is_self_type_the_wrapper = (base_ident == self.wrapped_type)
&& config.types.contains_key(base_ident);
let is_primitive = config.primitives.contains(base_ident);
is_self_type_the_wrapper || is_primitive
})
.for_each(|(impl_, item, _self_type)| {
let _ = match &item.inner {
ItemEnum::Function(m) => {
m.decl
.inputs
.iter()
.map(|(_, t)| {
// check arg is valid
let arg_type: ArgType = t.try_into()?;
// if the underlying ident is self, we shouldn't wrap it when printing it
let wrapper_type = ArgWrapperType::with_config(
self.wrapped_type,
&arg_type,
config,
)
.unwrap();
Ok(Arg::new(arg_type, wrapper_type).to_string())
})
.collect::<Result<Vec<_>, _>>()
.map(|v| v.join(&format!(" {} ", rep)))
.and_then(|expr| {
// then provide return type
// for these traits that's on associated types within the impl
let out_type = impl_
.items
.iter()
.find_map(|v| {
let item = self.source.index.get(v).unwrap();
if let ItemEnum::AssocType { default, .. } =
&item.inner
{
if let Some("Output") = item.name.as_deref() {
return Some(default.as_ref().unwrap());
}
}
None
})
.ok_or_else(|| expr.clone())?;
let arg_type: ArgType = out_type.try_into()?;
// if the underlying ident is self, we shouldn't wrap it when printing it
let wrapper_type: ArgWrapperType =
ArgWrapperType::with_config(
self.wrapped_type,
&arg_type,
config,
)
.unwrap();
if wrapper_type == ArgWrapperType::None {
return Err(arg_type.to_string());
}
let return_string =
Arg::new(arg_type, wrapper_type).to_string();
writer.write_no_newline(&expr);
writer.write_inline(" -> ");
writer.write_inline(&return_string);
writer.write_inline(",");
writer.newline();
Ok(())
})
}
_ => panic!("Expected method"),
};
})
}
});
writer.close_paren();
static UNARY_OPS: [(&str, &str); 1] = [("neg", "Neg")];
writer.write_line("+ UnaryOps");
writer.open_paren();
UNARY_OPS.into_iter().for_each(|(op, rep)| {
if let Some(items) = self.impl_items.get(op) {
items.iter().for_each(|(_, _)| {
writer.write_line(&format!("{rep} self -> self"));
});
}
});
writer.close_paren();
self.config.derive_flags.iter().for_each(|flag| {
writer.write_inline("+ ");
flag.lines().for_each(|line| {
writer.write_line(line);
});
});
}
}