texcore 0.7.2

Create LaTeX documents using native Rust types.
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
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
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
use crate::feature;
use crate::Level::*;
use crate::TextType::*;
use crate::Type::*;
use crate::*;
use serde::{Deserialize, Serialize};
use std::collections::linked_list::{Iter, IterMut};
use std::collections::LinkedList;
use std::fs::write;
use std::io::Error;
use std::path::PathBuf;
use texcore_traits::*;
feature! {
    "compile"
    use tectonic::latex_to_pdf;
}
feature! {
    "parallel"
    use rayon::prelude::*;
    use rayon::*;
}
/// Converts a struct to a string
pub trait Tex {
    // turns the element into a latex string
    fn to_latex_string(&self) -> String;
}

impl Tex for Any {
    fn to_latex_string(&self) -> String {
        self.latex.to_string()
    }
}

impl Tex for Environment {
    fn to_latex_string(&self) -> String {
        let begin = format!(r"\begin{{{}}}", &self.name);
        let end = format!(r"\end{{{}}}", &self.name);
        let strings = vec![begin, self.inner_latex_string(), end];
        strings.join("\n")
    }
}

impl Tex for Custom {
    fn to_latex_string(&self) -> String {
        self.latex.to_string()
    }
}

impl Tex for Comment {
    fn to_latex_string(&self) -> String {
        format!("% {}", &self.value)
    }
}

impl Tex for Input {
    fn to_latex_string(&self) -> String {
        let path = self.file_name.to_str();
        match path {
            Some(p) => format!(r"\input{{{p}}}"),
            None => String::new(),
        }
    }
}

impl Tex for Package {
    fn to_latex_string(&self) -> String {
        format!(r"\usepackage{{{}}}", &self.pkg)
    }
}

impl Tex for Part {
    fn to_latex_string(&self) -> String {
        format!(r"\part{{{}}}", &self.name)
    }
}

impl Tex for Chapter {
    fn to_latex_string(&self) -> String {
        format!(r"\chapter{{{}}}", &self.name)
    }
}

impl Tex for Header {
    fn to_latex_string(&self) -> String {
        match self.header_level {
            1 => format!(r"\section{{{}}}", &self.name),
            _ => {
                let mut result = r"\".to_string();
                let mut count = 0;
                while count < self.header_level {
                    result.push_str("sub");
                    count += 1;
                }
                result.push_str(&format!("section{{{}}}", &self.name));
                result
            }
        }
    }
}

impl Tex for Paragraph {
    fn to_latex_string(&self) -> String {
        format!(r"\paragraph{{{}}}", &self.content)
    }
}

impl Tex for Text {
    fn to_latex_string(&self) -> String {
        match &self.type_ {
            Bold => format!(r"\textbf{{{}}}", &self.content),
            Italics => format!(r"\textit{{{}}}", &self.content),
            Normal => self.content.to_string(),
            Math => format!("${}$", &self.content),
            Par => format!(r"\par {{{}}}", &self.content),
        }
    }
}

impl Tex for Item {
    fn to_latex_string(&self) -> String {
        format!(r"\item {{{}}}", &self.name)
    }
}

impl Tex for List {
    fn to_latex_string(&self) -> String {
        let list = match &self.type_ {
            ListType::Itemized => "itemize",
            ListType::Enumerated => "enumerate",
        };
        let begin = format!(r"\begin{{{list}}}");
        let end = format!(r"\end{{{list}}}");

        let mut result = Vec::new();
        result.push(begin);
        for i in &self.items {
            result.push(i.to_latex_string())
        }
        result.push(end);
        result.join("\n")
    }
}

impl Tex for Metadata {
    fn to_latex_string(&self) -> String {
        let doc_class = format!(
            r"\documentclass[{}pt, {}]{{{}}}",
            &self.fontsize, &self.papersize, &self.doc_class
        );
        let title = format!(r"\title{{{}}}", &self.title);
        let author = format!(r"\author{{{}}}", &self.author);
        let date = format!(r"\date{{{}}}", &self.date);
        let result = vec![doc_class, title, author, date];
        result.join("\n")
    }
}

