Sublime Text C++ Compiler Mac

Posted on  by 

Clang is the compiler built by Apple to compile C and a bunch of other languages. Or you can download Sublime Text. (this is our current favourite text editor). How to learn C in Mac OS X. Step 1: Download the.dmg file of Sublime Text from the official website just like we did for windows. Step 2: run and install the file and then you are ready to go. Now, you need to install the Gcc compiler on your mac.

New instructions: https://chromium.googlesource.com/chromium/src/+/master/docs/sublime_ide.md

Contents

  1. 9 Example plugin


What is Sublime Text?

It's a fast, powerful and easily extensible code editor. Check out some of the demos on the site for a quick visual demonstration.
  • Project support.
  • Theme support.
  • Works on Mac, Windows and Linux.
  • No need to close and re-open during a gclient sync.
  • Supports many of the great editing features found in popular IDE's like Visual Studio, Eclipse and SlickEdit.
  • Doesn't go to lunch while you're typing.
  • The UI and keyboard shortcuts are pretty standard (e.g. saving a file is still Ctrl+S on Windows).
  • It's inexpensive and you can evaluate it (fully functional) for free.

Installing Sublime Text 2

Download and install from here: http://www.sublimetext.com/
Help and general documentation is available here: http://www.sublimetext.com/docs/2/
Assuming you have access to the right repositories, you can also install Sublime via apt-get on Linux.

Preferences

Sublime configuration is done via JSON files. So the UI for configuring the text editor is simply a text editor. Same goes for project files, key bindings etc.
To modify the default preferences, go to the Preferences menu and select Settings-Default. Note that if you would rather like to make these settings user specific, select Settings - User as this applies there as well. The difference is that the default settings file already contains many settings that you might want to modify.
Here are some settings that you might want to change (look these variables up in the settings file and modify their value, you should not have to add them):
'tab_size': 2,
'ensure_newline_at_eof_on_save': true,
The settings take effect as soon as you save the file.
If you've got a big monitor and are used to viewing more than one source file at a time, you can use the View->Layout feature to split the view up into columns and/or rows and look at multiple files at the same time. There's also the Shift+F11, distraction free view that allows you to see nothing but code! ?8-D Sublime also supports dragging tabs out into new windows as Chrome supports, so that might be useful as well.
One thing to be aware of when editing these JSON files is that Sublime's JSON parser is slightly stricter than what you might be used to from editing e.g. GYP files. In particular Sublime does not like it if you end a collection with a comma. This is legal: {'foo', 'bar'} but not this: {'foo', 'bar', }. You have been warned.

Project files

Like configuration files, project files are just user editable JSON files.
Here's a very simple project file that was created for WebRTC and should be saved in the parent folder of the trunk folder (name it webrtc.sublime-project). It's as bare bones as it gets, so when you open this project file, you'll probably see all sorts of files that you aren't interested in.
'folders':
{
}
}

Here is a slightly more advanced example that has exclusions to reduce clutter. This one was made for Chrome on a Windows machine and has some Visual Studio specific excludes. Save this file in the same directory as your .gclient file and use the .sublime-project extension (e.g. chrome.sublime-project) and then open it up in Sublime.
'folders':
{
'name': 'src',
'*.vcproj',
'*.sln',
'*.gitmodules',
],
'build',
'third_party',
'Debug',
]
]

Navigating the project

Here are some basic ways to get you started browsing the source code.
  • 'Goto Anything' or Ctrl+P is how you can quickly open a file or go to a definition of a type such as a class. Just press Ctrl+P and start typing.
  • Open source/header file: If you're in a header file, press Alt+O to open up the corresponding source file and vice versa. For more similar features check out the Goto->Switch File submenu.
  • 'Go to definition': Right click a symbol and select 'Navigate to Definition'. A more powerful way to navigate symbols is by using the Ctags extension and use the Ctrl+T,Ctrl+T shortcut. See the section about source code indexing below.

Enable source code indexing

For a fast way to look up symbols, we recommend installing the CTags plugin. we also recommend installing Sublime's Package Control package manager, so let's start with that.
  • Install the Sublime Package Control package: https://packagecontrol.io/installation
  • Install Exuberant Ctags and make sure that ctags is in your path: http://ctags.sourceforge.net/
    • On linux you should be able to just do: sudo apt-get install ctags
  • Install the Ctags plugin: Ctrl+Shift+P and type 'Package Control: Install Package'
