Metadata-Version: 2.1
Name: compile-commands
Version: 0.0.1
Summary: Compilation Database Manipulation Utility
Home-page: https://github.com/qdewaghe/compile-commands
Author: Quentin Dewaghe
Author-email: q.dewaghe@gmail.com
License: UNKNOWN
Description: # Compilation Database Manipulation Utility
        
        This utility facilitates the use and modifications of compilation databases. \
        Modifying compilation databases can be useful especially when you don't have control over how a project is built.
        
        ## Install
        
        ```bash
        pip install compile-commands
        ```
        
        ## Usage
        
        In a project composed of subprojects where there are multiple build directory, LSP servers often don't handle this kind of project well.\
        You can use this utility to merge the compilation databases. It will find every compilation databases recursively.
        
        ```bash
        compile-commands.py --dir /path/to/project --merge
        ```
        
        You can also indicate to the LSP server that you prefer using libc++ instead of libstdc++:
        
        ```bash
        compile-commands.py --file /path/to/project/compile-commands.json --add_flags='-stdlib=libc++'
        ```
        
        `--add_flags` takes in a string so you can add multiple flags
        
        ```bash
        compile-commands.py --file /path/to/project/compile-commands.json --add_flags='-stdlib=libc++ -O0'
        ```
        
        You can combine `--add_flags` with `--run` to monitor warnings as example:
        
        ```bash
        compile-commands.py --file /path/to/project/compile-commands.json --add_flags='-Wall -Wextra -pedantic -fsyntax' --run --threads=12
        ```
        
        You can decide to treat only a subset of your project by using `--filter-files` or `--remove-files`.\
        `--filter-files` takes in a regular expression whereas `--remove-files` takes in a comma-separated list of absolute paths.
        
        You can as example filter out .c files from the database:
        ```bash 
        compile-commands.py --file /path/to/project/compile-commands.json --filter-files='.*\.c' --remove-files='path/to/file1,path/to/file2'
        ```
        
        You can also filter out parts of the commands based on a regular expression using `--filter`. \
        This is particularly useful when you need to modify the `-o` from the command. 
        A good example of that is using [ClangBuildAnalyzer](https://github.com/aras-p/ClangBuildAnalyzer). 
        
        ```bash
        mkdir ftime
        cd ftime
        ./compile-commands.py --file=/path/to/project/compile-commands.json --add_flags='-ftime-trace' --filter='-o .*\\.o' --run -j 12
        # .json and .o files are created in-place!
        ClangBuildAnalyzer --all . capture_file
        ClangBuildAnalyzer --analyze capture_file
        ```
        
        We add the clang's `-ftime-trace` as required by ClangBuildAnalyzer and remove every occurences of -o path/to/object/file.o and run each commands to produces the json tracings.\
        What if g++ was used during the creation of compilation database ? In this case we can use `--clang` and `--gcc` to switch between the two compilers and even change the path of the compiler with `--compiler_path` if let's say gcc is in `/usr/bin` and the clang we want to use is in `/usr/bin/local`.
        
        ```bash
        ./compile-commands.py --file=/path/to/project/compile-commands.json --clang --compiler_path='/usr/bin/local' --add_flags='-ftime-trace' --filter='-o .*\\.o' --run -j 12 
        ```
        
        `--filter` also accepts a replacement through the `--replacement` flag, it accepts reference to groups within the regular expression as per `re.sub()`
        
        `--filter` is also useful to remove flags that are not compatible with both compilers.
        
        
        
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Natural Language :: English
Requires-Python: >=3.4
Description-Content-Type: text/markdown
Provides-Extra: dev