impl From<Part> for Element<Any> {
    fn from(value: Part) -> Self {
        let latex = if value.modified {
            value.latex
        } else {
            value.to_latex_string()
        };
        let any = Any {
            value: value.name,
            type_: T_Part,
            level: Document,
            header_level: None,
            text_type: None,
            list_type: None,
            items: None,
            elements: None,
            latex,
            modified: value.modified,
        };
        Element::new_any(any)
    }
}

impl From<Chapter> for Element<Any> {
    fn from(value: Chapter) -> Self {
        let latex = if value.modified {
            value.latex
        } else {
            value.to_latex_string()
        };
        let any = Any {
            value: value.name,
            type_: T_Chapter,
            level: Document,
            header_level: None,
            text_type: None,
            list_type: None,
            items: None,
            elements: None,
            latex,
            modified: value.modified,
        };
        Element::new_any(any)
    }
}

impl From<Header> for Element<Any> {
    fn from(value: Header) -> Self {
        let latex = if value.modified {
            value.latex
        } else {
            value.to_latex_string()
        };
        let any = Any {
            value: value.name,
            type_: T_Header,
            level: Document,
            header_level: Some(value.header_level),
            text_type: None,
            list_type: None,
            items: None,
            elements: None,
            latex,
            modified: value.modified,
        };
        Element::new_any(any)
    }
}

impl From<Paragraph> for Element<Any> {
    fn from(value: Paragraph) -> Self {
        let latex = if value.modified {
            value.latex
        } else {
            value.to_latex_string()
        };
        let any = Any {
            value: value.content,
            type_: T_Paragraph,
            level: Document,
            header_level: None,
            text_type: None,
            list_type: None,
            items: None,
            elements: None,
            latex,
            modified: value.modified,
        };
        Element::new_any(any)
    }
}

impl From<Text> for Element<Any> {
    fn from(value: Text) -> Self {
        let latex = if value.modified {
            value.latex
        } else {
            value.to_latex_string()
        };
        let any = Any {
            value: value.content,
            type_: T_Text,
            level: Document,
            header_level: None,
            text_type: Some(value.type_),
            list_type: None,
            items: None,
            elements: None,
            latex,
            modified: value.modified,
        };
        Element::new_any(any)
    }
}

impl From<Package> for Element<Any> {
    fn from(value: Package) -> Self {
        let latex = if value.modified {
            value.latex
        } else {
            value.to_latex_string()
        };
        let any = Any {
            value: value.pkg,
            type_: T_Package,
            level: Packages,
            header_level: None,
            text_type: None,
            list_type: None,
            items: None,
            elements: None,
            latex,
            modified: value.modified,
        };
        Element::new_any(any)
    }
}

impl From<Input> for Element<Any> {
    fn from(value: Input) -> Self {
        let latex = if value.modified {
            value.latex.to_string()
        } else {
            value.to_latex_string()
        };
        let any = Any {
            value: value.file_name_str(),
            type_: T_Input,
            level: value.level,
            header_level: None,
            text_type: None,
            list_type: None,
            items: None,
            elements: None,
            latex,
            modified: value.modified,
        };
        Element::new_any(any)
    }
}

impl From<Environment> for Element<Any> {
    fn from(value: Environment) -> Self {
        let latex = if value.modified {
            value.latex
        } else {
            value.to_latex_string()
        };
        let any = Any {
            value: value.name,
            type_: T_Environment,
            level: Document,
            header_level: None,
            text_type: None,
            list_type: None,
            items: None,
            elements: Some(value.elements),
            latex,
            modified: value.modified,
        };
        Element::new_any(any)
    }
}

impl From<Custom> for Element<Any> {
    fn from(value: Custom) -> Self {
        let any = Any {
            value: value.latex.to_string(),
            type_: T_Custom,
            level: value.level,
            header_level: None,
            text_type: None,
            list_type: None,
            items: None,
            elements: None,
            latex: value.latex,
            modified: value.modified,
        };
        Element::new_any(any)
    }
}

impl From<Comment> for Element<Any> {
    fn from(value: Comment) -> Self {
        let latex = value.to_latex_string();
        let any = Any {
            value: value.value,
            type_: T_Custom,
            level: value.level,
            header_level: None,
            text_type: None,
            list_type: None,
            items: None,
            elements: None,
            latex,
            modified: false,
        };
        Element::new_any(any)
    }
}