Once installed, you'll get an entry in the context menu when you right click the top level folder(s) in your project that allow you to build the Ctags database. If you're working in a Chrome project however, do not do that at this point, since it will index much more than you actually want. Instead, do one of:
  1. Create a batch file (e.g. ctags_builder.bat) that you can run either manually or automatically after you do a gclient sync:
    ctags --languages=C++ --exclude=third_party --exclude=.git --exclude=build --exclude=out -R -f .tmp_tags & ctags --languages=C++ -a -R -f .tmp_tags third_partyplatformsdk_win8 & ctags --languages=C++ -a -R -f .tmp_tags third_partyWebKit & move /Y .tmp_tags .tags
    This takes a couple of minutes to run, but you can work while it is indexing.
  2. Edit the CTags.sublime-settings file for the ctags plugin so that it runs ctags with the above parameters. Note: the above is a batch file - don't simply copy all of it verbatim and paste it into the CTags settings file :-)
Once installed, you can quickly look up symbols with Ctrl+t, Ctrl+t etc. More information here: https://github.com/SublimeText/CTags
One more hint - Edit your .gitignore file (under %USERPROFILE% or ~/) so that git ignores the .tags file. You don't want to commit it. :)
If you don't have a .gitignore in your profile directory, you can tell git about it with this command:
Windows: git config --global core.excludesfile %USERPROFILE%.gitignore
Mac, Linux: git config --global core.excludesfile ~/.gitignore

Building with ninja

Assuming that you've got ninja properly configured and that you already have a project file as described above, here's how to build Chrome using ninja from within Sublime. For any other target, just replace the target name.
Go to Tools->Build System->New build system and save this as a new build system:
'cmd': ['ninja', '-C', 'outDebug', 'chrome.exe'],
'file_regex': '^[./]*([a-z]?:?[w./]+)[(:]([0-9]+)[):,]([0-9]+)?[:)]?(.*)$'

file_regex explained for easier tweaking in future:
Aims to capture the following error formats while respecting Sublime's perl-like group matching:
1. d:srcchromesrcbasethreadingsequenced_worker_pool.cc(670): error C2653: 'Foo': is not a class or namespace name
2. ../../base/threading/sequenced_worker_pool.cc:670:26: error: use of undeclared identifier 'Foo'
3. ../../base/process/memory_win.cc(18,26): error: use of undeclared identifier 'Foo'
4. ../..src/heap/item-parallel-job.h(145,31): error: expected ';' in 'for' statement specifier
'file_regex': '^[./]*([a-z]?:?[w.-/]+)[(:]([0-9]+)[):,]([0-9]+)?[:)]?(.*)$'

