runmat-runtime 0.6.0

use runmat_builtins::{
    BuiltinCompletionPolicy, BuiltinDescriptor, BuiltinErrorDescriptor, BuiltinOutputMode,
    BuiltinParamArity, BuiltinParamDescriptor, BuiltinParamType, BuiltinSignatureDescriptor, Value,
};
use runmat_macros::runtime_builtin;

use super::axis_tick_angle::axis_tick_angle_builtin;
use super::axis_ticks::TickAxis;
use crate::builtins::plotting::type_resolvers::get_type;

const OUTPUT_ANGLE: [BuiltinParamDescriptor; 1] = [BuiltinParamDescriptor {
    name: "angle",
    ty: BuiltinParamType::NumericScalar,
    arity: BuiltinParamArity::Required,
    default: None,
    description: "Current X-axis tick label rotation in degrees.",
}];
const NO_OUTPUTS: [BuiltinParamDescriptor; 0] = [];

const INPUTS_NONE: [BuiltinParamDescriptor; 0] = [];

const INPUTS_ANGLE: [BuiltinParamDescriptor; 1] = [BuiltinParamDescriptor {
    name: "angle",
    ty: BuiltinParamType::NumericScalar,
    arity: BuiltinParamArity::Required,
    default: None,
    description: "X-axis tick label rotation in degrees.",
}];

const INPUTS_AX: [BuiltinParamDescriptor; 1] = [BuiltinParamDescriptor {
    name: "ax",
    ty: BuiltinParamType::AxesHandle,
    arity: BuiltinParamArity::Required,
    default: None,
    description: "Scalar target axes handle.",
}];

const INPUTS_AX_ANGLE: [BuiltinParamDescriptor; 2] = [
    BuiltinParamDescriptor {
        name: "ax",
        ty: BuiltinParamType::AxesHandle,
        arity: BuiltinParamArity::Required,
        default: None,
        description: "Target axes handle or array of axes handles.",
    },
    BuiltinParamDescriptor {
        name: "angle",
        ty: BuiltinParamType::NumericScalar,
        arity: BuiltinParamArity::Required,
        default: None,
        description: "X-axis tick label rotation in degrees.",
    },
];

const SIGNATURES: [BuiltinSignatureDescriptor; 4] = [
    BuiltinSignatureDescriptor {
        label: "angle = xtickangle()",
        inputs: &INPUTS_NONE,
        outputs: &OUTPUT_ANGLE,
    },
    BuiltinSignatureDescriptor {
        label: "xtickangle(angle)",
        inputs: &INPUTS_ANGLE,
        outputs: &NO_OUTPUTS,
    },
    BuiltinSignatureDescriptor {
        label: "angle = xtickangle(ax)",
        inputs: &INPUTS_AX,
        outputs: &OUTPUT_ANGLE,
    },
    BuiltinSignatureDescriptor {
        label: "xtickangle(ax, angle)",
        inputs: &INPUTS_AX_ANGLE,
        outputs: &NO_OUTPUTS,
    },
];

const ERROR_INVALID_ARGUMENT: BuiltinErrorDescriptor = BuiltinErrorDescriptor {
    code: "RM.XTICKANGLE.INVALID_ARGUMENT",
    identifier: Some("RunMat:xtickangle:InvalidArgument"),
    when: "Argument count, angle value, or axes handle is invalid.",
    message: "xtickangle: invalid argument",
};

const ERROR_INTERNAL: BuiltinErrorDescriptor = BuiltinErrorDescriptor {
    code: "RM.XTICKANGLE.INTERNAL",
    identifier: Some("RunMat:xtickangle:Internal"),
    when: "Internal plotting state update fails.",
    message: "xtickangle: internal operation failed",
};

const ERRORS: [BuiltinErrorDescriptor; 2] = [ERROR_INVALID_ARGUMENT, ERROR_INTERNAL];

pub const XTICKANGLE_DESCRIPTOR: BuiltinDescriptor = BuiltinDescriptor {
    signatures: &SIGNATURES,
    output_mode: BuiltinOutputMode::Fixed,
    completion_policy: BuiltinCompletionPolicy::Public,
    errors: &ERRORS,
};

