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
###############################################################################
# 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.
# =============================================================================
#   @script
#       Annotate original, hierarchical paths.
###############################################################################


# =============================================================================
# AnnotatePaths -
# =============================================================================
#
proc ::ManipulateDesign::AnnotatePaths {} {
    variable _Progress
    variable _ProgressMax

    set db [gui database get]
    if {$db == {}} {
        return
    }

    RecordAnnotate

    if {[$db attr -db getValue ManipulateDesign:Annotated] != {}} {
        zmessage print WAR "AnnotatePaths: paths have already been annotated"
        return
    }
    $db attr -db set ManipulateDesign:Annotated=1

    zprogress begin

    zprogress push "ANNOTATE: parent modules" 0.2
    set _ProgressMax 0
    $db foreach module module_oid {
        incr _ProgressMax
    }
    set _Progress 0
    $db foreach module module_oid {
        zprogress update [$db oid oname $module_oid] \
            [incr _Progress] $_ProgressMax
        _annotateParentsInModule $db $module_oid
    }
    zprogress pop

    zprogress push "ANNOTATE: singlize" 0.5
    $db foreach top top_oid {
        $db oper singlizeTree $top_oid
    }
    zprogress pop

    zprogress push "ANNOTATE: paths" 0.9
    set _ProgressMax 0
    $db foreach top top_oid {
        array set reportTab {}
        $db report instCount reportTab $top_oid
        foreach {name count} [array get reportTab] {
            incr _ProgressMax $count
        }
    }
    set _Progress 0
    $db foreach top top_oid {
        _annotatePathsInModule \
            $db \
            [$db hiersep] \
            $top_oid
    }
    zprogress pop

    zprogress push "ANNOTATE: db modified" 1
    gui database modified
    zprogress pop

    zprogress end

    ClearOriginalPathCache
}


# =============================================================================
# EnablePathCache -
# =============================================================================
#
proc ManipulateDesign::EnablePathCache {} {
    variable _UsePathCaching

    set _UsePathCaching 1
}


# =============================================================================
# DisablePathCache -
# =============================================================================
#
proc ManipulateDesign::DisablePathCache {} {
    variable _UsePathCaching

    set _UsePathCaching 0
}


# =============================================================================
# FindPath -
# =============================================================================
#
proc ::ManipulateDesign::FindPath {
    path
    {path_separator .}
} {
    variable _UsePathCaching

    set db [gui database get]
    if {$db == {}} {
        return {}
    }

    set result [_findPathDirect $path $path_separator]
    if {$result != {}} {
        return $result
    }

    set items [split $path $path_separator]
    set hierarchy_separator [$db hiersep]
    if {$path_separator ne $hierarchy_separator} {
        set path [string map [list $path_separator $hierarchy_separator] $path]
    }

    if {$_UsePathCaching} {
        set result [LookupOriginalPath $path]
        if {$result != {}} {
            return [lindex $result 1]
        }
    } else {
        ##
        # Search via the ORIGINAL_PATH attribute.
        #
        $db find -type inst -resulttype treebased * oid {
            set attr [$db attr $oid getValue ORIGINAL_PATH]
            if {[string equal -nocase $attr $path]} {
                set result $oid
                break
            }
        }
    }

    return {}
}


# =============================================================================
# ClearOriginalPathCache - Clear the annotation cache.
# =============================================================================
#
proc ::ManipulateDesign::ClearOriginalPathCache {args} {
    variable _AnnotationCache

    set _AnnotationCache {}
}


# =============================================================================
# LookupOriginalPath - Lookup an original path
# =============================================================================
#
proc ::ManipulateDesign::LookupOriginalPath {pattern {glob 0}} {
    variable _AnnotationCache
    variable _ProgressMax
    variable _Progress

    set db [gui database get]
    if {$db == {}} {
        return {}
    }

    if {(![info exists _AnnotationCache]) || ($_AnnotationCache == {})} {
        zprogress begin
        zprogress push "Populating annotation cache" 1

        set _ProgressMax 0
        $db foreach top top_oid {
            array set reportTab {}
            $db report instCount reportTab $top_oid
            foreach {name count} [array get reportTab] {
                incr _ProgressMax $count
            }
        }
        set _Progress 0

        set _AnnotationCache [dict create]
        $db find -type inst -resulttype treebased * oid {
            set attr [string tolower [$db attr $oid getValue ORIGINAL_PATH]]
            if {$attr ne ""} {
                dict set _AnnotationCache $attr $oid
            }
            incr $_Progress
            if {($_Progress % 1000) == 0} {
                zprogress update $oid $_Progress $_ProgressMax
            }
        }

        zprogress pop
        zprogress end
    }

    set lower [string tolower $pattern]
    if {!$glob} {
        if {[dict exists $_AnnotationCache $lower]} {
            return [list $lower [dict get $_AnnotationCache $lower]]
        }
        return {}
    }

    set matches {}
    foreach key [dict keys $_AnnotationCache $lower] {
        lappend matches $key [dict get $_AnnotationCache $key]
    }
    return $matches
}


# -----------------------------------------------------------------------------
# _annotateParentsInModule -
# -----------------------------------------------------------------------------
#
proc ::ManipulateDesign::_annotateParentsInModule {
    db
    module_oid
} {
    set module_name [$db oid oname $module_oid]
    set attribute "ORIGINAL_PARENT_MODULE=$module_name"

    $db foreach inst $module_oid inst_oid {
        $db attr $inst_oid add $attribute
    }
}


# -----------------------------------------------------------------------------
# _annotatePathsInModule -
# -----------------------------------------------------------------------------
#
proc ::ManipulateDesign::_annotatePathsInModule {
    db
    hierarchy_separator
    module_oid
} {
    variable _ProgressMax
    variable _Progress

    $db foreach inst $module_oid inst_oid {
        incr _Progress
    }
    zprogress update [$db oid oname $module_oid] \
        [incr _Progress] $_ProgressMax

    $db foreach inst $module_oid inst_oid {
        set path [$db oid print $inst_oid -notype -hiersep $hierarchy_separator]
        $db attr $inst_oid add "ORIGINAL_PATH=$path"

        if {[$db isModule $inst_oid]} {
            _annotatePathsInModule \
                $db \
                $hierarchy_separator \
                [$db oid convertTo module $inst_oid]
        }
    }
}


# -----------------------------------------------------------------------------
# _findPathDirect -
# -----------------------------------------------------------------------------
#
proc ::ManipulateDesign::_findPathDirect {
    path
    {path_separator .}
} {
    set db [gui database get]
    if {$db == {}} {
        return {}
    }

    set items [split $path $path_separator]

    ##
    # Perform a direct search, using the first path item as top.
    #
    set result {}
    $db find \
        -type inst \
        -exact \
        -case insensitive \
        -resulttype treebased \
        -top [lindex $items 0] \
        -path [join [lrange $items 1 end-1] $path_separator] \
        -hiersep $path_separator \
        [lindex $items end] \
        result \
    {
        break
    }
    if {$result != {}} {
        return $result
    }

    ##
    # Perform a direct search inside all tops.
    #
    set result {}
    $db foreach top top_oid {
        $db find \
            -type inst \
            -exact \
            -case insensitive \
            -resulttype treebased \
            -top [$db oid oname $top_oid] \
            -path [join [lrange $items 0 end-1] $path_separator] \
            -hiersep $path_separator \
            [lindex $items end] \
            result \
        {
            break
        }
        if {$result != {}} {
            return $result
        }
    }

    return {}
}