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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
//!
//! poloto - plot to SVG and style with CSS
//!
//!
//! ### How do I change the color of the plots?
//!
//! You can doing it by overriding the css. If you embed the generated svg into a html file,
//! then you can add this example:
//! ```css
//! .poloto{
//!    --poloto_bg_color:"black";
//!    --poloto_fg_color:"white;
//!    --poloto_color0:"red";
//!    --poloto_color1:"green";
//!    --poloto_color2:"yellow";
//!    --poloto_color3:"orange";
//!    --poloto_color4:"purple";
//!    --poloto_color5:"pink";
//!    --poloto_color6:"aqua";
//!    --poloto_color7:"red";
//! }
//! ```  
//! By default these variables are not defined, so the svg falls back on some default colors.
//!
//! ### Can I change the styling of the plots?
//!
//! Yes! You can harness the power of CSS both in the svg, or outside
//! in html with an embeded svg. Some things you can do:
//!
//! * Change the color scheme to fit your html theme.
//! * Highlight one plot, make it dashed, or add hover effect
//! * Animate things using @keyframes
//!
//! Depending on whether you are adding a new style attribute or overriding
//! an existing one, you might have to increase the specificty of your css clause to make sure it overrides
//! the svg css clause.
//! ### Usage
//!
//! * Plots containing NaN or Infinity are ignored.
//! * After 6 plots, the colors cycle back and are repeated.
//!
//!
//! ### Units
//!
//! Poloto will first print intervals is normal decimal at the precision required to capture the differences
//! in the step size between the intervals. If the magnitude of a number is detected to be too big or small, it
//! may switch to scientific notation, still at the required precision. It will only switch if the scientific
//! notation version is actually less characters than the normal decimal format which is not always the case
//! when you consider the precision that might be required to capture the step size.
//!
//! Even with the above system, there are cases where the numbers all have a really big magnitude, but
//! are all really close together (small step size). In this case, there isnt a really good way to format it.
//! In this instance, poloto will fall back to making the number relative to the first number.
//!
//!
//! ### Why not scale the intervals to end nicely with the ends of the axis lines?
//!
//! Doing this you would have to either have more dead space, or exclude
//! plots that the user would expect to get plotted. Neither of these sounded
//! better than the option of just having the intervals stop not necessarily
//! at the end of the axis lines.
//!
//! ### Example
//!
//! See the graphs in this report: [broccoli_book](https://tiby312.github.io/broccoli_report/)
//!
use core::fmt::Write;
use core::marker::PhantomData;

pub use tagger;
mod util;
pub mod prelude {
    pub use super::iter::PlotIterator;
    pub use core::fmt::Write;
    pub use tagger::wr;
}
use core::fmt;
mod render;

use iter::DoubleIter;
pub mod iter;

pub mod default_tags {
    use core::fmt;

    pub use super::render::default_styling;

    ///The class of the svg tag.
    pub const CLASS: &str = "poloto";
    ///The width of the svg tag.
    pub const WIDTH: f64 = 800.0;
    ///The height of the svg tag.
    pub const HEIGHT: f64 = 500.0;

    pub const XMLNS: &str = "http://www.w3.org/2000/svg";
    ///Returns a function that will write the attributes.
    pub fn default_svg_attrs<T: fmt::Write>(
    ) -> impl FnOnce(&mut tagger::AttributeWriter<T>) -> Result<(), fmt::Error> {
        use tagger::prelude::*;

        |w| {
            w.attr("class", CLASS)?
                .attr("width", WIDTH)?
                .attr("height", HEIGHT)?
                .with_attr("viewBox", wr!("0 0 {} {}", WIDTH, HEIGHT))?
                .attr("xmlns", XMLNS)?;
            Ok(())
        }
    }
    use core::fmt::Write;
    pub fn default_svg_and_styling<T: Write>(
        writer: T,
        func: impl FnOnce(&mut tagger::Element<T>) -> Result<&mut tagger::Element<T>, fmt::Error>,
    ) -> Result<T, fmt::Error> {
        let mut root = tagger::Element::new(writer);

        root.elem("svg", |writer| {
            let mut svg = writer.write(|w| {
                default_svg_attrs()(w)?;

                Ok(w)
            })?;
            default_styling(&mut svg)?;
            func(svg)
        })?;

        Ok(root.into_writer())
    }
}

