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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265 | ###############################################################################
# Copyright (c) 2004-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
# Dump Hierarchy
# @namespace
# DumpHier
# @section
# Create Reports
# @description
# Dump hierarchy information to a text file.
#
# Right click on a hierarchical instance or module to invoke the `Dump
# Hierarchy` function from the Userware Popup menu.
# This function will write hierarchy information starting from the
# selected object.
#
# From the Userware main menu the `Dump Hierarchy Tree` function can be
# used to dump the hierarchy tree for each top module.
# @configuration
# @files
# dumpHier.tcl
# @example
# demo/rtl/aquarius/aquarius.f
# @cmdline
# -F @example[0]
# -userware @files[0]
# @tag
# gui zdb report
###############################################################################
# =============================================================================
# Init - Initialize the plugin.
# =============================================================================
#
proc DumpHier:Init {} {
##
# Add configuration.
#
gui plugin addConfig DumpHier depthLimit 0 number \
"Levels of Hierarchy to dump (0 for all)."
##
# Append "Dump Hierarchy" to the Popup menu and add a customization
# callback to disable the menu entry if no hierarchical instance is
# selected.
#
gui popup append "Dump Hierarchy" "DumpHier:Start"
gui popup customize "DumpHier:_customizePopup"
##
# Append "Dump Hierarchy Tree" to the main menu.
#
gui menu command {"Userware" "Dump Hierarchy Tree"} "DumpHier:StartTree"
}
# =============================================================================
# Finit - Finalize the plugin.
# =============================================================================
#
proc DumpHier:Finit {} {
##
# Undo modifications of the GUI.
#
gui popup remove "Dump Hierarchy"
gui popup removeCustomize "DumpHier:_customizePopup"
gui menu removeEntry {"Userware" "Dump Hierarchy Tree"}
}
# =============================================================================
# Start - Open a getSaveFile dialog and call _printHier for every module or
# hierarchical instance OID in oidList.
# =============================================================================
#
proc DumpHier:Start {oidList} {
set db [gui database get]
if {$db == {}} {
return
}
if {$oidList == {}} {
return
}
set file [gui window fileDialog saveFile "Dump Hierarchy to File" {}]
if {$file == "" } {
return
}
set depthLimit [gui plugin getConfigValue DumpHier depthLimit]
set out [open $file w]
foreach oid $oidList {
switch -exact -- [$db oid type $oid] {
"inst" {
if {![$db isModule $oid]} {
continue
}
set module [$db moduleOf $oid]
}
"module" {
set module $oid
}
default {
continue
}
}
set nodeText "[$db oid oname $oid]([$db oid module $module])"
puts $out "[DumpHier:_indent 0]$nodeText"
DumpHier:_printHier $db $module $out 1 $depthLimit
}
close $out
}
# =============================================================================
# StartTree - Open a getSaveFile dialog and dump the hierarchy tree for each
# top module.
# =============================================================================
#
proc DumpHier:StartTree {} {
set db [gui database get]
if {$db == {}} {
return
}
set file [gui window fileDialog saveFile "Dump Hierarchy Tree to File" {}]
if {$file == "" } {
return
}
set out [open $file w]
##
# Loop over all tops and call _traverse for each top.
#
set depthLimit [gui plugin getConfigValue DumpHier depthLimit]
$db foreach top top {
puts $out "[DumpHier:_indent 0][$db oid oname $top]"
DumpHier:_traverse $db $out $top 1 $depthLimit
}
close $out
}
# -----------------------------------------------------------------------------
# _printHier - Print next level of hierarchy to the file out.
# If a child is a node then call this procedure recursive.
# -----------------------------------------------------------------------------
#
proc DumpHier:_printHier {db node out level limit} {
if {$limit && ($level > $limit)} {
return
}
$db htree foreachClass $node child type clabel ilabel {
$db htree foreachInst $child ilabel {
puts $out "[DumpHier:_indent $level]${ilabel}($clabel)"
if {[expr $type & 1]} {
DumpHier:_printHier $db $child $out [incr level] $limit
incr level -1
}
}
}
}
# -----------------------------------------------------------------------------
# _traverse - Print next level of hierarchy to the file out.
# If a child is a node then call this procedure recursive.
# -----------------------------------------------------------------------------
#
proc DumpHier:_traverse {db out top indent limit} {
if {$limit && ($indent > $limit)} {
return
}
$db foreach inst $top inst {
if {![$db isModule $inst]} {
continue
}
set mod [$db moduleOf $inst]
set modName [$db oid oname $mod]
set instName [$db oid oname $inst]
puts $out "[DumpHier:_indent $indent]$instName \($modName\)"
DumpHier:_traverse $db $out $mod [incr indent] $limit
incr indent -1
}
}
# -----------------------------------------------------------------------------
# _indent - Calculate the indent for the output, each level is indented
# by 4 blank chars.
# -----------------------------------------------------------------------------
#
proc DumpHier:_indent {indent} {
return [string repeat " " [expr {$indent * 4}]]
}
# -----------------------------------------------------------------------------
# _customizePopup - Disable the added Popup menu entries if no hierarchical
# instance is selected.
# -----------------------------------------------------------------------------
#
proc DumpHier:_customizePopup {menu oidList} {
set enable 0
set db [gui database get]
if {$db == {}} {
return
} else {
foreach oid $oidList {
switch -exact -- [$db oid type $oid] {
"inst" {
if {[$db isModule $oid]} {
set enable 1
} else {
if {!$enable} {
set enable 0
}
}
}
"module" {
set enable 1
}
default {
if {!$enable} {
set enable 0
}
}
}
}
}
if {$enable} {
set state "normal"
} else {
set state "disabled"
}
set subMenu [$menu entrycget "Userware" -menu]
$subMenu entryconfigure "Dump Hierarchy" -state $state
}
# =============================================================================
# Call the initialization procedure.
# =============================================================================
#
DumpHier:Init
|