c++ tooling

Author: carneirofc

.clang-tidy

@@ -0,0 +1,55 @@
+# -*- mode: yaml -*-
+# vi: set ft=yaml :
+#
+# Name prefix           Description
+# abseil-               Checks related to Abseil library.
+# altera-               Checks related to OpenCL programming for FPGAs.
+# android-              Checks related to Android.
+# boost-                Checks related to Boost library.
+# bugprone-             Checks that target bug-prone code constructs.
+# cert-                 Checks related to CERT Secure Coding Guidelines.
+# clang-analyzer-       Clang Static Analyzer checks.
+# concurrency-          Checks related to concurrent programming (including threads, fibers, coroutines, etc.).
+# cppcoreguidelines-    Checks related to C++ Core Guidelines.
+# darwin-               Checks related to Darwin coding conventions.
+# fuchsia  -            Checks related to Fuchsia coding conventions.
+# google-               Checks related to Google coding conventions.
+# hicpp-                Checks related to High Integrity C++ Coding Standard.
+# linuxkernel-          Checks related to the Linux Kernel coding conventions.
+# llvm-                 Checks related to the LLVM coding conventions.
+# llvmlibc-             Checks related to the LLVM-libc coding standards.
+# misc-                 Checks that we didn’t have a better category for.
+# modernize-            Checks that advocate usage of modern (currently “modern” means “C++11”) language constructs.
+# mpi-                  Checks related to MPI (Message Passing Interface).
+# objc-                 Checks related to Objective-C coding conventions.
+# openmp-               Checks related to OpenMP API.
+# performance-          Checks that target performance-related issues.
+# portability-          Checks that target portability-related issues that don’t relate to any particular coding style.
+# readability-          Checks that target readability-related issues that don’t relate to any particular coding style.
+# zircon-               Checks related to Zircon kernel coding conventions.
+#
+---
+# https://clang.llvm.org/extra/clang-tidy/
+Checks: "*,
+        -abseil-*,
+        -altera-*,
+        -android-*,
+        -clang-diagnostic-old-style-cast,
+        -cppcoreguidelines-avoid-magic-numbers,
+        -cppcoreguidelines-non-private-member-variables-in-classes,
+        -cppcoreguidelines-pro-bounds-array-to-pointer-decay,
+        -fuchsia-*,
+        -google-*,
+        -hicpp-no-array-decay,
+        -llvm*,
+        -misc-non-private-member-variables-in-classes,
+        -modernize-use-trailing-return-type,
+        -readability-avoid-const-params-in-decls,
+        -readability-else-after-return,
+        -readability-magic-numbers,
+        -readability-static-accessed-through-instance,
+        -zircon-*,
+"
+WarningsAsErrors: ''
+HeaderFilterRegex: ''
+FormatStyle:     none

.gitignore

@@ -1,3 +1,7 @@
+# Ignore compile_commands
+compile_commands.json
+.clangd/
+
 # numpy.i
 numpy.i
 

INSTALL

@@ -0,0 +1,73 @@
+# General instructions
+
+These general instructions will build the binary and library versions of
+trackcpp, and also the python package. Before starting, read the requirements
+in the sections below. If you intend
+
+REQUIREMENTS
+
+(See below).
+
+INSTRUCTIONS
+
+1. Compile with 'make all'.
+
+1. Install with 'make install' or, alternatively, install a symbolic link to
+   the local compiled versions with 'make develop'.
+
+# trackcpp
+
+REQUIREMENTS
+
+- a C++ compiler with C++11 support (tested with GCC 4.8)
+- pthread
+- blas
+- gsl (GNU Scientific Library)
+
+For Debian systems the requirements can be installed using:
+
+```command
+# Debian
+apt install libgsl-dev  libblas-dev swig
+```
+
+Clang tooling: As we are using Makefiles, we can use Bear to generate a compilation database file.
+
+```command
+apt install bear clang-tools clang-format clang-tidy
+```
+
+INSTRUCTIONS
+
+1. Compile with 'make all'.
+
+1. Install trackcpp with 'make install'. The installation directory is
+   $(DEST_DIR), with DEST_DIR=/usr/local/bin by default. Alternatively, install a
+   symbolic link to the local compiled version with 'make develop'.
+
+# trackcpp Python package
+
+REQUIREMENTS
+
+- a C++ compiler with C++11 support (tested with GCC 4.8)
+- blas
+- gsl (GNU Scientific Library)
+- SWIG 2 (tested with SWIG 2.0.11)
+- Python 3 (tested with Python 3.4) with header files
+- Python setuptools (>=16.0)
+- libtrackcpp.a (see previous section)
+
+INSTRUCTIONS
+
+1. Check include and library paths in Makefile. On a Linux system, the default
+   options should work (tested on Ubuntu 14.04 LTS); if necessary, alter the
+   paths. An auxiliary script named 'compile' is provided and may be helpful on
+   Mac OS X.
+
+1. Run 'make all'.
+
+1. Install the package with 'make install'. This will run 'python3 setup.py
+   install', installing the Python package to a default location. Arguments to
+   the command can be supplied through the variable SETUPARGS. Alternatively, the
+   development version can be installed by running 'make develop', which will run
+   'python3 setup.py develop' instead; arguments can be supplied the same way.

