Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/old/vendor/pdepend/pdepend/src/main/php/PDepend/Metrics/Analyzer/ |
<?php
/**
* This file is part of PDepend.
*
* PHP Version 5
*
* Copyright (c) 2008-2017 Manuel Pichler <[email protected]>.
* 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.
*
* @copyright 2008-2017 Manuel Pichler. All rights reserved.
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
*/
namespace PDepend\Metrics\Analyzer;
use PDepend\Metrics\AbstractCachingAnalyzer;
use PDepend\Metrics\AnalyzerFilterAware;
use PDepend\Metrics\AnalyzerNodeAware;
use PDepend\Metrics\AnalyzerProjectAware;
use PDepend\Source\AST\ASTArtifact;
use PDepend\Source\AST\ASTClass;
use PDepend\Source\AST\ASTCompilationUnit;
use PDepend\Source\AST\ASTFunction;
use PDepend\Source\AST\ASTInterface;
use PDepend\Source\AST\ASTMethod;
use PDepend\Source\AST\ASTNamespace;
use PDepend\Source\Tokenizer\Token;
use PDepend\Source\Tokenizer\Tokens;
/**
* This analyzer collects different lines of code metrics.
*
* It collects the total Lines Of Code(<b>loc</b>), the None Comment Lines Of
* Code(<b>ncloc</b>), the Comment Lines Of Code(<b>cloc</b>) and a approximated
* Executable Lines Of Code(<b>eloc</b>) for files, classes, interfaces,
* methods, properties and function.
*
* The current implementation has a limitation, that affects inline comments.
* The following code will suppress one line of code.
*
* <code>
* function foo() {
* foobar(); // Bad behaviour...
* }
* </code>
*
* The same rule applies to class methods. mapi, <b>PLEASE, FIX THIS ISSUE.</b>
*
* @copyright 2008-2017 Manuel Pichler. All rights reserved.
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
*/
class NodeLocAnalyzer extends AbstractCachingAnalyzer implements
AnalyzerNodeAware,
AnalyzerFilterAware,
AnalyzerProjectAware
{
/**
* Metrics provided by the analyzer implementation.
*/
const M_LINES_OF_CODE = 'loc',
M_COMMENT_LINES_OF_CODE = 'cloc',
M_EXECUTABLE_LINES_OF_CODE = 'eloc',
M_LOGICAL_LINES_OF_CODE = 'lloc',
M_NON_COMMENT_LINES_OF_CODE = 'ncloc';
/**
* Collected project metrics.
*
* @var array<string, integer>
*/
private $projectMetrics = array(
self::M_LINES_OF_CODE => 0,
self::M_COMMENT_LINES_OF_CODE => 0,
self::M_EXECUTABLE_LINES_OF_CODE => 0,
self::M_LOGICAL_LINES_OF_CODE => 0,
self::M_NON_COMMENT_LINES_OF_CODE => 0
);
/**
* Executable lines of code in a class. The method calculation increases
* this property with each method's ELOC value.
*
* @var int
*
* @since 0.9.12
*/
private $classExecutableLines = 0;
/**
* Logical lines of code in a class. The method calculation increases this
* property with each method's LLOC value.
*
* @var int
*
* @since 0.9.13
*/
private $classLogicalLines = 0;
/**
* This method will return an <b>array</b> with all generated metric values
* for the given <b>$node</b> instance. If there are no metrics for the
* requested node, this method will return an empty <b>array</b>.
*
* <code>
* array(
* 'loc' => 23,
* 'cloc' => 17,
* 'eloc' => 17,
* 'ncloc' => 42
* )
* </code>
*
* @return array<string, integer>
*/
public function getNodeMetrics(ASTArtifact $artifact)
{
$metrics = array();
if (isset($this->metrics[$artifact->getId()])) {
$metrics = $this->metrics[$artifact->getId()];
}
return $metrics;
}
/**
* Provides the project summary as an <b>array</b>.
*
* <code>
* array(
* 'loc' => 23,
* 'cloc' => 17,
* 'ncloc' => 42
* )
* </code>
*
* @return array<string, integer>
*/
public function getProjectMetrics()
{
return $this->projectMetrics;
}
/**
* Processes all {@link ASTNamespace} code nodes.
*
* @return void
*/
public function analyze($namespaces)
{
if ($this->metrics === null) {
$this->loadCache();
$this->fireStartAnalyzer();
$this->metrics = array();
foreach ($namespaces as $namespace) {
$namespace->accept($this);
}
$this->fireEndAnalyzer();
$this->unloadCache();
}
}
/**
* Visits a class node.
*
* @return void
*/
public function visitClass(ASTClass $class)
{
$this->fireStartClass($class);
$class->getCompilationUnit()->accept($this);
$this->classExecutableLines = 0;
$this->classLogicalLines = 0;
foreach ($class->getMethods() as $method) {
$method->accept($this);
}
if ($this->restoreFromCache($class)) {
$this->fireEndClass($class);
return;
}
list($cloc) = $this->linesOfCode($class->getTokens(), true);
$loc = $class->getEndLine() - $class->getStartLine() + 1;
$ncloc = $loc - $cloc;
$this->metrics[$class->getId()] = array(
self::M_LINES_OF_CODE => $loc,
self::M_COMMENT_LINES_OF_CODE => $cloc,
self::M_EXECUTABLE_LINES_OF_CODE => $this->classExecutableLines,
self::M_LOGICAL_LINES_OF_CODE => $this->classLogicalLines,
self::M_NON_COMMENT_LINES_OF_CODE => $ncloc,
);
$this->fireEndClass($class);
}
/**
* Visits a file node.
*
* @return void
*/
public function visitCompilationUnit(ASTCompilationUnit $compilationUnit)
{
// Skip for dummy files
if ($compilationUnit->getFileName() === null) {
return;
}
// Check for initial file
$id = $compilationUnit->getId();
if (!$id || isset($this->metrics[$id])) {
return;
}
$this->fireStartFile($compilationUnit);
if ($this->restoreFromCache($compilationUnit)) {
$this->updateProjectMetrics($id);
$this->fireEndFile($compilationUnit);
return;
}
list($cloc, $eloc, $lloc) = $this->linesOfCode($compilationUnit->getTokens());
$loc = $compilationUnit->getEndLine();
$ncloc = $loc - $cloc;
$this->metrics[$id] = array(
self::M_LINES_OF_CODE => $loc,
self::M_COMMENT_LINES_OF_CODE => $cloc,
self::M_EXECUTABLE_LINES_OF_CODE => $eloc,
self::M_LOGICAL_LINES_OF_CODE => $lloc,
self::M_NON_COMMENT_LINES_OF_CODE => $ncloc
);
$this->updateProjectMetrics($id);
$this->fireEndFile($compilationUnit);
}
/**
* Visits a function node.
*
* @return void
*/
public function visitFunction(ASTFunction $function)
{
$this->fireStartFunction($function);
$function->getCompilationUnit()->accept($this);
if ($this->restoreFromCache($function)) {
$this->fireEndFunction($function);
return;
}
list($cloc, $eloc, $lloc) = $this->linesOfCode(
$function->getTokens(),
true
);
$loc = $function->getEndLine() - $function->getStartLine() + 1;
$ncloc = $loc - $cloc;
$this->metrics[$function->getId()] = array(
self::M_LINES_OF_CODE => $loc,
self::M_COMMENT_LINES_OF_CODE => $cloc,
self::M_EXECUTABLE_LINES_OF_CODE => $eloc,
self::M_LOGICAL_LINES_OF_CODE => $lloc,
self::M_NON_COMMENT_LINES_OF_CODE => $ncloc
);
$this->fireEndFunction($function);
}
/**
* Visits a code interface object.
*
* @return void
*/
public function visitInterface(ASTInterface $interface)
{
$this->fireStartInterface($interface);
$interface->getCompilationUnit()->accept($this);
foreach ($interface->getMethods() as $method) {
$method->accept($this);
}
if ($this->restoreFromCache($interface)) {
$this->fireEndInterface($interface);
return;
}
list($cloc) = $this->linesOfCode($interface->getTokens(), true);
$loc = $interface->getEndLine() - $interface->getStartLine() + 1;
$ncloc = $loc - $cloc;
$this->metrics[$interface->getId()] = array(
self::M_LINES_OF_CODE => $loc,
self::M_COMMENT_LINES_OF_CODE => $cloc,
self::M_EXECUTABLE_LINES_OF_CODE => 0,
self::M_LOGICAL_LINES_OF_CODE => 0,
self::M_NON_COMMENT_LINES_OF_CODE => $ncloc
);
$this->fireEndInterface($interface);
}
/**
* Visits a method node.
*
* @return void
*/
public function visitMethod(ASTMethod $method)
{
$this->fireStartMethod($method);
if ($this->restoreFromCache($method)) {
$this->fireEndMethod($method);
return;
}
if ($method->isAbstract()) {
$cloc = 0;
$eloc = 0;
$lloc = 0;
} else {
list($cloc, $eloc, $lloc) = $this->linesOfCode(
$method->getTokens(),
true
);
}
$loc = $method->getEndLine() - $method->getStartLine() + 1;
$ncloc = $loc - $cloc;
$this->metrics[$method->getId()] = array(
self::M_LINES_OF_CODE => $loc,
self::M_COMMENT_LINES_OF_CODE => $cloc,
self::M_EXECUTABLE_LINES_OF_CODE => $eloc,
self::M_LOGICAL_LINES_OF_CODE => $lloc,
self::M_NON_COMMENT_LINES_OF_CODE => $ncloc
);
$this->classExecutableLines += $eloc;
$this->classLogicalLines += $lloc;
$this->fireEndMethod($method);
}
/**
* Updates the project metrics based on the node metrics identifier by the
* given <b>$id</b>.
*
* @param string $id The unique identifier of a node.
*
* @return void
*/
private function updateProjectMetrics($id)
{
foreach ($this->metrics[$id] as $metric => $value) {
$this->projectMetrics[$metric] += $value;
}
}
/**
* Counts the Comment Lines Of Code (CLOC) and a pseudo Executable Lines Of
* Code (ELOC) values.
*
* ELOC = Non Whitespace Lines + Non Comment Lines
*
* <code>
* array(
* 0 => 23, // Comment Lines Of Code
* 1 => 42 // Executable Lines Of Code
* )
* </code>
*
* @param array<int, Token> $tokens The raw token stream.
* @param bool $search Optional boolean flag, search start.
*
* @return array<int, integer>
*/
private function linesOfCode(array $tokens, $search = false)
{
$clines = array();
$elines = array();
$llines = 0;
$count = count($tokens);
if ($search === true) {
for ($i = 0; $i < $count; ++$i) {
$token = $tokens[$i];
if ($token->type === Tokens::T_CURLY_BRACE_OPEN) {
break;
}
}
} else {
$i = 0;
}
for (; $i < $count; ++$i) {
$token = $tokens[$i];
if ($token->type === Tokens::T_COMMENT
|| $token->type === Tokens::T_DOC_COMMENT
) {
$lines =& $clines;
} else {
$lines =& $elines;
}
switch ($token->type) {
// These statement are terminated by a semicolon
//case Tokens::T_RETURN:
//case Tokens::T_THROW:
case Tokens::T_IF:
case Tokens::T_TRY:
case Tokens::T_CASE:
case Tokens::T_GOTO:
case Tokens::T_CATCH:
case Tokens::T_WHILE:
case Tokens::T_ELSEIF:
case Tokens::T_SWITCH:
case Tokens::T_DEFAULT:
case Tokens::T_FOREACH:
case Tokens::T_FUNCTION:
case Tokens::T_SEMICOLON:
++$llines;
break;
case Tokens::T_DO:
case Tokens::T_FOR:
// Because statements at least require one semicolon
--$llines;
break;
}
if ($token->startLine === $token->endLine) {
$lines[$token->startLine] = true;
} else {
for ($j = $token->startLine; $j <= $token->endLine; ++$j) {
$lines[$j] = true;
}
}
unset($lines);
}
return array(count($clines), count($elines), $llines);
}
}