trait PlotTrait2<T: fmt::Write> {
    fn write_name(&mut self, a: &mut T) -> fmt::Result;
    fn iter_first(&mut self) -> &mut dyn Iterator<Item = [f64; 2]>;
    fn iter_second(&mut self) -> &mut dyn Iterator<Item = [f64; 2]>;
}
struct Wrapper2<D: DoubleIter, F, T> {
    //TODO use enum instead.
    a: Option<D>,
    b: Option<D::Next>,
    func: Option<F>,
    _p: PhantomData<T>,
}

impl<I: DoubleIter<Item = [f64; 2]>, F: FnOnce(&mut T) -> fmt::Result, T> Wrapper2<I, F, T> {
    fn new(it: I, func: F) -> Self {
        Wrapper2 {
            a: Some(it),
            b: None,
            func: Some(func),
            _p: PhantomData,
        }
    }
}

impl<D: DoubleIter<Item = [f64; 2]>, F: FnOnce(&mut T) -> fmt::Result, T: fmt::Write> PlotTrait2<T>
    for Wrapper2<D, F, T>
{
    fn write_name(&mut self, a: &mut T) -> fmt::Result {
        self.func.take().unwrap()(a)
    }
    fn iter_first(&mut self) -> &mut dyn Iterator<Item = [f64; 2]> {
        self.a.as_mut().unwrap()
    }

    fn iter_second(&mut self) -> &mut dyn Iterator<Item = [f64; 2]> {
        self.b = Some(self.a.take().unwrap().finish_first());
        self.b.as_mut().unwrap()
    }
}

enum PlotType {
    Scatter,
    Line,
    Histo,
    LineFill,
}

struct Plot<'a, T> {
    plot_type: PlotType,
    plots: Box<dyn PlotTrait2<T> + 'a>,
}

///Keeps track of plots.
///User supplies iterators that will be iterated on when
///render is called.

//Its important to note that most of the time when this library is used,
//every run through the code is first accompanied by one compilation of the code.
//So inefficiencies in dynamically allocating strings using format!() to then
//be just passed to a writer are not that bad seeing as the solution
//would involve passing a lot of closures around.
pub struct Plotter<'a, T> {
    writer: T,
    plots: PlotData<'a, T>,
}

struct PlotData<'a, T>(Vec<Plot<'a, T>>);

///Convenience function for [`Plotter::new()`]
pub fn plot<'a, T: fmt::Write + 'a>(writer: T) -> Plotter<'a, T> {
    Plotter::new(writer)
}

///Convenience function for
///
/// Instead of this
/// ```
/// let plotter = poloto::plot(tagger::upgrade(std::io::stdout()));
/// ```
/// You can call this function like this
/// ```
/// let plotter = poloto::plot_io(std::io::stdout());
/// ```
pub fn plot_io<'a, T: std::io::Write + 'a>(writer: T) -> Plotter<'a, tagger::WriterAdaptor<T>> {
    Plotter::new(tagger::upgrade(writer))
}

