cust22/saveView.tcl

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
###############################################################################
# Copyright (c) 2010-2024 by Altair Engineering, Inc.
# All rights reserved.
#
# Altair Engineering, Inc. makes this software available as part of the Vision
# tool platform.  As long as you are a licensee of the Vision tool platform
# you may make copies of the software and modify it to be used within the
# Vision tool platform, but you must include all of this notice on any copy.
# Redistribution without written permission to any third party, with or
# without modification, is not permitted.
# Altair Engineering, Inc. does not warrant that this software is error free
# or fit for any purpose.  Altair Engineering, Inc. disclaims any liability for
# all claims, expenses, losses, damages and costs any user may incur as a
# result of using, copying or modifying the software.
# =============================================================================
#   @userware
#       Save/Restore Schematic Layout and Highlighting Colors
#   @section
#       Miscellaneous Userware Examples
#   @description
#       This script combines:
#       - preplace.tcl: save/restore the current schematic layout
#       - saveHilight.tcl: save/restore highlight information
#       - saveRotation.tcl: save/restore module rotation and pin orientation
#   @files
#       cust22/saveView.tcl
#   @example
#       demo/rtl/aquarius/aquarius.f
#   @cmdline
#       -F @example[0]
#       -userware @files[0]
#   @tag
#       gui zdb
###############################################################################


set usedAsSubmodule true
source [file join [file dirname [info script]] ../preplace.tcl]
source [file join [file dirname [info script]] ../saveHilight.tcl]
source [file join [file dirname [info script]] ../saveRotation.tcl]
unset usedAsSubmodule

##
# Configuration for loaded plugins
#
set SaveRestoreView(restoreHighlightsToMemWindow) true
set SaveRestoreView(overwriteFilesEnabled) true


# =============================================================================
# Init - Initialize the plugin.
# =============================================================================
#
proc SaveRestoreView:Init {} {
    gui menu command {"Userware" "Save View"} SaveRestoreView:Save
    gui menu command {"Userware" "Restore View"} SaveRestoreView:_restore
}


# =============================================================================
# Finit - Finalize the plugin.
# =============================================================================
#
proc SaveRestoreView:Finit {} {
    gui menu removeEntry {"Userware" "Save View"}
    gui menu removeEntry {"Userware" "Restore View"}
}


# =============================================================================
# Save - Ask the user for a directory, get the config options and execute
#        - SaveRestoreLayout:Save   -> save layout
#        - SaveHighlights:Save      -> save highlighting
#        - SaveRestoreRotation:Save -> save module rotation and pin orientation
# =============================================================================
#
proc SaveRestoreView:Save {} {
    global SaveRestoreView

    ##
    # Ask the user for the target directory.
    #
    set dir [gui window fileDialog chooseDir "Select Output Directory" {}]
    if {$dir == {}} {
        return
    }

    ##
    # 1. Run preplace
    #
    SaveRestoreLayout:Save $dir $SaveRestoreView(overwriteFilesEnabled)

    ##
    # 2. Save highlighting
    #
    set db [gui database get]
    set topmodule [$db get_top_design -name]
    set fname [file join $dir "$topmodule highlight.tcl"]
    SaveHighlights:Save $fname $SaveRestoreView(restoreHighlightsToMemWindow)

    ##
    # 3. Save rotation/pin orientation
    #
    SaveRestoreRotation:Save $dir $SaveRestoreView(overwriteFilesEnabled)
}


# -----------------------------------------------------------------------------
# _restore - Ask the user for a directory and execute
#            - SaveRestoreLayout:Restore   -> restore layout
#            - SaveHighlights:Restore      -> restore highlighting
#            - SaveRestoreRotation:Restore -> restore module rotation and
#            pin orientation
# -----------------------------------------------------------------------------
#
proc SaveRestoreView:_restore {{dir {}} {db {}}} {
    ##
    # Ask the user for the target directory.
    #
    set dir [gui window fileDialog chooseDir "Select Output Directory" {}]
    if {$dir == {}} {
        return
    }

    ##
    # 1. Load preplace
    #
    SaveRestoreLayout:Restore $dir

    ##
    # 2. Load highlighting
    #
    set db [gui database get]
    set topmodule [$db get_top_design -name]
    set fname [file join $dir "$topmodule highlight.tcl"]
    SaveHighlights:Restore $fname

    ##
    # 3. Load rotation/pin orientation
    #
    SaveRestoreRotation:Restore $dir $db
}


# =============================================================================
# Call the initialization procedure.
# =============================================================================
#
SaveRestoreView:Init