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
use interoptopus::util::NamespaceMappings;
/// The types to write for the given recorder.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
pub enum WriteTypes {
/// Only write items defined in the library for this namespace.
Namespace,
/// Write types in this namespace and global interoptopus types (e.g., FFIBool)
NamespaceAndInteroptopusGlobal,
/// Write every type in the library, regardless of namespace association.
All,
}
impl WriteTypes {
pub fn write_interoptopus_globals(&self) -> bool {
match self {
WriteTypes::Namespace => false,
WriteTypes::NamespaceAndInteroptopusGlobal => true,
WriteTypes::All => true,
}
}
}
/// The access modifiers for generated CSharp types
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
pub enum CSharpVisibility {
/// Mimics Rust visibility.
AsDeclared,
/// Generates all types as `public class` / `public struct`.
ForcePublic,
/// Generates all types as `internal class` / `internal struct`.
ForceInternal,
}
impl CSharpVisibility {
pub fn to_access_modifier(&self) -> &'static str {
match self {
// TODO: `AsDeclared` should ultimately use the declared visibility but for now copy the previous
// behavior which is to make everything public.
CSharpVisibility::AsDeclared => "public",
CSharpVisibility::ForcePublic => "public",
CSharpVisibility::ForceInternal => "internal",
}
}
}
/// Whether and how `unsafe` in generated C# should be emitted.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
pub enum Unsafe {
/// Do not use C# `unsafe`.
None,
/// Use `unsafe` for performance optimizations (Unity compatible).
UnsafeKeyword,
/// Also use `unsafe` for slice copies.
UnsafePlatformMemCpy,
}
impl Unsafe {
pub fn any_unsafe(self) -> bool {
match self {
Unsafe::None => false,
Unsafe::UnsafeKeyword => true,
Unsafe::UnsafePlatformMemCpy => true,
}
}
}
/// Configures C# code generation.
#[derive(Clone, Debug)]
pub struct Config {
/// The file header, e.g., `// (c) My Company`.
pub file_header_comment: String,
/// Name of static class for Interop methods, e.g., `Interop`.
pub class: String,
/// Name of static class for Interop constants, e.g., `Interop`. If [None] then [Self.class] is used
pub class_constants: Option<String>,
/// DLL to load, e.g., `my_library`.
pub dll_name: String,
/// Maps which namespace id belongs into which FQN (e.g., "common" => "MyCompany.Common").
pub namespace_mappings: NamespaceMappings,
/// Namespace ID of _this_ namespace to write (default "").
pub namespace_id: String,
/// Sets the visibility access modifiers for generated types.
pub visibility_types: CSharpVisibility,
/// Whether, say, a `x: [u8; 3]` should become 3 `x0: u8, ...` instead.
///
/// If this is not set, interop generation with arrays in structs will fail. This is a somewhat
/// open issue w.r.t Unity-sans-unsafe support and feedback would be greatly welcome!
pub unroll_struct_arrays: bool,
/// Which types to write.
pub write_types: WriteTypes,
/// If enabled bindings will use C# `unsafe` for increased performance; but will need to be enabled in C# project settings to work.
pub use_unsafe: Unsafe,
/// Generate functions and field names matching C# conventions, instead of mapping them 1:1 with Rust.
pub rename_symbols: bool,
/// Also generate markers for easier debugging
pub debug: bool,
}
impl Config {}
impl Default for Config {
fn default() -> Self {
Self {
file_header_comment: "// Automatically generated by Interoptopus.".to_string(),
class: "Interop".to_string(),
class_constants: None,
dll_name: "library".to_string(),
namespace_mappings: NamespaceMappings::new("My.Company"),
namespace_id: "".to_string(),
visibility_types: CSharpVisibility::AsDeclared,
unroll_struct_arrays: true,
write_types: WriteTypes::NamespaceAndInteroptopusGlobal,
use_unsafe: Unsafe::None,
rename_symbols: false,
debug: false,
}
}
}
/// Configures C# documentation generation.
#[derive(Clone, Debug, Default)]
pub struct DocConfig {
/// Header to append to the generated documentation.
pub header: String,
}