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

Sublime​Linter-contrib-gcc

by jfcherng ST3

This linter plugin for SublimeLinter provides an interface to gcc or other gcc-like (cross-)compiler.

Details

Installs

  • Total 1K
  • Win 499
  • OS X 196
  • Linux 515
Dec 18 Dec 17 Dec 16 Dec 15 Dec 14 Dec 13 Dec 12 Dec 11 Dec 10 Dec 9 Dec 8 Dec 7 Dec 6 Dec 5 Dec 4 Dec 3 Dec 2 Dec 1 Nov 30 Nov 29 Nov 28 Nov 27 Nov 26 Nov 25 Nov 24 Nov 23 Nov 22 Nov 21 Nov 20 Nov 19 Nov 18 Nov 17 Nov 16 Nov 15 Nov 14 Nov 13 Nov 12 Nov 11 Nov 10 Nov 9 Nov 8 Nov 7 Nov 6 Nov 5 Nov 4 Nov 3
Windows 1 2 2 0 0 1 2 4 0 0 6 1 1 5 1 1 2 8 2 0 4 2 1 3 2 2 2 6 0 0 0 2 3 2 1 1 2 3 5 3 1 2 4 3 5 1
OS X 1 0 0 0 0 1 2 1 0 0 1 1 1 1 1 0 0 0 1 0 0 2 5 1 0 1 2 0 0 0 0 1 2 1 1 0 1 3 0 5 2 1 2 1 0 0
Linux 0 1 1 0 5 2 1 4 1 0 1 1 3 2 6 3 1 1 6 3 2 3 0 1 2 2 2 3 4 2 1 3 1 2 0 0 3 8 6 0 1 4 5 0 1 4

Readme

Source
raw.​githubusercontent.​com

SublimeLinter-contrib-gcc

This linter plugin for SublimeLinter provides an interface to gcc or other gcc-like (cross-)compiler. It will be used with files that have the C/C++ syntax. If you are using clang, you should consider Sublime​Linter-contrib-clang.

Installation

SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.

Linter installation

Before using this plugin, you must ensure that gcc or other gcc-like (cross-)compiler is installed on your system.

You may install gcc with the following method:

Once gcc is installed, you must ensure it is in your system PATH so that SublimeLinter can find it. This may not be as straightforward as you think, so please read How linter executables are located in the documentation.

Once you have installed gcc you can proceed to install the SublimeLinter-contrib-gcc plugin if it is not yet installed.

Plugin installation

Please use Package Control to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won't cover that here.

To install via Package Control, do the following:

  1. Within Sublime Text, bring up the Command Palette and type install. Among the commands you should see Package Control: Install Package. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.

  2. When the plugin list appears, type gcc. Among the entries you should see SublimeLinter-contrib-gcc. If that entry is not highlighted, use the keyboard or mouse to select it.

Settings

For general information on how SublimeLinter works with settings, please see Settings. For information on generic linter settings, please see Linter Settings.

In addition to the standard SublimeLinter settings, SublimeLinter-contrib-gcc provides its own settings.

Setting Description
executable If you are not using gcc, you have to set this to your compiler binary. (like arm-none-eabi-gcc)
include_dirs A list of directories to be added to the header search paths (-I is not needed).
extra_flags A string with extra flags to pass to the compiler. These should be used carefully, as they may cause linting to fail.
  • All settings above could be C or C++ specific. To do that, simply add c_ or c++_ prefix to a setting's key.
  • For project-specific settings, ${project_folder} can be used to specify relative path.

Here is an example settings:

"SublimeLinter":
{
    "linters":
    {
        "gcc": {
            "c_executable": "gcc",
            "c++_executable": "g++",
            "c_extra_flags": "-fsyntax-only -std=c90",
            "c++_extra_flags": "-fsyntax-only -std=c++11",
            "include_dirs": [
                "${project_folder}/3rdparty/bar/include",
                "${project_folder}/3rdparty/baz"
            ]
        }
    }
},

Notes

  • Here is the official list of warning options in gcc 7.2.0. I prefer turn on all warnings via -Wall (this is default for this plugin) and then suppress unwanted warnings via -Wno- prefix.
  • Flag -fsyntax-only gives a much faster syntax-only checking but some warnings which are emitted in the code optimization phase would not be caught.

Demo

linting_example

Troubleshooting

C/C++ linting is not always straightforward. A few things to try when there's (almost) no linting information available:

  • Try to compile from the command line, and verify it works.
  • The linter might be missing some header files. They can be added with include_dirs.
  • Sometimes gcc fails to locate the C/C++ standard library headers.

Assuming the compilation works when executed via command line, try to compile with g++ -v. This will display all of the hidden flags that gcc uses. As a last resort, they can all be added as extra_flags.

Contributing

If you would like to contribute enhancements or fixes, please do the following:

  1. Fork the plugin repository.
  2. Hack on a separate topic branch created from the latest master.
  3. Commit and push the topic branch.
  4. Make sure your modification could pass unittests.
  5. Make a pull request.
  6. Be patient. ;-)

Please note that modifications should follow these coding guidelines:

  • Indent is 4 spaces.
  • Code should pass flake8 and pep257 linters.
  • Vertical whitespace helps readability, don’t be afraid to use it.
  • Please use descriptive variable names, no abbrevations unless they are very well known.

Thank you for helping out!

License

The MIT License (MIT)

Copyright © 2017 Jack Cherng

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Supporters

Thank you guys for sending me some cups of coffee.