#[macro_export]
macro_rules! diagnosed_error {
($($arg:tt)*) => {{
use txtx_addon_kit::types::diagnostics::{DiagnosticLevel, Diagnostic};
let res = format_args!($($arg)*).to_string();
Diagnostic::error_from_string(res)
}};
}
#[macro_export]
macro_rules! define_function {
($func_key:ident => {
name: $fn_name:expr,
documentation: $doc:expr,
example: $example:expr,
inputs: [$($input_name:ident: { documentation: $input_doc:expr, typing: $input_ts:expr $(, optional: $input_opt:expr)? }),*],
output: { documentation: $output_doc:expr, typing: $output_ts:expr },
}) => {
txtx_addon_kit::types::functions::FunctionSpecification {
name: String::from($fn_name),
documentation: String::from($doc),
inputs: vec![$(txtx_addon_kit::types::functions::FunctionInput {
name: String::from(stringify!($input_name)),
documentation: String::from($input_doc),
typing: $input_ts,
optional: {
let mut is_optional = true;
$(
is_optional = $input_opt;
)?
is_optional
},
}),*],
output: txtx_addon_kit::types::functions::FunctionOutput {
documentation: String::from($output_doc),
typing: $output_ts,
},
example: String::from($example),
snippet: String::from(""),
runner: $func_key::run,
checker: $func_key::check_instantiability,
};
};
}
#[macro_export]
macro_rules! define_command {
($func_key:ident => {
name: $fn_name:expr,
matcher: $matcher:expr,
documentation: $doc:expr,
implements_signing_capability: $implements_signing_capability:expr,
implements_background_task_capability: $implements_background_task_capability:expr,
// todo: add key field and use the input_name as the key, so the user can also provide a web-ui facing name
inputs: [$($input_name:ident: { documentation: $input_doc:expr, typing: $input_ts:expr, optional: $optional:expr, tainting: $tainting:expr, internal: $internal:expr $(, sensitive: $sensitive:expr)? }),*],
outputs: [$($output_name:ident: { documentation: $output_doc:expr, typing: $output_ts:expr }),*],
example: $example:expr,
$(, implements_cloud_service: $implements_cloud_service:expr)?
}) => {
{
use txtx_addon_kit::types::commands::{PreCommandSpecification, CommandSpecification, CommandInput, CommandOutput, CommandExecutionClosure};
let implements_signing_capability: bool = $implements_signing_capability;
let implements_background_task_capability: bool = $implements_background_task_capability;
PreCommandSpecification::Atomic(
CommandSpecification {
name: String::from($fn_name),
matcher: String::from($matcher),
documentation: String::from($doc),
accepts_arbitrary_inputs: false,
create_output_for_each_input: false,
update_addon_defaults: false,
create_critical_output: None,
implements_signing_capability,
implements_background_task_capability,
inputs: vec![$(CommandInput {
name: String::from(stringify!($input_name)),
documentation: String::from($input_doc),
typing: $input_ts,
optional: $optional,
tainting: $tainting,
internal: $internal,
check_required: false,
check_performed: false,
sensitive: {
let mut is_sensitive = false;
$(
is_sensitive = $sensitive;
)?
is_sensitive
},
self_referencing: false
}),*],
default_inputs: CommandSpecification::default_inputs(),
outputs: vec![$(CommandOutput {
name: String::from(stringify!($output_name)),
documentation: String::from($output_doc),
typing: $output_ts,
}),*],
inputs_post_processing_closure: $func_key::post_process_evaluated_inputs,
evaluate_pre_conditions: $func_key::evaluate_pre_conditions,
prepare_nested_execution: $func_key::prepare_nested_execution,
check_instantiability: $func_key::check_instantiability,
check_executability: $func_key::check_executability,
run_execution: Box::new($func_key::run_execution),
check_signed_executability: $func_key::check_signed_executability,
prepare_signed_nested_execution: $func_key::prepare_signed_nested_execution,
run_signed_execution: Box::new($func_key::run_signed_execution),
build_background_task: Box::new($func_key::build_background_task),
implements_cloud_service: {
let mut implements_cloud_service = false;
$(
implements_cloud_service = $implements_cloud_service;
)?
implements_cloud_service
},
aggregate_nested_execution_results: $func_key::aggregate_nested_execution_results,
evaluate_post_conditions: $func_key::evaluate_post_conditions,
example: String::from($example),
}
)
}
};
}
#[macro_export]
macro_rules! define_multistep_command {
($func_key:ident => {
name: $fn_name:expr,
matcher: $matcher:expr,
documentation: $doc:expr,
parts: [$($part:expr),*],
example: $example:expr,
}) => {
{
use txtx_addon_kit::types::commands::{PreCommandSpecification, CompositeCommandSpecification, CommandInput, CommandOutput, CommandExecutionClosure};
let mut parts = Vec::new();
$(parts.push($part);)*
PreCommandSpecification::Composite( CompositeCommandSpecification {
name: String::from($fn_name),
matcher: String::from($matcher),
documentation: String::from($doc),
parts: parts,
default_inputs: CommandSpecification::default_inputs(),
router: $func_key::router,
example: String::from($example),
})
}
};
}
#[macro_export]
macro_rules! define_strict_object_type {
[
$($input_name:ident: {
documentation: $input_doc:expr,
typing: $input_ts:expr,
optional: $optional:expr,
tainting: $tainting:expr
}),*
] => {
Type::strict_object(vec![$(txtx_addon_kit::types::types::ObjectProperty {
name: String::from(stringify!($input_name)),
documentation: String::from($input_doc),
typing: $input_ts,
optional: $optional,
tainting: $tainting,
internal: false,
}),*])
};
}
#[macro_export]
macro_rules! define_documented_arbitrary_object_type {
[
$($input_name:ident: {
documentation: $input_doc:expr,
typing: $input_ts:expr,
optional: $optional:expr,
tainting: $tainting:expr
}),*
] => {
Type::documented_arbitrary_object(vec![$(txtx_addon_kit::types::types::ObjectProperty {
name: String::from(stringify!($input_name)),
documentation: String::from($input_doc),
typing: $input_ts,
optional: $optional,
tainting: $tainting,
internal: false,
}),*])
};
}
#[macro_export]
macro_rules! define_strict_map_type {
[
$($input_name:ident: {
documentation: $input_doc:expr,
typing: $input_ts:expr,
optional: $optional:expr,
tainting: $tainting:expr
}),*
] => {
Type::strict_map(vec![$(txtx_addon_kit::types::types::ObjectProperty {
name: String::from(stringify!($input_name)),
documentation: String::from($input_doc),
typing: $input_ts,
optional: $optional,
tainting: $tainting,
internal: false,
}),*])
};
}
#[macro_export]
macro_rules! define_documented_arbitrary_map_type {
[
$($input_name:ident: {
documentation: $input_doc:expr,
typing: $input_ts:expr,
optional: $optional:expr,
tainting: $tainting:expr
}),*
] => {
Type::documented_arbitrary_map(vec![$(txtx_addon_kit::types::types::ObjectProperty {
name: String::from(stringify!($input_name)),
documentation: String::from($input_doc),
typing: $input_ts,
optional: $optional,
tainting: $tainting,
internal: false,
}),*])
};
}
#[macro_export]
macro_rules! define_addon_type {
($func_key:ident => {
name: $fn_name:expr,
documentation: $doc:expr,
}) => {
txtx_addon_kit::types::types::TypeSpecification {
id: String::from($fn_name),
documentation: String::from($doc),
checker: $func_key::check,
};
};
}
#[macro_export]
macro_rules! define_signer {
($func_key:ident => {
name: $fn_name:expr,
matcher: $matcher:expr,
documentation: $doc:expr,
inputs: [$($input_name:ident: { documentation: $input_doc:expr, typing: $input_ts:expr, optional: $optional:expr, tainting: $tainting:expr, sensitive: $sensitive:expr }),*],
outputs: [$($output_name:ident: { documentation: $output_doc:expr, typing: $output_ts:expr }),*],
example: $example:expr
$(, force_sequential_signing: $force_sequential_signing:expr)?
}) => {
{
use txtx_addon_kit::types::signers::{SignerSpecification, SignerSignClosure};
use txtx_addon_kit::types::commands::{CommandInput, CommandOutput};
SignerSpecification {
name: String::from($fn_name),
matcher: String::from($matcher),
documentation: String::from($doc),
requires_interaction: false,
inputs: vec![$(CommandInput {
name: String::from(stringify!($input_name)),
documentation: String::from($input_doc),
typing: $input_ts,
optional: $optional,
tainting: $tainting,
sensitive: $sensitive,
check_required: false,
check_performed: false,
internal: false,
self_referencing: false,
}),*],
default_inputs: CommandSpecification::default_inputs(),
outputs: vec![$(CommandOutput {
name: String::from(stringify!($output_name)),
documentation: String::from($output_doc),
typing: $output_ts,
}),*],
check_instantiability: $func_key::check_instantiability,
check_activability: $func_key::check_activability,
activate: Box::new($func_key::activate),
check_signability: $func_key::check_signability,
sign: Box::new($func_key::sign),
example: String::from($example),
force_sequential_signing: false $(|| $force_sequential_signing)?
}
}
};
}