https://github.com/LucHermitte/vim-clang

Module to Interact with libclang (and clang_indexer DB) from Vim.
https://github.com/LucHermitte/vim-clang

clang-indexer libclang vim

Last synced: 10 days ago
JSON representation

Module to Interact with libclang (and clang_indexer DB) from Vim.

• Host: GitHub
• URL: https://github.com/LucHermitte/vim-clang
• Owner: LucHermitte
• License: gpl-3.0
• Created: 2013-01-11T13:24:22.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2021-04-09T14:47:19.000Z (about 3 years ago)
• Last Synced: 2024-03-01T21:37:22.707Z (4 months ago)
• Topics: clang-indexer, libclang, vim
• Language: Vim script
• Homepage:
• Size: 120 KB
• Stars: 12
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Lists

• awesome-stars - LucHermitte/vim-clang - Module to Interact with libclang (and clang_indexer DB) from Vim. (Vim Script)
• awesome-stars - LucHermitte/vim-clang - Module to Interact with libclang (and clang_indexer DB) from Vim. (Vim Script)

README

        
vim-clang

=========

Module to Interact with libclang (and clang\_indexer DB) from Vim.

[![Project Stats](https://www.openhub.net/p/21020/widgets/project_thin_badge.gif)](https://www.openhub.net/p/21020)

Features:

---------

* Inter-operates with clang\_indexer DB

* Displays the references of the C++ symbol under the cursor with \r

* Displays the declaration(s) of the C++ symbol under the cursor with \d

* Displays the Subclasses of the C++ symbol under the cursor with \s

* Encapsulates the updating of clang\_indexer DB (which requires a project

  configuration compatible with BuildToolsWrappers format)

Installation Requirements:

-------------------------

* [Vim 7.3+](http://www.vim.org), compiled with python support

* Python 2.x

* [clang\_complete](https://github.com/Rip-Rip/clang_complete)

* [clang\_indexer](https://github.com/LucHermitte/clang_indexer)

* [lh-vim-lib](http://github.com/LucHermitte/lh-vim),

  [lh-dev](http://github.com/LucHermitte/lh-dev)

Note: this module takes advantage of the following modules when they are

installed:

* [BuildToolsWrappers](http://github.com/LucHermitte/vim-build-tools-wrapper)

* my fork of Michael Geddes' [buffer-menu](http://github.com/LucHermitte/lh-misc/blob/master/plugin/buffermenu.vim)

With vim-addon-manager, just install `vim-clang`, and let VAM take care of

installing all the vim dependencies. You'll still have to install Vim, Python,

**and** clang\_indexer by yourself.

Note: this script hasn't been registered yet to VAM addons list.

Options:

--------

* The options from clang\_complete apply regarding libclang configuration

  ([bg]:clang\_user\_options that defines how to use libclang)

* [bg]:_[{ft}\_]_clic\_filename that tells where clang\_indexer database is

  located

* g:clang\_key\_usr, g:clang\_key\_declarations, g:clang\_key\_references, and

  g:clang\_key\_subclasses, to override default choices to trigger vim-clang

  features.

To do list:

-----------

* Interface _à la_ taglist()

* Reimplements features from lh-dev and lh-cpp#analysisLib\*.

Disclaimer:

-----------

This module is a fork of @exclipy's fork of

[clang\_complete]().

The functions dedicated to the interaction with clang\_indexer have been extracted,

and a few more will be added.

Licence:

--------

getReferences() and getCurrentUser() functions are courtesy of exclipy.

Copyright 2013 Luc Hermitte

    This program is free software: you can redistribute it and/or modify

    it under the terms of the GNU General Public License as published by

    the Free Software Foundation, either version 3 of the License, or

    (at your option) any later version.

    This program is distributed in the hope that it will be useful,

    but WITHOUT ANY WARRANTY; without even the implied warranty of

    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License

    along with this program.  If not, see .