https://github.com/Badhi/nvim-treesitter-cpp-tools
C++ Helper Snippets Using Treesitter
https://github.com/Badhi/nvim-treesitter-cpp-tools
cpp lua neovim nvim nvim-treesitter treesitter
Last synced: 3 months ago
JSON representation
C++ Helper Snippets Using Treesitter
- Host: GitHub
- URL: https://github.com/Badhi/nvim-treesitter-cpp-tools
- Owner: Badhi
- License: apache-2.0
- Created: 2021-12-08T14:09:35.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-01T01:33:39.000Z (over 1 year ago)
- Last Synced: 2024-08-07T18:37:05.070Z (about 1 year ago)
- Topics: cpp, lua, neovim, nvim, nvim-treesitter, treesitter
- Language: Lua
- Homepage:
- Size: 880 KB
- Stars: 122
- Watchers: 4
- Forks: 9
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nt-cpp-tools
Experimental treesitter based neovim plugin to create intelligent implementations for C++
## Features
1. Out-of class member function implementation
2. Concrete class implement from Abstract class or Interface
3. Add missing functions to obey Rule of 3
4. Add missing functions to obey Rule of 5
## Install
Using [paq](https://github.com/savq/paq-nvim)
```lua
require "paq" {
"nvim-treesitter/nvim-treesitter",
"Badhi/nvim-treesitter-cpp-tools",
}
```
Using [packer.nvim](https://github.com/wbthomason/packer.nvim)
```lua
use {
requires = { "nvim-treesitter/nvim-treesitter" },
"Badhi/nvim-treesitter-cpp-tools",
}
```
Using [lazy.nvim](https://github.com/folke/lazy.nvim)
```lua
{
"Badhi/nvim-treesitter-cpp-tools",
dependencies = { "nvim-treesitter/nvim-treesitter" },
-- Optional: Configuration
opts = function()
local options = {
preview = {
quit = "q", -- optional keymapping for quit preview
accept = "", -- optional keymapping for accept preview
},
header_extension = "h", -- optional
source_extension = "cpp", -- optional
custom_define_class_function_commands = { -- optional
TSCppImplWrite = {
output_handle = require("nt-cpp-tools.output_handlers").get_add_to_cpp(),
},
--[[
= {
output_handle = function (str, context)
-- string contains the class implementation
-- do whatever you want to do with it
end
}
]]
},
}
return options
end,
-- End configuration
config = true,
}
```
## Setup
**For [lazy.nvim](https://github.com/folke/lazy.nvim), see [Install](#install)**
Add the following config to your init script
> **Note:** The config for this plugin, included in the `treesitter.config` is now moved to an independent config. Please make required changes
```lua
require 'nt-cpp-tools'.setup({
preview = {
quit = 'q', -- optional keymapping for quit preview
accept = '' -- optional keymapping for accept preview
},
header_extension = 'h', -- optional
source_extension = 'cxx', -- optional
custom_define_class_function_commands = { -- optional
TSCppImplWrite = {
output_handle = require'nt-cpp-tools.output_handlers'.get_add_to_cpp()
}
--[[
= {
output_handle = function (str, context)
-- string contains the class implementation
-- do whatever you want to do with it
end
}
]]
}
})
```
## Usage
* Select the range of the class using visual mode
* Use below commands
| Command | Feature |
| ----------- | ----------- |
| `TSCppDefineClassFunc` | Implement out of class member functions
*subset of functions can be implemented by selecting required function declarations using visual mode or simply keeping the cursor on the function declaration before calling the command*
Supported special features
1. Templates (with default args)
2. Function arguments with default values
3. Nested classes
(check [test_cases](https://github.com/Badhi/nvim-treesitter-cpp-tools/blob/master/test/implement_functions.txt) for tested examples)|
| `TSCppMakeConcreteClass` | Create a concrete class implementing all the pure virtual functions |
| `TSCppRuleOf3` | Adds the missing function declarations to the class to obey the Rule of 3 (if eligible) |
| `TSCppRuleOf5` | Adds the missing function declarations to the class to obey the Rule of 5 (if eligible) |
## Example
1. `TSCppDefineClassFunc`
2. `TSCppMakeConcreteClass`
3. `TSCppRuleOf3`
