Adding initial support for edif

Cargo.toml

@@ -25,11 +25,12 @@ path = "src/bin/ro.rs"
 
 [workspace]
 members = [
+  "src/langs/asm",
+  "src/langs/edif",
   "src/langs/ir",
   "src/langs/pat",
-  "src/langs/asm",
-  "src/langs/xir",
   "src/langs/xim",
+  "src/langs/xir",
   "src/langs/verilog",
   "src/tools/io",
   "src/tools/prettyprint",

src/langs/edif/Cargo.toml

@@ -0,0 +1,12 @@
+[package]
+name = "edif"
+version = "0.1.0"
+authors = ["Pedro Torruella <[email protected]>"]
+license = "Apache-2.0"
+edition = "2018"
+
+[dependencies]
+serde = { version = "1.0", features = ["derive", "rc"] }
+serde_sexpr = "0.1.0"
+expect-test = "1.0.2"
+derive_more = { version = "0.99.14" , features = ["from"] }

src/langs/edif/README.md

@@ -0,0 +1,9 @@
+# Project Structure
+The project has the following areas:
+* examples: this is a good point of entry as it will quicky show you a template for your application.
+* src: this is the place where we have stored the code, separated in crates.
+    * edif: This crate is the core of the project, provides generic edif utilities.
+    * platforms: This crate hosts a non-comprehensive list of platform specific support functions, mainly for unit-testing/example.
+* others: random files to support development.
+
+# Still under construction

src/langs/edif/src/ast.rs

@@ -0,0 +1,183 @@
+/*
+Copyright 2021 Pedro M. Torruella N.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+use derive_more::{Deref, DerefMut, From};
+use serde::Serialize;
+
+#[derive(Debug)]
+pub struct Rename {
+    pub from: String,
+    pub to: String,
+}
+
+// TODO: probably create a module to allow these fields to
+//       be private
+#[derive(Debug, Clone)]
+pub struct GenericRef {
+    pub name: String,
+    pub reference: String,
+}
+
+#[derive(Debug, From, Serialize)]
+pub struct LibraryRef(pub GenericRef);
+
+#[derive(Debug, From, Serialize, Clone)]
+pub struct InstanceRef(pub GenericRef);
+
+#[derive(Debug, From)]
+pub enum PropertyValue {
+    Integer(i32),
+    String(String),
+}
+
+#[derive(Debug)]
+pub struct Property {
+    pub name: String,
+    pub property: PropertyValue,
+}
+
+#[derive(Debug, Deref, DerefMut, From, Serialize)]
+pub struct PropertyList(pub Vec<Property>);
+
+#[derive(Debug)]
+pub struct PortMember {
+    pub name: String,
+    pub index: u32,
+}
+
+#[derive(Debug, From)]
+pub enum PortRefToken {
+    Name(String),
+    Member(PortMember),
+}
+
+#[derive(Debug)]
+pub struct PortRef {
+    pub token: PortRefToken,
+    pub instanceref: InstanceRef,
+}
+
+#[derive(Debug, Deref, DerefMut)]
+pub struct PortList(pub Vec<PortRef>);
+
+#[derive(Debug, From)]
+pub enum StringToken {
+    Name(String),
+    Rename(Rename),
+}
+
+#[derive(Debug)]
+pub struct ContentNet {
+    pub token: StringToken,
+    pub portlist: PortList,
+}
+
+#[derive(Debug)]
+pub struct CellRef {
+    pub name: String,
+    pub libraryref: LibraryRef,
+}
+
+#[derive(Debug)]
+pub struct ContentInstance {
+    pub token: StringToken,
+    pub viewref: String,
+    pub cellref: CellRef,
+    pub properties: PropertyList,
+}
+
+#[derive(Debug, From)]
+pub enum ContentElement {
+    Instance(ContentInstance),
+    Net(ContentNet),
+}
+
+#[derive(Debug, Deref, DerefMut)]
+pub struct CellContents(pub Vec<ContentElement>);
+
+#[derive(Debug, From)]
+pub enum PortDirection {
+    Input,
+    Output,
+}
+
+#[derive(Debug, From)]
+pub struct PortArray {
+    pub rename: Rename,
+    pub length: i32,
+}
+
+#[derive(Debug, From)]
+pub enum PortToken {
+    Name(String),
+    Array(PortArray),
+}
+
+#[derive(Debug)]
+pub struct InterfacePort {
+    pub token: PortToken,
+    pub direction: PortDirection,
+}
+
+#[derive(Debug, Deref, DerefMut)]
+pub struct CellInterface(pub Vec<InterfacePort>);
+
+#[derive(Debug)]
+pub struct CellView {
+    pub name: String,
+    pub interface: CellInterface,
+    pub contents: CellContents,
+    pub properties: PropertyList,
+}
+
+#[derive(Debug, Deref, DerefMut, From)]
+pub struct CellViews(pub Vec<CellView>);
+
+#[derive(Debug)]
+pub struct Cell {
+    pub name: String,
+    pub views: CellViews,
+}
+
+#[derive(Debug, Deref, DerefMut, From, Serialize)]
+pub struct Cells(pub Vec<Cell>);
+
+#[derive(Debug)]
+pub struct Library {
+    pub name: String,
+    pub elements: Cells,
+}
+
+#[derive(Debug)]
+pub struct Design {
+    pub name: String,
+    pub cellref: CellRef,
+    pub properties: PropertyList,
+}
+
+#[derive(Debug, From)]
+pub enum EdifElement {
+    Library(Library),
+    Design(Design),
+}
+
+#[derive(Debug, Deref, DerefMut, From, Serialize)]
+pub struct EdifElements(pub Vec<EdifElement>);
+
+#[derive(Debug)]
+pub struct Edif {
+    pub name: String,
+    pub elements: EdifElements,
+}