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
###############################################################################
# Copyright (c) 2012-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
#       Show Model Attributes
#   @namespace
#       ShowModelAttributes
#   @section
#       Miscellaneous Userware Examples
#   @description
#       Add a main menu entry to toggle the display of the model name and all
#       model attributes at each transistor device.
#   @license
#       permit spice
#   @files
#       showModelAttributes.tcl
#   @example
#       demo/spice/gl85.sp
#   @cmdline
#       -hspice @example[0]
#       -userware @files[0]
#   @tag
#       gui spice
###############################################################################


# =============================================================================
# Init - Initialize the plugin.
# =============================================================================
#
proc ShowModelAttributes:Init {} {
    global ShowModelAttributes

    ##
    # Initialize the default value to display the model name and attributes.
    #
    set ShowModelAttributes(displayModelName)        1
    set ShowModelAttributes(displayModelAttributes)  1

    ##
    # Add menu entries.
    #
    gui menu submenu {"Userware" "Model Attributes"}
    gui menu checkbutton \
        {"Userware" "Model Attributes" "Display Name"} \
        [list ShowModelAttributes:_toggleModelNameFromMenu] \
        ShowModelAttributes(displayModelName)
    gui menu checkbutton \
        {"Userware" "Model Attributes" "Display Attributes"} \
        [list ShowModelAttributes:_toggleModelAttributesFromMenu] \
        ShowModelAttributes(displayModelAttributes)

    ##
    # Use gui database runOrRegisterChangedCallback to immediately run
    # _toggleModelName and _toggleModelAttributes if we have a database,
    # or otherwise register the procedures to be executed after the database
    # is available.
    #
    gui database runOrRegisterChangedCallback \
        ShowModelAttributes:_toggleModelName
    gui database runOrRegisterChangedCallback \
        ShowModelAttributes:_toggleModelAttributes
}


# =============================================================================
# Finit - Finalize the plugin.
# =============================================================================
#
proc ShowModelAttributes:Finit {} {
    ##
    # Undo modifications of the GUI.
    #
    gui menu removeEntry {"Userware" "Model Attributes"}

    ##
    # Remove the callback registration.
    #
    gui database removeChangedCallback \
        "ShowModelAttributes:_toggleModelName"
    gui database removeChangedCallback \
        "ShowModelAttributes:_toggleModelAttributes"
}


# -----------------------------------------------------------------------------
# _toggleModelNameFromMenu -  Call _toggleModelName with a database.
# -----------------------------------------------------------------------------
#
proc ShowModelAttributes:_toggleModelNameFromMenu {} {
    ShowModelAttributes:_toggleModelName [gui database get]
}


# -----------------------------------------------------------------------------
# _toggleModelName - Toggle the model name display at all instances.
# -----------------------------------------------------------------------------
#
proc ShowModelAttributes:_toggleModelName {db} {
    global ShowModelAttributes

    ##
    # Return if the database is empty.
    #
    if {$db == {}} {
        return
    }

    ##
    # Set the value for the model name display attribute.
    #
    set modelNameAttr "MODEL=%@cell@\n"

    ##
    # Loop over all primitives.
    #
    $db foreach primitive prim {
        ##
        # Skip all functions except NMOS and PMOS.
        #
        set function [$db primFuncOf $prim]
        if {$function ne "NMOS" && $function ne "PMOS"} {
            continue
        }

        ##
        # Get the current value of the @nlv attribute.
        #
        set curAttrValue [$db attr $prim getValue "@nlv"]

        ##
        # Toggle the model name display attribute.
        #
        if {$ShowModelAttributes(displayModelName)} {
            if {[string match "*@cell@*" $curAttrValue]} {
                set newAttrValue $curAttrValue
            } else {
                set    newAttrValue $modelNameAttr
                append newAttrValue $curAttrValue
            }
        } else {
            set newAttrValue [string map [list $modelNameAttr ""] $curAttrValue]
        }
        $db attr $prim set "@nlv=$newAttrValue"
    }

    gui schem regenerate
    gui attribute changed
}


# -----------------------------------------------------------------------------
# _toggleModelAttributesFromMenu - Call _toggleModelAttributes with a database.
# -----------------------------------------------------------------------------
#
proc ShowModelAttributes:_toggleModelAttributesFromMenu {} {
    ShowModelAttributes:_toggleModelAttributes [gui database get]
}


# -----------------------------------------------------------------------------
# _toggleModelAttributes - Toggle the model attribute display at all instances.
# -----------------------------------------------------------------------------
#
proc ShowModelAttributes:_toggleModelAttributes {db} {
    global ShowModelAttributes

    ##
    # Return if the database is empty.
    #
    if {$db == {}} {
        return
    }

    $db foreach primitive prim {
        set meta [$db attr $prim getValue "@nlv"]

        $db attr $prim foreach attr {
            if {[string match "\$*" $attr]} {
                continue
            }
            if {[string match "#*"  $attr]} {
                continue
            }
            if {[string match "@*"  $attr]} {
                continue
            }

            set pos [string last "=" $attr]
            if {$pos <= 0} {
                continue
            }
            set name [string range $attr 0 $pos-1]

            set metaAttrValue "$name=~$name"

            if {$ShowModelAttributes(displayModelAttributes)} {
                append meta "$metaAttrValue\n"
            } else {
                set meta [string map [list "$metaAttrValue\n" ""] $meta]
                set meta [string map [list $metaAttrValue     ""] $meta]
            }
        }

        if {$ShowModelAttributes(displayModelAttributes)} {
            set meta [string range $meta 0 end-1]
        }
        $db attr $prim set "@nlv=$meta"
    }

    gui schem regenerate
    gui attribute changed
}


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