This package provides the following services:
This package consumes the following services:
KT-Advance C Analyzer Atom Package for Linter
https://atom.io/packages/atom-kt-advance
Installation and First Run
Installation from atom.io
- Make sure Java 8 is installed on your computer and is available on $PATH. In Terminal, type
java -version
, if it sayscommand not found
, stop reading this doc. Java 8 installation kits can be found at Oracle. - Make sure
atom
and its CLI package managerapm
are installed. Runningapm -v
should list its version number and some others. - Install the package through Atom Settings Screen or use CLI:
$ apm install atom-kt-advance
Installation from the source code (optional)
- The
atom-kt-advance
package is based on thelinter
package. So, install it from https://atom.io/packages/linter - 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 directorycd atom-kt-advance
. Run the Atom package manager's linker to create a symbolic link between the Atom packages and this projectapm link
. (Useapm unlink
to remove the symbolic link.) - 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. - Relaunch Atom.
- Raise Atom's Command Palette (e.g. ⇧+⌘+P on a Mac). Run the command "Update Package Dependencies: Update".
First run
- 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).
- 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.
Debugging and Settings.
- 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 thech_analysis
directory. When the plugin's scanner has completed you should see new or updated files in thekt_analysis_export.<version>
directory.
- 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).
- To see more detailed output of scanning process, you may enable Verbose Logging option via Atom Settings screen .
- 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
- 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.
- Linter package: https://atom.io/packages/linter.