pine-builtins 0.2.2

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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

//! Chart-wide global functions that write to the output's [`GlobalContext`]:
//! `bgcolor` (background color) and `barcolor` (price-bar color).
//!
//! Both take a color (often conditional, so `na` when it should not paint) plus
//! display arguments that are accepted and ignored in a headless run.

use pine_builtin_macro::BuiltinFunction;
use pine_core::{Color, GlobalOutput, PineOutput};
use pine_interpreter::{Interpreter, RuntimeError, Value};
use std::collections::HashMap;

/// bgcolor(color, offset, editable, show_last, title, transp, ...)
#[derive(BuiltinFunction)]
#[builtin(name = "bgcolor", output = GlobalOutput)]
struct Bgcolor {
    #[arg(default = None)]
    color: Option<Color>,
    #[arg(default = "")]
    title: String,
    #[arg(default = None)]
    transp: Option<f64>,
    #[arg(default = None)]
    offset: Option<f64>,
    #[arg(default = false)]
    editable: bool,
    #[arg(default = "")]
    display: String,
}

impl Bgcolor {
    fn execute<O: PineOutput + GlobalOutput>(
        &self,
        ctx: &mut Interpreter<O>,
    ) -> Result<Value<O>, RuntimeError> {
        let _ = (
            &self.title,
            self.transp,
            self.offset,
            self.editable,
            &self.display,
        );
        ctx.output.set_bgcolor(self.color.clone());
        Ok(Value::Na)
    }
}

/// barcolor(color, offset, editable, show_last, title, ...)
#[derive(BuiltinFunction)]
#[builtin(name = "barcolor", output = GlobalOutput)]
struct Barcolor {
    #[arg(default = None)]
    color: Option<Color>,
    #[arg(default = "")]
    title: String,
    #[arg(default = None)]
    offset: Option<f64>,
    #[arg(default = false)]
    editable: bool,
    #[arg(default = "")]
    display: String,
}

impl Barcolor {
    fn execute<O: PineOutput + GlobalOutput>(
        &self,
        ctx: &mut Interpreter<O>,
    ) -> Result<Value<O>, RuntimeError> {
        let _ = (&self.title, self.offset, self.editable, &self.display);
        ctx.output.set_barcolor(self.color.clone());
        Ok(Value::Na)
    }
}

/// The `bgcolor` and `barcolor` global functions.
/// max_bars_back(var, num) - Sizes a variable's historical buffer. A no-op here
/// (the interpreter keeps full history), so it just returns `na`.
#[derive(BuiltinFunction)]
#[builtin(name = "max_bars_back")]
struct MaxBarsBack<O: PineOutput> {
    var: Value<O>,
    num: f64,
}

impl<O: PineOutput> MaxBarsBack<O> {
    fn execute(&self, _ctx: &mut Interpreter<O>) -> Result<Value<O>, RuntimeError> {
        let _ = (&self.var, self.num);
        Ok(Value::Na)
    }
}

pub fn register<O: PineOutput + GlobalOutput>() -> HashMap<String, Value<O>> {
    let mut globals: HashMap<String, Value<O>> = HashMap::new();
    globals.insert("bgcolor".to_string(), Bgcolor::builtin_value::<O>());
    globals.insert("barcolor".to_string(), Barcolor::builtin_value::<O>());
    globals.insert(
        "max_bars_back".to_string(),
        MaxBarsBack::<O>::builtin_value(),
    );
    // Real-time bid/ask quotes; `na` without a live quote feed.
    globals.insert("bid".to_string(), Value::Na);
    globals.insert("ask".to_string(), Value::Na);
    globals
}