gdsr 0.0.1-alpha.3

A GDSII reader and writer for Rust
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
use std::sync::mpsc;

use chrono::{Datelike, Local, Timelike};
use rayon::prelude::*;

use crate::config::gds_file_types::{GDSDataType, GDSRecord, combine_record_and_data_type};
use crate::error::GdsError;
use crate::traits::ToGds;
use crate::utils::io::{
    validate_structure_name, write_string_with_record_to_file, write_u16_array_to_file,
};
use crate::{
    Dimensions, Element, GdsBox, LayerMapping, Library, Movable, Node, Path, Point, Polygon,
    Reference, Text, Transformable, Transformation,
};

/// A named cell containing polygons, paths, boxes, nodes, texts, and references to other cells or elements.
#[derive(Clone, Debug, PartialEq, Default)]
pub struct Cell {
    name: String,
    elements: Vec<Element>,
}

impl Cell {
    /// Creates a new empty cell with the given name.
    pub fn new(name: &str) -> Self {
        Self {
            name: name.to_string(),
            elements: Vec::new(),
        }
    }

    /// Returns the cell name.
    pub fn name(&self) -> &str {
        &self.name
    }

    pub(crate) fn set_name(&mut self, name: &str) {
        self.name = name.to_string();
    }

    /// Returns an iterator over all elements in this cell.
    pub fn iter_elements(&self) -> impl Iterator<Item = &Element> {
        self.elements.iter()
    }

    /// Returns a mutable iterator over all elements in this cell.
    pub fn iter_elements_mut(&mut self) -> impl Iterator<Item = &mut Element> {
        self.elements.iter_mut()
    }

    /// Returns an iterator over the polygons in this cell.
    pub fn polygons(&self) -> impl Iterator<Item = &Polygon> {
        self.elements.iter().filter_map(Element::as_polygon)
    }

    /// Returns an iterator over the paths in this cell.
    pub fn paths(&self) -> impl Iterator<Item = &Path> {
        self.elements.iter().filter_map(Element::as_path)
    }

    /// Returns an iterator over the boxes in this cell.
    pub fn boxes(&self) -> impl Iterator<Item = &GdsBox> {
        self.elements.iter().filter_map(Element::as_box)
    }

    /// Returns an iterator over the nodes in this cell.
    pub fn nodes(&self) -> impl Iterator<Item = &Node> {
        self.elements.iter().filter_map(Element::as_node)
    }

    /// Returns an iterator over the texts in this cell.
    pub fn texts(&self) -> impl Iterator<Item = &Text> {
        self.elements.iter().filter_map(Element::as_text)
    }

    /// Returns an iterator over the references in this cell.
    pub fn references(&self) -> impl Iterator<Item = &Reference> {
        self.elements.iter().filter_map(Element::as_reference)
    }

    /// Returns the names of all cells referenced by this cell, recursively resolving through
    /// inline element wrappers.
    pub fn referenced_cell_names(&self) -> Vec<&str> {
        self.references()
            .filter_map(Reference::referenced_cell_name)
            .collect()
    }

    /// Adds an element (polygon, path, text, or reference) to the cell.
    pub fn add(&mut self, element: impl Into<Element>) {
        self.elements.push(element.into());
    }

    /// Converts all elements to integer units.
    #[must_use]
    pub fn to_integer_unit(self) -> Self {
        Self {
            name: self.name,
            elements: self
                .elements
                .into_iter()
                .map(Element::to_integer_unit)
                .collect(),
        }
    }

    /// Converts all elements to float units.
    #[must_use]
    pub fn to_float_unit(self) -> Self {
        Self {
            name: self.name,
            elements: self
                .elements
                .into_iter()
                .map(Element::to_float_unit)
                .collect(),
        }
    }

    /// Remaps layer/data type pairs on all elements in this cell using the given mapping.
    pub fn remap_layers(&mut self, mapping: &LayerMapping) {
        for element in &mut self.elements {
            element.remap_layers(mapping);
        }
    }

