read meta data from vcd

TODO: timescale from FST
ekiwi · Nov 9, 2023 · 9691a67 · 9691a67
1 parent b905931
commit 9691a67
Show file tree

Hide file tree

Showing 4 changed files with 344 additions and 42 deletions.
diff --git a/src/fst.rs b/src/fst.rs
@@ -90,8 +90,18 @@ fn convert_var_direction(tpe: FstVarDirection) -> VarDirection {
     }
 }
 
+// fn convert_timescale_unit() -> TimescaleUnit {
+//
+// }
+
 fn read_hierarchy<F: BufRead + Seek>(reader: &mut FstReader<F>) -> Hierarchy {
     let mut h = HierarchyBuilder::default();
+    // load meta-data
+    let fst_header = reader.get_header();
+    h.set_version(fst_header.version.trim().to_string());
+    h.set_date(fst_header.date.trim().to_string());
+    //TODO: h.set_timescale( Timescale { factor: 0, unit: convert_timescale_unit(fst_header.) } );
+
     let mut path_names = HashMap::new();
 
     let cb = |entry: FstHierarchyEntry| {

diff --git a/src/hierarchy.rs b/src/hierarchy.rs
@@ -361,6 +361,25 @@ pub struct Hierarchy {
     scopes: Vec<Scope>,
     strings: Vec<String>,
     signal_idx_to_var: Vec<Option<VarRef>>,
+    meta: HierarchyMetaData,
+}
+
+struct HierarchyMetaData {
+    timescale: Option<Timescale>,
+    date: String,
+    version: String,
+    comments: Vec<String>,
+}
+
+impl Default for HierarchyMetaData {
+    fn default() -> Self {
+        HierarchyMetaData {
+            timescale: None,
+            date: "".to_string(),
+            version: "".to_string(),
+            comments: Vec::default(),
+        }
+    }
 }
 
 // public implementation
@@ -413,6 +432,16 @@ impl Hierarchy {
         let handle_lookup_size = self.signal_idx_to_var.capacity() * std::mem::size_of::<VarRef>();
         var_size + scope_size + string_size + handle_lookup_size + std::mem::size_of::<Hierarchy>()
     }
+
+    pub fn date(&self) -> &str {
+        &self.meta.date
+    }
+    pub fn version(&self) -> &str {
+        &self.meta.version
+    }
+    pub fn timescale(&self) -> Option<Timescale> {
+        self.meta.timescale
+    }
 }
 
 impl Hierarchy {
@@ -487,6 +516,7 @@ pub struct HierarchyBuilder {
     scope_stack: Vec<ScopeStackEntry>,
     strings: StringInterner,
     handle_to_node: Vec<Option<VarRef>>,
+    meta: HierarchyMetaData,
     // some statistics
     duplicate_string_count: usize,
     duplicate_string_size: usize,
@@ -500,6 +530,7 @@ impl Default for HierarchyBuilder {
             scope_stack: Vec::default(),
             strings: StringInterner::default(),
             handle_to_node: Vec::default(),
+            meta: HierarchyMetaData::default(),
             duplicate_string_count: 0,
             duplicate_string_size: 0,
         }
@@ -513,6 +544,7 @@ impl HierarchyBuilder {
             scopes: self.scopes,
             strings: interner_to_vec(self.strings),
             signal_idx_to_var: self.handle_to_node,
+            meta: self.meta,
         }
     }
 
@@ -629,6 +661,41 @@ impl HierarchyBuilder {
     pub fn pop_scope(&mut self) {
         self.scope_stack.pop().unwrap();
     }
+
+    pub fn set_date(&mut self, value: String) {
+        assert!(
+            self.meta.date.is_empty(),
+            "Duplicate dates: {} vs {}",
+            self.meta.date,
+            value
+        );
+        self.meta.date = value;
+    }
+
+    pub fn set_version(&mut self, value: String) {
+        assert!(
+            self.meta.version.is_empty(),
+            "Duplicate versions: {} vs {}",
+            self.meta.version,
+            value
+        );
+        self.meta.version = value;
+    }
+
+    pub fn set_timescale(&mut self, factor: u32, unit: TimescaleUnit) {
+        let value = Timescale { factor, unit };
+        assert!(
+            self.meta.timescale.is_none(),
+            "Duplicate timescales: {:?} vs {:?}",
+            self.meta.timescale.unwrap(),
+            value
+        );
+        self.meta.timescale = Some(value);
+    }
+
+    pub fn add_comment(&mut self, comment: String) {
+        self.meta.comments.push(comment);
+    }
 }
 
 #[cfg(test)]