Develop and Debug with CLion

Requirement

• CLion: Use CMU .edu email to get free, renewable 1-year license for CLion Professional Edition

Setup

• In CLion, select Check out from Version Control > Git, clone the repository. Alternatively, if you've already cloned the repository, choose Open and select the top level project directory.
• Go to File > Settings... (CLion > Preferences... on macOS)
  • Go to Build, Execution, Deployment > CMake. Create as many build profiles as you need. We recommend at least the following 3 for developers:
    • For development: Build type: Debug, CMake options: -DTERRIER_USE_ASAN=ON
    • For profiling: Build type: RelWithDebInfo
    • For benchmarking: Build type: Release
  • If you're on macOS and don't want to set them globally, add the following environment variables for each Profile:
    • LLVM_DIR=/usr/local/Cellar/llvm@6.0/6.0.1/lib/llvm-6.0
    • ASAN_OPTIONS=detect_container_overflow=0
• After CLion processes the CMake project files, choose your build target and profile from the drop-down menu at the top-right of the IDE and build.

Customization

• Go to File > Settings... (CLion > Preferences... on macOS) and then Editor > Code Style > C/C++. Go to Set from... > Predefined Style > Google. You should rely on scripts for formatting, but this will make CLion closely adhere to our preferred style while you work.

Debug

• Use CLion's built-in debugger to set breakpoints and step through the code.

Tips

• CLion caches the CMake project files, so if you add or remove files you'll want to refresh the build settings by going to Tools > CMake > Reset Cache and Reload Project.