Skip to content

Latest commit

 

History

History
executable file
·
70 lines (51 loc) · 2.85 KB

build_and_code.md

File metadata and controls

executable file
·
70 lines (51 loc) · 2.85 KB

Overview

CCSM is built as a Clang tool. clang does the heavy lifting of parsing the C/C++ into an AST, then CCSM processes the AST to gather the metrics.

Building The Project

Before starting, please ensure that you have a command-line version of git installed. If you are using Windows, you must ensure that git is available to Windows Command Prompt.

To build the project you will need to be able to compile Clang, including having all dependencies installed. See the instructions.

Currently I use Visual Studio 2019 on Windows and GCC on Ubuntu Bionic Beaver for builds.

Follow the instructions up to the point where you have checked out the LLVM project, then open the file llvm-project\clang\tools\CMakeLists.txt and add the following lines:

set(CCSM_DIR F:/WORK/GIT/CCSM/)
add_subdirectory(${CCSM_DIR}/src ${CMAKE_CURRENT_BINARY_DIR}/ccsm)

You will need to modify the path on the first line to point to wherever your clone of the CCSM project is (it should point to the parent of the 'src' directory)

After that, follow the remainder of the instructions for building Clang. CCSM should be build as part of the complete Clang build.

Quick Start

A script within the repo may help get you to the stage where you can build the code:

git clone --recurse-submodules https://github.com/bright-tools/ccsm.git
./ccsm/utils/vagrant/buildit.sh ccsm

Code Structure

File Content
ccsm.cpp main() function to process command line options, set up clang and invoke the processing of the AST via a MetricMatcher
MetricASTConsumer.cpp Class which received callbacks as new AST translation units are processed
MetricUnit.cpp Class to support counting of the metrics, arranged th objects arranged in a hierachial structure
MetricUtils.cpp Support functions for doing any significant AST processing not supported by clang out-of-the-box
MetricMatcher.cpp AST visitor which deals with processing the AST call-backs and recording the appropriate metrics via MetricUnit objects
MetricPPConsumer.cpp Class to receive call-backs from the pre-processor in order to collect metrics relating to comments (not present in the AST tree)

TODO: Needs to be updated

Running Regression Tests

To run the tests you need to

  1. Have BATS installed.
  2. Have compiled CCSM
  3. Set the environment variable CCSM_EXE to point to the binary to be tested. e.g. export CCSM_EXE=~/build/bin/ccsm

Once this is done, to run the test suite:

  1. cd tests
  2. bats tests