Experimental work in progress

Author: JimLewis

OsvvmScriptsFileCreate.tcl

@@ -39,18 +39,28 @@
 #  limitations under the License.
 #
 
+package require fileutil
 
 namespace eval ::osvvm {
 
 # -------------------------------------------------
-# CreateOsvvmScriptSettingsPkg
-#   do an operation on a list of items
+# FindOsvvmSettingsDirectory
 #
 proc FindOsvvmSettingsDirectory {} {
-  if {$::osvvm::SettingsAreRelativeToSimulationDirectory} {
-    set SettingsDirectory [file join ${::osvvm::CurrentSimulationDirectory} ${::osvvm::OsvvmSettingsSubDirectory}]
+
+  if {[info exists ::env(OSVVM_SETTINGS_DIR)]} {
+    # if OSVVM_SETTINGS_DIR has an absolute path, CurrentSimulationDirectory/OsvvmHomeDirectory is ignored
+    if {$::osvvm::SettingsAreRelativeToSimulationDirectory} {
+      set SettingsDirectory [file join ${::osvvm::CurrentSimulationDirectory} $::env(OSVVM_SETTINGS_DIR) ${::osvvm::OsvvmSettingsSubDirectory}]
+    } else {
+      set SettingsDirectory [file join ${::osvvm::OsvvmHomeDirectory} $::env(OSVVM_SETTINGS_DIR) ${::osvvm::OsvvmSettingsSubDirectory}]
+    }
   } else {
-    set SettingsDirectory [file join ${::osvvm::OsvvmHomeDirectory} "osvvm" ${::osvvm::OsvvmSettingsSubDirectory}]
+    if {$::osvvm::SettingsAreRelativeToSimulationDirectory} {
+      set SettingsDirectory [file join ${::osvvm::CurrentSimulationDirectory} ${::osvvm::OsvvmSettingsSubDirectory}]
+    } else {
+      set SettingsDirectory [file join ${::osvvm::OsvvmHomeDirectory} "osvvm" ${::osvvm::OsvvmSettingsSubDirectory}]
+    }
   }
   CreateDirectory $SettingsDirectory
 #  set RelativeSettingsDirectory [::fileutil::relative [pwd] $SettingsDirectory]
@@ -59,6 +69,9 @@ proc FindOsvvmSettingsDirectory {} {
   return $SettingsDirectory
 }
 
+# -------------------------------------------------
+#  CreateOsvvmScriptSettingsPkg
+#
 proc CreateOsvvmScriptSettingsPkg {SettingsDirectory} {
   set OsvvmScriptSettingsPkgFile  [file join ${SettingsDirectory} "OsvvmScriptSettingsPkg_generated.vhd"] 
   set NewFileName                 [file join ${SettingsDirectory} "OsvvmScriptSettingsPkg_new.vhd"]   
@@ -95,6 +108,77 @@ proc CreateOsvvmScriptSettingsPkg {SettingsDirectory} {
   return $OsvvmScriptSettingsPkgFile
 }
 
+
+# -------------------------------------------------
+#  CreatePathPkg
+#
+proc CreatePathPkg {BaseName {SettingsDirectory ""}} {
+  if {$SettingsDirectory eq ""} {set SettingsDirectory $::osvvm::OsvvmUserSettingsDirectory}
+  set TestSettingsPkgFile     [file join ${SettingsDirectory} "${BaseName}PathPkg_generated.vhd"] 
+  set NewFileName             [file join ${SettingsDirectory} "${BaseName}PathPkg_new.vhd"]   
+  set DefaultSettingsPkgFile  [file join ${SettingsDirectory} "${BaseName}PathPkg_default.vhd"] 
+
+  set WriteCode [catch {set FileHandle  [open $NewFileName w]} WriteErrMsg]
+  if {$WriteCode} { 
+    puts "Not able to open ${NewFileName}. Using defaults instead" 
+    analyze ${BaseName}SettingsPkg_default.vhd
+    return ""
+  }
+  set LocalScriptDir  "[::fileutil::relative ${::osvvm::CurrentSimulationDirectory} [file normalize ${::osvvm::CurrentWorkingDirectory}]]"
+  puts $FileHandle "-- This file is autogenerated by CreatePathPkg" 
+  puts $FileHandle "package ${BaseName}SettingsPkg is" 
+  puts $FileHandle "  constant TEST_PATH_DIR         : string := \"${LocalScriptDir}\" ;"
+  puts $FileHandle "  constant TEST_PATH_SET         : boolean := TRUE ;"
+  puts $FileHandle "end package ${BaseName}SettingsPkg ;" 
+  close $FileHandle
+  if {[FileDiff $TestSettingsPkgFile $NewFileName]} {
+    file rename -force $NewFileName $TestSettingsPkgFile
+  } else {
+    file delete -force $NewFileName
+  }
+  analyze $TestSettingsPkgFile
+  return $TestSettingsPkgFile
+}
+
+
+# -------------------------------------------------
+#  CreateAndAnalyzeBuildSettingsPkg
+#
+proc CreateBuildSettingsPkg {BaseName {SettingsDirectory ""}} {
+  if {$SettingsDirectory eq ""} {set SettingsDirectory $::osvvm::OsvvmUserSettingsDirectory}
+  set TestSettingsPkgFile     [file join ${SettingsDirectory} "${BaseName}SettingsPkg_generated.vhd"] 
+  set NewFileName             [file join ${SettingsDirectory} "${BaseName}SettingsPkg_new.vhd"]   
+  set DefaultSettingsPkgFile  [file join ${SettingsDirectory} "${BaseName}SettingsPkg_default.vhd"] 
+
+  set WriteCode [catch {set FileHandle  [open $NewFileName w]} WriteErrMsg]
+  if {$WriteCode} { 
+    puts "Not able to open ${NewFileName}. Using defaults instead" 
+    analyze ${BaseName}SettingsPkg_default.vhd
+    return ""
+  }
+  set LocalScriptDir  "[::fileutil::relative ${::osvvm::CurrentSimulationDirectory} [file normalize ${::osvvm::CurrentWorkingDirectory}]]"
+  puts $FileHandle "-- This file is autogenerated by CreateBuildSettingsPkg" 
+  puts $FileHandle "package ${BaseName}SettingsPkg is" 
+  puts $FileHandle "  constant LOCAL_SCRIPT_DIR         : string := \"${LocalScriptDir}\" ;"
+  puts $FileHandle "  constant TEST_SUITE_NAME          : string := \"${::osvvm::TestSuiteName}\" ;"
+  # Should be in top level OsvvmSettings
+  puts $FileHandle "  constant RESULTS_DIR              : string := \"${::osvvm::ResultsDirectory}\" ;"
+  if {$::osvvm::Debug} {
+    puts $FileHandle "  constant MIRROR_ENABLE            : boolean := TRUE ;"
+  } else {
+    puts $FileHandle "  constant MIRROR_ENABLE            : boolean := FALSE ;"
+  }
+  puts $FileHandle "end package ${BaseName}SettingsPkg ;" 
+  close $FileHandle
+  if {[FileDiff $TestSettingsPkgFile $NewFileName]} {
+    file rename -force $NewFileName $TestSettingsPkgFile
+  } else {
+    file delete -force $NewFileName
+  }
+  analyze $TestSettingsPkgFile
+  return $TestSettingsPkgFile
+}
+
 # AutoGenerateFile 
 #    Extract from FileName everything up to and including the pattern in the string
 #    Write Extracted contents to NewFileName
@@ -143,7 +227,7 @@ proc FileDiff {File1 File2} {
 # Don't export the following due to conflicts with Tcl built-ins
 # map
 
-namespace export CreateOsvvmScriptSettingsPkg FindOsvvmSettingsDirectory
+namespace export CreateOsvvmScriptSettingsPkg FindOsvvmSettingsDirectory CreateAndAnalyzeTestSettingsPkg