impl<'a, T: fmt::Write + 'a> Plotter<'a, T> {
    /// Create a plotter
    ///
    /// # Example
    ///
    /// ```
    /// let mut s=String::new();
    /// let plotter = poloto::Plotter::new(&mut s);
    /// ```
    pub fn new(writer: T) -> Plotter<'a, T> {
        Plotter {
            writer,
            plots: PlotData(Vec::new()),
        }
    }

    /// Create a line from plots.
    ///
    /// # Example
    ///
    /// ```
    /// let data=[
    ///         [1.0f64,4.0],
    ///         [2.0,5.0],
    ///         [3.0,6.0]
    /// ];
    /// use poloto::prelude::*;
    /// let mut s=String::new();
    /// let mut plotter = poloto::Plotter::new(&mut s);
    /// plotter.line(|w|write!(w,"cow"),data.iter().map(|&x|x).twice_iter())
    /// ```
    pub fn line(
        &mut self,
        name: impl FnOnce(&mut T) -> fmt::Result + 'a,
        plots: impl DoubleIter<Item = [f64; 2]> + 'a,
    ) {
        self.plots.0.push(Plot {
            plot_type: PlotType::Line,
            plots: Box::new(Wrapper2::new(plots.into_iter(), name)),
        })
    }

    /// Create a line from plots that will be filled underneath.
    ///
    /// # Example
    ///
    /// ```
    /// let data=[
    ///         [1.0f64,4.0],
    ///         [2.0,5.0],
    ///         [3.0,6.0]
    /// ];
    /// use poloto::prelude::*;
    /// let mut s=String::new();
    /// let mut plotter = poloto::Plotter::new(&mut s);
    /// plotter.line_fill(|w|write!(w,"cow"),data.iter().map(|&x|x).twice_iter())
    /// ```
    pub fn line_fill(
        &mut self,
        name: impl FnOnce(&mut T) -> fmt::Result + 'a,
        plots: impl DoubleIter<Item = [f64; 2]> + 'a,
    ) {
        self.plots.0.push(Plot {
            plot_type: PlotType::LineFill,
            plots: Box::new(Wrapper2::new(plots.into_iter(), name)),
        })
    }

    /// Create a scatter plot from plots.
    ///
    /// # Example
    ///
    /// ```
    /// let data=[
    ///         [1.0f64,4.0],
    ///         [2.0,5.0],
    ///         [3.0,6.0]
    /// ];
    /// use poloto::prelude::*;
    /// let mut s=String::new();
    /// let mut plotter = poloto::Plotter::new(&mut s);
    /// plotter.scatter(|w|write!(w,"cow"),data.iter().map(|&x|x).twice_iter())
    /// ```
    pub fn scatter(
        &mut self,
        name: impl FnOnce(&mut T) -> fmt::Result + 'a,
        plots: impl DoubleIter<Item = [f64; 2]> + 'a,
    ) {
        self.plots.0.push(Plot {
            plot_type: PlotType::Scatter,
            plots: Box::new(Wrapper2::new(plots.into_iter(), name)),
        })
    }

    /// Create a histogram from plots.
    /// Each bar's left side will line up with a point
    ///
    /// # Example
    ///
    /// ```
    /// let data=[
    ///         [1.0f64,4.0],
    ///         [2.0,5.0],
    ///         [3.0,6.0]
    /// ];
    /// use poloto::prelude::*;
    /// let mut s=String::new();
    /// let mut plotter = poloto::Plotter::new(&mut s);
    /// plotter.histogram(|w|write!(w,"cow"),data.iter().map(|&x|x).twice_iter())
    /// ```
    pub fn histogram(
        &mut self,
        name: impl FnOnce(&mut T) -> fmt::Result + 'a,
        plots: impl DoubleIter<Item = [f64; 2]> + 'a,
    ) {
        self.plots.0.push(Plot {
            plot_type: PlotType::Histo,
            plots: Box::new(Wrapper2::new(plots.into_iter(), name)),
        })
    }

    ///You can override the css in regular html if you embed the generated svg.
    ///This gives you a lot of flexibility giving your the power to dynamically
    ///change the theme of your svg.
    ///
    ///However, if you want to embed the svg as an image, you lose this ability.
    ///If embedding as IMG is desired, instead the user can insert a custom style into the generated svg itself.
    ///
    ///All the plot functions don't actually add anything to the document until a  `render` function is called.
    ///So calls to this will append elements to the start of the document.
    ///
    pub fn render_no_default_tags(
        self,
        title: impl FnOnce(&mut T) -> fmt::Result,
        xname: impl FnOnce(&mut T) -> fmt::Result,
        yname: impl FnOnce(&mut T) -> fmt::Result,
    ) -> Result<T, fmt::Error> {
        let Plotter { mut writer, plots } = self;

        render::render(&mut writer, plots, title, xname, yname)?;
        Ok(writer)
    }

    pub fn render(
        self,
        title: impl FnOnce(&mut T) -> fmt::Result,
        xname: impl FnOnce(&mut T) -> fmt::Result,
        yname: impl FnOnce(&mut T) -> fmt::Result,
    ) -> Result<T, fmt::Error> {
        let Plotter { writer, plots } = self;

        default_tags::default_svg_and_styling(writer, |e| {
            render::render(e.get_writer(), plots, title, xname, yname)?;
            Ok(e)
        })
    }
}