extension/lib/defaults.coffee

   1 ###
   2 # Copyright Simon Lydell 2015.
   3 #
   4 # This file is part of VimFx.
   5 #
   6 # VimFx is free software: you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation, either version 3 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # VimFx is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with VimFx.  If not, see <http://www.gnu.org/licenses/>.
  18 ###
  19
  20 # This file defines all VimFx’s options in an easy-to-read way.
  21
  22 shortcuts =
  23   'normal':
  24     'location':
  25       'o':         'focus_location_bar'
  26       'O':         'focus_search_bar'
  27       'p':         'paste_and_go'
  28       'P':         'paste_and_go_in_tab'
  29       'yy':        'copy_current_url'
  30       'gu':        'go_up_path'
  31       'gU':        'go_to_root'
  32       'gh':        'go_home'
  33       'H':         'history_back'
  34       'L':         'history_forward'
  35       'r':         'reload'
  36       'R':         'reload_force'
  37       'ar':        'reload_all'
  38       'aR':        'reload_all_force'
  39       's':         'stop'
  40       'as':        'stop_all'
  41
  42     'scrolling':
  43       'h':         'scroll_left'
  44       'l':         'scroll_right'
  45       'j':         'scroll_down'
  46       'k':         'scroll_up'
  47       '<space>':   'scroll_page_down'
  48       '<s-space>': 'scroll_page_up'
  49       'd':         'scroll_half_page_down'
  50       'u':         'scroll_half_page_up'
  51       'gg':        'scroll_to_top'
  52       'G':         'scroll_to_bottom'
  53       '0  ^':      'scroll_to_left'
  54       '$':         'scroll_to_right'
  55       'm':         'mark_scroll_position'
  56       '`':         'scroll_to_mark'
  57
  58     'tabs':
  59       't':         'tab_new'
  60       'yt':        'tab_duplicate'
  61       'J    gT':   'tab_select_previous'
  62       'K    gt':   'tab_select_next'
  63       'gJ':        'tab_move_backward'
  64       'gK':        'tab_move_forward'
  65       'g0':        'tab_select_first'
  66       'g^':        'tab_select_first_non_pinned'
  67       'g$':        'tab_select_last'
  68       'gp':        'tab_toggle_pinned'
  69       'x':         'tab_close'
  70       'X':         'tab_restore'
  71       'gx$':       'tab_close_to_end'
  72       'gxa':       'tab_close_other'
  73
  74     'browsing':
  75       'f':         'follow'
  76       'F':         'follow_in_tab'
  77       'gf':        'follow_in_focused_tab'
  78       'af':        'follow_multiple'
  79       'yf':        'follow_copy'
  80       'zf':        'follow_focus'
  81       '[':         'follow_previous'
  82       ']':         'follow_next'
  83       'gi':        'focus_text_input'
  84
  85     'find':
  86       '/':         'find'
  87       'a/':        'find_highlight_all'
  88       'g/':        'find_links_only'
  89       'n':         'find_next'
  90       'N':         'find_previous'
  91
  92     'misc':
  93       'i':         'enter_mode_ignore'
  94       'I':         'quote'
  95       '?':         'help'
  96       ':':         'dev'
  97       '<force><escape>': 'esc'
  98
  99   'hints':
 100     '':
 101       '<escape>':        'exit'
 102       '<space>':         'rotate_markers_forward'
 103       '<s-space>':       'rotate_markers_backward'
 104       '<backspace>':     'delete_hint_char'
 105       '<enter>':         'increase_count'
 106
 107   'ignore':
 108     '':
 109       '<s-escape>':      'exit'
 110       '<s-f1>':          'unquote'
 111
 112   'find':
 113     '':
 114       '<escape>    <enter>': 'exit'
 115
 116 options =
 117   'hint_chars':             'fjdkslaghrueiwovncm'
 118   'prev_patterns':          'prev  previous  ‹  «  ◀  ←  <<  <  back  newer'
 119   'next_patterns':          'next  ›  »  ▶  →  >>  >  more  older'
 120   'black_list':             ''
 121   'prevent_autofocus':      false
 122   'ignore_keyboard_layout': false
 123   'timeout':                2000
 124
 125 advanced_options =
 126   'notifications_enabled':              true
 127   'prevent_target_blank':               true
 128   'prevent_autofocus_modes':            'normal'
 129   'hints_timeout':                      200
 130   'smoothScroll.lines.spring-constant': '1000'
 131   'smoothScroll.pages.spring-constant': '2500'
 132   'smoothScroll.other.spring-constant': '2500'
 133   'pattern_selector':                   'a, button'
 134   'pattern_attrs':                      'rel  role  data-tooltip  aria-label'
 135   'last_scroll_position_mark':          '`'
 136   'hints_toggle_in_tab':                '<c-'
 137   'hints_toggle_in_background':         '<a-'
 138   'activatable_element_keys':           '<enter>'
 139   'adjustable_element_keys':            '<arrowup>  <arrowdown>  <arrowleft>
 140                                          <arrowright>  <space>  <enter>'
 141   'focus_previous_key':                 '<s-tab>'
 142   'focus_next_key':                     '<tab>'
 143   'options.key.quote':                  '<c-q>'
 144   'options.key.insert_default':         '<c-d>'
 145   'options.key.reset_default':          '<c-r>'
 146
 147 parsed_options =
 148   'translations': {}
 149   'categories':   {} # Will be filled in below.
 150
 151
 152
 153 # The above easy-to-read data is transformed in to easy-to-consume (for
 154 # computers) formats below.
 155
 156 translate = require('./l10n')
 157 utils     = require('./utils')
 158
 159 addCategory = (category, order) ->
 160   uncategorized = (category == '')
 161   categoryName =
 162     if uncategorized
 163       -> ''
 164     else
 165       translate.bind(null, "category.#{category}")
 166   parsed_options.categories[category] = {
 167     name:  categoryName
 168     order: if uncategorized then 0 else order
 169   }
 170
 171 shortcut_prefs = {}
 172 categoryMap    = {}
 173 mode_order     = {}
 174 command_order  = {}
 175
 176 createCounter   = -> new utils.Counter({step: 100})
 177 modeCounter     = createCounter()
 178 categoryCounter = createCounter()
 179
 180 for modeName, modeCategories of shortcuts
 181   mode_order[modeName] = modeCounter.tick()
 182   for categoryName, modeShortcuts of modeCategories
 183     addCategory(categoryName, categoryCounter.tick())
 184     commandIndex = createCounter()
 185     for shortcut, commandName of modeShortcuts
 186       pref = "mode.#{modeName}.#{commandName}"
 187       shortcut_prefs[pref] = shortcut
 188       command_order[pref] = commandIndex.tick()
 189       categoryMap[pref] = categoryName
 190
 191 # All options, excluding shortcut customizations.
 192 all_options = Object.assign({}, options, advanced_options, parsed_options)
 193 # All things that are saved in Firefox’s prefs system.
 194 all_prefs   = Object.assign({}, options, advanced_options, shortcut_prefs)
 195
 196 module.exports = {
 197   options
 198   advanced_options
 199   parsed_options
 200   all_options
 201   shortcut_prefs
 202   all_prefs
 203   categoryMap
 204   mode_order
 205   command_order
 206   BRANCH: 'extensions.VimFx.'
 207 }