https://github.com/pascalcorpsman/fpc_understand

Free Pascal static code analyser for Free Pascal and Lazarus Projects
https://github.com/pascalcorpsman/fpc_understand

analysis code-analysis-true cyclomatic-complexity freepascal lazarus source-code statistics

Last synced: 6 days ago
JSON representation

Free Pascal static code analyser for Free Pascal and Lazarus Projects

• Host: GitHub
• URL: https://github.com/pascalcorpsman/fpc_understand
• Owner: PascalCorpsman
• License: other
• Created: 2023-04-29T14:22:39.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-14T06:36:56.000Z (3 months ago)
• Last Synced: 2024-09-14T18:15:18.160Z (3 months ago)
• Topics: analysis, code-analysis-true, cyclomatic-complexity, freepascal, lazarus, source-code, statistics
• Language: Pascal
• Homepage:
• Size: 600 KB
• Stars: 18
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: license.md

Awesome Lists containing this project

README

        
# FPC Understand

FPC-Understand is a Free Pascal code analysing tool written in Free Pascal.

It's main purpose is to statically analyse Free Pascal code and give easy access to it's architecture informations.

![Unit dependencies of fpc_understand](images/fpc_understand_unit_dependencies.png)

These informations are:

- Unit dependencies

- Class hierarchy

- Statisics like: lines of code, cyclomatic complexity ...

- Reviewsupport by code editing and commentingmask

![Code_Line_Analysis](images/Preview_Line_Analysis.png)

The included source editor has a comment function. The created comments can be exported as .csv.

![Codereviews](images/fpc_understand_review_view.png)

The program is mainly designed to work with Lazarus .lpi files, but it is not forced to use .lpi files.

All statistics and analyses are exportable in .csv file format (except the unit dependency graph this is exported as .png)

## How to compile ?

Compile the code using Lazarus 2.2.0 or higher, all plattforms where you can run Lazarus on should be able to compile and run FPC Understand as it is not dependand to any higher level library.

## How to use ?

1. Start the program click "Edit" -> "Project settings"

2. Fill in the Name in page "General"

3. Select a .lpi file (second "select" button from top) in Page "Files"

4. [Optional] Add further files that are not included in the selected .lpi file (or edit the .lpi file to correct includings)

5. click ok

## Editing the dependency graph

Use right mouse context menu to center nodes that are created outside the visible screen.


Click and drag nodes.


Use left mouse button to create a rectangle for selecting multiple nodes. Holding "shift" while clicking on nodes will add them to a selected collection.

## How do i get to the calculated values ?

1. Select none (= all) or as much nodes you want to get the calculations of

2. Open the wanted calculation via "Edit" -> "Show *" or by double clicking on one of the selected nodes

## Known issues:

- The graph component does not support "same" filenames in the project. 

  

  -> If your project contains 2 .pas files with same name but in different locations the graph will merge them into one single node, this will produce invalid dependencies

- The callgraph analysis is more a heuristic than a real code "understanding" 

  -> function pointers are not evaluated, function calls that have the same name are merged into the same node (see "same" filename issue)