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

Sublime​Linter-gcc

by SublimeLinter ST3

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

Details

Installs

  • Total 9K
  • Win 3K
  • OS X 1K
  • Linux 4K
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 Nov 2 Nov 1 Oct 31 Oct 30 Oct 29 Oct 28 Oct 27 Oct 26 Oct 25
Windows 4 6 2 3 3 3 3 3 5 1 1 3 7 2 5 6 3 1 1 4 5 3 2 3 7 7 9 5 3 2 3 5 4 5 4 3 3 3 4 7 5 4 4 2 2 6
OS X 1 1 0 2 0 4 1 2 0 1 0 1 1 5 0 3 1 1 0 1 2 1 0 1 1 0 0 0 1 0 0 1 4 4 2 1 0 1 7 1 0 0 2 3 0 3
Linux 4 5 4 6 5 9 12 3 5 6 5 5 10 2 8 3 3 3 3 4 10 10 2 5 9 2 4 5 7 2 0 6 3 7 4 6 2 2 4 3 6 1 6 1 3 5

Readme

Source
raw.​githubusercontent.​com

SublimeLinter-gcc

Package Control GitHub tag (latest SemVer) Project license GitHub stars

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 may want to check SublimeLinter-clang.

Installation

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

Linter installation

Before using this plugin, you must ensure that gcc or other gcc-like 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 Debugging PATH problems in the documentation.

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 by Ctrl + Shift + P 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-gcc. If that entry is not highlighted, use the keyboard or mouse to select it.

Settings

Here are some most frequently used custom settings.

Setting Description
executable The compiler's binary path. This is ["gcc"] or ["g++"] by default. If you are not using them, you have to set this to your compiler binary such as ["arm-none-eabi-gcc"].
I A list of directories to be added to the header's searching paths. I.e., paths for -I flags.
args A list of extra flags to be passed to the compiler. These should be used carefully as they may cause linting to fail.

Here is an example settings:

{
    "linters":
    {
        "gcc": {
            "disable": false,
            "executable": ["gcc"],
            "args": ["-fsyntax-only", "-std=c90"],
            "I": [
                "${file_path}/include",
                "${folder}/include",
                "/usr/local/include",
            ],
            "excludes": [],
        },
        "g++": {
            "disable": false,
            "executable": ["g++"],
            "args": ["-fsyntax-only", "-std=c++17"],
            "I": [
                "${file_path}/include",
                "${folder}/include",
                "/usr/local/include",
            ],
            "excludes": [],
        },
    },
}

Here are some useful docs for SublimeLinter settings.

Notes

  • Here is the official list of warning options in gcc 9.2.0. I prefer turn on all warnings via -Wall (this is default for this plugin) and then suppress unwanted warnings via -Wno- prefix.

  • Use the -fsyntax-only flag in args 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 settings I.
  • 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 in settings args.

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.
  • Probably format codes with black code formatter.
  • Vertical whitespace helps readability, don’t be afraid to use it.
  • Please use descriptive variable names, no abbreviations unless they are very well known.

Thank you for helping out!