Phone highlight

For given phone and search pattern returns structures of indexes which should be highlighted. Allows to calculate highlights for visualization of search as it's done by phone. Some special characters are ignored during calculation (e.g. "(", ")", " " and some other)

E.g. for number "(123) 55 35" and search string "35" result will be "3-3;6-6;9-10". For more cases see unit tests.

Platform

Ubuntu 18.10: Clang 7.0, GCC 8.2, CMake 3.12, Conan

macOS 10.14: CMake 3.12, Conan

C++14 Standard is used.

WebKit style is used.

See tools/Dockerfile for details how to setup development environment

Setup

Submodules are used. Initial command after clone is git submodule update --init --recursive.

Assuming all further commands are executed from project root.

Setup git hook

Run tools/install_hooks.py

This will allow to perform some code checks locally before posting changes to server.

Dependencies

Libs: Boost 1.69, ICU, Google benchmark, Catch2, Range-v3

Project uses Conan Package Manager

Install conan with

sudo -H pip install conan

CMake will try to automatically setup dependencies.

Add additional repositories to conan:

conan remote add bincrafters https://api.bintray.com/conan/bincrafters/public-conan
conan remote add catchorg https://api.bintray.com/conan/catchorg/Catch2
conan remote add conan-mpusz https://api.bintray.com/conan/mpusz/conan-mpusz
conan remote add range-v3 https://api.bintray.com/conan/range-v3/range-v3

Cmake will automatically check required dependencies and setup them taking into account current compiler (clang or gcc).

Conan misses gcc 8.2 in default config at the moment. The one can use pre-defined config file.

conan config install ./tools/conan/cfg

Draw deps with cmake

cmake --graphviz=graph ..
dot graph -T png -o graph.png

Install doxygen

sudo apt install -y doxygen graphviz

Build

Build commands

macOS

Run in project root to build debug version

mkdir build-debug && cd build-debug && cmake .. && make -j$(sysctl -n hw.ncpu)

To build release version run the following command

mkdir build-release && cd build-release && cmake -DCMAKE_BUILD_TYPE=Release .. && make -j$(sysctl -n hw.ncpu)

Linux

By default used clang compiler and debug mode.

Run in project root to build debug version with clang

mkdir build-clang-debug && cd build-clang-debug && cmake .. && make -j$(nproc)

To build release version with gcc run the following command

RUN mkdir build-gcc-release && cd build-gcc-release && CXX=g++ cmake -DCMAKE_BUILD_TYPE=Release .. && make -j$(nproc)

Build with sanitizers (clang)

You can enable sanitizers with SANITIZE_ADDRESS, SANITIZE_MEMORY, SANITIZE_THREAD or SANITIZE_UNDEFINED options in your CMake configuration. You can do this by passing e.g. -DSANITIZE_ADDRESS=On in your command line.

Run

Run tests

Run from build directory

ctest

or

./testrunner

Test runner options

1. Show execution duration

./testrunner -d yes

2. List tests

./testrunner -l

3. Run specific test

3.1 Run test ./testrunner TestCaseName

3.2 Run section ./testrunner TestCaseName -c SectionName

Run benchmark

./benchmark

Coverage report

To enable coverage support in general, you have to enable ENABLE_COVERAGE option in your CMake configuration. You can do this by passing -DENABLE_COVERAGE=On on your command line or with your graphical interface.

If coverage is supported by your compiler, the specified targets will be build with coverage support. If your compiler has no coverage capabilities (I assume Intel compiler doesn't) you'll get a warning but CMake will continue processing and coverage will simply just be ignored.

Collect coverage in Debug mode. Tested with gcc 5.0 and clang 5.0 compiler.

Sample commands to get coverage html report

CXX=g++ cmake -DENABLE_COVERAGE=On -DCMAKE_BUILD_TYPE=Debug ..
make -j$(nproc)
make test
make lcov-capture
make lcov-genhtml
xdg-open lcov/html/selected_targets/index.html

Integration

Create docker image

Dockerfile: image, which contains basic environment setup (compiler, build tools)

docker build -t phone-highlight -f tools/Dockerfile .

Clang static analyzer

Sample command to run analyzer. By default report is stored in /tmp/scan-build*

mkdir build-debug
cd build-debug
scan-build --use-analyzer=/usr/bin/clang++ cmake ..
scan-build --use-analyzer=/usr/bin/clang++ make -j$(nproc)

or

cmake ..
make clang-static-analyzer

Clang-tidy

Setting are stored in .clang-tidy.

Run

mkdir build
cd build
cmake ..
make clang-tidy

Documentation

Code contains doxygen. To generate html documentation run command make doc. Output will be in <build dir>\doc\html