Giter Club home page Giter Club logo

include-fixer-demo's Introduction

#Include-fixer-Demo

The demo repository demonstrates core features of #clang-include-fixer, a tool that automatically adds missing headers for unidentified symbols in cpp files.

screenshot

Enjoy the tool. ➕#️⃣

Setup Include-Fixer

Currently, there is no prebuilt binary provided. You have to check out clang project and build the tool for yourself.

// check out llvm repository
git clone http://llvm.org/git/llvm.git llvm
cd llvm
// check out clang repository
git clone http://llvm.org/git/clang.git clang
cd clang
// check out extral clang tools for include-fixer
git clone http://llvm.org/git/clang-tools-extra.git extra
cd ../
mkdir build
cd build
cmake -G Ninja ../
ninja clang-include-fixer
ninja find-all-symbols

The upstream document is a good reference material.

Projects using Cmake

cd path/to/include-fixer-demo
mkdir build
cmake -G Ninja -DCMAKE_EXPORT_COMPILE_COMMANDS=ON ../
/path/to/run-find-all-symbols.py -b path/to/find-all-symbols
cd build
ln -sf $PWD/compile_commands.json ../
ln -sf $PWD/find_all_symbols.yaml ../

Projects using gyp

cd path/to/include-fixer-demo
gyp demo.gyp -f ninja --depth=.
// Generates compilation json database.
ninja -C out/Default -t compdb cc cxx objc objcxx > compile_commands.json
/path/to/run-find-all-symbols.py -b path/to/find-all-symbols

Other projects

For other non-cmake and non-gyp projects, there is a tool called Bear to generate JSON compilation database (compile_commands.json).

include-fixer-demo's People

Contributors

hokein avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.