src/third_party/clang_format/script/clang-format-sublime.py

   1 # This file is a minimal clang-format sublime-integration. To install:
   2 # - Change 'binary' if clang-format is not on the path (see below).
   3 # - Put this file into your sublime Packages directory, e.g. on Linux:
   4 #     ~/.config/sublime-text-2/Packages/User/clang-format-sublime.py
   5 # - Add a key binding:
   6 #     { "keys": ["ctrl+shift+c"], "command": "clang_format" },
   7 #
   8 # With this integration you can press the bound key and clang-format will
   9 # format the current lines and selections for all cursor positions. The lines
  10 # or regions are extended to the next bigger syntactic entities.
  11 #
  12 # It operates on the current, potentially unsaved buffer and does not create
  13 # or save any files. To revert a formatting, just undo.
  14
  15 from __future__ import print_function
  16 import sublime
  17 import sublime_plugin
  18 import subprocess
  19
  20 # Change this to the full path if clang-format is not on the path.
  21 binary = 'clang-format'
  22
  23 # Change this to format according to other formatting styles. See the output of
  24 # 'clang-format --help' for a list of supported styles. The default looks for
  25 # a '.clang-format' or '_clang-format' file to indicate the style that should be
  26 # used.
  27 style = 'file'
  28
  29 class ClangFormatCommand(sublime_plugin.TextCommand):
  30   def run(self, edit):
  31     encoding = self.view.encoding()
  32     if encoding == 'Undefined':
  33       encoding = 'utf-8'
  34     regions = []
  35     command = [binary, '-style', style]
  36     for region in self.view.sel():
  37       regions.append(region)
  38       region_offset = min(region.a, region.b)
  39       region_length = abs(region.b - region.a)
  40       command.extend(['-offset', str(region_offset),
  41                       '-length', str(region_length),
  42                       '-assume-filename', str(self.view.file_name())])
  43     old_viewport_position = self.view.viewport_position()
  44     buf = self.view.substr(sublime.Region(0, self.view.size()))
  45     p = subprocess.Popen(command, stdout=subprocess.PIPE,
  46                          stderr=subprocess.PIPE, stdin=subprocess.PIPE)
  47     output, error = p.communicate(buf.encode(encoding))
  48     if error:
  49       print(error)
  50     self.view.replace(
  51         edit, sublime.Region(0, self.view.size()),
  52         output.decode(encoding))
  53     self.view.sel().clear()
  54     for region in regions:
  55       self.view.sel().add(region)
  56     # FIXME: Without the 10ms delay, the viewport sometimes jumps.
  57     sublime.set_timeout(lambda: self.view.set_viewport_position(
  58       old_viewport_position, False), 10)