#[runtime_builtin(
    name = "xtickangle",
    category = "plotting",
    summary = "Query or set X-axis tick label rotation.",
    keywords = "xtickangle,plotting,axes,tick angle",
    suppress_auto_output = true,
    type_resolver(get_type),
    descriptor(crate::builtins::plotting::xtickangle::XTICKANGLE_DESCRIPTOR),
    builtin_path = "crate::builtins::plotting::xtickangle"
)]
pub fn xtickangle_builtin(args: Vec<Value>) -> crate::BuiltinResult<Value> {
    axis_tick_angle_builtin("xtickangle", TickAxis::X, args)
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::builtins::plotting::axis_tick_labels::tensor;
    use crate::builtins::plotting::get::get_builtin;
    use crate::builtins::plotting::set::set_builtin;
    use crate::builtins::plotting::tests::{ensure_plot_test_env, lock_plot_registry};
    use crate::builtins::plotting::{clear_figure, reset_hold_state_for_run};

    #[test]
    fn xtickangle_sets_queries_and_round_trips_properties() {
        let _guard = lock_plot_registry();
        ensure_plot_test_env();
        reset_hold_state_for_run();
        let _ = clear_figure(None);

        assert_eq!(xtickangle_builtin(Vec::new()).unwrap(), Value::Num(0.0));
        assert_eq!(
            xtickangle_builtin(vec![Value::Num(45.0)]).unwrap(),
            Value::Num(45.0)
        );
        assert_eq!(xtickangle_builtin(Vec::new()).unwrap(), Value::Num(45.0));

        let ax = crate::builtins::plotting::gca::gca_builtin(Vec::new()).unwrap();
        assert_eq!(
            get_builtin(vec![ax.clone(), Value::String("XTickLabelRotation".into())]).unwrap(),
            Value::Num(45.0)
        );
        let x_axis = get_builtin(vec![ax, Value::String("XAxis".into())]).unwrap();
        assert!(xtickangle_builtin(vec![x_axis.clone()]).is_err());
        assert_eq!(
            get_builtin(vec![
                x_axis.clone(),
                Value::String("TickLabelRotation".into())
            ])
            .unwrap(),
            Value::Num(45.0)
        );

        set_builtin(vec![
            x_axis,
            Value::String("TickLabelRotation".into()),
            Value::Num(-30.0),
        ])
        .unwrap();
        assert_eq!(xtickangle_builtin(Vec::new()).unwrap(), Value::Num(-30.0));
    }

    #[test]
    fn xtickangle_axes_target_and_array_setters_are_isolated() {
        let _guard = lock_plot_registry();
        ensure_plot_test_env();
        reset_hold_state_for_run();
        let _ = clear_figure(None);

        let ax1 = crate::builtins::plotting::subplot::subplot_builtin(
            Value::Num(1.0),
            Value::Num(2.0),
            Value::Num(1.0),
        )
        .unwrap();
        let ax2 = crate::builtins::plotting::subplot::subplot_builtin(
            Value::Num(1.0),
            Value::Num(2.0),
            Value::Num(2.0),
        )
        .unwrap();

        xtickangle_builtin(vec![Value::Num(ax1), Value::Num(15.0)]).unwrap();
        assert_eq!(
            xtickangle_builtin(vec![Value::Num(ax1)]).unwrap(),
            Value::Num(15.0)
        );
        assert_eq!(
            xtickangle_builtin(vec![Value::Num(ax2)]).unwrap(),
            Value::Num(0.0)
        );
        assert_eq!(
            crate::builtins::plotting::gca::gca_builtin(Vec::new()).unwrap(),
            Value::Num(ax2)
        );

        xtickangle_builtin(vec![tensor(vec![ax1, ax2]), Value::Num(60.0)]).unwrap();
        assert_eq!(
            xtickangle_builtin(vec![Value::Num(ax1)]).unwrap(),
            Value::Num(60.0)
        );
        assert_eq!(
            xtickangle_builtin(vec![Value::Num(ax2)]).unwrap(),
            Value::Num(60.0)
        );
        assert!(xtickangle_builtin(vec![tensor(vec![ax1, ax2])]).is_err());
        assert!(xtickangle_builtin(vec![tensor(vec![10.0, 20.0])]).is_err());
        assert!(xtickangle_builtin(vec![Value::Num(f64::NAN)]).is_err());
        assert!(set_builtin(vec![
            Value::Num(ax1),
            Value::String("XTickLabelRotation".into()),
            tensor(vec![10.0, 20.0]),
        ])
        .is_err());
    }
}