zdb/extract.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
###############################################################################
# Copyright (c) 2020-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
#       Display Path Extraction Results
#   @section
#       C Level Examples
#   @description
#       This example script demonstrates how to display path extraction results
#       generated by the extract C demo and stored as database root attributes
#       in the Cone window.
#   @files
#       zdb/extract.c
#       zdb/extract.tcl
#   @tag
#       zdb extract
###############################################################################

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


# -----------------------------------------------------------------------------
# getPathsFromRootAttrs - get root attributes
# -----------------------------------------------------------------------------
#
proc getPathsFromRootAttrs {db} {
    set paths {}
    $db attr -db foreach attr {
        if {[string match "EXTRACT_RESULT_*" $attr]} {
            set equal [string first "=" $attr]
            if {$equal eq -1} {
                continue
            }
            set value [string range $attr $equal+1 end]
            set name [lindex $value 0]
            set path [lindex $value 1]
            lappend paths $name $path
        }
    }
    return $paths
}


# -----------------------------------------------------------------------------
# getPathsFromFiles - get from files
# -----------------------------------------------------------------------------
#
proc getPathsFromFiles {dir} {
    set paths {}
    set files [glob -nocomplain -- [file join $dir out*.txt]]
    foreach file $files {
        set fp [open $file "r"]
        set value [read $fp]
        close $fp

        set name [lindex $value 0]
        set path [lindex $value 1]
        lappend paths $name $path
    }
    return $paths
}


# -----------------------------------------------------------------------------
# addExtractMenu - add menu entries.
# -----------------------------------------------------------------------------
#
proc addExtractMenu {outDir db} {
    foreach by {RootAttrs Files} {
        set menuName "ExtractBy$by"

        if {$db eq {}} {
            return
        }

        gui menu mainMenu $menuName

        switch -- $by {
            RootAttrs {set res [getPathsFromRootAttrs $db]}
            Files     {set res [getPathsFromFiles $outDir]}
            default   {}
        }
        foreach {pathName path} $res {
            gui menu command [list $menuName $pathName] \
                [list gui cone load $path]
        }
    }
}


# =============================================================================
# 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 <DIR> ?expected?"
    }
    set dir [lindex $argv 0]
    set exp [lindex $argv 1]

    ##
    # Open the given zdbfile.
    #
    set zdbFile [file join $dir out.zdb]
    set db [zdb open $zdbFile]

    ##
    # Call the userware sub-command 'getPathsFromRootAttrs' on the opened db.
    #
    set res1 [getPathsFromRootAttrs $db]

    ##
    # Call the userware sub-command 'getPathsFromFiles'.
    #
    set res2 [getPathsFromFiles $dir]

    ##
    # check the result, for automatic testing.
    #
    if {$argc == 2} {
        foreach res [list $res1 $res2] {
            set cnt [expr {[llength $res] / 2}]
            if {$cnt != $exp} {
                error "Wrong number of paths ($cnt != $exp)"
            }
        }
    }

# =============================================================================
# If this script runs in a *Vision GUI then the following code will be used.
# =============================================================================
#
} else {
    ##
    # Register the procedure to be executed after the
    # database is available.
    #
    if {$argc > 0} {
        gui database registerChangedCallback "addExtractMenu [lindex $argv 0]"
    } else {
        error "Wrong #of args: -userware2 [info script] <DIR>"
    }
}