cppmagic

cppmagic is a tool for generating C++ source files and headers. It provides functionality to generate, sort, and synchronize C++ files based on headers.

Installation

This program works based on the output generate by ctags.

# Runtime dependency
sudo apt install universal-ctags
# Optional dependency.
sudo apt install libgtest-dev libdw-dev libunwind-dev

git clone https://github.com/ms-jagadeeshan/cppmagic.git
cd cppmagic && mkdir build && cd build
cmake .. -DENABLE_TRACEBACK=OFF
make -j$(nproc)

Usage

cppmagic <subcommand> <options> files/folders

Subcommands

• generate Generate .cpp from header.
• sort Sort the functions in .cpp with respect to given sorting method.
• boom Sort the functions in .cpp and fills the missing functions in .cpp

Options

• -h,--help Print this help message and exit
• --method TEXT Sorting method. header, alpha (Default : header)

Common Options

• --ctags-path ... Path of ctags executable.(Default: /usr/bin/ctags)
• --header-ext ... File extensions to be considered as headers.
• --source-ext ... File extensions to be considered as sources.
• -i,--in-place SUFFIX Edit files in place (makes backup if SUFFIX supplied)

Arguments

To sort C++ files based on their header files, you can specify directories or individual files:

1. Sorting Directories: If you have both headers and sources in separate directories:

• HEADER_FOLDER: The directory containing your header files (e.g., include/mylibrary).
• SOURCE_FOLDER: The directory where the source files exist or to be generated (e.g., src/).

./cppmagic sort [HEADER_FOLDER] [SOURCE_FOLDER]

2. Sorting Single Folder: If your headers and sources are in the same directory:

./cppmagic sort [FOLDER]

3. Sorting Files: if you want to sort certail files only:

./cppmagic sort [FILES]

Example

To sort functions in .cpp with respect to function order in header.

cppmagic/
├── CMakeLists.txt
├── include/
│   ├── cppmagic/
│   │   ├── CppMagic.hpp
│   │   ├── FilePath.hpp
│   │   ├── FileSelector.hpp
│   │   ├── GenerateMode.hpp
│   │   └── ... (other headers)
├── src/
│   ├── CppMagic.cpp
│   ├── FilePath.cpp
│   ├── FileSelector.cpp
│   ├── GenerateMode.cpp
│   └── ... (other files)

cppmagic sort include/cppmagic src

cppmagic/
├── CMakeLists.txt
├── src/
│   ├── CppMagic.cpp
│   ├── FilePath.cpp
│   ├── FileSelector.cpp
│   ├── GenerateMode.cpp
│   ├── ... (other files)
│   ├── CppMagic.hpp
│   ├── FilePath.hpp
│   ├── FileSelector.hpp
│   ├── GenerateMode.hpp
│   └── ... (other headers)

cppmagic sort src

By default, files won't be overwritted. You could use -i or --in-place flag to overwrite.

cppmagic sort -i src

Known Bugs

• Functions will be generated for pure virtual functions and deleted constructor/destructor.

Contributing

Contributions to cppmagic are welcome. Please follow these steps to contribute:

How to Contribute

1. Fork the Repository: Create a personal copy of the repository on GitHub.
2. Create a Branch: Make a new branch for your changes:

git checkout -b feature/your-feature-name

3. Make Changes: Implement your changes and follow the existing code style.
4. Push Changes: Push the branch to GitHub:

git push origin feature/your-feature-name

5. Create a Pull Request: Open a pull request on GitHub with details of the changes.

Need Help?

For support:

• GitHub Issues: Open an issue for questions or problems.

Thank you for contributing!