Giter Club home page Giter Club logo

vim-headerguard's Introduction

Headerguard - Add header guards to C/C++ header files

It is a common practice to insert header guards into C/C++ header files to allow a header to be included multiple times. A header guard for file HeaderName.h typically looks something like this:

#ifndef HEADERNAME_H
#define HEADERNAME_H

  ...header content...

#endif /* HEADERNAME_H */

Headerguard provides methods for inserting and updating header guards, and for tailoring the header guard style to fit local conventions. It checks for a pre-existing header guard, and if found, modifies the existing guard in-place.

See documentation in doc/headerguard.txt for installation, customization, and usage instructions.

Developed by Michael Henry (vim at drmikehenry.com).

Distributed under Vim's license.

Git repository: https://github.com/drmikehenry/vim-headerguard

vim-headerguard's People

Contributors

drmikehenry avatar petersohn avatar sigill avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar avatar

Forkers

karlmoritz petersohn trygveu thoh-ot handsomedylan1988 yuan- kashioh noevilme weg901127 zhujian198 xiaoweish zeffiretti arsenisoitu seres67

vim-headerguard's Issues

Not compliant with 'Google C++ Style Guide'

First off, thank you for a very nice solution to the header guards! It is greatly appreciated.

The Google C++ Style guide has a point that the include guard should be based off the full project path of the file, to reduce the chance of name collision. This does result in very long include guards, which many probably wont like, others might. It's part of the default check for cpplint.py, which leads me to seeking compliance.

To do this, Vim needs to be aware of the project structure to find the root. I don't know what would be the best way to do this. Some ideas are:

  • look for the .git file
  • check CMakeLists for the project name

It's a too big task to do this for all build systems, but maybe we could do it for git repositories?
What do you think? How would you solve it, and do you consider it worth the effort?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.