/// A latex element
#[derive(PartialOrd, PartialEq, Clone, Debug, Deserialize, Serialize)]
pub struct Element<T: Tex> {
    pub(crate) value: T,
    pub(crate) type_: Type,
    pub(crate) level: Level,
    pub(crate) latex: String,
    pub(crate) modified: bool,
}

impl<T: Tex> Element<T> {
    /// Creates a new Element
    pub fn new(value: T, type_: Type, level: Level, latex: String) -> Self {
        Self {
            value,
            type_,
            level,
            latex,
            modified: false,
        }
    }
}

impl Element<Any> {
    /// Creates a new `Element<Any>`
    pub fn new_any(value: Any) -> Self {
        let type_ = value.type_;
        let level = value.level;
        let latex = value.latex.to_string();
        let modified = value.modified;
        Self {
            value,
            type_,
            level,
            latex,
            modified,
        }
    }
}

impl ExtraOptions for Element<Any> {
    fn modify_element(&mut self, options: Vec<Options>) {
        self.latex = self.value.to_latex_string();
        for option in options {
            self.latex = option.modify(&self.latex);
        }
    }
}

/// A linked list of elements
#[derive(Debug, Clone, Deserialize, Serialize, PartialOrd, PartialEq)]
pub struct ElementList<T: Tex> {
    metadata: Metadata,
    list: LinkedList<Element<T>>,
}

