atom-kt-advance

KT Advance static C analyser
compartia
0.1.3 644
Flag as spam or malicious

KT-Advance C Analyzer Atom Package for Linter

https://atom.io/packages/atom-kt-advance

Installation and First Run

Installation from atom.io

  1. Make sure Java 8 is installed on your computer and is available on $PATH. In Terminal, type java -version, if it says command not found, stop reading this doc. Java 8 installation kits can be found at Oracle.
  2. Make sure atom and its CLI package manager apm are installed. Running apm -v should list its version number and some others.
  3. Install the package through Atom Settings Screen or use CLI:
$ apm install atom-kt-advance

Installation from the source code (optional)

  1. The atom-kt-advance package is based on the linter package. So, install it from https://atom.io/packages/linter
  2. Download and configure the plugin code. Download the atom-kt-advance project code from https://github.com/compartia/atom-kt-advance. Change into the project directory cd atom-kt-advance. Run the Atom package manager's linker to create a symbolic link between the Atom packages and this project apm link. (Use apm unlink to remove the symbolic link.)
  3. Remove any existing kt_analysis_export* directories from the C project to be analyzed. These may contain plugin output so updated plugin software may be incompatible with older files.
  4. Relaunch Atom.
  5. Raise Atom's Command Palette (e.g. ⇧+⌘+P on a Mac). Run the command "Update Package Dependencies: Update".

First run

  1. In Atom, open a sample KT-Advance-analyzed C project (for example, this one: https://github.com/mrbkt/kestreltech/tree/master/src/test/resources/test_project/itc-benchmarks/01.w_Defects).
  2. Open any C file. The atom-kt-advance code should

Statistics Panel

By pressing ctrl+alt+l you may hide/show the side Statistics Panel. Image

Debugging and Settings.

  1. Raise Atom's Developer's Tools Console (e.g. ⌘+ ⌥+i on a Mac) and confirm the line logged kt-advance: activate. This indicates a successful launch. Upon activation the plugin spawns a Java process to scan the C project for the ch_analysis directory. When the plugin's scanner has completed you should see new or updated files in the kt_analysis_export.<version> directory. Image
  2. Open a C file and save it (e.g. ⌘+S on a Mac) in order to initiate a rescan (linter is triggered every time a C file is saved). Image
  3. To see more detailed output of scanning process, you may enable Verbose Logging option via Atom Settings screen . Image
  4. Because there could be huge number of Open Proof Oblications reported in a large C project, only proven violations are shown by default. To see all issues, one may disable 'Shown proven violation only' option.

Dependencies

  1. This package depends on https://github.com/compartia/kt-advance-to-json which in turn depends on https://github.com/mrbkt/kestreltech/tree/atom-tools.
  2. Linter package: https://atom.io/packages/linter.