Skip to content
This repository has been archived by the owner on Sep 14, 2024. It is now read-only.

Latest commit

 

History

History
160 lines (118 loc) · 5.51 KB

README.md

File metadata and controls

160 lines (118 loc) · 5.51 KB
Raw

VIM Studio

Can we turn Vim into an IDE? Yes, we can. It works even better and faster than any traditional IDE. Let's dive right in.

overview

Features

  • File system explorer browses directory hierarchies, and performs file system operations

  • Source code browser provides an overview of the structure of the source code

  • Statusbar at the bottom displays useful information

  • Source tab at the top displays all opened source via tab interface

    tab

  • Git wrapper works with Git without leaving Vim studio.

  • Marker highlights several words in different colors.

    maker

  • Auto completion opens a popup menu to complete using tab

    auto completion

  • Automatic index searches and browses source code thanks to Gutentags. Without Gutentags, whenever you modify code, tags must be up-to-date MANUALLY. Yuck!

  • Clang-format integration formats code with the desired style.

  • Vim-airline shows you nice glyphs.

    auto completion

  • For more features, see .vimrc

Environment

Vim studio has been tested on the following environments:

Installation

  1. Set up the terminal

    Set export TERM=xterm-256color in .bashrc

  2. Install exuberant-ctags and global.

    • apt install exuberant-ctags global
    • If you are used to building things from source, universal-ctags is recommended instead of exuberant-ctags because exuberant-ctags is very old and is not maintained.

  3. Install clang-format if you want. apt install clang-format

  4. Install Cascadia Code fonts for glyphs.

  5. Set up Vim config

    git clone --depth 1 --recurse-submodules https://github.com/guru245/vim-studio.git [vim-studio where you want]
ln -s [vim-studio]/.vim ~/.vim
ln -s [vim-studio]/.vimrc ~/.vimrc
vim +PluginInstall +qall

Usage

This section describes mapping keys for Vim studio. Note that normal Vim commands and other detailed configurations of .vimrc are not explained. If you are not familiar with the Vim commands or .vimrc, check out Vim help or Vim options.

  • F1: Show a man page for the keyword under the cursor.
  • F2: Save the current file
  • F3: Toggle tagbar, source code browser on the left side
  • F4: Toggle NERDTree, file system explorer on the right side
  • F5: Fold a function body
  • F6: Unfold a function body
  • F7: Empty
  • F8: Clear all marks
  • F9: Empty
  • F10: Empty
  • F11: Step into the function.
  • F12: Step out of the function.
  • ctrl+h, ctrl+l: Go to the tab on the left/right
  • shift+h, shift+l, shift+k, shift+j: Move between split windows
  • ,w: Save and close the current file. Well~ we call it buffer in Vim
  • ctrl+k: Format code style as per clang-format style options
  • <leader>d: Toggle line number
  • <leader>p: Toggle paste option. This is useful if you want to cut or copy some text from one window and paste it in Vim. Don't forget to toggle paste again once you finish pasting.
  • <leader>m: Mark the keyword under the cursor

To perform cscope searching, use :GscopeFind {querytype} {name}. Where {querytype} corresponds to the actual cscope line interface numbers as well as default nvi commands:

0 or s: Find this symbol
1 or g: Find this definition
2 or d: Find functions called by this function
3 or c: Find functions calling this function
4 or t: Find this text string
6 or e: Find this egrep pattern
7 or f: Find this file
8 or i: Find files #including this file
9 or a: Find places where this symbol is assigned a value

Or you can use the following keymaps:

keymap desc
<leader>cs Find symbol (reference) under cursor
<leader>cg Find symbol definition under cursor
<leader>cd Functions called by this function
<leader>cc Functions calling this function
<leader>ct Find text string under cursor
<leader>ce Find egrep pattern under cursor
<leader>cf Find file name under cursor
<leader>ci Find files #including the file name under cursor
<leader>ca Find places where current symbol is assigned
<leader>cz Find current word in ctags database

Powered by: