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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385 | ###############################################################################
# Copyright (c) 2021-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
# Highlight And Remove Devices
# @section
# GUI Specific Userware Examples
# @description
# Highlight and remove PODE and DUMMY devices by model/cell name patterns.
# Highlight devices py parameter name patterns.
# @files
# cust39/highlightAndRemoveDevices.tcl
# @tag
# gui zdb
###############################################################################
namespace eval HighlightAndRemoveDevices {
}
# =============================================================================
# Init - Initialize the Userware, e.g. set configuration, extend the main menu.
# =============================================================================
#
proc HighlightAndRemoveDevices::Init {} {
variable _HighlightColor
variable _ModelNamePatterns
variable _ParameterPatterns
variable _CheckModelParameters
##
# The highlight color to be used.
# 0=red, 1=green, 2=blue, ...
#
set _HighlightColor 1
##
# List of case sensitive, glob-style patterns for pode/dummy model/cell
# matching.
# May be extended by additional patterns.
#
set _ModelNamePatterns {
"*pode_*_mac"
}
##
# List of case sensitive, glob-style patterns for parameter matching.
# May be extended by additional patterns.
#
set _ParameterPatterns {
"*_SCPD_*"
}
##
# If 1, check instance parameters as well as model parameters,
# if 0, only check instance parameters.
#
set _CheckModelParameters 1
##
# Extend the main menu with an "Highlight And Remove Devices" entry.
#
gui menu mainMenu "Highlight And Remove Devices"
gui menu command \
{"Highlight And Remove Devices" {Highlight by Name}} \
HighlightAndRemoveDevices::HighlightDevicesByModelName
gui menu command \
{"Highlight And Remove Devices" {Remove by Name}} \
HighlightAndRemoveDevices::RemoveDevicesByModelName
gui menu command \
{"Highlight And Remove Devices" {Highlight by Parameters}} \
HighlightAndRemoveDevices::HighlightDevicesByParameters
}
# =============================================================================
# HighlightDevicesByModelName - Highlight all device instances whose model/cell
# name matches one of the _ModelNamePatterns
# =============================================================================
#
proc HighlightAndRemoveDevices::HighlightDevicesByModelName {} {
variable _HighlightColor
variable _ModelNamePatterns
##
# No DB => nothing to do.
#
set db [gui database get]
if {$db == {}} {
return
}
##
# Clear all highlights.
#
$db hilight * deleteAll
##
# Mark all cells matching one of the "_ModelNamePatterns" with the
# "target" flag.
#
FlagCellsByName $db $_ModelNamePatterns target
##
# Highlight all instances of "target"-flagged cells.
#
$db foreach module module_oid {
$db foreach inst $module_oid inst_oid {
set cell_oid [$db oid down $inst_oid]
if {[$db flag $cell_oid is target]} {
$db hilight $inst_oid set $_HighlightColor
}
}
}
##
# Inform the GUI about highlight changes.
#
gui highlight changed
}
# =============================================================================
# RemoveDevicesByModelName - Remove all device instances whose model/cell name
# matches one of the _ModelNamePatterns
# =============================================================================
#
proc HighlightAndRemoveDevices::RemoveDevicesByModelName {} {
variable _ModelNamePatterns
##
# No DB => nothing to do.
#
set db [gui database get]
if {$db == {}} {
return
}
##
# Mark all cells matching one of the "_ModelNamePatterns" with the
# "target" flag.
#
FlagCellsByName $db $_ModelNamePatterns target
##
# Set the "zombie" flag at all instances of "target"-flagged cells, e.g.
# mark them for deletion.
#
$db foreach module module_oid {
$db foreach inst $module_oid inst_oid {
set cell_oid [$db oid down $inst_oid]
if {[$db flag $cell_oid is target]} {
$db flag $inst_oid set zombie
}
}
}
##
# Delete all "zombie"-flagged instances.
#
$db deleteZombies
##
# Inform the GUI about the DB modification.
#
gui database modified
}
# =============================================================================
# HighlightDevicesByParameters -
#
# Highlight all device instances whose parameters/attributes or
# parameters/attributes of the instantiated model/cell match one of the
# _ParameterPatterns.
# =============================================================================
#
proc HighlightAndRemoveDevices::HighlightDevicesByParameters {} {
variable _HighlightColor
variable _ParameterPatterns
variable _CheckModelParameters
##
# No DB => nothing to do.
#
set db [gui database get]
if {$db == {}} {
return
}
##
# Clear all highlights.
#
$db hilight * deleteAll
##
# Remove all "target" flags.
#
$db foreach cell cell_oid {
$db flag $cell_oid clear target
}
##
# Mark all empty cells whose parameters match one of $ParameterPatterns
# with the "target" flag.
#
if {$_CheckModelParameters} {
$db foreach cell cell_oid {
if {[$db isEmpty $cell_oid] &&
[MatchParameters $db $cell_oid $_ParameterPatterns]
} {
$db flag $cells_oid set target
}
}
}
##
# Iterate over all empty cell instances in all modules, inspect their
# parameters, highlight them.
#
$db foreach module module_oid {
$db foreach inst $module_oid inst_oid {
##
# Get the instantiated cell.
#
set cell_oid [$db oid down $inst_oid]
##
# Skip non-empty cells.
#
if {![$db isEmpty $cell_oid]} {
continue
}
if {$_CheckModelParameters} {
##
# Check "target" flag of the instantiated cell.
#
if {[$db flag $cell_oid is target]} {
$db hilight $inst_oid set $_HighlightColor
continue
}
}
##
# Check the instance's parameters.
#
if {[MatchParameters $db $inst_oid $_ParameterPatterns]} {
$db hilight $inst_oid set $_HighlightColor
}
}
}
##
# Inform the GUI about highlight changes.
#
gui highlight changed
}
# =============================================================================
# FlagCellsByName - Mark all empty cells matching one of the
# "$patterns" with the "$flag" flag.
# =============================================================================
#
proc HighlightAndRemoveDevices::FlagCellsByName {
db
patterns
flag
} {
$db foreach cell cell_oid {
##
# Clear the flag.
#
$db flag $cell_oid clear $flag
##
# Skip non-empty cells.
#
if {![$db isEmpty $cell_oid]} {
continue
}
##
# Get the cell's name.
#
set name [$db oid oname $cell_oid]
##
# Try to match the name with at least one pattern from
# $patterns. Flag matching cells.
#
foreach pattern $patterns {
if {[string match $pattern $name]} {
$db flag $cell_oid set $flag
break
}
}
}
}
# =============================================================================
# MatchParameters - Return 1 if one of the $patterns matches attributes of the
# netlist object referenced by $oid. Return 0 otherwise.
# =============================================================================
#
proc HighlightAndRemoveDevices::MatchParameters {
db
oid
patterns
} {
##
# Iterate over the attributes of the object (SPICE parameters are stored in
# attributes!).
# Skip internal attributes.
# Check attribute keys against all $patterns.
#
$db attr $oid foreach attribute {
if {[IsInternalAttribute $attribute]} {
continue
}
set key [GetAttributeKey $attribute]
foreach pattern $patterns {
if {[string match $pattern $key]} {
return 1
}
}
}
return 0
}
# =============================================================================
# IsInternalAttribute - Return 1 if the given $attribute is an internal
# attribute.
# =============================================================================
#
proc HighlightAndRemoveDevices::IsInternalAttribute {
attribute
} {
##
# Internal attributes start with "$", "@", or "!".
#
return [expr {[string range $attribute 0 0] in {"$" "@" "!"}}]
}
# =============================================================================
# GetAttributeKey - Extract the key from the $attribute.
# =============================================================================
#
proc HighlightAndRemoveDevices::GetAttributeKey {
attribute
} {
##
# Attributes have the form "KEY=VALUE".
# Find the first "=" and extract the key.
#
set pos [string first "=" $attribute]
if {$pos < 0} {
return ""
}
return [string range $attribute 0 [expr {$pos - 1}]]
}
# =============================================================================
# Call the initialization procedure.
# =============================================================================
#
HighlightAndRemoveDevices::Init
|