/usr/share/tcltk/tcl8.5/vtk/PrintSelfCheck.tcl is in tcl-vtk 5.8.0-17.5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 | #
# Verify that each class's PrintSelf prints all ivars that have
# a set/get.
#
#
# Verbose Levels:
#
# 0: No extra printing
# 1: Print basic extra information
# 2: Print lots of details
#
set verbose 0
set class_name ""
set class_count 0
set class_print_count 0
set printself_miss_count 0
set super_miss_count 0
set ivar_count 0
set ivar_miss_count 0
set total_class_count 0
set total_class_print_count 0
set total_ivar_count 0
set total_printself_miss_count 0
set total_super_miss_count 0
set total_ivar_miss_count 0
# Fileid for the PrintSelfDetails.html file
set pd_id 0
#
# class_list contains the following for each class evaluated:
#
# <class>.p <true|false> True if printself declared
# <class>.s.<super_class> <true|false> True if superclass used in printself
# <class>.i.<ivar> <true|false> True if ivar used in printself
set class_list(null) 1
proc list_contains { string } {
global class_list
set ivar_found 0
set searchid [array startsearch class_list]
while { [array anymore class_list $searchid] } {
set element [array nextelement class_list $searchid]
if { $element == $string } {
set ivar_found 1
}
}
array donesearch class_list $searchid
return $ivar_found
}
proc get_ivar { string } {
global verbose
set ivar_string "-1"
#puts "Getting ivar from macro: $string"
# Search for the first occurrence of an open parenthesis
set first [string first "(" $string];
if { $first > -1 } {
set begintrim [string range $string [expr $first + 1] end];
set begintrim [string trim $begintrim];
# Find the end of the ivar
set last [string wordend $begintrim 0]
if { $last > -1 } {
set ivar_string [string range $begintrim 0 [expr $last - 1] ];
set ivar_string [string trim $ivar_string];
if { $verbose >= 2 } {
puts " Macro: $ivar_string"
}
}
}
return [string trim $ivar_string]
}
proc check_header_file { filename } {
global class_name
global class_count
global ivar_count
global class_list
global verbose
if { $verbose >= 2 } {
puts "Processing file: $filename"
}
set data ""
set class_name ""
set printself_found 0
set class_found 0
set line_count 0
if { [file readable $filename] } {
set fileid [open $filename "r"]
set protected_not_found 1
#
# Read each line in the file
#
while { [gets $fileid data] >= 0 && $protected_not_found } {
incr line_count
# Search for the printSelf string
if { [string match "*PrintSelf*(*" $data] == 1 } {
set printself_found 1
set class_list($class_name.p) 1
}
if { [string match "*protected:*" $data] == 1 } {
set protected_not_found 0
}
# Search for the class string
# Extract the class name from the string
if { [string match "*class VTK_*EXPORT* vtk*" $data] == 1 } {
set class_found 1
set class_ivar_count 0
set first [string first "vtk" $data]
if { $first > -1 } {
set end [expr [string first ":" $data] - 1]
if { $end > $first } {
# found ":" - class name before the ":"
set newstring [string range $data $first $end]
set last [string wordend $newstring 0]
if { $last > -1 } {
set class_name [string trim [string range $newstring 0 $last]]
}
} else {
# found no ":" - class name from $first to end of word
# (root class has no superclass)
set last [string wordend $data $first]
set class_name [string trim [string range $data $first $last]]
}
set class_list($class_name.p) 0
if { $verbose >= 2 } {
puts " Class Name: $class_name"
}
}
if { [string compare $class_name ""] == 0 } {
puts "Problem with class definition in file $filename"
puts " Could not determine class name from line: '$data'"
}
set first [string first "public" $data]
if { $first > -1 } {
set first [expr $first + 7];
set end [ string length $data]
set string [string range $data $first $end ]
set first [string first "vtk" $string]
set end [string wordend $string $first]
set super_class [string range $string $first $end ]
set super_class [string trim $super_class]
set class_list($class_name.s.$super_class) 0
set class_list($class_name.s.Superclass) 0
}
}
if { $class_found == 1 } {
# Search for Set and Get macros
set set_macro_found [string match "*vtkSet*Macro*(*" $data]
set get_macro_found [string match "*vtkGet*Macro*(*" $data]
if { $set_macro_found || $get_macro_found } {
# Get the ivar from the Macro declaration
set ivar [get_ivar $data];
if { [string compare $ivar "-1"] != 0 } {
if { [list_contains "$class_name.i.$ivar"] == 0 } {
incr ivar_count
incr class_ivar_count
set class_list($class_name.i.$ivar) 0
}
}
}
}
}
# If a class was found within the file then increment the class count
if { $class_found } {
incr class_count
}
close $fileid
}
}
proc check_printself { filename } {
global verbose
global class_list
global class_name
if { $verbose >= 2 } {
puts " Checking PrintSelf in file: $filename"
}
if { [file readable $filename] } {
set fileid [open $filename "r"]
set search_state 0
set curly_open 0
set curly_close 0
set line_count 0
#
# Read each line in the file
#
while { [gets $fileid data] >= 0 && $search_state != 3 } {
incr line_count
# Search for the PrintSelf string
if { $search_state == 0 && [string match "*PrintSelf*(*" $data] == 1 } {
set search_state 1
set first [string first ")" $data]
set data [string range $data [expr $first + 1] end]
}
# Find the first open curly bracket
if { $search_state == 1 } {
while { [string length $data] > 0 && $curly_open == 0 } {
# Check for an open curly bracket
set curly_found [string first "\{" $data]
if { $curly_found > -1 } {
set data [string range $data [expr $curly_found + 1] end ]
set curly_open 1
set search_state 2
} else {
set data ""
}
}
}
# Count curly brackets in PrintSelf() method and find ivars
if { $search_state == 2 } {
set start 0
set end [string length $data]
#puts "Line: $data"
if { [string match "*this->Superclass::PrintSelf(*)*" $data] == 1 } {
if { [list_contains "$class_name.s.Superclass"] == 1 } {
set class_list($class_name.s.Superclass) 1
}
} elseif { [string match "*::PrintSelf(*)*" $data] == 1 } {
set start [string first "vtk" $data]
set end [string wordend $data $start]
set super_class [string range $data $start [expr $end -1]]
set super_class [string trim $super_class]
if { [list_contains "$class_name.s.$super_class"] == 1 } {
set class_list($class_name.s.$super_class) 1
} elseif { $verbose >= 2 } {
puts "\tSuperclass Issue:\tCan't find $class_name.s.$super_class"
}
}
while { $start < $end && $curly_open > $curly_close } {
set word_end [string wordend $data $start]
set token [string range $data $start [expr $word_end -1] ]
set token [string trim $token]
set start $word_end
if { $verbose >= 2 } {
puts "\tNew Token: $token"
}
# Check for open and close curly braces
if { [string compare "\{" $token] == 0 } {
incr curly_open
} elseif { [string compare "\}" $token] == 0 } {
incr curly_close
} elseif { [string compare "this" $token] == 0 } {
set start [expr $start + 2]
set token_end [expr [string wordend $data $start ] - 1]
# Check if this is an array. If so, remove bracket
#if { [string first "\[" $data] > -1 } {
# set token_end [expr $token_end - 1];
#}
set ivar [string range $data $start $token_end]
# Check if this is a Get procedure. If so, remove open parenthesis
#if { [string first "(" $ivar] > -1 } {
# set token_end [expr $token_end - 1];
# set ivar [string range $data $start $token_end]
#}
if { [string first "Get" $ivar] > -1 } {
set start [expr $start + 3];
# Check if this is a Get*AsString() method
if { [string first "AsString" $ivar] > -1 } {
set token_end [expr $token_end - 8];
}
set ivar [string range $data $start $token_end]
}
set ivar [string trim $ivar]
if { [list_contains "$class_name.i.$ivar"] == 1 } {
set class_list($class_name.i.$ivar) 1
} elseif { $verbose } {
puts "\tIvar Issue:\t\tCan't find $class_name.i.$ivar - no Set or Get Macro?"
}
}
}
if { $curly_open == $curly_close } {
set search_state 3
}
}
}
close $fileid
}
}
proc read_directory { dirname } {
global class_name
global argv
set total_defects 0
set files [glob -nocomplain "$dirname/vtk*.h"]
if { $files != "" } {
foreach headername $files {
set class_name ""
# Check that a PrintSelf() is defined
check_header_file $headername
# Check that the PrintSelf() method accesses the appropriate ivars
if { $class_name != "" && [list_contains "$class_name.p"] == 1 } {
set length [string length $headername]
set filename [string range $headername 0 [expr $length - 3] ]
if {[file exists "$filename.mm"] == 1} {
check_printself "$filename.mm"
} else {
check_printself "$filename.cxx"
}
}
}
}
}
proc class_has_ivars { class } {
global verbose
global class_list
set searchid [array startsearch class_list]
while { [array anymore class_list $searchid] } {
set element [array nextelement class_list $searchid]
if { [string match "$class.i.*" $element] == 1 } {
array donesearch class_list $searchid
return 1
}
}
array donesearch class_list $searchid
return 0
}
proc check_for_defects { print } {
global pd_id
global verbose
global class_list
global class_print_count
global ivar_miss_count
global printself_miss_count
global super_miss_count
#
# PRINTSELF CHECK
#
# Loop through list and count printself defects, if any
set searchid [array startsearch class_list]
while { [array anymore class_list $searchid] } {
set element [array nextelement class_list $searchid]
# Extract strings that represent PrintSelfs
if { [string match "*.p" $element] == 1 } {
set end [expr [string wordend $element 0] - 1]
set curr_class [string range $element 0 $end]
if { [class_has_ivars $curr_class] == 1 } {
incr class_print_count
if { $class_list($element) != 1 } {
incr printself_miss_count
}
}
}
}
array donesearch class_list $searchid
# Loop through list and print printself defects
if { $printself_miss_count > 0 && $print } {
puts $pd_id " PrintSelf DEFECTS: "
set searchid [array startsearch class_list]
while { [array anymore class_list $searchid] } {
set element [array nextelement class_list $searchid]
# Extract strings that represent PrintSelfs
if { [string match "*.p" $element] == 1 } {
set end [expr [string wordend $element 0] - 1]
set curr_class [string range $element 0 $end]
if { [class_has_ivars $curr_class] == 1 } {
if { $class_list($element) != 1 } {
puts $pd_id " $curr_class does not have a PrintSelf method"
}
}
}
}
array donesearch class_list $searchid
}
#
# SUPERCLASS CHECK
#
# Loop through list and count superclass defects, if any
set searchid [array startsearch class_list]
while { [array anymore class_list $searchid] } {
set element [array nextelement class_list $searchid]
# Extract strings that represent superclasses
if { [string match "*.s.*" $element] == 1 } {
set end [expr [string wordend $element 0] - 1]
set curr_class [string range $element 0 $end]
if { $class_list($curr_class.s.Superclass) != 1 &&
[class_has_ivars $curr_class] == 1 &&
$class_list($element) != 1 } {
set start [expr $end + 4]
set end [expr [string wordend $element $start] - 1]
set parent [string range $element $start $end]
if { $parent == "Superclass" } continue;
incr super_miss_count
}
}
}
array donesearch class_list $searchid
# Loop through list and print superclass defects
if { $super_miss_count > 0 && $print } {
puts $pd_id " Superclass DEFECTS: "
set searchid [array startsearch class_list]
while { [array anymore class_list $searchid] } {
set element [array nextelement class_list $searchid]
# Extract strings that represent superclasses
if { [string match "*.s.*" $element] == 1 } {
set end [expr [string wordend $element 0] - 1]
set curr_class [string range $element 0 $end]
if { $class_list($curr_class.s.Superclass) != 1 &&
[class_has_ivars $curr_class] == 1 &&
$class_list($element) != 1 } {
set start [expr $end + 4]
set end [expr [string wordend $element $start] - 1]
set parent [string range $element $start $end]
if { $parent == "Superclass" } continue;
puts $pd_id " $curr_class did not print superclass $parent"
}
}
}
array donesearch class_list $searchid
}
#
# IVAR CHECK
#
# Loop through list and count ivar defects, if any
set searchid [array startsearch class_list]
while { [array anymore class_list $searchid] } {
set element [array nextelement class_list $searchid]
# Extract strings that represent ivars
if { [string match "*.i.*" $element] == 1 } {
if { $class_list($element) != 1 } {
incr ivar_miss_count
}
}
}
array donesearch class_list $searchid
# Loop through list and print ivar defects
if { $ivar_miss_count > 0 && $print } {
puts $pd_id " Ivar DEFECTS: "
set searchid [array startsearch class_list]
while { [array anymore class_list $searchid] } {
set element [array nextelement class_list $searchid]
# Extract strings that represent ivars
if { [string match "*.i.*" $element] == 1 } {
if { $class_list($element) != 1 } {
set end [expr [string wordend $element 0] - 1]
set curr_class [string range $element 0 $end]
set start [expr $end + 4]
set end [expr [string wordend $element $start] - 1]
set ivar [string range $element $start $end]
puts $pd_id " $curr_class does not print ivar: $ivar"
}
}
}
array donesearch class_list $searchid
}
}
proc print_toolkit_results { toolkit } {
global pd_id
global class_count
global class_print_count
global printself_miss_count
global ivar_count
global ivar_miss_count
global super_miss_count
check_for_defects 1
set tk [string range $toolkit 0 14 ]
}
proc print_totals {} {
global total_defects
global total_class_count
global total_class_print_count
global total_printself_miss_count
global total_ivar_count
global total_ivar_miss_count
global total_super_miss_count
set total_defects [expr $total_printself_miss_count + $total_super_miss_count + $total_ivar_miss_count]
}
proc open_files { } {
global pd_id
set pd_id stdout
}
proc close_files { } {
global pd_id
close $pd_id
set pd_id 0
}
proc clear_results { } {
global class_count
global class_print_count
global printself_miss_count
global ivar_count
global ivar_miss_count
global super_miss_count
global class_list
unset class_list
set class_list(null) 1
set class_count 0
set class_print_count 0
set ivar_count 0
set printself_miss_count 0
set ivar_miss_count 0
set super_miss_count 0
}
proc measure_vtk {kit} {
global pd_id
global verbose
global class_list
global class_count
global class_print_count
global printself_miss_count
global ivar_count
global ivar_miss_count
global super_miss_count
global total_class_count
global total_class_print_count
global total_printself_miss_count
global total_ivar_count
global total_ivar_miss_count
global total_super_miss_count
open_files
clear_results
read_directory "$kit"
print_toolkit_results $kit
set total_class_count [expr $total_class_count + $class_count]
set total_class_print_count [expr $total_class_print_count + $class_print_count]
set total_printself_miss_count [expr $total_printself_miss_count + $printself_miss_count];
set total_ivar_count [expr $total_ivar_count + $ivar_count];
set total_ivar_miss_count [expr $total_ivar_miss_count + $ivar_miss_count];
set total_super_miss_count [expr $total_super_miss_count + $super_miss_count];
print_totals
if { $verbose } {
parray class_list
}
close_files
}
measure_vtk [lindex $argv 0]
exit $total_defects
|