do_fish_indent.py

import sublime, sublime_plugin
import os.path
import subprocess

from fish.Tools.misc import getFishOutput

# Only a TextCommand can use replace()
class DoFishIndentCommand(sublime_plugin.TextCommand):
  def is_enabled(self):
    # We are very incompatible with ST1, and kind of with ST2
    return int(sublime.version()[0]) >= 3

  def is_visible(self):
    # Syntax will be like "Packages/fish/fish.tmLanguage"
    return 'Packages/fish/fish' in self.view.settings().get('syntax')

  def description(self):
    return 'Indent and Prettify'

  def run(self, edit):
    # Note the user's current settings for this buffer
    indentUsingSpaces = self.view.settings().get('translate_tabs_to_spaces')
    tabSize = self.view.settings().get('tab_size')

    # Create a copy of the initial selection before any edits
    originalSelection = list( self.view.sel() )

    # If user does not use the native fish_indent format, convert file to tabs
    #   of user's preferred width. Then when the formatted text is inserted,
    #   we can convert it to tabs of width 4 without affecting anything else in
    #   the file
    # Note that unexpand_tabs sets translate_tabs_to_spaces to false
    if not indentUsingSpaces or not tabSize == 4:
      self.view.run_command('unexpand_tabs')

    # fish_indent assumes UTF-8 encoding so the user may get unexpected results
    #   if this file's encoding is different
    enc = self.view.encoding().lower()
    if enc != 'undefined' and enc != 'utf-8': # "undefined" is for a temp file
      print('Warning! fish_indent may be unreliable on file with encoding {}'.format(enc))

    # If user only has simple cursor placements (zero-width regions), indent whole file
    # Otherwise, we'll iterate over and test all the regions in the selection
    restoreSelection = None
    if all( map(lambda p: p.size() == 0, self.view.sel()) ):
      inputRegions = [ sublime.Region(0, self.view.size()) ]
      restoreSelection = originalSelection
    else:
      inputRegions = self.view.sel()
      restoreSelection = False

    for inputRegion in inputRegions:
      # Skip zero-width regions
      if inputRegion.size() == 0:
        continue

      inputContent = self.view.substr(inputRegion)
      out,err = getFishOutput(['fish_indent'], self.view.settings(), inputContent)
      if not out:
        return
      outputContent = out

      # Trim a trailing newline
      # if outputContent[-1] == '\n':
      #   outputContent = outputContent[:-1]

      if err:
        sublime.error_message(err)

      # Replace the contents of the region with the output of fish_indent
      self.view.replace(edit, inputRegion, outputContent)

      # # Alternative code if replace() does not adequately track changes
      # #   in cursor position. erase() changes the acted upon selection to be
      # #   zero-width, and we recalculate its width based on the number of
      # #   inserted characters
      # beginIndex = inputRegion.begin()
      # self.view.erase(edit, inputRegion)
      # insChars = self.view.insert(edit, beginIndex, outputContent)
      # if not restoreSelection:
      #   # Update selection (extends the zero-width region now at beginIndex)
      #   outputRegion = sublime.Region(beginIndex, beginIndex + insChars)
      #   self.view.sel().add(outputRegion)

    # Convert the format to the user's preferred format
    if indentUsingSpaces and tabSize == 4:
      # Do nothing as this is the format produced by fish_indent
      pass
    else:
      # Convert sets of 4 spaces to tabs in all the fish_indent output
      self.view.settings().set('tab_size', 4)
      self.view.run_command('unexpand_tabs')

      if not indentUsingSpaces:
        # User prefers tabs, which we now have
        if tabSize == 4:
          # Conversion finished
          pass
        else:
          # Resize everything back to the preferred tab size
          self.view.settings().set('tab_size', tabSize)
      else:
        # User prefers spaces, so set back to true after unexpand_tabs changed it
        self.view.settings().set('translate_tabs_to_spaces', True)

        # Resize tabs, then convert back into spaces
        self.view.settings().set('tab_size', tabSize)
        self.view.run_command('expand_tabs')

    if restoreSelection:
      # Put back the original zero-width regions of the selection
      self.view.sel().clear()
      self.view.sel().add_all(restoreSelection)

    # Ensure view doesn't drift off with repeated runs
    self.view.show(self.view.visible_region(), False)

# Only a WindowCommand can be a build system target
class DoFishIndentBuildCommand(sublime_plugin.WindowCommand):
  def run(self):
    self.window.run_command('do_fish_indent')

class DoFishIndentOnSave(sublime_plugin.ViewEventListener):
  def is_applicable(self):
    # In non-fish files the setting is unset (hence, we ask for False), or if
    #   the user set it to False then it will be False even in fish files
    return self.get('indent_on_save', False)

  def on_pre_save(self):
    # Skip blacklisted files
    if os.path.basename(self.view.file_name()) in self.view.settings().get('indent_on_save_blacklist'):
      return
    self.view.run_command('do_fish_indent')