(0) Cut relative paths (which typically are relative to the out dir and targeting src/ which is already the 'working_dir')
(2) Match the rest of the file
(3) File name is followed by open bracket or colon before line number
(5) Line # is either followed by close bracket (no column group) or comma/colon
(7) If (6) is non-empty there will be a closed bracket or another colon (but can't put it inside brackets as the 'column filename group' only wants digits).
(8) Everything else until EOL is the error message.

On Linux and Mac, fix the targets up appropriately, fwd slash instead of backslash, no .exe, etc
Linux example:
// Pass -j1024 if (and only if!) building with GOMA.
'cmd': ['ninja', '-C', 'out/Debug', 'blink', '-j1024'],
// Ninja/GN build errors are build-dir relative, however file_regexp
// is expected to produce project-relative paths, ignore the leading
// ../../(file_path):(line_number):(column):(error_message)
'file_regex': '^../../([^:n]*):([0-9]+):?([0-9]+)?:? (.*)$'

or to avoid making ninja in the path or environment variables:
{
'cmd': ['/usr/local/google/home/MYUSERNAME/git/depot_tools/ninja', '-j', '150', '-C', '.', 'chrome', 'content_shell', 'blink_tests'],
'working_dir': '${project_path}/src/out/Release',
'file_regex': '([^:n]*):([0-9]+):?([0-9]+)?:? (.*)$',
[
'cmd': ['/usr/local/google/home/MYUSERNAME/git/depot_tools/ninja', '-j', '150', '-C', '.', 'chrome', 'content_shell', 'blink_tests'],
'working_dir': '${project_path}/src/out/Debug',
'file_regex': '([^:n]*):([0-9]+):?([0-9]+)?:? (.*)$'
]


Further build system documentation or older documentation (as of Nov 2014 older is more complete).
This will make hitting Ctrl-B build chrome.exe (really quickly, thanks to ninja), F4 will navigate to the next build error, etc. If you're using Goma, you can play with something like: 'cmd': ['ninja', '-j', '200', '-C', 'outDebug', 'chrome.exe'],.

You can also add build variants so that you can also have quick access to building other targets like unit_tests or browser_tests. You build description file could look like this:

And keep using 'ctrl+b' for a regular, 'chrome.exe' build. Enjoy!

Example plugin

Sublime has a Python console window and supports Python plugins. So if there's something you feel is missing, you can simply add it.
Here's an example plugin (Tools->New Plugin) that runs cpplint (assuming depot_tools is in the path) for the current file and prints the output to Sublime's console window (Ctrl+`):
import subprocess
class RunLintCommand(sublime_plugin.TextCommand):
command = ['cpplint.bat', self.view.file_name()]
stdout=subprocess.PIPE,
print process.communicate()[1]
Sublime Text C++ Compiler Mac
Or, in Sublime Text 3:

import subprocess
class RunLintCommand(sublime_plugin.TextCommand):
print('AMI: %s' % self.view.file_name())
command = ['/home/fischman/src/depot_tools/cpplint.py', self.view.file_name()]
process = subprocess.Popen(command, shell=False, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
if error:
Save this file as run_lint.py (Sublime will suggest the right location when you save the plugin - PackagesUser).


Note that here's an interesting thing in how Sublime works. CamelCaps are converted to lower_case_with_undescore format. Note also that although the documentation currently has information about 'runCommand' member method for the view object, this too is now subject to that convention.
Taking this a step further, you can create a keybinding for your new plugin. Here's an example for how you could add a binding to your User key bindings (Preferences->Key Bindings - User):
{
}
Now, when you hit Ctrl+Shift+L, cpplint will be run for the currently active view. Here's an example output from the console window:
D:srccgitsrccontentbrowserbrowsing_instance.cc:69: Add #include <string> for string [build/include_what_you_use] [4]
Done processing D:srccgitsrccontentbrowserbrowsing_instance.cc

Sublime Text C++ Compiler Machine

As a side note, if you run into problems with the documentation as I did above, it's useful to just use Python's ability to dump all properties of an object with the dir() function:
['__class__', '__delattr__', '__dict__', '__doc__', '__format__', '__getattribute__', '__hash__', '__init__', '__len__', '__module__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__', '__weakref__', 'add_regions', 'begin_edit', 'buffer_id', 'classify', 'command_history', 'em_width', 'encoding', 'end_edit', 'erase', 'erase_regions', 'erase_status', 'extract_completions', 'extract_scope', ... <snip>

Compile current file using Ninja

As a more complex plug in example, look at the attached python file: compile_current_file.py. This plugin will compile the current file with Ninja, so will start by making sure that all this file's project depends on has been built before, and then build only that file.

First, it confirms that the file is indeed part of the current project (by making sure it's under the <project_root> folder, which is taken from the self.view.window().folders() array, the first one seems to always be the project folder when one is loaded). Then it looks for the file in all the .ninja build files under the <project_root>out<target_build>, where <target_build> must be specified as an argument to the compile_current_file command. Using the proper target for this file compilation, it starts Ninja from a background thread and send the results to the output.exec panel (the same one used by the build system of Sublime Text 2). So you can use key bindings like these two, to build the current file in either Debug or Release mode:

{ 'keys': ['ctrl+f7'], 'command': 'compile_current_file', 'args': {'target_build': 'Debug'} },
{ 'keys': ['ctrl+shift+f7'], 'command': 'compile_current_file', 'args': {'target_build': 'Release'} },

If you are having trouble with this plugin, you can set the python logging level to DEBUG in the console and see some debug output.

Format selection (or area around cursor) using clang-format

Copy buildtools/clang_format/scripts/clang-format-sublime.py to ~/.config/sublime-text-3/Packages/User/ (or -2 if still on ST2) and add something like this to Preferences->Key Bindings - User:

Sublime Text C++ Plugin

'keys': ['ctrl+shift+c'], 'command': 'clang_format',

Miscellaneous tips

  • To synchronize the project sidebar with the currently open file, right click in the text editor and select 'Reveal in Side Bar'. Alternatively you can install the SyncedSideBar sublime package (via the Package Manager) to have this happen automatically like in Eclipse.
  • If you're used to hitting a key combination to trigger a build (e.g. Ctrl+Shift+B in Visual Studio) and would like to continue to do so, add this to your Preferences->Key Bindings - User file:
    • { 'keys': ['ctrl+shift+b'], 'command': 'show_panel', 'args': {'panel': 'output.exec'} }
  • Install the Open-Include plugin (Ctrl+Shift+P, type:'Install Package', type:'Open Include'). Then just put your cursor inside an #include path, hit Alt+D and voila, you're there.
    • If you want to take that a step further, add an entry to the right-click context menu by creating a text file named 'context.sublime-menu' under '%APPDATA%Sublime Text 2PackagesUser' with the following content:
      [ { 'command': 'open_include', 'caption': 'Open Include' } ]
Assuming you've installed Package Control already (https://packagecontrol.io/installation) you can easily install more packages via:
  1. Open Command Palette (Ctrl-Shift-P)
  2. Type 'Package Control: Install Package' (note: given ST's string match is amazing you can just type something like 'instp' and it will find it :-)).
  • Case Conversion (automatically swap casing of selected text -- works marvel with multi-select -- go from a kConstantNames to ENUM_NAMES in seconds)
  • CTags (see detailed setup info above).
  • Git
  • Open-Include
  • Text Pastry (insert incremental number sequences with multi-select, etc.)
  • Wrap Plus (auto-wrap a comment block to 80 columns with Alt-Q)

This tutorial will guide you through the process of installing, updating, and initial configuration of CLion on macOS.

Installation procedures

Before you start the CLion installation on macOS, make sure your machine meets the hardware requirements, and the version of your macOS is 10.9.4+.

You can always have multiple instances of CLion installed on the same OS, including both release and EAP builds.

  1. Download the latest release or EAP version of CLion for macOS (earlier versions are available on the Previous CLion Releases page).

  2. Open the downloaded CLion-*.dmg package and drag CLion to the Applications folder.

  3. Open the Applications folder and launch the CLion installer.

  4. If the security warning appears, agree to open the application:

  5. When you install CLion manually, the update checking is performed automatically by default (every time the IDE is ready to update, you will see a message in the status bar). To configure the update process, go to Preferences | Appearance and Behaviour | System Settings | Updates and select the update channel:

    Click Check now to perform the checking right away. In case there are available updates according to the chosen channel, you will see a dialog like the following:

Toolbox is a control panel that allows you to manage all JetBrains developer tools, including CLion, as well as your projects, from a single point of access. It enables you to maintain different versions of CLion, install updates and roll them back if needed. Toolbox remembers your JetBrains Account and uses it to automatically log in when you install and register new tools.

  1. Download Toolbox and launch the setup file.

  2. When the installation is complete, accept the JetBrains privacy policy and sign in to your JetBrains Account.

  3. Now you can choose which version of CLion to install:

  4. Toolbox shows the list of the installed versions:

  5. In the Settings dialog, configure the way of updating CLion:

    Note that in case of using Toolbox, the update process cannot be configured from within the IDE. The Preferences | Appearance and Behaviour | System Settings | Updates dialog shows the following message:

Alternatively, you can install CLion via the Homebrew package manager : brew cask install clion. However, this option is unofficial, as the CLion team is not involved in its maintenance or support.

After the installation or upgrade, you will be prompted to import, inherit, or create new settings for the IDE.

Required tools

CLion needs to be provided with C and C++ compilers and the make utility. These tools may be pre-installed on your system: check it in Preferences | Build, Execution, Deployment | Toolchains- the compiler and make detection should perform successfully.

If your system does not have working installations of compilers and make, the simplest solution is to install Xcode command line developer tools.

  1. Run the following command:

  2. When prompted to install command line developer tools, click the Install button:

    You can also choose to install the full package of Xcode, though it is not necessary for CLion.

With Xcode command line tools, you get the Clang compiler installed by default. To check the compiler presence and its version, run clang --version.

Command line tools may not update automatically along with the system or Xcode update. This may cause error messages like invalid active developer path during project loading in CLion. To fix this, run the same xcode-select --install command, and the tools will be updated accordingly.

As an alternative, you can separately install compilers and make, and then provide the paths in Preferences | Build, Execution, Deployment | Toolchains.

Note that you can use multiple compilers for the needs of your project, see Switching Compilers.

Configure toolchains

Now you need to configure the toolchain to work with, which means choosing the CMake executable, the make and C/C++ compilers location, and the debugger. Navigate to Preferences | Build, Execution, Deployment | Toolchains and edit the default toolchain, or click to add a new one.

CMake, make, and compilers

In the CMake field, specify the CMake binary that you want to use. You may stick to the bundled CMake, or use your custom CMake executable (see the minimum supported version in Software requirements).

The chosen CMake attempts to detect the compilers and make considering the packages installed on your system. If the detection succeeds, the fields Make, C Compiler, and C++ Compiler are filled automatically:

The detection of compilers and make fails if CMake cannot locate the appropriate tools (this may happen, for instance, if you installed them separately without the Xcode developer tools). In this case, you need to provide the actual paths manually.

Debugger

CLion for macOS comes with the bundled LLDB v 12.0.0 (the default debugger) and GDB v 10.2. You can also switch to a custom GDB (supported versions are 7.8.x-8.1.x). Select the debugger in Preferences | Build, Execution, Deployment | Toolchains:

Issues are possible when working with both bundled or custom GDB on macOS. To improve the behavior, enable the cidr.debugger.gdb.workaround.macOS.startupWithShell option in Registry (select Help | Find Action from the main menu and type Registry):

Note that enabling this option is not equivalent to setting set startup-with-shell off in your .gdbinit script.

A combination of GDB and Clang implies certain limitations to debugging your projects on macOS. See STL renderers for GDB on macOS for details and a workaround.

Further steps

Now that you have CLion installed and configured, you may find the following articles useful for further steps of the development:

Last modified: 08 March 2021

Coments are closed