ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Cpp​Toolkit

by mccartnm ST3

Sublime Text 3+ plugin to make C++ life a little easier

Details

Installs

  • Total 754
  • Win 377
  • Mac 100
  • Linux 277
Jun 7 Jun 6 Jun 5 Jun 4 Jun 3 Jun 2 Jun 1 May 31 May 30 May 29 May 28 May 27 May 26 May 25 May 24 May 23 May 22 May 21 May 20 May 19 May 18 May 17 May 16 May 15 May 14 May 13 May 12 May 11 May 10 May 9 May 8 May 7 May 6 May 5 May 4 May 3 May 2 May 1 Apr 30 Apr 29 Apr 28 Apr 27 Apr 26 Apr 25 Apr 24 Apr 23
Windows 0 2 0 3 1 0 1 0 0 1 1 3 2 1 1 0 0 1 1 1 1 0 3 1 1 2 2 2 0 2 3 3 2 2 1 1 2 4 2 1 3 2 4 1 3 0
Mac 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 2 0 1 1 0 1 0 1 0 0 0 0 0 0 0 0 1 0 0 0 1 1 0 1 1 0 0 0
Linux 0 0 0 1 0 1 2 0 0 1 2 0 0 2 0 1 0 0 1 0 1 1 2 0 1 2 2 0 1 0 2 2 1 1 0 1 1 0 1 0 2 1 2 3 1 1

Readme

Source
raw.​githubusercontent.​com

Cpp Toolkit

A collection of utilities for managing C++ code implementation.

Disclaimer: Sublime is not a fully featured C++ IDE and this plugin doesn't try to make it one. It simply tries to speed up your usual work

Features

  • Build Implementation from the class definition
  • Generate get/set commands for internal members
  • Move implementations outside of the class definition
  • (Coming soon) Build implementations for an entire class

Quick Tour

Auto Implement

Many IDEs out there make use their inherent understanding of you project through syntax and preprocessing to present perks like being able to automatically declare methods from the header within the source. This saves the developer loads of time.

Usability

Getter / Setter Functions

Getters and setters are used in a plentiful sense in modern C++. For this reason, there is also the ability to right click on members and build their respective functions.

Currently this does its best to identify the proper signature but may not always be what you're looking for. That said it should still speed up Sublime typing.

GetAndSet

A Scenario

Let's say you have the header:

// my_file.h
namespace my_namespace
{

class MyClass : public SomeBase
{
public:
    // ...

    void getSomeData(float bar, MyStruct::SomeEnum val = MyStruct::Value) const override;
}

And now you want to move that to your source. Currently in Sublime you have a limited set of options. Until this plugin I would do the following:

  1. Move my cursor to the line and hit Ctrl + C to copy the whole line
    • If the definition was multiple lines, I would use Ctrl + L enough times to get it all or use my mouse
  2. Swap to the source with Alt + O
  3. Move my cursor to where I could declare the method
  4. Paste in the header code via Ctrl + V
  5. Highlight the line (or just have one cursor on it if one line) and Shift + Tab enough to set it
  6. Fill in the ownership chain
  7. Die a little inside
  8. Go throughout the function and remove any cruft like override; and the = MyStrcut::Value in the example above
  9. Finally add the parentheses and get to freaking work

The Fix

With Cpp Toolkit, the workflow is:

  1. Right click on the function name to declare
  2. Go to C++ Toolkit > Declare in <source_file_name>.cpp

And bam! You'll be moved to the source file, all the right guts and ownership will be filled in, no pesky non-const classifiers or default values, and your cursor will be right where you need it to start typing the function body!

Note: At the moment, this assumes, just like the Alt + O shortcut, that the header and implementation are next to each other in the filesystem. In the future I may add ways to declare an implementation root or location or some such.

The Catch

Ultimately, this tool is parsing the file and doing what it can with immediate information but, as any C++ developer knows, the language has quite a few caveats so you may not get the perfect signature or ownership every time however it should still get you moving in the right direction and speed up a lot of typing.

Install

Using Package Control Sublime Package Manager

To install use these commands.

  • Hit Ctrl + Shift + P
  • Type install and select Package Control: Install Package
  • Type CppToolkit and select CppToolkit

Or just clone this repo and place it into your Sublime user data directory under Packages.

Roadmap

There are many things to do for this plugin that I'm hoping to tick away at in my spare time

  1. Basic preprocess for things like #ifdef 0 ... #endif clauses
  2. Camel case/Snake case conversion when needed This is already in the sweet CaseConversion plugin
  3. Switch statement breakout (based on some kind of classifier)
  4. Smart inject based on other declarations in the source rather than always at the end
  5. Reverse implement to go from source to header under a given privilege
  6. Apply changes to function signatures in both header and source
  7. Getter/Setter functions of members (done)
  8. Have the commands work in both source and header, just using the parser to understand what commands can be used
  9. Hotkeys for select functions
  10. Implement a whole class by simply right clicking on the class name (woah)