altium 0.2.1

A library for processing Altium file 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

//! Things related to the entire component

use std::cmp::Ordering;
use std::fs::OpenOptions;
use std::io;
use std::path::Path;
use std::sync::Arc;

use svg::node::element::SVG as Svg;

use super::record::parse_all_records;
use super::storage::Storage;
use super::{SchDrawCtx, SchRecord};
use crate::draw::{Canvas, Draw, SvgCtx};
use crate::font::FontCollection;
use crate::Error;

/// Representation of a component
// TODO: should this just be "entry" or something? Not sure how it works with a
// schematic
#[derive(Clone, Debug)]
pub struct Component {
    pub(crate) name: Box<str>,
    pub(crate) records: Vec<SchRecord>,
    // TODO: figure out how to combine these
    pub(crate) fonts: Arc<FontCollection>,
    pub(crate) storage: Arc<Storage>,
}

impl Component {
    pub(crate) fn from_buf(
        name: &str,
        buf: &[u8],
        fonts: Arc<FontCollection>,
        storage: Arc<Storage>,
    ) -> Result<Self, Error> {
        Ok(Component {
            name: name.into(),
            records: parse_all_records(buf, name)?,
            fonts,
            storage,
        })
    }

    /// Draw this component to a SVG
    pub fn svg(&self) -> Svg {
        let mut draw = SvgCtx::new();
        let ctx = SchDrawCtx {
            fonts: &self.fonts,
            storage: &self.storage,
        };

        for record in &self.records {
            record.draw(&mut draw, &ctx);
        }
        draw.svg()
    }

    /// Draw this component to a SVG and write it to a file. Will create the file
    /// if it does not exist.
    pub fn save_svg<P: AsRef<Path>>(&self, path: P) -> io::Result<()> {
        let file = OpenOptions::new().write(true).create(true).open(path)?;
        svg::write(&file, &self.svg())
    }

    pub fn draw<C: Canvas>(&self, canvas: &mut C) {
        let ctx = SchDrawCtx {
            fonts: &self.fonts,
            storage: &self.storage,
        };
        self.records.iter().for_each(|r| r.draw(canvas, &ctx));
    }

    /// The name of this part
    pub fn name(&self) -> &str {
        &self.name
    }

    /// This part's description
    pub fn description(&self) -> &str {
        let meta = self
            .records
            .iter()
            .find_map(|record| {
                if let SchRecord::MetaData(d) = record {
                    Some(d)
                } else {
                    None
                }
            })
            .expect("no metadata record");
        meta.description.as_deref().unwrap_or("")
    }

    /// Compare two components based on name only
    pub fn name_cmp(&self, other: &Self) -> Option<Ordering> {
        self.name.partial_cmp(&other.name)
    }

    /// Iterate over all records in this component
    pub fn records(&self) -> impl Iterator<Item = &SchRecord> {
        self.records.iter()
    }
}