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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
###############################################################################
# Copyright (c) 2022-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.
# =============================================================================
#   @plugin
#       Unfold Hierarchy in Schem
#   @namespace
#       UnfoldHierarchy
#   @section
#       GUI Specific Userware Examples
#   @description
#       Unfold the visible hierarchy modules in the Schem window.
#   @files
#       unfoldHierarchy.tcl
#   @example
#       demo/rtl/aquarius/aquarius.f
#   @cmdline
#       -F @example[0]
#       -userware @files[0]
#   @tag
#       gui
###############################################################################

namespace eval UnfoldHierarchy {
    variable _CurrentModule
    variable _CurrentDepth
}


# =============================================================================
# Init - Initialize the plugin.
# =============================================================================
#
proc UnfoldHierarchy::Init {} {
    variable _CurrentModule
    variable _CurrentDepth

    gui menu command {"Unfold Hierarchy" "Unfold at One Level"} \
        [list UnfoldHierarchy::UnfoldModules]
    gui menu command {"Unfold Hierarchy" "More"} \
        [list UnfoldHierarchy::UnfoldMoreModules]

    gui menu command {"Unfold Hierarchy" "Fold All"} \
        [list UnfoldHierarchy::FoldModules]

    set _CurrentModule [gui schem getCurrentModule]
    set _CurrentDepth  0
}


# =============================================================================
# Finit - Finalize the plugin.
#         This procedure is automatically called when deactivating the plugin.
# =============================================================================
#
proc UnfoldHierarchy::Finit {} {
    gui menu removeEntry {"Unfold Hierarchy" "Unfold at One Level"}
    gui menu removeEntry {"Unfold Hierarchy" "More"}
    gui menu removeEntry {"Unfold Hierarchy" "Fold All"}
}


# =============================================================================
# UnfoldModules - Unfold the hierarchy of the current module
# =============================================================================
#
proc UnfoldHierarchy::UnfoldModules {} {
    variable _CurrentModule
    variable _CurrentDepth

    set module [gui schem getCurrentModule]
    set db     [gui database get]
    set _CurrentDepth 0

    ##
    # Iterate over all instances in the current module and unfold them.
    #
    zprogress begin
    unfoldHierarchyModule $module 0
    zprogress end

    ##
    # Store the info.
    #
    set _CurrentDepth 1
    set _CurrentModule $module
}


# =============================================================================
# FoldModules - Fold the hierarchy of the current module
# =============================================================================
#
proc UnfoldHierarchy::FoldModules {} {
    variable _CurrentModule
    variable _CurrentDepth

    set module [gui schem getCurrentModule]
    set db     [gui database get]

    ##
    # Iterate over all instances in the current module and unfold them.
    #
    $db foreach inst $module inst {
        set subModule [$db oid down $inst]

        ##
        # If the current inst is not a hierarchical module continue.
        #
        if {[$db oid type $subModule] ne "module"} {
            continue
        }

        gui schem fold [list $inst]
    }

    ##
    # Store the info.
    #
    set _CurrentDepth 0
    set _CurrentModule $module
}


# =============================================================================
# UnfoldMoreModules - Unfold the hierarchy of the current module
# =============================================================================
#
proc UnfoldHierarchy::UnfoldMoreModules {} {
    variable _CurrentModule
    variable _CurrentDepth

    set module [gui schem getCurrentModule]
    set db     [gui database get]

    ##
    # If module has been changed, reset internal storage.
    #
    if {$_CurrentModule != $module} {
        set _CurrentModule $module
        set _CurrentDepth  0
    }

    zprogress begin

    unfoldHierarchyModule $module 0
    incr _CurrentDepth

    zprogress end
}


# -----------------------------------------------------------------------------
# unfoldHierarchyModule - Unfold the hierarchy of the current module
# -----------------------------------------------------------------------------
#
proc UnfoldHierarchy::unfoldHierarchyModule {module depth} {
    variable _CurrentDepth

    set db [gui database get]

    set total [$db count inst $module]
    set progress 0

    $db foreach inst $module inst {
        ##
        # Get the module of the current inst.
        #
        set subModule [$db oid down $inst]

        ##
        # Update the progress.
        #
        zprogress push "Unfolding hierarchy modules" \
            [expr {double($progress)/double($total)}]

        ##
        # If the current inst is not a hierarchical module continue.
        #
        if {[$db oid type $subModule] ne "module"} {
            incr progress
            zprogress pop

            continue
        }

        gui schem unfold [list $inst]

        if {$depth < $_CurrentDepth} {
            unfoldHierarchyModule $subModule [expr {$depth + 1}]
        }

        incr progress
        zprogress pop
    }
}


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