seaplane_cli/

macros.rs

macro_rules! _print {
    (@$color:ident, $ptr:ident, $($args:tt)+) => {{
        use ::std::io::Write;

        let mut ptr = $crate::printer::$ptr();
        ptr.set_color($crate::printer::Color::$color);
        let _ = ::std::write!(ptr, $($args)+);
        ptr.reset();
    }};
    ($ptr:ident, $($args:tt)+) => {{
        use ::std::io::Write;

        let _ = ::std::write!($crate::printer::$ptr(), $($args)+);
    }};
}

// Print is akin to info! level messages
macro_rules! cli_print {
    (@$color:ident, $($args:tt)+) => {{
        if $crate::log::log_level() <= &$crate::log::LogLevel::Info {
            _print!(@$color, printer, $($args)+);
        }
    }};
    ($($args:tt)+) => {{
        if $crate::log::log_level() <= &$crate::log::LogLevel::Info {
            _print!(printer, $($args)+);
        }
    }};
}

// Akin to info! level messages
macro_rules! cli_println {
    (@$color:ident, $($args:tt)+) => {{
        cli_print!(@$color, $($args)+);
        cli_print!("\n");
    }};
    // TODO: change to zero or more (*)
    ($($args:tt)+) => {{
        cli_print!($($args)+);
        cli_print!("\n");
    }}
}

// akin to error! level messages
macro_rules! cli_eprint {
    (@$color:ident, $($args:tt)+) => {{
        if $crate::log::log_level() <= &$crate::log::LogLevel::Error {
            _print!(@$color, eprinter, $($args)+);
        }
    }};
    ($($args:tt)+) => {{
        if $crate::log::log_level() <= &$crate::log::LogLevel::Error {
            _print!(eprinter, $($args)+);
        }
    }}
}

// Akin to error! level messages
macro_rules! cli_eprintln {
    (@$color:ident, $($args:tt)+) => {{
        cli_eprint!(@$color, $($args)+);
        cli_eprint!("\n");
    }};
    ($($args:tt)*) => {{
        cli_eprint!($($args)+);
        cli_eprint!("\n");
    }}
}

/// Writes an error message to stderr and exits the process
#[allow(unused_macros)]
macro_rules! cli_bail {
    (@impl $prefix:expr, $status:expr, $($args:tt)*) => {{
        cli_eprint!(@Red, $prefix);
        cli_eprintln!($($args)+);
        ::std::process::exit($status);
    }};
    (@prefix $prefix:expr, @status $status:expr, $($args:tt)+) => {{
        cli_bail!(@impl $prefix, $status, $($args)+);
    }};
    (@status $status:expr, $($args:tt)+) => {{
        cli_bail!(@impl "error: ", $status, $($args)+);
    }};
    (@prefix $prefix:expr, $($args:tt)+) => {{
        cli_bail!(@impl $prefix, 1, $($args)+);
    }};
    ($($args:tt)*) => {{
        cli_bail!(@impl "error: ", 1, $($args)+);
    }};
}

// Akin to warn! level messages.
//
// The *ln variants it's more common to want a oneshot message with a
// "warn: " prefix, so that's the default. You opt out of the prefix with `@noprefix`. The non-line
// versions are the opposite, because it's more common to *not* want a prefix i.e. you're writing
// multiple portions of the same line.
macro_rules! cli_warn {
    (@prefix, @$color:ident, $($args:tt)+) => {{
        if $crate::log::log_level() <= &$crate::log::LogLevel::Warn {
            _print!(@Yellow, printer, "warn: ");
            _print!(@$color, printer, $($args)+);
        }
    }};
    (@prefix, $($args:tt)+) => {{
        if $crate::log::log_level() <= &$crate::log::LogLevel::Warn {
            _print!(printer, "warn: ");
            _print!(printer, $($args)+);
        }
    }};
    (@$color:ident, $($args:tt)+) => {{
        if $crate::log::log_level() <= &$crate::log::LogLevel::Warn {
            _print!(@$color, printer, $($args)+);
        }
    }};
    ($($args:tt)+) => {{
        if $crate::log::log_level() <= &$crate::log::LogLevel::Warn {
            _print!(printer, $($args)+);
        }
    }};
}

