StartUp.tcl

#  File Name:         StartUp.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   
# 
#  Description
#    Tcl procedures to configure and adapt the OSVVM simulator 
#    scripting methodology for a particular project.
#    As part of its tasks, it runs OSVVM scripts that define
#    procedures use in the OSVVM scripting methodology.
#    
#  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
#    07/2024   2024.07    Added detection for Siemen's Visualizer 
#    05/2022   2022.05    Refactored StartUp.tcl to move items 
#                         shared by all StartUp scripts to StartUpShared.tcl
#    01/2022   2022.01    New StartUp algorithm for detecting ActiveHDL's VSimSA.
#    10/2021   2021.10    Loads YAML utilities when YAML library available: OsvvmYamlSupport.tcl, NoYamlPackage.tcl
#                         Loads LocalScriptDefaults.tcl if it is in the OsvvmScriptDirectory.  This is a optional user settings file.
#                         LocalScriptsDefaults.tcl is not provided by OSVVM so your local settings will not be overwritten.  
#     2/2021   2021.02    Refactored.                                                          
#                         - Tool now determined in here (was in ToolConfiguration.tcl). 
#                            - Simplifies ActiveHDL startup
#                         - Initial tool settings now in VendorScripts_*.tcl (was in ToolConfiguration.tcl)              
#                         - Added: Default settings now in OsvvmScriptDefaults.tcl (was here)         
#                         - Removed: ToolConfiguration.tcl (now in StartUp.tcl and VendorScripts_*.tcl)                                
#     7/2020   2020.07    Refactored tool execution for simpler vendor customization
#     2/2020   2020.02    Moved tool determination to outer layer
#     1/2020   2020.01    Updated Licenses to Apache
#     2/2019   Beta       Project descriptors in .pro which execute 
#    11/2018   Alpha      Project descriptors in .files and .dirs files
#                         as TCL scripts in conjunction with the library 
#                         procedures
#
#
#  This file is part of OSVVM.
#  
#  Copyright (c) 2018 - 2022 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.
#


namespace eval ::osvvm {
  # Default OsvvmScriptDirectory setup - revised for ActiveHDL VSimSA
  variable OsvvmScriptDirectory  [file dirname [file normalize [info script]]]
  variable OsvvmInitialized  "false"
  
  # 
  # Determine simulator from name of executable and settings
  #   Primarily this only applies to simulators that run from a GUI
  #
  variable ToolExecutable [info nameofexecutable]
  variable ToolExecutableName [file rootname [file tail $ToolExecutable]]

  if {[info exists ::env(OSVVM_TOOL)]} {
    variable ScriptBaseName $::env(OSVVM_TOOL)
    
  } elseif {[info exists aldec]} {
    variable ToolFamily [lindex [split [vsim -version]] 2]
    if {$ToolFamily eq "Riviera-PRO"} { 
      variable ScriptBaseName   "RivieraPro"

    } elseif {[string match -nocase $ToolExecutableName "vsimsa"]} {
      if {![info exists ScriptBaseName]} {
        set OsvvmScriptDirectory [file dirname [string trim $argv0 ?{}?]]
      } 
      variable ScriptBaseName   "VSimSA"

    } else {
      variable ScriptBaseName   "ActiveHDL"
    }
    
  } elseif {$ToolExecutableName eq "vish" || $ToolExecutableName eq "vsimk"} {
    variable ScriptBaseName "Siemens"

#    if {![catch {vsimId} msg]} {
#      variable ToolVersion [vsimId]
#    } else {
#      set VersionString [exec vsim -version &2>1]
#      regexp {(vsim\s+)(\d+\.\d+\S*)} $VersionString s1 s2 s3
#      variable ToolVersion $s3
#    }

    # if {[expr [string compare $ToolVersion "2025.2"] >= 0]} { }  ;# if next code is universally supported keep it.
    if {![catch {qsim -version} msg]} {
      variable ScriptBaseName "Questa"
    }
    
  } elseif {$ToolExecutableName eq "hdlclient"} {
#    variable ScriptBaseName "Visualizer"
    variable ScriptBaseName "Questa"
    
  } elseif {[string match -nocase $ToolExecutableName "vivado"]} {
    variable ScriptBaseName "Vivado"

  } elseif {[info exist ::nvc_dataDir]} {
    variable ScriptBaseName "NVC"

  } else {
    variable ScriptBaseName "GHDL"

  }
}

source ${::osvvm::OsvvmScriptDirectory}/StartUpShared.tcl

set ::osvvm::OsvvmInitialized "true"

puts -nonewline ""  ; # suppress printing of true from above line