support filetype tags

contains a dictionary to map form vim filetype identifiers,
to the "scope" names Sublime uses in its Syntax files.
This was generated half-automatically, and scope names
cover those available in Sublime and the CMake plugin.

The mapping from Sublime's "scope" names to package names
if created the first time it is requested.

both mappings should allow changes by the user
(not implemented).

Signed-off-by: Norbert Lange <nolange79@gmail.com>

Author: nolange

lib/filetype.py

@@ -0,0 +1,110 @@
+# vim: set ts=4 sw=4 et fileencoding=utf-8:
+'''Vim filetype mappings to Sublime Text'''
+
+FILETYPE_MAP = {
+    'ant': 'text.xml',
+    'antlr': 'source.java',
+    'arduino': 'source.c++',
+    'aspperl': 'text.html.basic',
+    'aspvbs': 'text.html.basic',
+    'automake': 'source.makefile',
+    'bash': 'source.shell.bash',
+    'bzl': 'source.python',
+    'c': 'source.cmake.config.c',
+    'cf': 'text.html.basic',
+    'ch': 'source.cmake.config.c',
+    'chaskell': 'text.tex.latex.haskell',
+    'clojure': 'source.clojure',
+    'cmake': 'source.cmake',
+    'cmod': 'source.cmake.config.c',
+    'conaryrecipe': 'source.python',
+    'cpp': 'source.cmake.config.c',
+    'cs': 'source.cs',
+    'css': 'source.css',
+    'cuda': 'source.c++',
+    'cweb': 'text.tex',
+    'cynlib': 'source.c++',
+    'd': 'source.d',
+    'diff': 'source.diff',
+    'dosbatch': 'source.dosbatch',
+    'dot': 'source.dot',
+    'dsl': 'text.xml',
+    'dtml': 'text.html.basic',
+    'dtrace': 'source.cmake.config.c',
+    'erlang': 'source.erlang',
+    'esqlc': 'source.c++',
+    'go': 'source.go',
+    'groovy': 'text.html.basic',
+    'gsp': 'text.html.basic',
+    'haml': 'text.html.basic',
+    'haskell': 'text.tex.latex.haskell',
+    'html': 'text.html.basic',
+    'htmlcheetah': 'text.html.basic',
+    'htmldjango': 'text.html.basic',
+    'htmlm4': 'text.html.basic',
+    'htmlos': 'text.html.basic',
+    'java': 'source.java',
+    'javacc': 'source.java',
+    'javascript': 'source.js',
+    'javascriptreact': 'source.js',
+    'json': 'source.json',
+    'jsp': 'text.html.jsp',
+    'kwt': 'source.c++',
+    'less': 'source.css',
+    'lhaskell': 'text.tex',
+    'lisp': 'source.lisp',
+    'lua': 'source.lua',
+    'make': 'source.makefile',
+    'markdown': 'text.html.markdown',
+    'mason': 'text.html.basic',
+    'matlab': 'source.matlab',
+    'msql': 'text.html.basic',
+    'nasm': 'source.cmake.config.c',
+    'objc': 'source.objc',
+    'objcpp': 'source.objc++',
+    'ocaml': 'source.ocaml',
+    'papp': 'text.xml',
+    'pascal': 'source.pascal',
+    'perl': 'source.perl',
+    'php': 'text.html.basic',
+    'phtml': 'embedding.php',
+    'plp': 'text.html.basic',
+    'pyrex': 'source.python',
+    'python': 'source.python',
+    'r': 'source.r',
+    'rmd': 'text.html.markdown',
+    'rnoweb': 'text.tex',
+    'rpcgen': 'source.cmake.config.c',
+    'rrst': 'text.restructuredtext',
+    'rst': 'text.restructuredtext',
+    'ruby': 'text.html.ruby',
+    'rust': 'source.rust',
+    'sass': 'source.css',
+    'sbt': 'source.scala',
+    'scala': 'source.scala',
+    'sdc': 'text.html.tcl',
+    'smarty': 'text.html.basic',
+    'splint': 'source.cmake.config.c',
+    'spyce': 'text.html.basic',
+    'sql': 'source.sql',
+    'svg': 'text.xml',
+    'tcl': 'text.html.tcl',
+    'template': 'text.html.basic',
+    'tex': 'text.tex',
+    'tt2html': 'text.html.basic',
+    'tt2js': 'source.js',
+    'typescript': 'source.json',
+    'vue': 'text.html.basic',
+    'webmacro': 'text.html.basic',
+    'wml': 'text.html.basic',
+    'wsh': 'text.xml',
+    'xbl': 'text.xml',
+    'xhtml': 'text.html.basic',
+    'xml': 'text.xml',
+    'xquery': 'text.xml',
+    'xs': 'source.cmake.config.c',
+    'xsd': 'text.xml',
+    'xslt': 'text.xml',
+    'yaml': 'source.yaml',
+    'zsh': 'source.shell.bash'
+}

vimmodelines.py

@@ -6,6 +6,7 @@
 
 from itertools import chain
 from .lib.encoding import ENCODING_MAP
+from .lib.filetype import FILETYPE_MAP
 import re
 import sublime
 import sublime_plugin
@@ -79,6 +80,7 @@ class VimModelinesApplyCommand(Common, sublime_plugin.WindowCommand):
 
     __attr_sep_RX = re.compile(r'[:\s]')
     __attr_kvp_RX = re.compile(r'([^=]+)=?([^=]*)')
+    __syntax_map = None
 
     def run(self):
         view = self.window.active_view()
@@ -128,6 +130,17 @@ def run(self):
                 else:
                     view.run_command('set_encoding',
                                      {'encoding': target_encoding})
+            elif attr in ('filetype', 'ft'):
+                # TODO: allow user to set vim -> package/syntax mapping in
+                # settings.
+                # package names will have path delimiters, so you can
+                # figure out if a name is a package or syntax
+                sublime_syntax = FILETYPE_MAP.get(value.lower())
+                package_path = self.get_syntax_packages().get(sublime_syntax)
+
+                if package_path:
+                    view.settings().set('syntax', package_path +
+                                        '.sublime-syntax')
 
     @staticmethod
     def header_and_footer(view, line_count):
@@ -158,3 +171,32 @@ def parse_for_modeline(cls, line):
                                         cls.__attr_sep_RX.split(modeline))]
 
             return attrs
+
+    @classmethod
+    def get_syntax_packages(cls):
+        '''Inspect sublime's installed syntax plugins and build a dictionary'''
+
+        if not cls.__syntax_map:
+            syntax_map = {}
+            for package in sublime.find_resources('*.sublime-syntax'):
+                # Find the first scope entry, and ignore "hidden" syntax files.
+                # Not using yaml parsers for avoiding that dependency and
+                # more speed.
+
+                scope = None
+                for line in sublime.load_resource(package).splitlines():
+                    line = line.strip()
+                    if line.startswith('hidden:'):
+                        if line[len('hidden:'):].strip().startswith('True'):
+                            break
+
+                    if not scope and line.startswith('scope:'):
+                        scope = line[len('scope:'):].strip()
+
+                # TODO: What if multiple packages implement a syntax?
+                if scope:
+                    syntax_map[scope] = package[:-len('.sublime-syntax')]
+
+            cls.__syntax_map = syntax_map
+
+        return cls.__syntax_map