jarod42 / ccccc

C and C++ Code Counter using Clang. Tool which reports some metrics like LOC (line of code), Mc Cabe Cyclomatic Number or Halstead metrics.

---

CCCCC stands for C and C++ Code Counter using Clang.

Similar to CCCC, CCCCC is a tool which analyzes C/C++ files and generates a report on various metrics of the code. Metrics supported include lines of code, McCabe's Cyclomatic Complexity, Halstead metrics.

Those metrics can help to identify complex code which might need refactoring.

---

Basic Usage

ccccc myProject/compile_commands.json > output.html ccccc -I IncludeDir srcFiles > output.html

It will create a report in output.html with each function and associated statistics.

It outputs in stderr some extra information about progress or parsing issues (most of them might be ignored, unknown types (due to missing include path) would be replaced by int)

Command arguments

ccccc [-D define] [-I include-path] [-pch pch-file] [-e extra_options] [-t template-file] files...

• -D, --define=name Predefine name as a macro, with definition.
• -I, --include-dir=dir Add the directory dir to the list of directories to be searched for header files.
• -pch Compiled header path
• -e, --extra-option=option Extra option directly given to the clang parser (as -e "-std=c++17").
• -t, --template-file=file Template file to use for report. (default is template/html/template.tpl)
• files... List of source files to examine or directly compile_commands.json (all files in that file would be examined)

CCCCC supports response file, i.e. @my_response_file in command line. Content of the response file is the command line arguments optionally split by line.

---

Example

That is the result applied on ccccc src files:

CCCCC report

---

Build Dependencies

• LLVM/Clang
• mstch (included)
• doctest (for unit tests) (included (header-only))

ccccc's Issues

The feature request for getting metric statistics data of the user include file

Hi,
Thank you for your work. I think high of this project. I like it.
But I have a requirement to get the metric statistics data for all of the user source files which includes header files included within source files. I think many of the statistics would not like to lost header files. Of course, it should not consider system header files, only user include files.
How do you think of that?

Build instructions

After trial and error I was able to build the project. It would be good to have build instructions.

So far I have been able to build a docker container 👍

FROM debian:bookworm-slim
RUN apt-get update
RUN apt-get install make git wget gcc g++ -y
ENV LLVM_VERSION 15
RUN apt-get install gnupg software-properties-common -y
RUN wget -nv https://apt.llvm.org/llvm.sh && \
    chmod +x llvm.sh && \
    ./llvm.sh $LLVM_VERSION && rm -rf llvm.sh
RUN apt-get install clang-15 libclang-15-dev llvm-15-dev llvm-15-runtime llvm-15 -y

#CCCCC
ENV CCCCC_VER f2520dc635c5d232a0f76426c1d525497ab37f22
ENV PREMAKE_VER 2a3f3b75ec97209f0a93368711485d81c4796310
RUN apt-get install libunittest++ \
                    autoconf \
                    libtool \
                    libtinfo-dev \
                    uuid-dev \
                    libctemplate-dev -y
RUN cd /tmp/ && \
    git clone https://github.com/premake/premake-core && \
    cd premake-core && git checkout $PREMAKE_VER && \
    make -f Bootstrap.mak linux CONFIG=release && \
    cp bin/release/premake5 /usr/bin && cd .. && rm -rf premake-core
RUN cd /tmp/ && \
    git clone https://github.com/Jarod42/ccccc && \
    cd ccccc && git checkout $CCCC_VER && \
    premake5 --file="premake/premake5.lua" --llvm-root="/usr/lib/llvm-${LLVM_VERSION}" gmake && \
    cd project/gmake && make config=release verbose=1 && \
    cd ../../bin/gmake/Release && ./ccccc_test && \
    mv ccccc /usr/bin/ && cd .. && rm -rf ccccc