New OsvvmScripts... to handle translation from pro to other formats

Author: JimLewis

OsvvmScriptsTranslate.tcl

@@ -0,0 +1,132 @@
+#  File Name:         OsvvmScriptsFileCreate.tcl
+#  Purpose:           Scripts for running simulations
+#  Revision:          OSVVM MODELS STANDARD VERSION
+#
+#  Maintainer:        Jim Lewis      email:  jim@synthworks.com
+#  Contributor(s):
+#     Jim Lewis           email:  jim@synthworks.com
+#     Markus Ferringer    Patterns for error handling and callbacks, ...
+#
+#  Description
+#    Tcl procedures to Autogenerate Files
+#
+#  Developed by:
+#        SynthWorks Design Inc.
+#        VHDL Training Classes
+#        OSVVM Methodology and Model Library
+#        11898 SW 128th Ave.  Tigard, Or  97223
+#        http://www.SynthWorks.com
+#
+#  Revision History:
+#    Date      Version    Description
+#     1/2025   2025.01    Initial
+#
+#
+#  This file is part of OSVVM.
+#
+#  Copyright (c) 2025 by SynthWorks Design Inc.
+#
+#  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
+#
+#      https://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.
+#
+
+package require fileutil
+
+namespace eval ::osvvm {
+  # Declare existance as a global, but do not initialize as it will clear it
+  variable AnalyzeDict  
+  variable AnalyzeOrderList 
+  variable SimulateDict 
+
+# -------------------------------------------------
+# CreateDryRunDict
+#
+proc CreateDryRunDict {ProFileToBuild} {
+  # CreateDryRunDict runs a build script in DryRunMode and 
+  # creates dictionaries of Analyze and Simulate information.
+  # The Analyze dictionary, ::osvvm::AnalyzeDict, has a dictionary
+  # for each library used.  For each library there is an array of 
+  # dictionaries that contain the file analyzed as well as language version used.
+  # The Simulation dictionary, ::osvvm::SimulateDict, has a dictionary
+  # for each library used.  For each library there is an array of 
+  # dictionaries that contain information passed to simulate.
+	#
+  #  ProFileToBuild - Path to the pro file that build the entire design.
+  #  WhereToCreate  - Directory into which to create vhdl_ls.toml.  Default = .
+	#
+  
+  variable GenerateOsvvmReports
+  set SavedGenerateOsvvmReports $GenerateOsvvmReports
+  set GenerateOsvvmReports "false"   ;# turn off reports
+ 
+  # initialize dictionaries to empty
+  variable AnalyzeDict  [dict create]  ;# empty dictionary
+  variable AnalyzeOrderList ""         ;# empty list
+  variable SimulateDict [dict create]  ;# empty dictionary
+  
+  # Create AnalyzeDict and SimulateDict as a recording of 
+  source $::OsvvmLibraries/Scripts/VendorScripts_DryRunDict.tcl
+  
+  build $ProFileToBuild [BuildName CreateDryRunDict]
+#  if {$ScriptToRun ne ""} { $ScriptToRun }
+  
+  # restore settings and tool API actions
+  # StartUp  ;# replace source below with StartUp if features beyond VendorScripts_xxx.tcl are changed
+  source $::OsvvmLibraries/Scripts/VendorScripts_${::osvvm::ScriptBaseName}.tcl
+  set GenerateOsvvmReports $SavedGenerateOsvvmReports  ;# restore reports
+}
+
+# -------------------------------------------------
+# CreateVhdlLsToml for VHDL LS
+#
+proc CreateVhdlLsToml {ProFileToBuild {WhereToCreate .}} {
+  # CreateVhdlLsToml runs a build script in DryRunMode and 
+  # creates a vhdl_ls.toml file.
+	#
+  #  ProFileToBuild - Path to the pro file that build the entire design.
+  #  WhereToCreate  - Directory into which to create vhdl_ls.toml.  Default = .
+	#
+  variable AnalyzeDict
+
+  # Create AnalyzeDict for the ProFileToBuild script
+  CreateDryRunDict $ProFileToBuild
+
+  set TomlHomeDir   [file normalize $WhereToCreate]
+  set TomlFile      [open [file join $TomlHomeDir vhdl_ls.toml] w]
+
+  puts $TomlFile "# Generated by OSVVM's CreateToml"
+  puts $TomlFile "\[Libraries\]"
+
+  foreach key [dict keys $AnalyzeDict] {
+    # Print library name
+    set FileList [dict get $AnalyzeDict $key]
+    puts $TomlFile "${key}.files = \["
+    foreach FileDict $FileList {
+      puts $TomlFile "  '[dict get $FileDict FileName]',"
+    }
+    puts $TomlFile "\]"
+    # mark things from OSVVM libraries as thrid party
+  }
+  close $TomlFile
+}
+
+
+# Don't export the following due to conflicts with Tcl built-ins
+# map
+
+namespace export CreateDryRunDict
+namespace export CreateVhdlLsToml
+
+
+
+# end namespace ::osvvm
+}