ncursesw-win 0.6.3

/*
    src/macros.rs

    Copyright (c) 2019-2021 Stephen Whittle  All rights reserved.

    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"),
    to deal in the Software without restriction, including without limitation
    the rights to use, copy, modify, merge, publish, distribute, sublicense,
    and/or sell copies of the Software, and to permit persons to whom
    the Software is furnished to do so, subject to the following conditions:
    The above copyright notice and this permission notice shall be included
    in all copies or substantial portions of the Software.
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
    THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
    IN THE SOFTWARE.
*/

#![macro_use]

macro_rules! result { ($t: ty) => { Result<$t, NCurseswWinError> } }

macro_rules! assert_origin {
    ($str: expr, $window_size: expr, $origin: expr) => {
        let _window_size = $window_size;

        assert!(
            $origin.y <= _window_size.lines && $origin.x <= _window_size.columns,
            "{}() : origin is invalid, origin={}, window_size={}", $str, $origin, _window_size
        );
    }
}

macro_rules! assert_region {
    ($str: expr, $window_size: expr, $region: expr) => {
        let _window_size = $window_size;

        assert!(
            $region.top < $region.bottom && $region.bottom <= _window_size.lines,
            "{}() : region is invalid, region={}, window_size={}", $str, $region, _window_size
        );
    }
}

macro_rules! assert_origin_hlength {
    ($str: expr, $window_size: expr, $origin: expr, $length: expr) => {
        let _window_size = $window_size;

        assert_origin!($str, _window_size, $origin);
        assert!(
            $origin.x + $length <= _window_size.columns,
            "{}() : attempting to write over window edge, origin.x={} + length={} <= window_size.columns={}", $str, $origin.x, $length, _window_size.columns
        );
    }
}

macro_rules! assert_origin_vlength {
    ($str: expr, $window_size: expr, $origin: expr, $length: expr) => {
        let _window_size = $window_size;

        assert_origin!($str, _window_size, $origin);
        assert!(
            $origin.y + $length <= _window_size.lines,
            "{}() : attempting to write over window edge, origin.y={} + length={} <= window_size.lines={}", $str, $origin.y, $length, _window_size.lines
        );
    }
}

macro_rules! c_str_with_nul { ($name: ident) => { unsafe { &*($name.to_c_str()?.as_bytes_with_nul() as *const [u8] as *const [i8]) } } }

macro_rules! option_length { ($length: expr) => { $length.map_or_else(|| Ok(-1), i32::try_from) } }

macro_rules! nonblocking_get {
    ($fname: ident, $func: ident, $str: expr, $type: ty) => {
        fn $fname(&self, timeout: Timeout) -> result!(NonBlockingResult<$type>) {
            // remember the original timeout
            let orig_timeout = self.get_timeout()?;

            // set the timeout to what has been specified.
            self.set_timeout(timeout)?;

            // call $func, if it returned Err and the error is a timeout error
            // then return Ok(None) otherwise return the error.
            // if $func returned Ok then return Ok(Some(result))
            let result = match self.$func() {
                Err(source) => {
                    if source == crate::ncurseswwinerror::timeout_error(&$str) {
                        Ok(None)
                    } else {
                        Err(source)
                    }
                },
                Ok(result) => Ok(Some(result))
            };

            // if we didn't error above then set the timeout back to what it
            // originally was.
            if result.is_ok() {
                self.set_timeout(orig_timeout)?;
            }

            result
        }
    }
}

macro_rules! nonblocking_get_with_origin {
    ($fname: ident, $fname_str: expr, $func: ident, $str: expr, $type: ident) => {
        fn $fname(&self, origin: Origin, timeout: Timeout) -> result!(NonBlockingResult<$type>) {
            assert_origin!($fname_str, self.size()?, origin);

            // remember the original timeout
            let orig_timeout = self.get_timeout()?;

            // set the timeout to what has been specified.
            self.set_timeout(timeout)?;

            // call $func, if it returned Err and the error is a timeout error
            // then return Ok(None) otherwise return the error.
            // if $func returned Ok then return Ok(Some(result))
            let result = match self.$func(origin) {
                Err(source) => {
                    if source == crate::ncurseswwinerror::timeout_error(&$str) {
                        Ok(None)
                    } else {
                        Err(source)
                    }
                },
                Ok(result) => Ok(Some(result))
            };

            // if we didn't error above then set the timeout back to what it
            // originally was.
            if result.is_ok() {
                self.set_timeout(orig_timeout)?;
            }

            result
        }
    }
}