// Akin to warn! level messages.
//
// The *ln variants it's more common to want a oneshot message with a
// "warn: " prefix, so that's the default. You opt out of the prefix with `@noprefix`. The non-line
// versions are the opposite, because it's more common to *not* want a prefix i.e. you're writing
// multiple portions of the same line.
macro_rules! cli_warnln {
    (@noprefix, @$color:ident, $($args:tt)+) => {{
        cli_warn!(@$color, $($args)+);
        cli_warn!("\n");
    }};
    // TODO: change to zero or more (*)
    (@noprefix, $($args:tt)+) => {{
        cli_warn!($($args)+);
        cli_warn!("\n");
    }};
    (@$color:ident, $($args:tt)+) => {{
        cli_warn!(@prefix, @$color, $($args)+);
        cli_warn!("\n");
    }};
    // TODO: change to zero or more (*)
    ($($args:tt)+) => {{
        cli_warn!(@prefix, $($args)+);
        cli_warn!("\n");
    }}
}

// Akin to debug! level messages
//
// The *ln variants it's more common to want a oneshot message with a
// "warn: " prefix, so that's the default. You opt out of the prefix with `@noprefix`. The non-line
// versions are the opposite, because it's more common to *not* want a prefix i.e. you're writing
// multiple portions of the same line.
macro_rules! cli_debug {
    (@prefix, @$color:ident, $($args:tt)+) => {{
        if $crate::log::log_level() <= &$crate::log::LogLevel::Debug {
            _print!(@$color, eprinter, "DEBUG: ");
            _print!(@$color, eprinter, $($args)+);
        }
    }};
    (@prefix, $($args:tt)+) => {{
        if $crate::log::log_level() <= &$crate::log::LogLevel::Debug {
            _print!(eprinter, "DEBUG: ");
            _print!(eprinter, $($args)+);
        }
    }};
    (@$color:ident, $($args:tt)+) => {{
        if $crate::log::log_level() <= &$crate::log::LogLevel::Debug {
            _print!(@$color, eprinter, $($args)+);
        }
    }};
    ($($args:tt)+) => {{
        if $crate::log::log_level() <= &$crate::log::LogLevel::Debug {
            _print!(eprinter, $($args)+);
        }
    }};
}

// Akin to the debug! level messages.
//
// The *ln variants it's more common to want a oneshot message with a
// "DEBUG: " prefix, so that's the default. You opt out of the prefix with `@noprefix`. The non-line
// versions are the opposite, because it's more common to *not* want a prefix i.e. you're writing
// multiple portions of the same line.
macro_rules! cli_debugln {
    (@prefix, @$color:ident, $($args:tt)+) => {{
        cli_debug!(@prefix, @$color, $($args)+);
        cli_debug!("\n");
    }};
    // TODO: change to zero or more (*)
    (@prefix, $($args:tt)+) => {{
        cli_debug!(@prefix, $($args)+);
        cli_debug!("\n");
    }};
    (@$color:ident, $($args:tt)+) => {{
        cli_debug!(@$color, $($args)+);
        cli_debug!("\n");
    }};
    // TODO: change to zero or more (*)
    ($($args:tt)+) => {{
        cli_debug!($($args)+);
        cli_debug!("\n");
    }}
}

// Akin to trace! level messages
//
// The *ln variants it's more common to want a oneshot message with a
// "warn: " prefix, so that's the default. You opt out of the prefix with `@noprefix`. The non-line
// versions are the opposite, because it's more common to *not* want a prefix i.e. you're writing
// multiple portions of the same line.
macro_rules! cli_trace {
    (@prefix, @$color:ident, $($args:tt)+) => {{
        if $crate::log::log_level() <= &$crate::log::LogLevel::Trace {
            _print!(@$color, eprinter, "TRACE: ");
            _print!(@$color, eprinter, $($args)+);
        }
    }};
    (@prefix, $($args:tt)+) => {{
        if $crate::log::log_level() <= &$crate::log::LogLevel::Trace {
            _print!(eprinter, "TRACE: ");
            _print!(eprinter, $($args)+);
        }
    }};
    (@$color:ident, $($args:tt)+) => {{
        if $crate::log::log_level() <= &$crate::log::LogLevel::Trace {
            _print!(@$color, eprinter, $($args)+);
        }
    }};
    ($($args:tt)+) => {{
        if $crate::log::log_level() <= &$crate::log::LogLevel::Trace {
            _print!(eprinter, $($args)+);
        }
    }};
}

