pine-builtins 0.2.0

Built-in functions and namespaces for the Pine Script interpreter.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

//! The `alertcondition(condition, title, message)` declaration.
//!
//! A global function that declares a named alert. The condition is a per-bar
//! boolean series; in a headless run there is no alerting engine, so the
//! declaration (title + message) is simply recorded via [`AlertConditionOutput`].

use pine_builtin_macro::BuiltinFunction;
use pine_core::{AlertCondition, AlertConditionOutput, PineOutput};
use pine_interpreter::{Interpreter, RuntimeError, Value};

/// alertcondition(condition, title, message)
#[derive(BuiltinFunction)]
#[builtin(name = "alertcondition")]
struct Alertcondition<O: PineOutput + AlertConditionOutput> {
    condition: Value<O>,
    #[arg(default = "")]
    title: String,
    #[arg(default = "")]
    message: String,
}

impl<O: PineOutput + AlertConditionOutput> Alertcondition<O> {
    fn execute(&self, ctx: &mut Interpreter<O>) -> Result<Value<O>, RuntimeError> {
        // Record (fire) the alert only on bars where the condition is true.
        if self.condition.truthy_for_condition()? {
            ctx.output.add_alertcondition(AlertCondition {
                title: self.title.clone(),
                message: self.message.clone(),
            });
        }
        Ok(Value::Na)
    }
}

/// The `alertcondition` global function value.
pub fn register<O: PineOutput + AlertConditionOutput>() -> Value<O> {
    Alertcondition::<O>::builtin_value()
}