microsoft / pal
Source Code Overview

Analysis scope, overview of main, test, generated, deployment, build, and other code.

Source Code Analysis Scope
Files includes and excluded from analyses
proj
txt
vcxproj
filters
cfg
s
xsl
sl
  • 17 extensions are included in analyses: h, cpp, proj, txt, py, sh, vcxproj, filters, yml, cfg, s, xsl, bat, md, json, sl, gitignore
  • 5 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (2 files).
    • exclude files with path like ".*/git[-]history[.]txt" (Git history) (1 file).
    • exclude files with path like ".*/git[-][a-zA-Z0-9_]+[.]txt" (Git data exports for sokrates analyses) (0 files).
    • exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
    • exclude files with path like ".*[.]txt" (Text files) (24 files).
Overview of Analyzed Files
Basic stats on analyzed files
Intro
For analysis purposes we separate files in scope into several categories: main, test, generated, deployment and build, and other.

  • The main category contains all manually created source code files that are being used in the production.
  • Files in the main category are used as input for other analyses: logical decomposition, concerns, duplication, file size, unit size, and conditional complexity.
  • Test source code files are used only for testing of the product. These files are normally not deployed to production.
  • Build and deployment source code files are used to configure or support build and deployment process.
  • Generated source code files are automatically generated files that have not been manually changed after generation.
  • While a source code folder may contain a number of files, we are primarily interested in the source code files that are being written and maintained by developers.
  • Files containing binaries, documentation, or third-party libraries, for instance, are excluded from analysis. The exception are third-party libraries that have been changed by developers.

main53579 LOC (57%) 293 files
test39092 LOC (42%) 185 files
generated0 LOC (0%) 0 files
build and deployment266 LOC (<1%) 3 files
other80 LOC (<1%) 1 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
proj
vcxproj
filters
cfg
s
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 293 files match defined criteria (53,579 lines of code, 100.0% vs. main code):
    • 116 *.cpp files (37,255 lines of code)
    • 130 *.h files (10,807 lines of code)
    • 25 *.proj files (2,712 lines of code)
    • 9 *.py files (1,383 lines of code)
    • 4 *.vcxproj files (786 lines of code)
    • 4 *.filters files (375 lines of code)
    • 2 *.cfg files (180 lines of code)
    • 2 *.s files (61 lines of code)
    • 1 *.yml files (20 lines of code)
  • " *.cpp" is biggest, containing 69.53% of code.
  • " *.yml" is smallest, containing 0.04% of code.


*.cpp37255 LOC (69%) 116 files
*.h10807 LOC (20%) 130 files
*.proj2712 LOC (5%) 25 files
*.py1383 LOC (2%) 9 files
*.vcxproj786 LOC (1%) 4 files
*.filters375 LOC (<1%) 4 files
*.cfg180 LOC (<1%) 2 files
*.s61 LOC (<1%) 2 files
*.yml20 LOC (<1%) 1 files
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
xsl
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]est/.*".
    • files with paths like ".*_test[.].*".
    • files with any line of content like ".*/simpletest/.*".
  • 185 files match defined criteria (39,092 lines of code, 73.0% vs. main code):
    • 87 *.cpp files (33,274 lines of code)
    • 91 *.h files (5,682 lines of code)
    • 1 *.xsl files (111 lines of code)
    • 6 *.sh files (25 lines of code)
  • " *.cpp" is biggest, containing 85.12% of code.
  • " *.sh" is smallest, containing 0.06% of code.


*.cpp33274 LOC (85%) 87 files
*.h5682 LOC (14%) 91 files
*.xsl111 LOC (<1%) 1 files
*.sh25 LOC (<1%) 6 files
Build and Deployment Code
Source code used to configure or support build and deployment process.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]sh".
    • files with paths like ".*[.]bat".
  • 3 files match defined criteria (266 lines of code, 0.5% vs. main code):
    • 2 *.sh files (262 lines of code)
    • 1 *.bat files (4 lines of code)
  • " *.sh" is biggest, containing 98.5% of code.
  • " *.bat" is smallest, containing 1.5% of code.


*.sh262 LOC (98%) 2 files
*.bat4 LOC (1%) 1 files
Other Code
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]json".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*[.]txt".
  • 1 file matches defined criteria (80 lines of code, 0.1% vs. main code). All matches are in *.md files.


*.md80 LOC (100%) 1 files
Analyzers
Info about analyzers used for source code examinations.
  • *.cpp files are analyzed with CppAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • Unit size analysis
    • Conditional complexity analysis
    • Advanced heuristic dependency analysis
  • *.h files are analyzed with CppAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • Unit size analysis
    • Conditional complexity analysis
    • Advanced heuristic dependency analysis
  • *.proj files are analyzed with XmlAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis
  • *.py files are analyzed with PythonAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • Unit size analysis
    • Conditional complexity analysis
    • Basic heuristic dependency analysis
  • *.vcxproj files are analyzed with XmlAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis
  • *.filters files are analyzed with XmlAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis
  • *.cfg files are analyzed with CfgAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis
  • *.s files are analyzed with DefaultLanguageAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Basic code cleaning (empty lines removed for LOC calculations and duplication calculations)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis
  • *.yml files are analyzed with YamlAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis


2022-01-30 11:30