// Akin to the trace! level messages.
//
// The *ln variants it's more common to want a oneshot message with a
// "DEBUG: " prefix, so that's the default. You opt out of the prefix with `@noprefix`. The non-line
// versions are the opposite, because it's more common to *not* want a prefix i.e. you're writing
// multiple portions of the same line.
macro_rules! cli_traceln {
    (@prefix, @$color:ident, $($args:tt)+) => {{
        cli_trace!(@prefix, @$color, $($args)+);
        cli_trace!("\n");
    }};
    // TODO: change to zero or more (*)
    (@prefix, $($args:tt)+) => {{
        cli_trace!(@prefix, $($args)+);
        cli_trace!("\n");
    }};
    (@$color:ident, $($args:tt)+) => {{
        cli_trace!(@$color, $($args)+);
        cli_trace!("\n");
    }};
    // TODO: change to zero or more (*)
    ($($args:tt)+) => {{
        cli_trace!($($args)+);
        cli_trace!("\n");
    }}
}

// Helper macros to make some CLI aspects a little less verbose

/// Makes declaring *consistent* arguments less verbose and less tedious.
///
/// The available syntax is:
///
/// - `--STRING` or `--("STRING-WITH-HYPHENS")` will make an `Arg` where *both* the name and long
/// are the same. Due to Rust syntax, if the argument should have hyphens, one must use
/// `--("foo-bar-baz")`
/// - `-('f')` sets the Short value. (Due to Rust syntax rules)
/// - Visible aliases can be set with using `|` along with the similar Long value rules. I.e. `|foo`
///   or
/// `|("foo-with-hyphens"). When combined the Long/name it actually looks good `--foo|bar`, etc.
/// - A value name can be set with `=["STRING"]` optionally also setting a default value
///   `=["STRING"=>"default"]`
/// - Setting multiple values can be done with `...` Note that this sets multiple
/// values/occurrences in a consistent manner for this application. If you need arguments with
/// different semantics you'll have to set those manually. `...` is equivalent to setting
/// `Arg::new("foo").action(ArgAction::Append).number_of_values(1).
/// value_delimiter(',')`
/// - Setting any boolean value to `true` can be done by just the function name i.e. `required`
/// - Setting any boolean value to `false` can be done by prefixing the function with `!` i.e.
/// `!required`
///
/// ```rust
/// # use clap::{ArgAction, Arg};
/// # use seaplane_cli::arg;
/// # let _ =
/// arg!(--foo|foos =["NUM"=>"2"]... global !allow_hyphen_values);
///
/// // is equivalent to (with the macro syntax in the comment to the right)...
/// # let _ =
/// Arg::new("foo")                // --foo
///   .long("foo")                 // --foo
///   .visible_alias("foos")       // |foos
///   .value_name("NUM")           // =["NUM"]
///   .default_value("2")          // =[..=>"2"]
///   .action(ArgAction::Append)   // ...
///   .value_delimiter(',')        // ...
///   .number_of_values(1)         // ...
///   .global(true)                // global
///   .allow_hyphen_values(false); // !allow_hyphen_values
/// ```
#[macro_export]
macro_rules! arg {
    (@arg ($arg:expr) ) => { $arg };
    (@arg ($arg:expr) --$long:ident $($tail:tt)*) => {
        arg!(@arg ($arg.long(stringify!($long)).action(::clap::ArgAction::SetTrue)) $($tail)* )
    };
    (@arg ($arg:expr) -($short:expr) $($tail:tt)*) => {
        arg!(@arg ($arg.short($short).action(::clap::ArgAction::SetTrue)) $($tail)* )
    };
    (@arg ($arg:expr) | ($alias:expr) $($tail:tt)*) => {
        arg!(@arg ($arg.visible_alias($alias)) $($tail)* )
    };
    (@arg ($arg:expr) | $alias:ident $($tail:tt)*) => {
        arg!(@arg ($arg.visible_alias(stringify!($alias))) $($tail)* )
    };
    (@arg ($arg:expr) ... $($tail:tt)*) => {
        arg!(@arg ({
            let arg = $arg.value_delimiter(',').action(::clap::ArgAction::Append);
            if arg.get_long().is_some() || arg.get_short().is_some() {
                arg.number_of_values(1)
            } else {
                arg
            }
        }) $($tail)* )
    };
    (@arg ($arg:expr) =[$var:expr$(=>$default:expr)?] $($tail:tt)*) => {
        arg!(@arg ({
            #[allow(unused_mut)]
            let mut a = $arg.value_name($var).action(::clap::ArgAction::Set);
            $(
                a = a.default_value($default);
            )?
            a
            }) $($tail)*)
    };
    // !foo -> .foo(false)
    (@arg ($arg:expr) !$ident:ident $($tail:tt)*) => {
        arg!(@arg ($arg.$ident(false)) $($tail)*)
    };
    // +foo -> .foo(true)
    (@arg ($arg:expr) $ident:ident $($tail:tt)*) => {
        arg!(@arg ($arg.$ident(true)) $($tail)*)
    };
    ($name:ident $($tail:tt)*) => {
        arg!(@arg (::clap::Arg::new(stringify!($name))) $($tail)* )
    };
    (--($name:expr) $($tail:tt)*) => {
        arg!(@arg (::clap::Arg::new($name)
                .long($name)
                .action(::clap::ArgAction::SetTrue))
            $($tail)*
        )
    };
    (--$name:ident $($tail:tt)*) => {
        arg!(@arg (::clap::Arg::new(stringify!($name))
                .long(stringify!($name))
                .action(::clap::ArgAction::SetTrue))
            $($tail)*
        )
    };
}

