zdb/userware.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
###############################################################################
# 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.
# =============================================================================
#   @userware
#       Example for C Userware
#   @section
#       C Level Examples
#   @description
#       C implementation of the floatingNodes Userware.
#       This example script demonstrates how to use the userware extension
#       compiled as a shared library in the *Vision GUI as well as in the
#       starsh.
#   @files
#       zdb/userware.c
#       zdb/userware.tcl
#   @tag
#       spice zdb
###############################################################################


##
# Load the shared library userware.
# This will provide the new Tcl command userware
#
load [file join . userware[info sharedlibextension]] Userware

##
# Get the name of the running executable.
#
set exeName [file tail [info nameofexecutable]]


# =============================================================================
# If this script runs in starsh then the following code will be used.
# =============================================================================
#
if {[string equal -length 6 $exeName "starsh"]} {
    ##
    # Check for wrong arguments.
    #
    if {($argc < 1) || ($argc > 2)} {
        error "Wrong args.\nUsage: $exeName $argv0 <BINFILE> ?expected?"
    }

    ##
    # Open the given binfile.
    #
    set db  [zdb open -populate [lindex $argv 0]]

    ##
    # Call the userware sub-command 'floatingNodes' on the opened database.
    #
    set res [userware $db floatingNodes]

    ##
    # Do something with the result.
    #
    if {$argc == 2} {
        set cnt [llength $res]
        set exp [lindex $argv 1]
        if {$cnt != $exp} {
            error "Wrong floating node count ($cnt != $exp)"
        }
    }


# =============================================================================
# If this script runs in a *Vision GUI then the following code will be used.
# =============================================================================
#
} else {
    ##
    # Call the userware sub-command 'floatingNodes' on the opened database and
    # load the result into the 'Mem' window.
    #
    proc userware_floatingNodes {db} {
        ##
        # Return if database is empty.
        #
        if {$db == {}} {
            return
        }

        gui window show Mem
        gui mem append [userware $db floatingNodes]
    }

    ##
    # Register the procedure floatingNodes to be executed after the
    # database is available.
    #
    gui database registerChangedCallback "userware_floatingNodes"
}