/usr/share/php/PHP/Depend/Metrics/NPathComplexity/Analyzer.php is in pdepend 1.1.4-1.
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 | <?php
/**
* This file is part of PHP_Depend.
*
* PHP Version 5
*
* Copyright (c) 2008-2012, Manuel Pichler <mapi@pdepend.org>.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* * Neither the name of Manuel Pichler nor the names of his
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @category PHP
* @package PHP_Depend
* @subpackage Metrics
* @author Manuel Pichler <mapi@pdepend.org>
* @copyright 2008-2012 Manuel Pichler. All rights reserved.
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version SVN: $Id$
* @link http://www.pdepend.org/
*/
/**
* This analyzer calculates the NPath complexity of functions and methods. The
* NPath complexity metric measures the acyclic execution paths through a method
* or function. See Nejmeh, Communications of the ACM Feb 1988 pp 188-200.
*
* @category PHP
* @package PHP_Depend
* @subpackage Metrics
* @author Manuel Pichler <mapi@pdepend.org>
* @copyright 2008-2012 Manuel Pichler. All rights reserved.
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
* @version Release: 1.1.4
* @link http://www.pdepend.org/
*/
class PHP_Depend_Metrics_NPathComplexity_Analyzer
extends PHP_Depend_Metrics_AbstractCachingAnalyzer
implements PHP_Depend_Metrics_AnalyzerI,
PHP_Depend_Metrics_FilterAwareI,
PHP_Depend_Metrics_NodeAwareI,
PHP_Depend_Code_ASTVisitorI
{
/**
* Type of this analyzer class.
*/
const CLAZZ = __CLASS__;
/**
* Metrics provided by the analyzer implementation.
*/
const M_NPATH_COMPLEXITY = 'npath';
/**
* Processes all {@link PHP_Depend_Code_Package} code nodes.
*
* @param PHP_Depend_Code_NodeIterator $packages All code packages.
*
* @return void
*/
public function analyze(PHP_Depend_Code_NodeIterator $packages)
{
if ($this->metrics === null) {
$this->loadCache();
$this->fireStartAnalyzer();
$this->metrics = array();
foreach ($packages as $package) {
$package->accept($this);
}
$this->fireEndAnalyzer();
$this->unloadCache();
}
}
/**
* This method will return an <b>array</b> with all generated metric values
* for the node with the given <b>$uuid</b> identifier. If there are no
* metrics for the requested node, this method will return an empty <b>array</b>.
*
* <code>
* array(
* 'npath' => '17'
* )
* </code>
*
* @param PHP_Depend_Code_NodeI $node The context node instance.
*
* @return array
*/
public function getNodeMetrics(PHP_Depend_Code_NodeI $node)
{
$metric = array();
if (isset($this->metrics[$node->getUuid()])) {
$metric = array(
self::M_NPATH_COMPLEXITY => $this->metrics[$node->getUuid()]
);
}
return $metric;
}
/**
* Visits a code interface object.
*
* @param PHP_Depend_Code_Interface $interface The context code interface.
*
* @return void
*/
public function visitInterface(PHP_Depend_Code_Interface $interface)
{
// Empty visit method, we don't want interface metrics
}
/**
* Visits a function node.
*
* @param PHP_Depend_Code_Function $function The current function node.
*
* @return void
*/
public function visitFunction(PHP_Depend_Code_Function $function)
{
$this->fireStartFunction($function);
if (false === $this->restoreFromCache($function)) {
$this->calculateComplexity($function);
}
$this->fireEndFunction($function);
}
/**
* Visits a method node.
*
* @param PHP_Depend_Code_Method $method The method class node.
*
* @return void
*/
public function visitMethod(PHP_Depend_Code_Method $method)
{
$this->fireStartMethod($method);
if (false === $this->restoreFromCache($method)) {
$this->calculateComplexity($method);
}
$this->fireEndMethod($method);
}
/**
* This method will calculate the NPath complexity for the given callable
* instance.
*
* @param PHP_Depend_Code_AbstractCallable $callable The context callable.
*
* @return void
* @since 0.9.12
*/
protected function calculateComplexity(
PHP_Depend_Code_AbstractCallable $callable
) {
$npath = '1';
foreach ($callable->getChildren() as $child) {
$stmt = $child->accept($this, $npath);
$npath = PHP_Depend_Util_MathUtil::mul($npath, $stmt);
}
$this->metrics[$callable->getUuid()] = $npath;
}
/**
* Magic call method used to provide simplified visitor implementations.
* With this method we can call <b>visit${NodeClassName}</b> on each node.
*
* @param string $method Name of the called method.
* @param array $args Array with method argument.
*
* @return mixed
* @since 0.9.12
*/
public function __call($method, $args)
{
$value = $args[1];
foreach ($args[0]->getChildren() as $child) {
$value = $child->accept($this, $value);
}
return $value;
}
/**
* This method calculates the NPath Complexity of a conditional-statement,
* the meassured value is then returned as a string.
*
* <code>
* <expr1> ? <expr2> : <expr3>
*
* -- NP(?) = NP(<expr1>) + NP(<expr2>) + NP(<expr3>) + 2 --
* </code>
*
* @param PHP_Depend_Code_ASTNode $node The currently visited node.
* @param string $data The previously calculated npath value.
*
* @return string
* @since 0.9.12
*/
public function visitConditionalExpression($node, $data)
{
// New PHP 5.3 ifsetor-operator $x ?: $y
if (count($node->getChildren()) === 1) {
$npath = '4';
} else {
$npath = '3';
}
foreach ($node->getChildren() as $child) {
if (($cn = $this->sumComplexity($child)) === '0') {
$cn = '1';
}
$npath = PHP_Depend_Util_MathUtil::add($npath, $cn);
}
return PHP_Depend_Util_MathUtil::mul($npath, $data);
}
/**
* This method calculates the NPath Complexity of a do-while-statement, the
* meassured value is then returned as a string.
*
* <code>
* do
* <do-range>
* while (<expr>)
* S;
*
* -- NP(do) = NP(<do-range>) + NP(<expr>) + 1 --
* </code>
*
* @param PHP_Depend_Code_ASTNode $node The currently visited node.
* @param string $data The previously calculated npath value.
*
* @return string
* @since 0.9.12
*/
public function visitDoWhileStatement($node, $data)
{
$stmt = $node->getChild(0)->accept($this, 1);
$expr = $this->sumComplexity($node->getChild(1));
$npath = PHP_Depend_Util_MathUtil::add($expr, $stmt);
$npath = PHP_Depend_Util_MathUtil::add($npath, '1');
return PHP_Depend_Util_MathUtil::mul($npath, $data);
}
/**
* This method calculates the NPath Complexity of an elseif-statement, the
* meassured value is then returned as a string.
*
* <code>
* elseif (<expr>)
* <elseif-range>
* S;
*
* -- NP(elseif) = NP(<elseif-range>) + NP(<expr>) + 1 --
*
*
* elseif (<expr>)
* <elseif-range>
* else
* <else-range>
* S;
*
* -- NP(if) = NP(<if-range>) + NP(<expr>) + NP(<else-range> --
* </code>
*
* @param PHP_Depend_Code_ASTNode $node The currently visited node.
* @param string $data The previously calculated npath value.
*
* @return string
* @since 0.9.12
*/
public function visitElseIfStatement($node, $data)
{
$npath = $this->sumComplexity($node->getChild(0));
foreach ($node->getChildren() as $child) {
if ($child instanceof PHP_Depend_Code_ASTStatement) {
$expr = $child->accept($this, 1);
$npath = PHP_Depend_Util_MathUtil::add($npath, $expr);
}
}
if (!$node->hasElse()) {
$npath = PHP_Depend_Util_MathUtil::add($npath, '1');
}
return PHP_Depend_Util_MathUtil::mul($npath, $data);
}
/**
* This method calculates the NPath Complexity of a for-statement, the
* meassured value is then returned as a string.
*
* <code>
* for (<expr1>; <expr2>; <expr3>)
* <for-range>
* S;
*
* -- NP(for) = NP(<for-range>) + NP(<expr1>) + NP(<expr2>) + NP(<expr3>) + 1 --
* </code>
*
* @param PHP_Depend_Code_ASTNode $node The currently visited node.
* @param string $data The previously calculated npath value.
*
* @return string
* @since 0.9.12
*/
public function visitForStatement($node, $data)
{
$npath = '1';
foreach ($node->getChildren() as $child) {
if ($child instanceof PHP_Depend_Code_ASTStatement) {
$stmt = $child->accept($this, 1);
$npath = PHP_Depend_Util_MathUtil::add($npath, $stmt);
} else if ($child instanceof PHP_Depend_Code_ASTExpression) {
$expr = $this->sumComplexity($child);
$npath = PHP_Depend_Util_MathUtil::add($npath, $expr);
}
}
return PHP_Depend_Util_MathUtil::mul($npath, $data);
}
/**
* This method calculates the NPath Complexity of a for-statement, the
* meassured value is then returned as a string.
*
* <code>
* fpreach (<expr>)
* <foreach-range>
* S;
*
* -- NP(foreach) = NP(<foreach-range>) + NP(<expr>) + 1 --
* </code>
*
* @param PHP_Depend_Code_ASTNode $node The currently visited node.
* @param string $data The previously calculated npath value.
*
* @return string
* @since 0.9.12
*/
public function visitForeachStatement($node, $data)
{
$npath = $this->sumComplexity($node->getChild(0));
$npath = PHP_Depend_Util_MathUtil::add($npath, '1');
foreach ($node->getChildren() as $child) {
if ($child instanceof PHP_Depend_Code_ASTStatement) {
$stmt = $child->accept($this, 1);
$npath = PHP_Depend_Util_MathUtil::add($npath, $stmt);
}
}
return PHP_Depend_Util_MathUtil::mul($npath, $data);
}
/**
* This method calculates the NPath Complexity of an if-statement, the
* meassured value is then returned as a string.
*
* <code>
* if (<expr>)
* <if-range>
* S;
*
* -- NP(if) = NP(<if-range>) + NP(<expr>) + 1 --
*
*
* if (<expr>)
* <if-range>
* else
* <else-range>
* S;
*
* -- NP(if) = NP(<if-range>) + NP(<expr>) + NP(<else-range> --
* </code>
*
* @param PHP_Depend_Code_ASTNode $node The currently visited node.
* @param string $data The previously calculated npath value.
*
* @return string
* @since 0.9.12
*/
public function visitIfStatement($node, $data)
{
$npath = $this->sumComplexity($node->getChild(0));
foreach ($node->getChildren() as $child) {
if ($child instanceof PHP_Depend_Code_ASTStatement) {
$stmt = $child->accept($this, 1);
$npath = PHP_Depend_Util_MathUtil::add($npath, $stmt);
}
}
if (!$node->hasElse()) {
$npath = PHP_Depend_Util_MathUtil::add($npath, '1');
}
return PHP_Depend_Util_MathUtil::mul($npath, $data);
}
/**
* This method calculates the NPath Complexity of a return-statement, the
* meassured value is then returned as a string.
*
* <code>
* return <expr>;
*
* -- NP(return) = NP(<expr>) --
* </code>
*
* @param PHP_Depend_Code_ASTNode $node The currently visited node.
* @param string $data The previously calculated npath value.
*
* @return string
* @since 0.9.12
*/
public function visitReturnStatement($node, $data)
{
if (($npath = $this->sumComplexity($node)) === '0') {
return $data;
}
return PHP_Depend_Util_MathUtil::mul($npath, $data);
}
/**
* This method calculates the NPath Complexity of a switch-statement, the
* meassured value is then returned as a string.
*
* <code>
* switch (<expr>)
* <case-range1>
* <case-range2>
* ...
* <default-range>
*
* -- NP(switch) = NP(<expr>) + NP(<default-range>) + NP(<case-range1>) ... --
* </code>
*
* @param PHP_Depend_Code_ASTNode $node The currently visited node.
* @param string $data The previously calculated npath value.
*
* @return string
* @since 0.9.12
*/
public function visitSwitchStatement($node, $data)
{
$npath = $this->sumComplexity($node->getChild(0));
foreach ($node->getChildren() as $child) {
if ($child instanceof PHP_Depend_Code_ASTSwitchLabel) {
$label = $child->accept($this, 1);
$npath = PHP_Depend_Util_MathUtil::add($npath, $label);
}
}
return PHP_Depend_Util_MathUtil::mul($npath, $data);
}
/**
* This method calculates the NPath Complexity of a try-catch-statement, the
* meassured value is then returned as a string.
*
* <code>
* try
* <try-range>
* catch
* <catch-range>
*
* -- NP(try) = NP(<try-range>) + NP(<catch-range>) --
*
*
* try
* <try-range>
* catch
* <catch-range1>
* catch
* <catch-range2>
* ...
*
* -- NP(try) = NP(<try-range>) + NP(<catch-range1>) + NP(<catch-range2>) ... --
* </code>
*
* @param PHP_Depend_Code_ASTNode $node The currently visited node.
* @param string $data The previously calculated npath value.
*
* @return string
* @since 0.9.12
*/
public function visitTryStatement($node, $data)
{
$npath = '0';
foreach ($node->getChildren() as $child) {
if ($child instanceof PHP_Depend_Code_ASTStatement) {
$stmt = $child->accept($this, 1);
$npath = PHP_Depend_Util_MathUtil::add($npath, $stmt);
}
}
return PHP_Depend_Util_MathUtil::mul($npath, $data);
}
/**
* This method calculates the NPath Complexity of a while-statement, the
* meassured value is then returned as a string.
*
* <code>
* while (<expr>)
* <while-range>
* S;
*
* -- NP(while) = NP(<while-range>) + NP(<expr>) + 1 --
* </code>
*
* @param PHP_Depend_Code_ASTNode $node The currently visited node.
* @param string $data The previously calculated npath value.
*
* @return string
* @since 0.9.12
*/
public function visitWhileStatement($node, $data)
{
$expr = $this->sumComplexity($node->getChild(0));
$stmt = $node->getChild(1)->accept($this, 1);
$npath = PHP_Depend_Util_MathUtil::add($expr, $stmt);
$npath = PHP_Depend_Util_MathUtil::add($npath, '1');
return PHP_Depend_Util_MathUtil::mul($npath, $data);
}
/**
* Calculates the expression sum of the given node.
*
* @param PHP_Depend_Code_ASTNode $node The currently visited node.
*
* @return string
* @since 0.9.12
* @todo I don't like this method implementation, it should be possible to
* implement this method with more visitor behavior for the boolean
* and logical expressions.
*/
public function sumComplexity($node)
{
$sum = '0';
if ($node instanceof PHP_Depend_Code_ASTConditionalExpression) {
$sum = PHP_Depend_Util_MathUtil::add($sum, $node->accept($this, 1));
} else if ($node instanceof PHP_Depend_Code_ASTBooleanAndExpression
|| $node instanceof PHP_Depend_Code_ASTBooleanOrExpression
|| $node instanceof PHP_Depend_Code_ASTLogicalAndExpression
|| $node instanceof PHP_Depend_Code_ASTLogicalOrExpression
|| $node instanceof PHP_Depend_Code_ASTLogicalXorExpression
) {
$sum = PHP_Depend_Util_MathUtil::add($sum, '1');
} else {
foreach ($node->getChildren() as $child) {
$expr = $this->sumComplexity($child);
$sum = PHP_Depend_Util_MathUtil::add($sum, $expr);
}
}
return $sum;
}
}
|