tm2deftheme 0.2.1

data/README.md

@@ -0,0 +1,73 @@
+# tm2deftheme
+
+Convert TextMate/SublimeText .tmTheme to Emacs 24 deftheme .el
+
+### Install
+
+    gem install tm2deftheme
+
+### Usage:
+
+    tm2deftheme [options] [themefile.tmTheme]
+
+    options:
+
+        -f         ouput Emacs 24 deftheme to file
+                   e.g. Birds of Paradise.tmTheme
+
+                   becomes:
+
+                   birds-of-paradise-theme.el
+
+        -s         when used with -f silence output
+        -o         when used with -f overwrite existing file
+
+        --debug    debugging output
+
+When run without options converted theme is sent to `STDOUT`
+
+### Notes
+
+Note that Emacs syntax highlighting is managed differently to
+SublimeText / TextMate. Various Emacs modes provide additional
+highlighing support, but `tm2deftheme` (currently) only maps to core
+`font-lock` faces. So while things won't look like a one-to-one copy,
+the results are still pretty good.
+
+Linum, fringe and modeline colours are derived from the base foreground
+and background colors.  Support for [Rainbow Delimiters](http://www.emacswiki.org/emacs/RainbowDelimiters)
+is provided automatically.
+
+The imported foreground colors which constrast most from the background
+are averaged, from this average colour, 9 tint colors are generated and
+assigned to the `rainbow-delimiters-depth-n-face` collection.
+
+I'll be adding additional support for `js3-mode`, git-gutter, flyspell,
+flymake, flycheck, isearch and more.
+
+### Demo
+
+See for yourself, here's a handful of converted themes, shown in their
+original format (here rendered by the excellent
+[http://tmtheme-editor.herokuapp.com/](http://tmtheme-editor.herokuapp.com/))
+and then shown in Emacs 24 after conversion.
+
+![](https://raw.githubusercontent.com/emacsfodder/tmtheme-to-deftheme/master/slides.gif)
+
+### Dependencies
+
+Ruby 1.9 or later required.
+
+Development, clone and run `bundle install` in the project folder.
+
+### Contribution  / Development
+
+If you'd like to contribute, the best place to do so is in mapping
+SublimeText / TextMate scopes to Emacs faces.  Although any issue
+posting, bug fixing, feature pull-requests, etc. are welcome.
+
+Avoid using `test.sh` and `install-generated-themes.el`, they're not
+tuned for general use.
+
+PLEASE NOTE: `test.sh` will forceably remove all folders matching
+`~/.emacs.d/elpa/*-theme-140*`.

data/bin/tm2deftheme

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+require 'tmtheme-to-deftheme'
+require 'slop'
+
+Slop.parse do
+
+  banner <<-EOF
+TextMate/SublimeText .tmTheme to Emacs 24 deftheme .el
+
+Usage: tm2deftheme [themefile.tmTheme] [options]
+EOF
+
+  on :f,     'ouput Emacs 24 deftheme to file'
+  on :s,     'when used with -f silence output'
+  on :o,     'when used with -f overwrite existing file'
+  on :debug, 'show debugging output'
+
+  run do |opts, args|
+    if args.first.nil?
+      $stderr.puts opts
+      exit 1
+    end
+
+    theme_filename = args.first
+
+    unless File.exist? theme_filename
+      $stderr.puts "#{theme_filename} : file doesn't exist"
+      exit 1
+    end
+
+    TmthemeToDeftheme::Main.new theme_filename, opts
+  end
+
+end

data/data/scopes-to-faces.yml

@@ -0,0 +1,86 @@
+# Pairs of TMate scopes and equivalent Emacs faces
+
+- - entity
+  - font-lock-type-face
+- - entity.name.class
+  - font-lock-type-face
+- - class
+  - font-lock-type-face
+- - comment
+  - font-lock-comment-face
+- - constant
+  - font-lock-constant-face
+- - constant.language
+  - font-lock-builtin-face
+- - entity.name.function
+  - font-lock-function-name-face
+- - meta.preprocessor.c
+  - font-lock-preprocessor-face
+- - string
+  - font-lock-string-face
+- - variable
+  - font-lock-variable-name-face
+- - keyword
+  - font-lock-keyword-face
+- - diff.header
+  - diff-file-header
+- - markup.changed
+  - diff-changed
+- - markup.deleted
+  - diff-removed
+- - markup.inserted
+  - diff-added
+- - invalid.deprecated
+  - font-lock-warning-face
+- - invalid.illegal
+  - error
+
+# js3 and js2 mode
+
+- - keyword.other.documentation.param.javadoc
+  - js3-jsdoc-tag-face
+  - js2-jsdoc-tag
+- - variable.parameter
+  - js3-function-param-face
+  - js2-function-param
+- - variable.other.external-symbol
+  - js3-external-variable-face
+  - js2-external-variable
+
+# GitGutter
+
+- - markup.deleted.git_gutter
+  - git-gutter:deleted
+- - markup.inserted.git_gutter
+  - git-gutter:added
+- - markup.changed.git_gutter
+  - git-gutter:modified
+- - markup.ignored.git_gutter
+  - git-gutter:untracked
+
+# Markdown
+
+- - punctuation.definition.italic.markdown
+  - markdown-italic-face
+- - punctuation.definition.bold.markdown
+  - markdown-bold-face
+- - meta.separator.markdown
+  - markdown-header-rule-face
+- - entity.name.section.markdown
+  - markdown-header-face
+- - markup.raw.inline.markdown
+  - markdown-inline-code-face
+- - punctuation.definition.list_item.markdown
+  - markdown-list-face
+- - punctuation.definition.blockquote.markdown
+  - markdown-blockquote-face
+- - markup.raw.block.markdown
+  - markdown-pre-face
+- - meta.link.inline.markdown
+  - markdown-url-face
+- - string.other.link.title.markdown
+  - markdown-link-title-face
+
+# Blank lines are ignored
+
+# See YAML Docs at http://yaml.org/spec/1.2/spec.html

data/lib/tmtheme-to-deftheme.rb

@@ -0,0 +1,219 @@
+module TmthemeToDeftheme
+
+  require 'plist4r'
+  require 'color'
+  require 'erubis'
+  require 'yaml'
+
+  class Main
+
+    SCOPE_MAP   = YAML.load_file(File.join(File.dirname(__FILE__),'..','data','scopes-to-faces.yml'))
+    TM_SCOPES   = SCOPE_MAP.map(&:first)
+    EMACS_FACES = SCOPE_MAP.map{|a| a[1..-1]}
+
+    def initialize theme_filename, options
+      @theme_filename  = theme_filename
+      @options         = options
+
+      @plist           = Plist4r.open @theme_filename
+      @author          = @plist["author"]
+      @name            = @plist["name"]
+      @theme_name      = "#{@plist["name"]}".downcase.tr ' _', '-'
+      @long_theme_name = "#{@theme_name}-theme"
+
+      if @options[:f]
+        @deftheme_filename = "#{@long_theme_name}.el"
+        unless @options[:s]
+          $stderr.puts "Creating: #{@deftheme_filename}"
+        end
+        if File.exist? @deftheme_filename
+          unless @options[:o]
+            $stderr.puts "#{@deftheme_filename} already exists, use -o to force overwrite"
+            exit 1
+          end
+        end
+        File.open(@deftheme_filename, "w") {|f| f.puts parse}
+      else
+        puts parse
+      end
+    end
+
+    def debug_out message
+      $stderr.puts message if @options[:debug]
+    end
+
+    def map_scope scope
+      if scope.index ","
+        names = scope.split(",").map(&:strip)
+        debug_out names
+        first_match = names.map{|n| TM_SCOPES.find_index n}.compact.first
+      else
+        debug_out scope
+        first_match = TM_SCOPES.find_index scope
+      end
+
+      if first_match.nil?
+        nil
+      else
+        debug_out "#{first_match} :: #{scope} : #{EMACS_FACES[first_match]}"
+        EMACS_FACES[first_match]
+      end
+    end
+
+    def make_attr s, k
+      debug_out "Make attrs: #{s[:face]} : #{k} : #{s} : #{s[k]}"
+      ":#{k} \"#{s[k]}\"" if s[k]
+    end
+
+    def italic_underline_bold s
+      if s["fontStyle"]
+        s["fontStyle"].split(" ").map{|i| ":#{i} t" }.join " "
+      end
+    end
+
+    def face_attrs s
+      "#{make_attr s, "foreground"} #{make_attr s, "background"} #{italic_underline_bold s}"
+    end
+
+    def map_scope_to_emacs_face hash
+      emacs_face = map_scope hash["scope"]
+      return nil if emacs_face.nil?
+      settings = hash["settings"]
+      emacs_face = [emacs_face] unless emacs_face.class == Array
+      mapped_scope = emacs_face.map{|face| {face: face, settings: settings, scope: hash["scope"]}}
+      debug_out mapped_scope
+      mapped_scope
+    end
+
+    def map_palette_key faces, key
+      faces.map{|f| Color::RGB.from_html f[:settings][key] if f[:settings][key]}.compact
+    end
+
+    def isolate_palette faces
+      [map_palette_key( faces, "foreground"), map_palette_key( faces, "background")]
+    end
+
+    def fix_rgba hexcolor
+      if hexcolor.length == 9
+        c = Color::RGB.from_html hexcolor[0,7]
+        a = hexcolor[7,2].to_i(16).to_f
+        p = (a / 255.0) * 100.0
+        unless @base_bg.nil?
+          c.mix_with(@base_bg, p).html
+        else
+          c.html
+        end
+      elsif hexcolor.length == 7 || hexcolor.length == 4
+        hexcolor
+      end
+    end
+
+    # Note: Foreground palette
+    def palette_average_values sample_palette
+      samples = sample_palette.map{|c|
+        c = c.to_hsl
+        {hue: c.hue, sat: c.saturation, lvl: c.brightness}
+      }
+
+      avg = {}
+      avg[:hue] = samples.map{|s| s[:hue]}.reduce{|sum,c| sum + c} / samples.size
+      avg[:sat] = samples.map{|s| s[:sat]}.reduce{|sum,c| sum + c} / samples.size
+      avg[:lvl] = samples.map{|s| s[:lvl]}.reduce{|sum,c| sum + c} / samples.size
+
+      {
+        color: Color::HSL.new(avg[:hue], avg[:sat], avg[:lvl]).to_rgb,
+        avg: avg,
+        brightest: sample_palette.max_by(&:brightness),
+        darkest: sample_palette.min_by(&:brightness),
+        samples: samples
+      }
+    end
+
+    def darktheme?
+      !lighttheme?
+    end
+
+    def lighttheme?
+      @base_bg.brightness > 0.45
+    end
+
+    def make_rainbow_parens
+      samples = if lighttheme?
+        @foreground_palette.sort_by{|c| c.brightness }.select{|c| c.brightness < 0.65 }
+      else
+        @foreground_palette.sort_by{|c| - c.brightness }.select{|c| c.brightness > 0.45 }
+      end
+
+      debug_out "- Palette sample -------------------------------"
+      debug_out samples.map(&:html)
+      debug_out "- <<<<<<<<<<<<<< -------------------------------"
+
+      values = palette_average_values samples
+      @average_foregroung_color = values[:color]
+      @darkest_foregroung_color = values[:darkest]
+      @brightest_foregroung_color = values[:brightest]
+      rainbow_top = @average_foregroung_color.mix_with @darkest_foregroung_color, 30
+
+      9.times.collect do |i|
+        rainbow_top.adjust_brightness(i * 10).html
+      end
+    end
+
+    def parse
+      debug_out "= Converting : #{@theme_filename} =============================="
+      debug_out "- tmTheme scope settings --------------------"
+      debug_out @plist["settings"].to_yaml
+
+      @base_settings   = @plist["settings"].first["settings"]
+      @base_bg_hex     = fix_rgba @base_settings["background"]
+      @base_bg         = Color::RGB.from_html @base_bg_hex
+      @base_fg_hex     = fix_rgba @base_settings["foreground"]
+      @base_fg         = Color::RGB.from_html @base_fg_hex
+
+      @emacs_faces     = @plist["settings"].collect{|s| map_scope_to_emacs_face(s) if s["scope"] }.flatten.compact
+
+      if lighttheme?
+        debug_out "- Converting : Light Theme ----------------"
+      else
+        debug_out "- Converting : Dark Theme ----------------"
+      end
+
+      # Debug faces
+      debug_out "- Mapped faces ------------------------------"
+
+      # Fix any RGBA colors in the tmTheme
+      @emacs_faces.each do |f|
+        debug_out f.to_yaml
+        f[:settings]["foreground"] = fix_rgba f[:settings]["foreground"] if f[:settings]["foreground"]
+        f[:settings]["background"] = fix_rgba f[:settings]["background"] if f[:settings]["background"]
+        debug_out f.to_yaml
+      end
+
+      @foreground_palette, @background_palette = isolate_palette @emacs_faces
+      @rainbow_parens = make_rainbow_parens + ["#FF0000"]
+
+      if @emacs_faces.select{|f| f[:face] == "font-lock-comment-face"}
+        comment_face = @emacs_faces.select{|f| f[:face] == "font-lock-comment-face"}.first
+        if comment_face
+          @emacs_faces << {face: "font-lock-comment-delimiter-face", settings: comment_face[:settings]}
+        end
+      end
+
+      render
+    end
+
+    def render
+      Erubis::Eruby.new(
+                        File.read(
+                                  File.join(
+                                            File.dirname(__FILE__),
+                                            '..',
+                                            'templates',
+                                            'deftheme.erb.el'
+                                            )))
+        .result binding
+    end
+
+  end
+
+end

data/templates/deftheme.erb.el

@@ -0,0 +1,156 @@
+;;; <%= @long_theme_name %>.el --- an Emacs 24 theme based on <%= @name %> (tmTheme)
+;;
+;;; Author: Auto Converted to Emacs 24 by tmtheme-to-deftheme (tm2deftheme)
+;;; Version: <%= Time.now.to_i %>
+;;; Original author: <%= @author %>
+;;; Url: https://github.com/emacsfodder/tmtheme-to-deftheme
+;;; Package-Requires: ((emacs "24.0"))
+;;
+;;; Commentary:
+;;  This theme was automatically generated by tmtheme-to-deftheme (tm2deftheme),
+;;  from <%= @name %> (tmTheme) by <%= @author %>
+;;
+;;; Code:
+
+(deftheme <%= @theme_name %>
+  "<%= @long_theme_name %> - Created by tmtheme-to-deftheme - <%= Time.now.to_s %>")
+
+(custom-theme-set-variables
+ '<%= @theme_name %>
+)
+
+(custom-theme-set-faces
+ '<%= @theme_name %>
+ ;; basic theming.
+
+ '(default ((t (<%= face_attrs(@base_settings) %>))))
+ '(region  ((t (:background "<%= @base_settings["selection"] %>"))))
+ '(cursor  ((t (:background "<%= @base_settings["caret"] %>"))))
+
+ ;; Temporary defaults
+ <%
+ # Linum and Fringe are generated from base_bg
+ %>
+ <% if darktheme? %>
+ <% debug_out "Dark theme linum/fringe"  %>
+ '(linum                               ((t (:foreground "<%= @base_bg.mix_with(@base_fg, 80).html %>"  :background "<%= @base_bg.mix_with(@base_fg, 90).html %>" ))))
+ '(fringe                              ((t (                       :background "<%= @base_bg.mix_with(@base_fg, 90).html %>" ))))
+ <% else %>
+ <% debug_out "Light theme linum/fringe"  %>
+ '(linum                               ((t (:foreground "<%= @base_fg.adjust_brightness(90).html %>"  :background "<%= @base_bg.adjust_brightness(-30).html %>" ))))
+ '(fringe                              ((t (                       :background "<%= @base_bg.adjust_brightness(-30).html %>" ))))
+ <% end %>
+
+ '(minibuffer-prompt                   ((t (:foreground "#1278A8"  :background nil       :weight bold                                  ))))
+ '(escape-glyph                        ((t (:foreground "orange"   :background nil                                                     ))))
+ '(highlight                           ((t (:foreground "orange"   :background nil                                                     ))))
+ '(shadow                              ((t (:foreground "#777777"  :background nil                                                     ))))
+
+ '(trailing-whitespace                 ((t (:foreground "#FFFFFF"  :background "#C74000"                                               ))))
+ '(link                                ((t (:foreground "#00b7f0"  :background nil       :underline t                                  ))))
+ '(link-visited                        ((t (:foreground "#4488cc"                        :underline t :inherit (link)                  ))))
+ '(button                              ((t (:foreground "#FFFFFF"  :background "#444444" :underline t :inherit (link)                  ))))
+ '(next-error                          ((t (                                             :inherit (region)                             ))))
+ '(query-replace                       ((t (                                             :inherit (isearch)                            ))))
+ '(header-line                         ((t (:foreground "#EEEEEE"  :background "#444444" :box nil :inherit (mode-line)                 ))))
+
+ <%
+ # Modeline is generated from base_fg / base_bg
+ %>
+ '(mode-line-highlight                 ((t (                                             :box nil                                      ))))
+ '(mode-line-emphasis                  ((t (                                             :weight bold                                  ))))
+ '(mode-line-buffer-id                 ((t (                                             :box nil :weight bold                         ))))
+
+<% if darktheme? %>
+ <% debug_out "Dark theme modeline"  %>
+ '(mode-line-inactive                  ((t (:foreground "<%= @base_fg.adjust_brightness(-20).html %>"  :background "<%= @base_bg.mix_with(@base_fg, 90).html %>" :box nil :weight light :inherit (mode-line)   ))))
+ '(mode-line                           ((t (:foreground "<%= @base_fg.html %>"  :background "<%= @base_bg.mix_with(@base_fg, 90).html %>" :box nil ))))
+<% else %>
+ <% debug_out "Light theme modeline"  %>
+ '(mode-line-inactive                  ((t (:foreground "<%= @base_fg.html %>"  :background "<%= @base_bg.adjust_brightness(-10).html %>" :box nil :weight light :inherit (mode-line)   ))))
+ '(mode-line                           ((t (:foreground "<%= @base_fg.html %>"  :background "<%= @base_bg.adjust_brightness(-20).html %>" :box nil ))))
+<% end %>
+
+<%
+# Search highlighting
+%>
+ '(isearch                             ((t (:foreground "#99ccee"  :background "#444444"                                               ))))
+ '(isearch-fail                        ((t (                       :background "#ffaaaa"                                               ))))
+ '(lazy-highlight                      ((t (                       :background "#77bbdd"                                               ))))
+ '(match                               ((t (                       :background "#3388cc"                                               ))))
+
+ '(tooltip                             ((t (:foreground "black"    :background "LightYellow" :inherit (variable-pitch)                 ))))
+
+ '(js3-function-param-face             ((t (:foreground "#BFC3A9"                                                                      ))))
+ '(js3-external-variable-face          ((t (:foreground "#F0B090"  :bold t                                                             ))))
+
+ <%
+ # TODO: Generate cua-rectangle and secondary-selection from region/selection import
+ %>
+ '(secondary-selection                 ((t (                       :background "#342858"                                               ))))
+ '(cua-rectangle                       ((t (:foreground "#E0E4CC"  :background "#342858" ))))
+
+ ;; Magit hightlight
+ '(magit-item-highlight                ((t (:foreground "white" :background "#1278A8" :inherit nil ))))
+
+ <%
+ # TODO: Generate flyspell / flymake / flycheck / git:gutter from diff defaults/imported colors.
+ %>
+ ;; flyspell-mode
+ '(flyspell-incorrect                  ((t (:underline "#AA0000" :background nil :inherit nil ))))
+ '(flyspell-duplicate                  ((t (:underline "#009945" :background nil :inherit nil ))))
+
+ ;; flymake-mode
+ '(flymake-errline                     ((t (:underline "#AA0000" :background nil :inherit nil ))))
+ '(flymake-warnline                    ((t (:underline "#009945" :background nil :inherit nil ))))
+
+ ;;git-gutter
+ '(git-gutter:added                    ((t (:foreground "#609f60" :bold t))))
+ '(git-gutter:modified                 ((t (:foreground "#3388cc" :bold t))))
+ '(git-gutter:deleted                  ((t (:foreground "#cc3333" :bold t))))
+
+ '(diff-added                          ((t (:background "#305030"))))
+ '(diff-removed                        ((t (:background "#903010"))))
+ '(diff-file-header                    ((t (:background "#362145"))))
+ '(diff-context                        ((t (:foreground "#E0E4CC"))))
+ '(diff-changed                        ((t (:foreground "#3388cc"))))
+ '(diff-hunk-header                    ((t (:background "#242130"))))
+
+<%
+
+# TODO: defaults should be overriden when the @emacs_faces below are
+# evaluated, it'd be much cleaner if we managed it a better way.
+# Perhaps keep the default faces as a hash and then merge the tmtheme
+# imported faces hash, before writing out the face definitions.
+
+# TODO: Infer color values of defaults based on the provided palette,
+# using suitable tonal emphasis/de-emphasis as necessary. (this is
+# being done "casually" for the modeline, fringe and linum)
+
+%>
+
+<% @emacs_faces.each do |e| debug_out e[:face] %>
+ '(<%= e[:face] %> ((t (<%= face_attrs(e[:settings]) %>))))
+<% end %>
+
+<% if @rainbow_parens && @rainbow_parens.count == 10 %>
+;; Rainbow delimiters
+<% @rainbow_parens[0,9].each_with_index do |e,i| %>
+ '(rainbow-delimiters-depth-<%= i + 1 %>-face ((t (:foreground "<%= e %>"))))
+<% end %>
+ '(rainbow-delimiters-unmatched-face ((t (:foreground "<%= @rainbow_parens[9] %>"))))
+<% end %>
+) ;; End face definitions
+
+;;;###autoload
+(when load-file-name
+  (add-to-list 'custom-theme-load-path
+               (file-name-as-directory (file-name-directory load-file-name))))
+
+(provide-theme '<%= @theme_name %>)
+
+;; Local Variables:
+;; eval: (when (fboundp 'rainbow-mode) (rainbow-mode +1))
+;; End:
+
+;;; <%= @long_theme_name %>.el ends here