tari_comms 5.3.0-pre.3

//  Copyright 2019 The Tari Project
//
//  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
//  following conditions are met:
//
//  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
//  disclaimer.
//
//  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
//  following disclaimer in the documentation and/or other materials provided with the distribution.
//
//  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
//  products derived from this software without specific prior written permission.
//
//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
//  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
//  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
//  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
//  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
//  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
//  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

/// Creates a setter function used with the builder pattern.
/// The value is moved into the function and returned out.
macro_rules! setter {
    (
     $(#[$outer:meta])*
     $func:ident, $($name: ident).+, Option<$type: ty>
 ) => {
        $(#[$outer])*
        pub fn $func(mut self, val: $type) -> Self {
            self.$($name).+ = Some(val);
            self
        }
    };
    (
        $(#[$outer:meta])*
        $func:ident, $($name: ident).+, $type: ty
    ) => {
        $(#[$outer])*
        pub fn $func(mut self, val: $type) -> Self {
            self.$($name).+ = val;
            self
        }
    };
}

/// Creates a setter function used with the builder pattern
/// A mutable reference is taken and returned
macro_rules! setter_mut {
    ($func:ident, $name: ident, Option<$type: ty>) => {
        #[allow(dead_code)]
        #[allow(unused_doc_comments)]
        pub fn $func(&mut self, val: $type) -> &mut Self {
            self.$name = Some(val);
            self
        }
    };
    ($func:ident, $name: ident, $type: ty) => {
        #[allow(dead_code)]
        #[allow(unused_doc_comments)]
        pub fn $func(&mut self, val: $type) -> &mut Self {
            self.$name = val;
            self
        }
    };
}

/// Internal macro used to recover locks
macro_rules! recover_lock {
    ($e:expr) => {
        match $e {
            Ok(lock) => lock,
            Err(poisoned) => {
                log::warn!(target: "comms", "Lock has been POISONED and will be silently recovered");
                poisoned.into_inner()
            },
        }
    };
}

/// Used to acquire a lock from a sync resource. If that resource is poisoned, the lock
/// returned contains the state prior to it being poisoned.
macro_rules! acquire_lock {
    ($e:expr, $m:ident) => {
        recover_lock!($e.$m())
    };
    ($e:expr) => {
        recover_lock!($e.lock())
    };
}

/// Acquires a read lock from a RwLock. If the lock is poisoned, the returned lock contains
/// the state prior to it being poisoned. This provides semantics similar to a DB transaction.
macro_rules! acquire_read_lock {
    ($e:expr) => {
        acquire_lock!($e, read)
    };
}

/// Acquires an exclusive write lock from a RwLock. If the lock is poisoned, the returned lock contains
/// the state prior to it being poisoned. This provides semantics similar to a DB transaction.
macro_rules! acquire_write_lock {
    ($e:expr) => {
        acquire_lock!($e, write)
    };
}

/// Log an error if an `Err` is returned from the `$expr`. If the given expression is `Ok(v)`,
/// `Some(v)` is returned, otherwise `None` is returned (same as `Result::ok`).
/// Useful in cases where the error should be logged and ignored.
/// instead of writing `if let Err(err) = my_error_call() { error!(...) }`, you can write
/// `log_if_error!(my_error_call())`
///
/// ```edition2018,no_compile
/// # use tari_common::log_if_error;
/// let opt = log_if_error!(target: "docs", level: debug, Result::<(), _>::Err("this will be logged as 'error' tag"), "Error: {error}");
/// assert_eq!(opt, None);
/// ```
#[macro_export]
macro_rules! log_if_error {
    (level:$level:ident, target:$target:expr, $expr:expr, $msg:expr, $($args:tt),* $(,)*) => {{
        match $expr {
            Ok(v) => Some(v),
            Err(err) => {
                log::$level!(target: $target, $msg, $($args,)* error = err);
                None
            }
        }
    }};
    (target:$target:expr, $expr:expr, $msg:expr, $($args:tt),* $(,)*) => {{
        log_if_error!(level:warn, target:$target, $expr, $msg, $($args),*)
    }};
    (level:$level:ident, $expr:expr, $msg:expr, $($args:tt),* $(,)*) => {{
        log_if_error!(level:$level, target:"$crate", $expr, $msg, $($args),*)
    }};
    ($expr:expr, $msg:expr, $($args:tt)* $(,)*) => {{
        log_if_error!(level:warn, target:"$crate", $expr, $msg, $($args),*)
    }};
}

#[macro_export]
macro_rules! log_if_error_fmt {
    (level: $level:ident, target: $target:expr, $expr:expr, $($args:tt)+) => {{
        match $expr {
            Ok(v) => Some(v),
            Err(_) => {
                log::$level!(target: $target, $($args)+);
                None
            }
        }
    }};
    (level:$level:ident, $expr:expr, $($args:tt)+) => {{
        log_if_error_fmt!(level:$level, target: "$crate", $expr, $($args)+)
    }};
    (target: $target:expr, $expr:expr , $($args:tt)+) => {{
        log_if_error_fmt!(level:error, target: $target, $expr, $($args)+)
    }};
    ($msg:expr, $expr:expr, $($args:tt)+) => {{
        log_if_error_fmt!(level:error, target: "$crate", $expr, $($args)+)
    }};
}

/// Add `#[cfg(test)]` attribute to items
macro_rules! cfg_test {
     ($($item:item)*) => {
        $(
            #[cfg(test)]
            $item
        )*
    }
}

/// Generates an `is_xx` function for an enum variant.
macro_rules! is_fn {
    (
        $(#[$outer:meta])*
        $name: ident, $($enum_key:ident)::+
    ) => {
        $(#[$outer])*
        pub fn $name(&self) -> bool {
            matches!(self, $($enum_key)::+)
        }
    };
    (
        $(#[$outer:meta])*
        $name: ident, $($enum_key:ident)::+ ( $($p:tt),* )
    ) => {
      pub fn $name(&self) -> bool {
        matches!(self, $($enum_key)::+($($p),*))
        }
    };
}

/// Includes code from the OUT_DIR
#[macro_export]
macro_rules! outdir_include {
    ($name: expr) => {
        include!(concat!(env!("OUT_DIR"), "/", $name));
    };
}