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

//! The `polyline.*` namespace: a multi-point line built from an array of
//! `chart.point`s. Id-based over the shared [`DrawingOutput`] sink.

use pine_builtin_macro::BuiltinFunction;
use pine_core::{Color, DrawingOutput, PineOutput, PolylineObject};
use pine_interpreter::{Interpreter, RuntimeError, Value};
use std::cell::RefCell;
use std::collections::HashMap;
use std::rc::Rc;

/// polyline.new(points, curved, closed, xloc, line_color, fill_color,
/// line_style, line_width) - A polyline through an array of `chart.point`s.
#[derive(BuiltinFunction)]
#[builtin(name = "polyline.new")]
struct PolylineNew<O: PineOutput + DrawingOutput> {
    points: Value<O>,
    #[arg(default = false)]
    curved: bool,
    #[arg(default = false)]
    closed: bool,
    #[arg(default = "bar_index")]
    xloc: String,
    #[arg(default = None)]
    line_color: Option<Color>,
    #[arg(default = None)]
    fill_color: Option<Color>,
    #[arg(default = "solid")]
    line_style: String,
    #[arg(default = 1.0)]
    line_width: f64,
}

impl<O: PineOutput + DrawingOutput> PolylineNew<O> {
    fn execute(&self, ctx: &mut Interpreter<O>) -> Result<Value<O>, RuntimeError> {
        let Value::Array(points) = &self.points else {
            return Err(RuntimeError::TypeError(
                "polyline.new: expected an array of points".into(),
            ));
        };
        let points: Vec<(f64, f64)> = points
            .borrow()
            .iter()
            .map(crate::chart::point_coords)
            .collect::<Result<_, _>>()?;
        let id = ctx.output.add_polyline(PolylineObject {
            points,
            curved: self.curved,
            closed: self.closed,
            xloc: self.xloc.clone(),
            line_color: self.line_color.clone(),
            fill_color: self.fill_color.clone(),
            line_style: self.line_style.clone(),
            line_width: self.line_width,
        });
        Ok(Value::Number(id as f64))
    }
}

/// polyline.delete(id) - Remove the polyline.
#[derive(BuiltinFunction)]
#[builtin(name = "polyline.delete", output = DrawingOutput)]
struct PolylineDelete {
    id: f64,
}

impl PolylineDelete {
    fn execute<O: PineOutput + DrawingOutput>(
        &self,
        ctx: &mut Interpreter<O>,
    ) -> Result<Value<O>, RuntimeError> {
        ctx.output.delete_polyline(self.id as usize);
        Ok(Value::Na)
    }
}

/// Register the `polyline.*` namespace object.
pub fn register<O: PineOutput + DrawingOutput>() -> Value<O> {
    let mut members: HashMap<String, Value<O>> = HashMap::new();
    members.insert("new".to_string(), PolylineNew::<O>::builtin_value());
    members.insert("delete".to_string(), PolylineDelete::builtin_value::<O>());
    members.insert(
        "all".to_string(),
        Value::Array(Rc::new(RefCell::new(Vec::new()))),
    );
    Value::Object {
        type_name: "polyline".to_string(),
        fields: Rc::new(RefCell::new(members)),
        call: None,
        value: None,
    }
}