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 | ###############################################################################
# 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
# Save/Restore Schematic Layout
# @namespace
# SaveRestoreLayout
# @section
# Miscellaneous Userware Examples
# @description
# Save/Restore the current schematic layout ('preplace' information)
# to/from a set of files.
# @configuration
# @files
# preplace.tcl
# @example
# demo/rtl/aquarius/aquarius.f
# @cmdline
# -F @example[0]
# -userware @files[0]
# @tag
# gui zdb
###############################################################################
# =============================================================================
# Init - Initialize the plugin.
# =============================================================================
#
proc SaveRestoreLayout:Init {argc argv} {
global SaveRestoreLayout
##
# Add selection box to config to allow overwriting existing files
#
gui plugin addConfig SaveRestoreLayout overwriteLayoutFiles 0 bool \
"Overwrite existing files"
gui menu command {"Userware" "Save Schematic Layout"} \
SaveRestoreLayout:Save
gui menu command {"Userware" "Restore Schematic Layout"} \
SaveRestoreLayout:Restore
set SaveRestoreLayout(callbackRegistered) 0
if {$argc == 1} {
set SaveRestoreLayout(callbackRegistered) \
[gui database runOrRegisterChangedCallback \
[list SaveRestoreLayout:Restore [lindex $argv 0]]]
}
}
# =============================================================================
# Finit - Finalize the plugin.
# =============================================================================
#
proc SaveRestoreLayout:Finit {} {
global SaveRestoreLayout
gui menu removeEntry {"Userware" "Save Schematic Layout"}
gui menu removeEntry {"Userware" "Restore Schematic Layout"}
if {$SaveRestoreLayout(callbackRegistered)} {
gui database removeChangedCallback SaveRestoreLayout:Restore
set SaveRestoreLayout(callbackRegistered) 0
}
}
# =============================================================================
# Save - save all available preplace data (from the database schematic cache)
# to Nlview files, named $modulename.nlv (only modules
# that have been displayed before have preplace data available).
# =============================================================================
#
proc SaveRestoreLayout:Save {{dir {}} {overwriteEnabled {}}} {
##
# Return if the database is empty.
#
set db [gui database get]
if {$db == {}} {
return
}
if {$overwriteEnabled == {}} {
set overwriteEnabled [gui plugin getConfigValue SaveRestoreLayout \
overwriteLayoutFiles]
} elseif {![string is boolean $overwriteEnabled]} {
zmessage print ERR \
"Expected type boolean for overwriteEnabled: $overwriteEnabled"
set overwriteEnabled false
}
##
# Return if no directory was selected.
#
if {$dir == {}} {
##
# Ask the user for the target directory.
#
set dir [gui window fileDialog chooseDir "Select Output Directory" {}]
if {$dir == {}} {
return
}
}
##
# Create directory if it is not present yet.
#
if {![file exists $dir]} {
file mkdir $dir
}
$db foreach module mod {
set data [$db oid getSchematicCache $mod]
if {[string bytelength $data] == 0} {
continue
}
set name [$db oid module $mod]
set fname [file join $dir $name.nlv]
if {[file exists $fname] && (!$overwriteEnabled)} {
zmessage print WAR \
"Skipping module $name, file already exists: $fname"
continue
}
set f [open $fname wb]
puts -nonewline $f $data
close $f
zmessage print DBG "Saved preplace data in $fname"
}
zmessage print DBG "Saving preplace information done"
}
# =============================================================================
# Restore - After reading in a new design (and defining a new database)
# this procedure will check for each database module, if it
# can find a file named $modulename.nlv - and if so it will
# read expected preplace data from that file and store it
# in the database schematic cache. This has the effect, that
# whenever a module is displayed, that preplace information
# will apply.
# =============================================================================
#
proc SaveRestoreLayout:Restore {{dir {}} {db {}}} {
##
# Return if the database is empty.
#
if {$db == {}} {
set db [gui database get]
if {$db == {}} {
return
}
}
if {$dir == {}} {
##
# Ask the user for the source directory.
#
set dir [gui window fileDialog chooseDir \
"Select Directory To Restore From" {}]
if {$dir == {}} {
return
}
}
set currentModule [gui schem getCurrentModule]
gui schem clearCache \
-all \
-removeAttribute \
-clearCurrentModule
gui schem setCurrentModule {}
gui tree setCurrentModule {}
$db foreach module mod {
set name [$db oid module $mod]
set fname [file join $dir $name.nlv]
if {[file exists $fname]} {
gui console print "Loading layout for module $name from $fname"
set f [open $fname r]
$db oid setSchematicCache $mod [read $f]
close $f
} else {
gui console print "Cannot find file for module $name"
}
}
gui schem setCurrentModule $currentModule
gui tree setCurrentModule $currentModule
}
# =============================================================================
# Call the initialization procedure.
# =============================================================================
#
if {![info exists usedAsSubmodule]} {
SaveRestoreLayout:Init $argc $argv
}
|