hierarchyOverview.tcl

  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
###############################################################################
# Copyright (c) 2016-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
#       Hierarchy Overview
#   @namespace
#       HierarchyOverview
#   @section
#       Miscellaneous Userware Examples
#   @description
#       Add a main menu entry to load all hierarchical instances into the Cone
#       window.
#   @files
#       hierarchyOverview.tcl
#   @example
#       demo/rtl/aquarius/aquarius.f
#   @cmdline
#       -F @example[0]
#       -userware @files[0]
#   @tag
#       gui zdb
###############################################################################


# =============================================================================
# Init - Initialize the plugin.
# =============================================================================
#
proc HierarchyOverview:Init {} {
    ##
    # Add menu entries.
    #
    gui menu submenu {"Userware" "Hierarchy Overview"}
    gui menu command {"Userware" "Hierarchy Overview" "Full"} \
        [list HierarchyOverview:_load 0]
    gui menu command {"Userware" "Hierarchy Overview" "Folded"} \
        [list HierarchyOverview:_load 1]
}


# =============================================================================
# Finit - Finalize the plugin.
# =============================================================================
#
proc HierarchyOverview:Finit {} {
    ##
    # Undo modifications of the GUI.
    #
    gui menu removeEntry {"Userware" "Hierarchy Overview" "Full"}
    gui menu removeEntry {"Userware" "Hierarchy Overview" "Folded"}
    gui menu removeEntry {"Userware" "Hierarchy Overview"}
}


# -----------------------------------------------------------------------------
# _load - Load a hierarchy overview into the cone window;
#         fold instances if $fold is true.
# -----------------------------------------------------------------------------
#
proc HierarchyOverview:_load {fold} {
    ##
    # Return if the database is empty.
    #
    set db   [gui database get]
    if {$db == {}} {
        return
    }

    set top [$db get_top_design]

    $db foreach module module {
        $db flag $module clear blue
        if {[HierarchyOverview:_skipModule $db $module]} {
            continue
        }
        $db flag $module set blue
    }

    set instList {}
    $db flat foreach instOfCell blue $top inst {
        lappend instList $inst
    }

    gui window show Cone
    gui cone load $instList
    if {$fold} {
        gui cone fold $instList
        gui cone regenerate
    }
}


# -----------------------------------------------------------------------------
# _skipModule - Check if the given module should be skipped.
# -----------------------------------------------------------------------------
#
proc HierarchyOverview:_skipModule {db module} {
    if {[$db isTop $module]} {
        return true
    }
    if {[$db primFuncOf $module] != "NONE"} {
        return true
    }
    if {[$db attr $module getValue @symbol] != ""} {
        return true
    }
    return false
}


# =============================================================================
# Call the initialization procedure.
# =============================================================================
#
HierarchyOverview:Init