berkus
/
topola
mirror of https://codeberg.org/topola/topola.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

refactor(specctra/design): turn SpecctraDesign into a trait

This commit is contained in:
Ellen Emilia Anna Zscheile 2025-06-07 10:39:39 +02:00
parent 3c807b5078
commit f1225ba52e
7 changed files with 350 additions and 338 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
crates/topola-cli/src/main.rs
View File

@ -9,11 +9,10 @@ use topola::autorouter::execution::Command;
use topola::autorouter::history::History;
use topola::autorouter::invoker::Invoker;
use topola::autorouter::selection::PinSelection;
use topola::autorouter::Autorouter;
use topola::autorouter::AutorouterOptions;
use topola::autorouter::{Autorouter, AutorouterOptions};
use topola::layout::LayoutEdit;
use topola::router::RouterOptions;
use topola::specctra::design::SpecctraDesign;
use topola::specctra::design::{DsnFile, SpecctraDesign as _};
pub mod cli;
use cli::Cli;
@ -23,8 +22,7 @@ fn main() -> Result<(), std::io::Error> {
let design_file = File::open(&args.input)?;
let design_bufread = BufReader::new(design_file);
let design =
SpecctraDesign::load(design_bufread).expect("File failed to parse as Specctra DSN");
let design = DsnFile::load(design_bufread).expect("File failed to parse as Specctra DSN");
let board = design.make_board(&mut LayoutEdit::new());

9
crates/topola-egui/src/app.rs
View File

@ -14,7 +14,10 @@ use unic_langid::{langid, LanguageIdentifier};
use topola::{
interactor::activity::InteractiveInput,
specctra::{design::SpecctraDesign, ParseErrorContext as SpecctraLoadingError},
specctra::{
design::{DsnFile, SpecctraDesign},
ParseErrorContext as SpecctraLoadingError,
},
};
use crate::{
@ -27,8 +30,8 @@ pub struct App {
translator: Translator,
content_channel: (
Sender<Result<SpecctraDesign, SpecctraLoadingError>>,
Receiver<Result<SpecctraDesign, SpecctraLoadingError>>,
Sender<Result<DsnFile, SpecctraLoadingError>>,
Receiver<Result<DsnFile, SpecctraLoadingError>>,
),
viewport: Viewport,

9
crates/topola-egui/src/menu_bar.rs
View File

@ -10,7 +10,10 @@ use topola::{
},
board::AccessMesadata,
router::RouterOptions,
specctra::{design::SpecctraDesign, ParseError, ParseErrorContext as SpecctraLoadingError},
specctra::{
design::{DsnFile, SpecctraDesign as _},
ParseError, ParseErrorContext as SpecctraLoadingError,
},
};
use crate::{
@ -59,7 +62,7 @@ impl MenuBar {
&mut self,
ctx: &egui::Context,
tr: &mut Translator,
content_sender: Sender<Result<SpecctraDesign, SpecctraLoadingError>>,
content_sender: Sender<Result<DsnFile, SpecctraLoadingError>>,
viewport: &mut Viewport,
maybe_workspace: Option<&mut Workspace>,
) -> Result<(), InvokerError> {
@ -174,7 +177,7 @@ impl MenuBar {
let data = handle_file(&file_handle)
.await
.map_err(|e| ParseError::from(e).add_context((0, 0)))
.and_then(SpecctraDesign::load);
.and_then(DsnFile::load);
content_sender.send(data);
ctx.request_repaint();
}

9
crates/topola-egui/src/workspace.rs
View File

@ -11,7 +11,10 @@ use topola::{
autorouter::history::History,
interactor::{activity::InteractiveInput, Interactor},
layout::LayoutEdit,
specctra::{design::SpecctraDesign, mesadata::SpecctraMesadata},
specctra::{
design::{DsnFile, SpecctraDesign as _},
mesadata::SpecctraMesadata,
},
};
use crate::{
@ -21,7 +24,7 @@ use crate::{
/// A loaded design and associated structures.
pub struct Workspace {
pub design: SpecctraDesign,
pub design: DsnFile,
pub appearance_panel: AppearancePanel,
pub overlay: Overlay,
pub interactor: Interactor<SpecctraMesadata>,
@ -33,7 +36,7 @@ pub struct Workspace {
}
impl Workspace {
pub fn new(design: SpecctraDesign, tr: &Translator) -> Result<Self, String> {
pub fn new(design: DsnFile, tr: &Translator) -> Result<Self, String> {
let board = design.make_board(&mut LayoutEdit::new());
let appearance_panel = AppearancePanel::new(&board);
let overlay = Overlay::new(&board).map_err(|err| {

4
examples/specctra.rs
View File

@ -7,13 +7,13 @@ use std::io::BufReader;
use topola::autorouter::invoker::Invoker;
use topola::autorouter::Autorouter;
use topola::layout::LayoutEdit;
use topola::specctra::design::SpecctraDesign;
use topola::specctra::design::{DsnFile, SpecctraDesign as _};
fn main() -> Result<(), std::io::Error> {
let design_file = File::open("example.dsn")?;
let design_bufread = BufReader::new(design_file);
let design = SpecctraDesign::load(design_bufread).unwrap();
let design = DsnFile::load(design_bufread).unwrap();
let board = design.make_board(&mut LayoutEdit::new());
let invoker = Invoker::new(Autorouter::new(board).unwrap());

136
src/specctra/design.rs
View File

@ -25,48 +25,61 @@ use crate::{
specctra::{
mesadata::SpecctraMesadata,
read::ListTokenizer,
structure::{self, DsnFile, Layer, Pcb, Shape},
structure::{self, Layer, Shape},
write::ListWriter,
},
};
pub use specctra_core::error::ParseErrorContext;
pub use specctra_core::{error::ParseErrorContext, structure::DsnFile};
/// This struct is responsible for managing the various Specctra components of a PCB design,
/// This trait is responsible for managing the various Specctra components of a PCB design,
/// including parsing the DSN file, handling the resolution, unit of measurement,
/// and organizing the PCB's structure, placement, library, network, and wiring.
/// It provides functionality for reading from a DSN file and writing Specctra's .SES session files.
#[derive(Debug)]
pub struct SpecctraDesign {
pcb: Pcb,
}
impl SpecctraDesign {
pub trait SpecctraDesign: Sized {
/// Loads a [`SpecctraDesign`] structure instance from a buffered reader.
///
/// This function reads the Specctra Design data from an input stream.
/// Later the data is parsed and loaded into a [`SpecctraDesign`] structure,
/// allowing further operations such as rule validation, routing, or netlist management.
pub fn load(reader: impl std::io::BufRead) -> Result<SpecctraDesign, ParseErrorContext> {
let mut list_reader = ListTokenizer::new(reader);
let dsn = list_reader.read_value::<DsnFile>()?;
Ok(Self { pcb: dsn.pcb })
}
fn load(reader: impl std::io::BufRead) -> Result<Self, ParseErrorContext>;
/// Function to get name of the DSN file
///
/// This function returns the name of the `Pcb` objects
pub fn get_name(&self) -> &str {
&self.pcb.name
}
fn get_name(&self) -> &str;
/// Writes the Specctra Session (.ses) file format using the current board layout and mesadata.
///
/// This function generates a Specctra SES session file that represents the board's net routing and
/// writes it to the provided output stream. The session data includes routed nets, wires,
/// layers, and other essential information for routing management.
pub fn write_ses(
fn write_ses(
&self,
board: &Board<SpecctraMesadata>,
writer: impl std::io::Write,
) -> Result<(), std::io::Error>;
/// Generates a [`Board<SpecctraMesadata>`] from the current PCB data.
///
/// This function takes the internal `Pcb` structure and transforms it into a [`Board`] object,
/// which is used for layout and routing operations. The board is initialized with [`SpecctraMesadata`],
/// which includes layer and net mappings, and is populated with components, pins, vias, and wires
/// from the PCB definition.
fn make_board(&self, recorder: &mut LayoutEdit) -> Board<SpecctraMesadata>;
}
impl SpecctraDesign for DsnFile {
fn load(reader: impl std::io::BufRead) -> Result<Self, ParseErrorContext> {
let mut list_reader = ListTokenizer::new(reader);
list_reader.read_value::<DsnFile>()
}
fn get_name(&self) -> &str {
&self.pcb.name
}
fn write_ses(
&self,
board: &Board<SpecctraMesadata>,
writer: impl std::io::Write,
@ -173,13 +186,7 @@ impl SpecctraDesign {
ListWriter::new(writer).write_value(&ses)
}
/// Generates a [`Board<SpecctraMesadata>`] from the current PCB data.
///
/// This function takes the internal `Pcb` structure and transforms it into a [`Board`] object,
/// which is used for layout and routing operations. The board is initialized with [`SpecctraMesadata`],
/// which includes layer and net mappings, and is populated with components, pins, vias, and wires
/// from the PCB definition.
pub fn make_board(&self, recorder: &mut LayoutEdit) -> Board<SpecctraMesadata> {
fn make_board(&self, recorder: &mut LayoutEdit) -> Board<SpecctraMesadata> {
let mesadata = SpecctraMesadata::from_pcb(&self.pcb);
let mut board = Board::new(Layout::new(Drawing::new(
mesadata,
@ -224,7 +231,7 @@ impl SpecctraDesign {
for place in &component.places {
let place_side_is_front = place.side == "front";
let get_layer = |board: &Board<SpecctraMesadata>, name: &str| {
Self::layer(board, &self.pcb.structure.layers, name, place_side_is_front)
layer(board, &self.pcb.structure.layers, name, place_side_is_front)
};
for pin in &image.pins {
@ -237,7 +244,7 @@ impl SpecctraDesign {
match shape {
Shape::Circle(circle) => {
let layer = get_layer(&board, &circle.layer);
Self::add_circle(
add_circle(
recorder,
&mut board,
place.point_with_rotation(),
@ -250,7 +257,7 @@ impl SpecctraDesign {
}
Shape::Rect(rect) => {
let layer = get_layer(&board, &rect.layer);
Self::add_rect(
add_rect(
recorder,
&mut board,
place.point_with_rotation(),
@ -266,7 +273,7 @@ impl SpecctraDesign {
}
Shape::Path(path) => {
let layer = get_layer(&board, &path.layer);
Self::add_path(
add_path(
recorder,
&mut board,
place.point_with_rotation(),
@ -280,7 +287,7 @@ impl SpecctraDesign {
}
Shape::Polygon(polygon) => {
let layer = get_layer(&board, &polygon.layer);
Self::add_polygon(
add_polygon(
recorder,
&mut board,
place.point_with_rotation(),
@ -304,14 +311,14 @@ impl SpecctraDesign {
let padstack = self.pcb.library.find_padstack_by_name(&via.name).unwrap();
let get_layer = |board: &Board<SpecctraMesadata>, name: &str| {
Self::layer(board, &self.pcb.structure.layers, name, true)
layer(board, &self.pcb.structure.layers, name, true)
};
for shape in &padstack.shapes {
match shape {
Shape::Circle(circle) => {
let layer = get_layer(&board, &circle.layer);
Self::add_circle(
add_circle(
recorder,
&mut board,
// TODO: refactor?
@ -326,7 +333,7 @@ impl SpecctraDesign {
}
Shape::Rect(rect) => {
let layer = get_layer(&board, &rect.layer);
Self::add_rect(
add_rect(
recorder,
&mut board,
PointWithRotation::from_xy(via.x, via.y),
@ -342,7 +349,7 @@ impl SpecctraDesign {
}
Shape::Path(path) => {
let layer = get_layer(&board, &path.layer);
Self::add_path(
add_path(
recorder,
&mut board,
PointWithRotation::from_xy(via.x, via.y),
@ -356,7 +363,7 @@ impl SpecctraDesign {
}
Shape::Polygon(polygon) => {
let layer = get_layer(&board, &polygon.layer);
Self::add_polygon(
add_polygon(
recorder,
&mut board,
PointWithRotation::from_xy(via.x, via.y),
@ -381,7 +388,7 @@ impl SpecctraDesign {
.unwrap();
let net = board.layout().drawing().rules().netname_net(&wire.net);
Self::add_path(
add_path(
recorder,
&mut board,
PointWithRotation::default(),
@ -396,13 +403,9 @@ impl SpecctraDesign {
board
}
}
fn layer(
board: &Board<SpecctraMesadata>,
layers: &[Layer],
layername: &str,
front: bool,
) -> usize {
fn layer(board: &Board<SpecctraMesadata>, layers: &[Layer], layername: &str, front: bool) -> usize {
let image_layer = board
.layout()
.drawing()
@ -415,9 +418,9 @@ impl SpecctraDesign {
} else {
layers.len() - image_layer - 1
}
}
}
fn add_circle(
fn add_circle(
recorder: &mut LayoutEdit,
board: &mut Board<SpecctraMesadata>,
place: PointWithRotation,
@ -426,9 +429,9 @@ impl SpecctraDesign {
layer: usize,
maybe_net: Option<usize>,
maybe_pin: Option<String>,
) {
) {
let circle = Circle {
pos: Self::pos(place, pin, 0.0, 0.0),
pos: pos(place, pin, 0.0, 0.0),
r,
};
@ -441,9 +444,9 @@ impl SpecctraDesign {
}),
maybe_pin,
);
}
}
fn add_rect(
fn add_rect(
recorder: &mut LayoutEdit,
board: &mut Board<SpecctraMesadata>,
place: PointWithRotation,
@ -455,13 +458,13 @@ impl SpecctraDesign {
layer: usize,
maybe_net: Option<usize>,
maybe_pin: Option<String>,
) {
) {
// Corners.
let dot_1_1 = board.add_fixed_dot_infringably(
recorder,
FixedDotWeight(GeneralDotWeight {
circle: Circle {
pos: Self::pos(place, pin, x1, y1),
pos: pos(place, pin, x1, y1),
r: 0.5,
},
layer,
@ -473,7 +476,7 @@ impl SpecctraDesign {
recorder,
FixedDotWeight(GeneralDotWeight {
circle: Circle {
pos: Self::pos(place, pin, x2, y1),
pos: pos(place, pin, x2, y1),
r: 0.5,
},
layer,
@ -485,7 +488,7 @@ impl SpecctraDesign {
recorder,
FixedDotWeight(GeneralDotWeight {
circle: Circle {
pos: Self::pos(place, pin, x2, y2),
pos: pos(place, pin, x2, y2),
r: 0.5,
},
layer,
@ -497,7 +500,7 @@ impl SpecctraDesign {
recorder,
FixedDotWeight(GeneralDotWeight {
circle: Circle {
pos: Self::pos(place, pin, x1, y2),
pos: pos(place, pin, x1, y2),
r: 0.5,
},
layer,
@ -566,9 +569,9 @@ impl SpecctraDesign {
seg4.into(),
],
);
}
}
fn add_path(
fn add_path(
recorder: &mut LayoutEdit,
board: &mut Board<SpecctraMesadata>,
place: PointWithRotation,
@ -578,9 +581,9 @@ impl SpecctraDesign {
layer: usize,
maybe_net: Option<usize>,
maybe_pin: Option<String>,
) {
) {
// add the first coordinate in the wire path as a dot and save its index
let mut prev_pos = Self::pos(place, pin, coords[0].x, coords[0].y);
let mut prev_pos = pos(place, pin, coords[0].x, coords[0].y);
let mut prev_index = board.add_fixed_dot_infringably(
recorder,
FixedDotWeight(GeneralDotWeight {
@ -596,7 +599,7 @@ impl SpecctraDesign {
// iterate through path coords starting from the second
for coord in coords.iter().skip(1) {
let pos = Self::pos(place, pin, coord.x, coord.y);
let pos = pos(place, pin, coord.x, coord.y);
if pos == prev_pos {
continue;
@ -631,9 +634,9 @@ impl SpecctraDesign {
prev_index = index;
prev_pos = pos;
}
}
}
fn add_polygon(
fn add_polygon(
recorder: &mut LayoutEdit,
board: &mut Board<SpecctraMesadata>,
place: PointWithRotation,
@ -643,7 +646,7 @@ impl SpecctraDesign {
layer: usize,
maybe_net: Option<usize>,
maybe_pin: Option<String>,
) {
) {
let mut nodes = Vec::with_capacity(coords.len() * 2 - 1);
// add the first coordinate in the wire path as a dot and save its index
@ -651,7 +654,7 @@ impl SpecctraDesign {
recorder,
FixedDotWeight(GeneralDotWeight {
circle: Circle {
pos: Self::pos(place, pin, coords[0].x, coords[0].y),
pos: pos(place, pin, coords[0].x, coords[0].y),
r: width / 2.0,
},
layer,
@ -680,7 +683,7 @@ impl SpecctraDesign {
recorder,
FixedDotWeight(GeneralDotWeight {
circle: Circle {
pos: Self::pos(place, pin, coord.x, coord.y),
pos: pos(place, pin, coord.x, coord.y),
r: width / 2.0,
},
layer,
@ -713,10 +716,9 @@ impl SpecctraDesign {
maybe_pin,
&nodes[..],
);
}
}
fn pos(place: PointWithRotation, pin: PointWithRotation, x: f64, y: f64) -> Point {
fn pos(place: PointWithRotation, pin: PointWithRotation, x: f64, y: f64) -> Point {
let pos = (point! {x: x, y: y} + pin.pos).rotate_around_point(pin.rot, pin.pos);
(pos + place.pos).rotate_around_point(place.rot, place.pos)
}
}

7
tests/common/mod.rs
View File

@ -17,13 +17,16 @@ use topola::{
graph::{GetPetgraphIndex, MakeRef},
layout::LayoutEdit,
router::{navmesh::Navmesh, RouterOptions},
specctra::{design::SpecctraDesign, mesadata::SpecctraMesadata},
specctra::{
design::{DsnFile, SpecctraDesign as _},
mesadata::SpecctraMesadata,
},
};
pub fn load_design(filename: &str) -> Autorouter<SpecctraMesadata> {
let design_file = File::open(filename).unwrap();
let design_bufread = BufReader::new(design_file);
let design = SpecctraDesign::load(design_bufread).unwrap();
let design = DsnFile::load(design_bufread).unwrap();
Autorouter::new(design.make_board(&mut LayoutEdit::new())).unwrap()
}