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

//! The `indicator(...)` declaration.
//!
//! A global function (not a namespace) that declares the script's identity and
//! display settings. It records the declaration into the output via
//! [`MetadataOutput`]; a script may have at most one (enforced by sema).

use pine_builtin_macro::BuiltinFunction;
use pine_core::PineVersion;
use pine_core::{Indicator, MetadataOutput, PineOutput};
use pine_interpreter::{Interpreter, RuntimeError, Value};

/// indicator(title, shorttitle, overlay, format, precision, ...)
#[derive(BuiltinFunction)]
#[builtin(name = "indicator", output = MetadataOutput)]
struct IndicatorFn {
    title: String,
    #[arg(default = "")]
    shorttitle: String,
    #[arg(default = false)]
    overlay: bool,
    #[arg(default = "")]
    format: String,
    #[arg(default = None)]
    precision: Option<f64>,
    #[arg(default = "")]
    timeframe: String,
    // Accepted and ignored: chart-capacity and display hints.
    #[arg(default = None)]
    max_bars_back: Option<f64>,
    #[arg(default = None)]
    max_lines_count: Option<f64>,
    #[arg(default = None)]
    max_labels_count: Option<f64>,
    #[arg(default = None)]
    max_boxes_count: Option<f64>,
    #[arg(default = "")]
    scale: String,
}

impl IndicatorFn {
    fn execute<O: PineOutput + MetadataOutput>(
        &self,
        ctx: &mut Interpreter<O>,
    ) -> Result<Value<O>, RuntimeError> {
        let _ = (
            self.max_bars_back,
            self.max_lines_count,
            self.max_labels_count,
            self.max_boxes_count,
            &self.scale,
        );
        ctx.output.set_indicator(Indicator {
            title: self.title.clone(),
            shorttitle: self.shorttitle.clone(),
            overlay: self.overlay,
            format: self.format.clone(),
            precision: self.precision.map(|p| p as i64),
            timeframe: self.timeframe.clone(),
        });
        Ok(Value::Na)
    }
}

pub fn register<O: PineOutput + MetadataOutput>(version: PineVersion) -> Vec<(String, Value<O>)> {
    let name = if version < PineVersion::V5 {
        "study"
    } else {
        "indicator"
    };
    vec![(name.to_string(), IndicatorFn::builtin_value::<O>())]
}