Writing custom checkers with Klocwork Extensibility

From Insight-9.2

Revision as of 12:55, 28 March 2011 by Habbott (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

The Klocwork Extensibility Interface consists of Application Programming Interfaces (APIs) that allow you to define additional C/C++ or Java code issues to check for, and to integrate these "checkers" into Klocwork. There are two kinds of custom checkers you can create--KAST and Path.

The Klocwork Extensibility Interface is automatically installed when you install the Klocwork command line feature from the Klocwork Insight User package.

Prerequisites

To create custom checkers, you must have the Klocwork Insight User package installed. If you do a custom install of the Klocwork User package, you must at minimum install "Klocwork command line".

Mac users: You must have a working version of the GCC compiler on your machine to create custom checkers.

Note: The how-to's in this section assume that you have added the Klocwork bin directory to your Path. For:

  • Windows, the Klocwork bin directory is automatically added to your User Path environment variable
  • Mac, symbolic links are set in /usr/local/kw/ for command-line tools

For a complete list of system requirements, see System requirements.

Before you begin creating your own checkers, you can go to the Klocwork Forums to see if anyone has posted a checker that you can use.

How-to's and tutorials

Writing custom C/C++ checkers

Writing custom Java checkers

Deploying custom checkers

Extensibility troubleshooting