/// Shorthand for checking if an argument in the CLI commands was base64 or not, and doing
/// the conversion if necessary
macro_rules! maybe_base64_arg {
    ($m:expr, $arg:expr, $is_base64:expr) => {
        if let Some(raw_key) = $m.get_one::<String>($arg) {
            let engine = ::base64::engine::fast_portable::FastPortable::from(
                &::base64::alphabet::URL_SAFE,
                ::base64::engine::fast_portable::NO_PAD,
            );
            if $is_base64 {
                let _ = ::base64::decode_engine(raw_key, &engine)?;
                Some(raw_key.to_string())
            } else {
                Some(::base64::encode_engine(raw_key, &engine))
            }
        } else {
            None
        }
    };
}

/// Remove items from a Vec matching some predicate, returning the removed items as a new Vec
macro_rules! vec_remove_if {
    ($v:expr, $f:expr) => {{
        let idx: Vec<_> = $v
            .iter()
            .enumerate()
            .rev()
            .filter_map(|(i, item)| if $f(item) { Some(i) } else { None })
            .collect();
        let mut ret = Vec::new();
        for i in idx {
            ret.push($v.swap_remove(i));
        }
        ret
    }};
}

/// Performs the wrapped method request against the SDK API. If the response is that the access
/// token is expired, it will refresh the access token and try again. All other errors are mapped
/// to the CliError type.
macro_rules! maybe_retry {
    ($this:ident . $fn:ident ( $($arg:expr),* ) ) => {{
        if $this.inner.is_none() {
            $this.refresh_inner()?;
        }
        let req = &mut $this.inner.as_mut().unwrap();

        let res = match req.$fn($( $arg ),*) {
            Ok(ret) => Ok(ret),
            Err(SeaplaneError::ApiResponse(ae))
                if ae.kind == ApiErrorKind::Unauthorized =>
            {
                $this.token = Some(request_token(
                        &$this.api_key,
                        $this.identity_url.as_ref(),
                        $this.insecure_urls,
                        $this.invalid_certs)?);
                Ok(req.$fn($( $arg ,)*)?)
            }
            Err(e) => Err(e),
        };
        res.map_err(CliError::from)
    }};
}

/// Same as maybe_retry but will clone the function arguments
macro_rules! maybe_retry_cloned {
    ($this:ident . $fn:ident ( $($arg:expr),* ) ) => {{
        maybe_retry!($this.$fn($( $arg.clone() ),*))
    }};
}