impl ElementList<Any> {
    /// Creates a new empty list
    pub fn new(metadata: &Metadata) -> Self {
        Self {
            metadata: metadata.to_owned(),
            list: LinkedList::new(),
        }
    }
    /// A forward iterator of elements in the list
    pub fn iter(&self) -> Iter<'_, Element<Any>> {
        self.list.iter()
    }
    /// A mutable forward iterator of elements in the list
    pub fn iter_mut(&mut self) -> IterMut<'_, Element<Any>> {
        self.list.iter_mut()
    }
    /// Changes the metadata
    pub fn change_metadata(&mut self, metadata: Metadata) {
        self.metadata = metadata
    }
    /// Pushes a vector of Packages as String
    pub fn push_packages(&mut self, packages: Vec<String>) {
        for p in packages {
            let package = Package::new(&p);
            self.push(Element::from(package))
        }
    }
    /// Adds in `\newpage` text as next element in the list
    pub fn add_newpage(&mut self) {
        let text = Text::new(r"\newpage", Normal);
        self.push(Element::from(text));
    }
    /// Pushes an element to the end of the list
    pub fn push(&mut self, element: Element<Any>) {
        self.list.push_back(element)
    }
    /// Pushes an element vector into the list
    pub fn push_array(&mut self, element_vec: Vec<Element<Any>>) {
        for element in element_vec {
            self.push(element)
        }
    }
    /// Pops an element at the end of the list
    pub fn pop(&mut self) -> Option<Element<Any>> {
        self.list.pop_back()
    }
    /// Pushes element to the front of the list
    pub fn fpush(&mut self, element: Element<Any>) {
        self.list.push_front(element)
    }
    /// Pops an element in the front of the list
    pub fn fpop(&mut self) -> Option<Element<Any>> {
        self.list.pop_front()
    }

    /// Walks the list and returns a combined latex string
    pub fn to_latex_string(&self) -> String {
        let mut meta = Vec::new();
        let mut packages = Vec::new();
        let mut document = Vec::new();
        meta.push(self.metadata.to_latex_string());
        document.push(r"\begin{document}".to_owned());
        if self.metadata.maketitle {
            document.push(r"\maketitle".to_owned());
        }
        for i in self.iter() {
            iter_push(i, &mut document, &mut packages, &mut meta)
        }
        document.push(r"\end{document}".to_owned());
        let result = vec![meta.join("\n"), packages.join("\n"), document.join("\n")];
        result.join("\n")
    }
    /// Walks the list and returns a split latex string separating Packages level
    pub fn to_latex_split_string(&self, input: Input) -> (String, String) {
        let mut meta = Vec::new();
        meta.push(self.metadata.to_latex_string());
        meta.push(input.to_latex_string());
        let mut packages = Vec::new();
        let mut document = Vec::new();
        document.push(r"\begin{document}".to_owned());
        if self.metadata.maketitle {
            document.push(r"\maketitle".to_owned());
        }
        for i in self.iter() {
            iter_push(i, &mut document, &mut packages, &mut meta)
        }
        document.push(r"\end{document}".to_owned());
        let result = vec![meta.join("\n"), document.join("\n")];
        (result.join("\n"), packages.join("\n"))
    }
    /// Writes `ElementList` into a latex file
    pub fn write(&self, main: PathBuf) -> Result<(), Error> {
        let latex = self.to_latex_string();
        write_file(main, latex.as_bytes())?;
        Ok(())
    }
    /// Writes `ElementList` into two latex files splitting the `main` content and `path` for packages
    /// Input is used to declare the appropriate `\input{}` for your package file
    pub fn write_split(&self, main: PathBuf, structure: PathBuf, input: Input) {
        let (main_tex, str_tex) = self.to_latex_split_string(input);
        std::thread::scope(|s| {
            s.spawn(move || {
                write_file(main, main_tex.as_bytes()).expect("Couldn't write main file")
            });
            s.spawn(move || {
                write_file(structure, str_tex.as_bytes()).expect("Couldn't write structure file")
            });
        })
    }
    feature! {
       "parallel"
        /// A parallel alternate to `write()`
        pub fn par_write(&self, main: PathBuf){
            let pool = ThreadPoolBuilder::default().build().expect("Couldn't build pool");
            let latex = pool.install(|| self.to_latex_string());
            pool.install(|| write_file(main, latex.as_bytes()).expect("Couldn't write latex file in pool"));
        }
        /// A parallel alternate to `write_split()`
        pub fn par_write_split(&self, main: PathBuf, structure: PathBuf, input: Input){
            let pool = ThreadPoolBuilder::default().build().expect("Couldn't build pool");
            let (main_tex, str_tex) = pool.install(|| self.to_latex_split_string(input));
            pool.join(
                || write_file(main, main_tex.as_bytes()).expect("Couldn't write main file in pool"),
                || write_file(structure, str_tex.as_bytes()).expect("Couldn't write structure file in pool")
            );
        }
        pub fn par_iter(&self) -> impl ParallelIterator<Item=&Element<Any>> {
            use rayon::prelude::*;
            self.list.par_iter()
        }
    }

    #[cfg(feature = "compile")]
    /// Compiles the list into a pdf file
    pub fn compile(&self, path: PathBuf) -> Result<(), Error> {
        use std::fs::File;
        let mut file = File::create(path)?;
        let latex = self.to_latex_string();
        let pdf = latex_to_pdf(latex)?;
        file.write_all(&pdf)?;
        Ok(())
    }
    /// Prints the whole tex source code
    pub fn print_tex(&mut self) {
        println!("{}", self.to_latex_string());
    }
    /// Returns &self.list to `Vec<Element<Any>>`
    pub fn list_to_array(&self) -> Vec<Element<Any>> {
        let mut vec = Vec::new();
        for element in &self.list {
            vec.push(element.to_owned())
        }
        vec
    }
    /// returns the list's metadata
    pub fn metadata(&self) -> Metadata {
        self.metadata.clone()
    }
    /// returns a reference to the inner linked list
    pub fn list(&self) -> &LinkedList<Element<Any>> {
        &self.list
    }
}

impl Default for ElementList<Any> {
    fn default() -> Self {
        Self {
            metadata: Metadata::default(),
            list: LinkedList::new(),
        }
    }
}

// A helper function to write bytes to a file
fn write_file(path: PathBuf, bytes: &[u8]) -> Result<(), Error> {
    write(path, bytes)?;
    Ok(())
}

fn iter_push(
    i: &Element<Any>,
    document: &mut Vec<String>,
    packages: &mut Vec<String>,
    meta: &mut Vec<String>,
) {
    let latex = i.latex.to_string();
    match i.level {
        Document => document.push(latex),
        Packages => packages.push(latex),
        Meta => meta.push(latex),
    }
}