    /// Like [`get_elements`](Self::get_elements) but sends elements through a channel as they're
    /// produced, enabling progressive rendering. Stops early if the receiver is dropped.
    pub fn stream_elements(
        &self,
        depth: Option<usize>,
        library: &Library,
        tx: &mpsc::Sender<Element>,
    ) {
        let depth = depth.unwrap_or(usize::MAX);

        for element in &self.elements {
            if let Element::Reference(reference) = element {
                if reference
                    .clone()
                    .stream_flatten(Some(depth), library, tx)
                    .is_err()
                {
                    return;
                }
            } else if tx.send(element.clone()).is_err() {
                return;
            }
        }
    }

    /// Returns all elements in this cell, recursively flattening references up to the given depth.
    pub fn get_elements(&self, depth: Option<usize>, library: &Library) -> Vec<Element> {
        let depth = depth.unwrap_or(usize::MAX);
        let mut result: Vec<Element> = Vec::new();

        for element in &self.elements {
            if let Element::Reference(reference) = element {
                result.extend(reference.clone().flatten(Some(depth), library));
            } else {
                result.push(element.clone());
            }
        }

        result
    }
}

impl std::fmt::Display for Cell {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        write!(
            f,
            "Cell '{}' with {} polygon(s), {} path(s), {} box(es), {} node(s), {} text(s)",
            self.name,
            self.polygons().count(),
            self.paths().count(),
            self.boxes().count(),
            self.nodes().count(),
            self.texts().count(),
        )
    }
}

impl Transformable for Cell {
    fn transform_impl(self, transformation: &Transformation) -> Self {
        Self {
            name: self.name,
            elements: self
                .elements
                .into_iter()
                .map(|e| e.transform_impl(transformation))
                .collect(),
        }
    }
}

impl Dimensions for Cell {
    fn bounding_box(&self) -> (Point, Point) {
        let all_points: Vec<Point> = self
            .elements
            .iter()
            .filter(|e| !matches!(e, Element::Reference(_)))
            .flat_map(|e| {
                let (min, max) = e.bounding_box();
                vec![min, max]
            })
            .collect();

        crate::geometry::bounding_box(&all_points)
    }
}

impl Movable for Cell {
    fn move_to(self, target: crate::Point) -> Self {
        Self {
            name: self.name,
            elements: self
                .elements
                .into_iter()
                .map(|e| e.move_to(target))
                .collect(),
        }
    }
}

