extractParam.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
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
###############################################################################
# Copyright (c) 2011-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 Instance's Attribute List
#   @namespace
#       ExtractParam
#   @section
#       Create Reports
#   @description
#       Print all attributes of all instances to a text file.
#   @test
#       ModuleTest
#   @non-interactive
#   @files
#       extractParam.tcl
#   @example
#       demo/spice/aquarius.sp
#   @cmdline
#       -hspice @example[0]
#       -userware2 @files[0] attributes.txt
#   @tag
#       zdb gui report
###############################################################################


# =============================================================================
# Init - Initialize the plugin.
# =============================================================================
#
proc ExtractParam:Init {argc argv} {
    global ExtractParam

    ##
    # If plugin is called from the commandline.
    #
    set db [gui database get]
    set ExtractParam(databaseChangedCallback) {}
    if {$db == {}} {
        if {$argc == 1} {
            set ExtractParam(outputFile) [lindex $argv 0]
            gui database runOrRegisterChangedCallback \
                [list ExtractParam:_writeFile [lindex $argv 0]]
            set ExtractParam(databaseChangedCallback) ExtractParam:_writeFile
        } else {
            gui database runOrRegisterChangedCallback ExtractParam:Run
            set ExtractParam(databaseChangedCallback) ExtractParam:Run
        }
    } else {
        if {$argc == 1} {
            set ExtractParam(outputFile) [lindex $argv 0]
            ExtractParam:_writeFile [lindex $argv 0] $db
        } else {
            ExtractParam:Run $db
        }
    }
}


# =============================================================================
# Finit - Finalize the plugin.
# =============================================================================
#
proc ExtractParam:Finit {} {
    global ExtractParam

    if {$ExtractParam(databaseChangedCallback) != {}} {
        gui database removeChangedCallback \
            $ExtractParam(databaseChangedCallback)
    }
}


# =============================================================================
# Run - Write attributes of instances to a text file.s
# =============================================================================
#
proc ExtractParam:Run {db} {
    ##
    # Get the output file.
    #
    set file \
        [gui window fileDialog saveFile "Select output file" {{"text" {.txt}}}]

    if {$file eq {}} {
        return
    }

    ExtractParam:_writeFile $file $db
}


# -----------------------------------------------------------------------------
# _writeFile - write the infos from the given db to the given file.
# -----------------------------------------------------------------------------
#
proc ExtractParam:_writeFile {file db} {
    ##
    # Return if the database is empty.
    #
    if {$db == {}} {
        return
    }

    ##
    # Open the output file.
    #
    set out [open $file "w"]

    ##
    # Loop over all loaded modules.
    #
    $db foreach module module {
        ##
        # Get the name of the current module.
        #
        set mName [$db oid oname $module]

        ##
        # Loop over all instances of this module.
        #
        $db foreach inst $module inst {
            ##
            # Get the name of the current instance.
            #
            set iName [$db oid oname $inst]

            ##
            # Get all attributes of the current instance.
            #
            set attrs [$db attr $inst get]

            ##
            # Skip instances with no attributes.
            #
            if {$attrs == {}} {
                continue
            }

            ##
            # Dump the module and instance name and all attributes of this
            # instance to the output file.
            #
            puts $out "$mName.$iName: $attrs"
        }
    }

    ##
    # Close the output file.
    #
    close $out
}


# =============================================================================
# Call the initialization procedure.
# =============================================================================
#
ExtractParam:Init $argc $argv