Updated naming in YAML files

OSVVM · Jul 7, 2024 · 102f564 · 102f564
1 parent 20facca
commit 102f564
Show file tree

Hide file tree

Showing 7 changed files with 32 additions and 32 deletions.
diff --git a/OsvvmScriptsCore.tcl b/OsvvmScriptsCore.tcl
@@ -416,7 +416,7 @@ proc LocalBuild {BuildName Path_Or_File args} {
 
   puts "build $Path_Or_File"                      ; # EchoOsvvmCmd
 
-  CopyCssAndPngFiles ${::osvvm::OsvvmScriptDirectory} ${::osvvm::OutputBaseDirectory} $::osvvm::CssSubdirectory
+  CopyHtmlThemeFiles ${::osvvm::OsvvmScriptDirectory} ${::osvvm::OutputBaseDirectory} $::osvvm::HtmlThemeSubdirectory
   StartBuildYaml $BuildName
 
   CallbackBefore_Build ${Path_Or_File}
@@ -1041,7 +1041,7 @@ proc simulate {LibraryUnit args} {
   set SavedInteractive [GetInteractiveMode] 
   if {!($::osvvm::BuildStarted)} {
     SetInteractiveMode "true"
-    CopyCssAndPngFiles ${::osvvm::OsvvmScriptDirectory} ${::osvvm::OutputBaseDirectory} $::osvvm::CssSubdirectory
+    CopyHtmlThemeFiles ${::osvvm::OsvvmScriptDirectory} ${::osvvm::OutputBaseDirectory} $::osvvm::HtmlThemeSubdirectory
   }
 
   set SimulateErrorCode [catch {LocalSimulate $LibraryUnit {*}$args} SimErrMsg]
@@ -1993,45 +1993,45 @@ proc SimulateDoneMoveTestCaseFiles {} {
     file delete -force -- ${::osvvm::TranscriptYamlFile}
   }
 
-##  CopyCssAndPngFiles ${::osvvm::OsvvmScriptDirectory} ${::osvvm::OutputBaseDirectory} $::osvvm::CssSubdirectory
-#  FindCssPngFiles ${::osvvm::OutputBaseDirectory} $::osvvm::CssSubdirectory
+##  CopyHtmlThemeFiles ${::osvvm::OsvvmScriptDirectory} ${::osvvm::OutputBaseDirectory} $::osvvm::HtmlThemeSubdirectory
+#  FindHtmlThemeFiles ${::osvvm::OutputBaseDirectory} $::osvvm::HtmlThemeSubdirectory
 #  
 #  if {([GetTranscriptType] eq "html") && ($BuildName ne "")} {
 #    set SimulationHtmlLogFile [file join ${::osvvm::LogSubdirectory} ${BuildName}_log.html]
 #  } else { set SimulationHtmlLogFile "" }
 }
 
 # -------------------------------------------------
-# CopyCssAndPngFiles
+# CopyHtmlThemeFiles
 #
-proc CopyCssAndPngFiles {CssSourceDirectory BaseDirectory CssTargetSubdirectory} {
+proc CopyHtmlThemeFiles {HtmlThemeSourceDirectory BaseDirectory HtmlThemeTargetSubdirectory} {
   variable Report2CssFiles
   variable Report2PngFile
 
-  CreateDirectory [file join $BaseDirectory  $CssTargetSubdirectory]
+  CreateDirectory [file join $BaseDirectory  $HtmlThemeTargetSubdirectory]
 
   # Note files are linked into the HTML in glob order (alphabetical but may be OS dependent WRT upper case)
-  set CssFiles [glob -nocomplain [file join ${CssSourceDirectory} *.css]]
+  set CssFiles [glob -nocomplain [file join ${HtmlThemeSourceDirectory} *.css]]
   set Report2CssFiles ""
   if {$CssFiles ne ""} {
     foreach CssFileWithPath ${CssFiles} {
-      set CssFile [file join $CssTargetSubdirectory [file tail $CssFileWithPath]]
+      set CssFile [file join $HtmlThemeTargetSubdirectory [file tail $CssFileWithPath]]
       file copy -force ${CssFileWithPath}  [file join $BaseDirectory  $CssFile]
       # HTML file is relative to the BaseDirectory
       lappend Report2CssFiles $CssFile
     }
   }
 
   # There should only be one *.png file.
-  set PngFiles [glob -nocomplain [file join ${CssSourceDirectory} *.png]]
+  set PngFiles [glob -nocomplain [file join ${HtmlThemeSourceDirectory} *.png]]
   set LastPngFile ""
   if {$PngFiles ne ""} {
     foreach PngFileWithPath ${PngFiles} {
       set LastPngFile $PngFileWithPath
     }
   }
   # There should be only one PNG file, so only copy the last one we find.
-  set PngDestFile [file join $CssTargetSubdirectory [file tail $LastPngFile]]
+  set PngDestFile [file join $HtmlThemeTargetSubdirectory [file tail $LastPngFile]]
   file copy -force ${LastPngFile} [file join $BaseDirectory $PngDestFile]
   set Report2PngFile $PngDestFile
 }

diff --git a/OsvvmScriptsCreateYamlReports.tcl b/OsvvmScriptsCreateYamlReports.tcl
@@ -158,7 +158,7 @@ proc WriteOsvvmSettingsYaml {ReportFile} {
   puts  $ReportFile "OsvvmSettingsInfo:"
   puts  $ReportFile "  BaseDirectory:        \"$::osvvm::OutputBaseDirectory\""
   puts  $ReportFile "  ReportsSubdirectory:  \"$::osvvm::ReportsSubdirectory\""
-  puts  $ReportFile "  CssSubdirectory:      \"$::osvvm::CssSubdirectory\""  
+#  puts  $ReportFile "  HtmlThemeSubdirectory:      \"$::osvvm::HtmlThemeSubdirectory\""  
   if {$::osvvm::TranscriptExtension ne "none"} {
     puts  $ReportFile "  SimulationLogFile: \"[file join ${::osvvm::LogSubdirectory} ${::osvvm::BuildName}.log]\""
   } else {
@@ -170,10 +170,10 @@ proc WriteOsvvmSettingsYaml {ReportFile} {
     puts  $ReportFile "  SimulationHtmlLogFile: \"\""
   }
 
-#   if {[catch {set CssPngSourceDirectoryRel [::fileutil::relative [pwd] $::osvvm::OsvvmScriptDirectory]} errmsg]}  {
-#     set CssPngSourceDirectoryRel $::osvvm::OsvvmScriptDirectory
+#   if {[catch {set HtmlThemeSourceDirectoryRel [::fileutil::relative [pwd] $::osvvm::OsvvmScriptDirectory]} errmsg]}  {
+#     set HtmlThemeSourceDirectoryRel $::osvvm::OsvvmScriptDirectory
 #   }
-#   puts  $ReportFile "  CssPngSourceDirectory:   \"${CssPngSourceDirectoryRel}\""
+#   puts  $ReportFile "  HtmlThemeSourceDirectory:   \"${HtmlThemeSourceDirectoryRel}\""
 
   if {[file exists [file join $::osvvm::ReportsDirectory ${::osvvm::BuildName}_req.yml]]} {
     puts  $ReportFile "  RequirementsSubdirectory: \"$::osvvm::ReportsSubdirectory\""
@@ -203,7 +203,7 @@ proc WriteTestCaseSettingsYaml {FileName} {
     WriteDictOfString2Yaml $YamlFile TestSuiteName
   }
   WriteDictOfString2Yaml $YamlFile BuildName $::osvvm::BuildName
-  WriteDictOfDict2Yaml   $YamlFile GenericDict $::osvvm::GenericDict
+  WriteDictOfDict2Yaml   $YamlFile Generics $::osvvm::GenericDict
 
   WriteDictOfString2Yaml $YamlFile TestSuiteDirectory    $::osvvm::TestSuiteDirectory
   WriteDictOfString2Yaml $YamlFile RequirementsYamlFile  $::osvvm::RequirementsYamlFile
@@ -281,7 +281,7 @@ proc FinishSimulateBuildYaml {} {
 
   set RunFile [open ${::osvvm::OsvvmBuildYamlFile} a]
   puts  $RunFile "        TestCaseFileName: \"$TestCaseFileName\""
-  WriteDictOfDict2Yaml $RunFile TestCaseGenerics $::osvvm::GenericDict  "        "
+  WriteDictOfDict2Yaml $RunFile Generics $::osvvm::GenericDict  "        "
 #  puts  $RunFile "        TestCaseGenerics: \"$::osvvm::GenericDict\""
   puts  $RunFile "        ElapsedTime: [format %.3f [expr ${SimulateElapsedTimeMs}/1000.0]]"
   close $RunFile

diff --git a/OsvvmSettingsRequired.tcl b/OsvvmSettingsRequired.tcl
@@ -117,8 +117,8 @@ namespace eval ::osvvm {
     variable ResultsDirectory     [file join ${OutputBaseDirectory} ${ResultsSubdirectory}]
     variable CoverageDirectory    [file join ${OutputBaseDirectory} ${CoverageSubdirectory}]
     variable LogDirectory         [file join ${OutputBaseDirectory} ${LogSubdirectory}]
-    variable CssSubdirectory      [file join ${ReportsSubdirectory}]
-    variable CssDirectory         [file join ${OutputBaseDirectory} ${CssSubdirectory}]
+    variable HtmlThemeSubdirectory      [file join ${ReportsSubdirectory}]
+    variable HtmlThemeDirectory         [file join ${OutputBaseDirectory} ${HtmlThemeSubdirectory}]
 
   #
   #  Initialize OSVVM Internals

diff --git a/ReportBuildDict2Html.tcl b/ReportBuildDict2Html.tcl
@@ -50,11 +50,11 @@ package require yaml
 
 #  Notes:  
 #  The following variables are set by GetPathSettings that read the YAML file
-#      Report2CssDirectory 
+#      Report2HtmlThemeDirectory 
 #      Report2BaseDirectory
 #      Report2ReportsSubdirectory
 #      Report2LogSubdirectory
-#      Report2CssPngSourceDirectory
+#      Report2HtmlThemeSourceDirectory
 #      Report2RequirementsSubdirectory - value is "" if requirements not used
 #      Report2CoverageSubdirectory - value is "" if coverage not used
 #
@@ -367,8 +367,8 @@ proc CreateTestCaseSummaries {TestDict} {
         }
         set TestCaseHtmlFile [file join ${ReportsDirectory} ${TestFileName}.html]
         set TestCaseName $TestName
-        if { [dict exists $TestCase TestCaseGenerics] } { 
-          set TestCaseGenerics [dict get $TestCase TestCaseGenerics]
+        if { [dict exists $TestCase Generics] } { 
+          set TestCaseGenerics [dict get $TestCase Generics]
           if {${TestCaseGenerics} ne ""} {
             set GenericValueList [dict values $TestCaseGenerics] 
             set i 0

diff --git a/ReportBuildYaml2Dict.tcl b/ReportBuildYaml2Dict.tcl
@@ -49,11 +49,11 @@ package require yaml
 
 #  Notes:  
 #  The following variables are set by GetPathSettings that read the YAML file
-#      Report2CssDirectory 
+#      Report2HtmlThemeDirectory 
 #      Report2BaseDirectory
 #      Report2ReportsSubdirectory
 #      Report2LogSubdirectory
-#      Report2CssPngSourceDirectory
+#      Report2HtmlThemeSourceDirectory
 #      Report2RequirementsSubdirectory - value is "" if requirements not used
 #      Report2CoverageSubdirectory - value is "" if coverage not used
 #

diff --git a/ReportSupport.tcl b/ReportSupport.tcl
@@ -75,9 +75,9 @@ proc CreateOsvvmReportFooter {ResultsFile} {
 }
 
 # -------------------------------------------------
-# FindCssPngFiles
+# FindHtmlThemeFiles
 #
-# proc FindCssPngFiles {BaseDirectory CssTargetSubdirectory} {
+# proc FindHtmlThemeFiles {BaseDirectory CssTargetSubdirectory} {
 #   variable Report2CssFiles
 #   variable Report2PngFile
 #   
@@ -136,7 +136,7 @@ proc GetOsvvmPathSettings {TestDict} {
   set SettingsInfoDict                         [dict get $TestDict OsvvmSettingsInfo]
   variable Report2BaseDirectory                [dict get $SettingsInfoDict BaseDirectory]
   variable Report2ReportsSubdirectory          [dict get $SettingsInfoDict ReportsSubdirectory]
-  variable Report2CssSubdirectory              [dict get $SettingsInfoDict CssSubdirectory]
+#  variable Report2HtmlThemeSubdirectory              [dict get $SettingsInfoDict HtmlThemeSubdirectory]
   variable Report2SimulationLogFile            [dict get $SettingsInfoDict SimulationLogFile]
   variable Report2SimulationHtmlLogFile        [dict get $SettingsInfoDict SimulationHtmlLogFile]
   variable Report2RequirementsSubdirectory     [dict get $SettingsInfoDict RequirementsSubdirectory]
@@ -153,7 +153,7 @@ proc GetTestCaseSettings {SettingsFileName} {
   variable Report2TestCaseName                 [dict get $TestDict TestCaseName        ]
   variable Report2TestSuiteName                [dict get $TestDict TestSuiteName       ]
   variable Report2BuildName                    [dict get $TestDict BuildName           ]
-  variable Report2GenericDict                  [dict get $TestDict GenericDict         ]
+  variable Report2GenericDict                  [dict get $TestDict Generics            ]
 
   variable Report2TestCaseFileName             [dict get $TestDict TestCaseFileName    ]
   variable Report2GenericNames                 [dict get $TestDict GenericNames        ]

diff --git a/Requirements2Html.tcl b/Requirements2Html.tcl
@@ -95,8 +95,8 @@ proc RequirementsTableHeader { ReportName AdditionalPath } {
   puts $ResultsFile "<!DOCTYPE html>"
   puts $ResultsFile "<html lang=\"en\">"
   puts $ResultsFile "<head>"
-  puts $ResultsFile "  <link rel=\"stylesheet\" href=\"${AdditionalPath}../${::osvvm::CssSubdirectory}/CssOsvvmStyle.css\">"
-  puts $ResultsFile "  <link rel=\"stylesheet\" href=\"${AdditionalPath}../${::osvvm::CssSubdirectory}/Custom-Style.css\">"
+  puts $ResultsFile "  <link rel=\"stylesheet\" href=\"${AdditionalPath}../${::osvvm::HtmlThemeSubdirectory}/CssOsvvmStyle.css\">"
+  puts $ResultsFile "  <link rel=\"stylesheet\" href=\"${AdditionalPath}../${::osvvm::HtmlThemeSubdirectory}/Custom-Style.css\">"
   puts $ResultsFile "  <title>$ReportName Requirement Results</title>"
   puts $ResultsFile "</head>"
   puts $ResultsFile "<body>"
@@ -106,7 +106,7 @@ proc RequirementsTableHeader { ReportName AdditionalPath } {
   puts $ResultsFile "      <h1>$ReportName Requirement Results</h1>"
   puts $ResultsFile "    </div>"
   puts $ResultsFile "    <div class=\"requirements-logo\">"
-  puts $ResultsFile "      <img src=\"${AdditionalPath}../${::osvvm::CssSubdirectory}/OsvvmLogo.png\" alt=\"OSVVM logo\">"
+  puts $ResultsFile "      <img src=\"${AdditionalPath}../${::osvvm::HtmlThemeSubdirectory}/OsvvmLogo.png\" alt=\"OSVVM logo\">"
   puts $ResultsFile "    </div>"
   puts $ResultsFile "  </div>"
   puts $ResultsFile "</header>"