impl ToGds for Cell {
    fn to_gds_impl(&self, database_units: f64) -> Result<Vec<u8>, GdsError> {
        validate_structure_name(&self.name)?;

        let now = Local::now();
        let timestamp = now.naive_utc();

        let cell_head = [
            28,
            combine_record_and_data_type(GDSRecord::BgnStr, GDSDataType::TwoByteSignedInteger),
            timestamp.year() as u16,
            timestamp.month() as u16,
            timestamp.day() as u16,
            timestamp.hour() as u16,
            timestamp.minute() as u16,
            timestamp.second() as u16,
            timestamp.year() as u16,
            timestamp.month() as u16,
            timestamp.day() as u16,
            timestamp.hour() as u16,
            timestamp.minute() as u16,
            timestamp.second() as u16,
        ];

        let mut buffer = Vec::new();

        write_u16_array_to_file(&mut buffer, &cell_head)?;

        write_string_with_record_to_file(&mut buffer, GDSRecord::StrName, &self.name)?;

        let element_bufs: Result<Vec<_>, _> = self
            .elements
            .par_iter()
            .map(|e| e.to_gds_impl(database_units))
            .collect();
        for b in element_bufs? {
            buffer.extend_from_slice(&b);
        }

        let cell_tail = [
            4,
            combine_record_and_data_type(GDSRecord::EndStr, GDSDataType::NoData),
        ];

        write_u16_array_to_file(&mut buffer, &cell_tail)?;

        Ok(buffer)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{DataType, Layer};

    #[test]
    fn test_cell_new() {
        let cell = Cell::new("test_cell");
        assert_eq!(cell.name, "test_cell");
        assert_eq!(cell.polygons().next(), None);
        assert_eq!(cell.paths().next(), None);
        assert_eq!(cell.boxes().next(), None);
        assert_eq!(cell.nodes().next(), None);
        assert_eq!(cell.texts().next(), None);
        assert_eq!(cell.references().next(), None);
    }

    #[test]
    fn test_cell_default() {
        let cell = Cell::default();
        assert_eq!(cell.name, "");
        assert_eq!(cell.elements.len(), 0);
    }

    #[test]
    fn test_add_polygon() {
        let mut cell = Cell::new("test_cell");
        let polygon = Polygon::default();

        cell.add(polygon.clone());
        assert_eq!(cell.polygons().count(), 1);
        assert_eq!(cell.polygons().next().unwrap(), &polygon);
    }

    #[test]
    fn test_add_path() {
        let mut cell = Cell::new("test_cell");
        let path = Path::default();

        cell.add(path.clone());
        assert_eq!(cell.paths().count(), 1);
        assert_eq!(cell.paths().next().unwrap(), &path);
    }

    #[test]
    fn test_add_text() {
        let mut cell = Cell::new("test_cell");
        let text = Text::default();

        cell.add(text.clone());
        assert_eq!(cell.texts().count(), 1);
        assert_eq!(cell.texts().next().unwrap(), &text);
    }

    #[test]
    fn test_cell_display() {
        let mut cell = Cell::new("test_cell");
        let polygon = Polygon::default();
        cell.add(polygon);

        insta::assert_snapshot!(cell.to_string(), @"Cell 'test_cell' with 1 polygon(s), 0 path(s), 0 box(es), 0 node(s), 0 text(s)");
    }

    #[test]
    fn test_cell_to_integer_unit() {
        let mut cell = Cell::new("test");
        cell.add(Polygon::new(
            vec![
                Point::float(1.5, 2.5, 1e-6),
                Point::float(10.0, 0.0, 1e-6),
                Point::float(10.0, 10.0, 1e-6),
            ],
            Layer::new(1),
            DataType::new(0),
        ));
        cell.add(Path::new(
            vec![Point::float(0.0, 0.0, 1e-6)],
            Layer::new(0),
            DataType::new(0),
            None,
            None,
            None,
            None,
        ));
        cell.add(Text::default().set_origin(Point::float(5.0, 5.0, 1e-6)));

        let converted = cell.to_integer_unit();

        assert_eq!(converted.polygons().count(), 1);
        assert_eq!(converted.paths().count(), 1);
        assert_eq!(converted.texts().count(), 1);
        for point in converted.polygons().next().unwrap().points() {
            assert_eq!(*point, point.to_integer_unit());
        }
    }

    #[test]
    fn test_cell_to_float_unit() {
        let mut cell = Cell::new("test");
        cell.add(Polygon::new(
            vec![
                Point::integer(0, 0, 1e-9),
                Point::integer(10, 0, 1e-9),
                Point::integer(10, 10, 1e-9),
            ],
            Layer::new(1),
            DataType::new(0),
        ));

        let converted = cell.to_float_unit();

        assert_eq!(converted.polygons().count(), 1);
        for point in converted.polygons().next().unwrap().points() {
            assert_eq!(*point, point.to_float_unit());
        }
    }

    #[test]
    fn test_cell_get_elements() {
        let library = Library::new("main");

        let polygon = Polygon::default();

        let reference = Reference::new(polygon.clone());

        let mut cell = Cell::new("test_cell");

        let path = Path::default();

        let text = Text::default();

        cell.add(reference);
        cell.add(polygon);
        cell.add(path);
        cell.add(text);

        let elements = cell.get_elements(None, &library);

        insta::assert_debug_snapshot!(elements);

        let moved_cell = cell.move_to(Point::integer(5, 5, 1e-9));

        let moved_elements = moved_cell.get_elements(None, &library);

        insta::assert_debug_snapshot!(moved_elements);

        let rotated_cell = moved_cell.rotate(90.0, Point::integer(5, 5, 1e-9));

        let rotated_elements = rotated_cell.get_elements(None, &library);

        insta::assert_debug_snapshot!(rotated_elements);
    }

    #[test]
    fn test_cell_bounding_box() {
        let mut cell = Cell::new("test");
        cell.add(Polygon::new(
            [
                Point::integer(0, 0, 1e-9),
                Point::integer(10, 0, 1e-9),
                Point::integer(10, 10, 1e-9),
            ],
            Layer::new(1),
            DataType::new(0),
        ));
        cell.add(Path::new(
            vec![Point::integer(-5, 5, 1e-9), Point::integer(15, 20, 1e-9)],
            Layer::new(1),
            DataType::new(0),
            None,
            None,
            None,
            None,
        ));
        cell.add(Text::default().set_origin(Point::integer(3, -2, 1e-9)));

        let (min, max) = cell.bounding_box();
        assert_eq!(min, Point::integer(-5, -2, 1e-9));
        assert_eq!(max, Point::integer(15, 20, 1e-9));
    }

    #[test]
    fn test_cell_bounding_box_empty() {
        let cell = Cell::new("empty");
        let (min, max) = cell.bounding_box();
        assert_eq!(min, Point::default());
        assert_eq!(max, Point::default());
    }

    #[test]
    fn test_cell_bounding_box_polygons_only() {
        let mut cell = Cell::new("test");
        cell.add(Polygon::new(
            [
                Point::integer(0, 0, 1e-9),
                Point::integer(5, 0, 1e-9),
                Point::integer(5, 5, 1e-9),
            ],
            Layer::new(1),
            DataType::new(0),
        ));
        cell.add(Polygon::new(
            [
                Point::integer(10, 10, 1e-9),
                Point::integer(20, 10, 1e-9),
                Point::integer(20, 20, 1e-9),
            ],
            Layer::new(1),
            DataType::new(0),
        ));

        let (min, max) = cell.bounding_box();
        assert_eq!(min, Point::integer(0, 0, 1e-9));
        assert_eq!(max, Point::integer(20, 20, 1e-9));
    }

    #[test]
    fn stream_elements_matches_get_elements() {
        let mut library = Library::new("main");

        let polygon = Polygon::new(
            vec![
                Point::integer(0, 0, 1e-9),
                Point::integer(10, 0, 1e-9),
                Point::integer(10, 10, 1e-9),
            ],
            Layer::new(1),
            DataType::new(0),
        );
        let path = Path::new(
            vec![Point::integer(0, 0, 1e-9), Point::integer(5, 5, 1e-9)],
            Layer::new(2),
            DataType::new(0),
            None,
            None,
            None,
            None,
        );
        let text = Text::default().set_origin(Point::integer(3, 3, 1e-9));

        let mut inner = Cell::new("inner");
        inner.add(polygon.clone());
        library.add_cell(inner);

        let mut cell = Cell::new("test_cell");
        cell.add(polygon);
        cell.add(path);
        cell.add(text);
        cell.add(Reference::new("inner"));

        let expected = cell.get_elements(None, &library);

        let (tx, rx) = mpsc::channel();
        cell.stream_elements(None, &library, &tx);
        drop(tx);
        let streamed: Vec<Element> = rx.iter().collect();

        assert_eq!(expected.len(), streamed.len());
        assert_eq!(expected, streamed);
    }

    #[test]
    fn stream_elements_cancellation() {
        let library = Library::new("main");

        let mut cell = Cell::new("test_cell");
        cell.add(Polygon::new(
            vec![
                Point::integer(0, 0, 1e-9),
                Point::integer(10, 0, 1e-9),
                Point::integer(10, 10, 1e-9),
            ],
            Layer::new(1),
            DataType::new(0),
        ));

        let (tx, rx) = mpsc::channel();
        drop(rx);
        cell.stream_elements(None, &library, &tx);
    }
}