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 | ###############################################################################
# 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.
# =============================================================================
# @plugin
# Create Nomenclature
# @namespace
# CreateNomenclature
# @section
# Create Reports
# @description
# Create a list of instance names with their corresponding page and
# sector.
# If the instance has an attribute named 'PartValue' then the value of
# this attribute is added to the created instance list.
# @files
# cust12/nomenclature.tcl
# @example
# demo/rtl/aquarius/aquarius.f
# @cmdline
# -F @example[0]
# -userware @files[0]
# @tag
# zdb
###############################################################################
# =============================================================================
# Init - Initialize the plugin.
# =============================================================================
#
proc CreateNomenclature:Init {} {
gui menu command {"Userware" "Create Nomenclature (with Part value)"} \
{CreateNomenclature:Run}
}
# =============================================================================
# Finit - Finalize the plugin.
# =============================================================================
#
proc CreateNomenclature:Finit {} {
gui menu removeEntry {"Userware" "Create Nomenclature (with Part value)"}
}
# =============================================================================
# Run - Loop over all database modules, render the schematic and
# write a xref file for each module in dir.
# =============================================================================
#
proc CreateNomenclature:Run {} {
set db [gui database get]
##
# Return if the database is empty.
#
if {$db == {}} {
return
}
set outputDirectory [CreateNomenclature:_getPath]
if {$outputDirectory eq ""} {
return
}
set count 0
$db foreach module module {
set moduleName [$db oid oname $module]
##
# We got a module-based OID in $module but unfortunately, need
# a tree-based OID for the 'gui * setCurrentModule' command below.
# The "searchTreeBased" just returns one possible instance
# path to the given module.
#
set mod [$db oid searchTreeBased $module]
gui schem setCurrentModule -activate $mod
gui tree setCurrentModule $mod
update idletasks
set nlv [gui schem nlv]
$nlv property showframe 2
$nlv regenerate -resplit
set page_report {}
foreach pg [$nlv pages] {
$nlv show $pg
set hv [$nlv framecoords]
set hvec [lindex $hv 0]
set vvec [lindex $hv 1]
foreach inst [$nlv search -curpage inst * *] {
##
# query the placement point of the instance
#
set xy [$nlv getplacement -x -y $inst]
set x [lindex $xy 0]
set y [lindex $xy 1]
##
# Compute the horizontal frame coord h: A...Z
#
set i -1
set h "?"
set bbox [$nlv bbox $inst]
set width [expr {[lindex $bbox 2] - [lindex $bbox 0]}]
set height [expr {[lindex $bbox 3] - [lindex $bbox 1]}]
foreach l $hvec {
if {$x<$l} {
set h [format %c [expr 65+$i]]
break
}
incr i
}
##
# Compute the vertical frame coord v: 0...9
#
set i -1
set v "?"
set step 0
if {[llength $vvec] > 1} {
set step [expr {[lindex $vvec 1] - [lindex $vvec 0]}]
}
foreach t $vvec {
if {$y<$t && [expr {$y + $height}] < [expr {$t + $step}]} {
set v [format %c [expr 48+$i]]
break
}
incr i
}
set iName [lindex $inst end-2]
set cName [lindex $inst end-1]
set inst_report [list $iName $cName $pg ${h}${v}]
lappend page_report $inst_report
}
}
set outfile [file join $outputDirectory \
${moduleName}_xref_partValue.txt]
set o [open $outfile "w"]
set cNameLength 0
foreach element $page_report {
set len [string length [lindex $element 1]]
if {$len > $cNameLength} {set cNameLength $len}
}
puts $o [format "%-58s%10s %4s %s" "Instance (Cell)" "PartValue" \
"Page" "Sector"]
puts $o [string repeat "-" 80]
set page_report [lsort -index 0 -dictionary $page_report]
foreach element $page_report {
set inst [lindex $element 0]
set cell [lindex $element 1]
set page [lindex $element 2]
set sector [lindex $element 3]
set value ""
set zInst [$db search inst $mod $inst]
if {![$db oid isnull $zInst]} {
set value [$db attr $zInst getValue "PartValue"]
}
puts $o [format "%-58s%10s %4s %s" "$inst ($cell)" $value $page \
$sector]
}
close $o
incr count
}
gui console print "Created $count Instance-Xref \
files in '[file join $outputDirectory xref]'"
}
# -----------------------------------------------------------------------------
# _getPath - Get the output path.
# -----------------------------------------------------------------------------
#
proc CreateNomenclature:_getPath {} {
set path [gui window fileDialog chooseDir \
"Choose a Directory for xref Output" ""]
if {$path eq ""} {
return {}
}
##
# Check if path exists and is directory.
#
if {[file exists $path] && [file isdirectory $path]} {
return $path
}
if {[file exists $path]} {
error "File $path exists and is not a directory. Aborting."
}
file mkdir $path
return $path
}
# =============================================================================
# Call the initialization procedure.
# =============================================================================
#
CreateNomenclature:Init
|