INSTALL.md

@@ -82,11 +82,34 @@ PYTHON_PACKAGE_DIR = python_package
 
 $(shell touch $(SRCDIR)/output.cpp) # this is so that last compilation time always goes into executable
 
+WARNINGS_CFLAGS += -Wall
+WARNINGS_CFLAGS += -Wextra # reasonable and standard
+WARNINGS_CFLAGS += -Wshadow # warn the user if a variable declaration shadows one from a parent context
+WARNINGS_CFLAGS += -Wnon-virtual-dtor # warn the user if a class with virtual functions has a non-virtual destructor.
+									 # This helps catch hard to track down memory errors
+# WARNINGS_CFLAGS += -Wdouble-promotion # warn if float is implicit promoted to double
+# WARNINGS_CFLAGS += -Wformat=2 # warn on security issues around functions that format output (ie printf)
+# WARNINGS_CFLAGS += -Wold-style-cast # warn for c-style casts
+# WARNINGS_CFLAGS += -Wsign-conversion # warn on sign conversions
+WARNINGS_CFLAGS += -Wcast-align # warn for potential performance problem casts
+WARNINGS_CFLAGS += -Wconversion # warn on type conversions that may lose data
+WARNINGS_CFLAGS += -Wduplicated-branches # warn if if / else branches have duplicated code
+WARNINGS_CFLAGS += -Wduplicated-cond # warn if if / else chain has duplicated conditions
+WARNINGS_CFLAGS += -Wimplicit-fallthrough # warn on statements that fallthrough without an explicit annotation
+WARNINGS_CFLAGS += -Wlogical-op # warn about logical operations being used where bitwise were probably wanted
+WARNINGS_CFLAGS += -Wmisleading-indentation # warn if indentation implies blocks where blocks do not exist
+WARNINGS_CFLAGS += -Wnull-dereference # warn if a null dereference is detected
+WARNINGS_CFLAGS += -Woverloaded-virtual # warn if you overload (not override) a virtual function
+WARNINGS_CFLAGS += -Wpedantic # warn if non-standard C++ is used
+WARNINGS_CFLAGS += -Wunused # warn on anything being unused
+WARNINGS_CFLAGS += -Wuseless-cast # warn if you perform a cast to the same type
+
 ifeq ($(MAKECMDGOALS),trackcpp-debug)
   CFLAGS    = $(MACHINE) $(DBG_FLAG) $(DFLAGS) -pthread
 else
   CFLAGS    = $(MACHINE) $(OPT_FLAG) $(DFLAGS) -pthread
 endif
+CFLAGS += $(WARNINGS_CFLAGS)
 
 LIBOBJECTS  = $(addprefix $(OBJDIR)/, $(LIBSOURCES_CPP:.cpp=.o))
 BINOBJECTS  = $(addprefix $(OBJDIR)/, $(BINSOURCES_CPP:.cpp=.o))

Makefile

@@ -1,2 +1,13 @@
 # trackcpp
-Particle tracking code 
+
+Particle tracking code
+
+## Code check
+
+In order to use clang-tidy, a compile_commands.json file must be present at the root of the repository.
+In order to generate one and still use make as the build system:
+
+```command
+# Compile using 'bear <build command>'
+bear make -j$(nproc)
+```

README.md

@@ -0,0 +1,4 @@
+#!/bin/sh
+set -exu
+make clean
+bear make

tools/compile-command.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+set -exu
+clang-tidy-12 src/*.cpp