logo

dotfiles

My dotfiles, one branch per machine, rebased on base git clone https://hacktivis.me/git/dotfiles.git

go.py (20474B)

    

  1. # -*- coding: utf-8 -*-
  2. #
  3. # Copyright (C) 2009-2014 Sébastien Helleu <flashcode@flashtux.org>
  4. # Copyright (C) 2010 m4v <lambdae2@gmail.com>
  5. # Copyright (C) 2011 stfn <stfnmd@googlemail.com>
  6. #
  7. # This program is free software; you can redistribute it and/or modify
  8. # it under the terms of the GNU General Public License as published by
  9. # the Free Software Foundation; either version 3 of the License, or
  10. # (at your option) any later version.
  11. #
  12. # This program is distributed in the hope that it will be useful,
  13. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15. # GNU General Public License for more details.
  16. #
  17. # You should have received a copy of the GNU General Public License
  18. # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19. #
  21. #
  22. # History:
  23. #
  24. # 2017-04-01, Sébastien Helleu <flashcode@flashtux.org>:
  25. #     version 2.5: add option "buffer_number"
  26. # 2017-03-02, Sébastien Helleu <flashcode@flashtux.org>:
  27. #     version 2.4: fix syntax and indentation error
  28. # 2017-02-25, Simmo Saan <simmo.saan@gmail.com>
  29. #     version 2.3: fix fuzzy search breaking buffer number search display
  30. # 2016-01-28, ylambda <ylambda@koalabeast.com>
  31. #     version 2.2: add option "fuzzy_search"
  32. # 2015-11-12, nils_2 <weechatter@arcor.de>
  33. #     version 2.1: fix problem with buffer short_name "weechat", using option
  34. #                  "use_core_instead_weechat", see:
  35. #                  https://github.com/weechat/weechat/issues/574
  36. # 2014-05-12, Sébastien Helleu <flashcode@flashtux.org>:
  37. #     version 2.0: add help on options, replace option "sort_by_activity" by
  38. #                  "sort" (add sort by name and first match at beginning of
  39. #                  name and by number), PEP8 compliance
  40. # 2012-11-26, Nei <anti.teamidiot.de>
  41. #     version 1.9: add auto_jump option to automatically go to buffer when it
  42. #                  is uniquely selected
  43. # 2012-09-17, Sébastien Helleu <flashcode@flashtux.org>:
  44. #     version 1.8: fix jump to non-active merged buffers (jump with buffer name
  45. #                  instead of number)
  46. # 2012-01-03 nils_2 <weechatter@arcor.de>
  47. #     version 1.7: add option "use_core_instead_weechat"
  48. # 2012-01-03, Sébastien Helleu <flashcode@flashtux.org>:
  49. #     version 1.6: make script compatible with Python 3.x
  50. # 2011-08-24, stfn <stfnmd@googlemail.com>:
  51. #     version 1.5: /go with name argument jumps directly to buffer
  52. #                  Remember cursor position in buffer input
  53. # 2011-05-31, Elián Hanisch <lambdae2@gmail.com>:
  54. #     version 1.4: Sort list of buffers by activity.
  55. # 2011-04-25, Sébastien Helleu <flashcode@flashtux.org>:
  56. #     version 1.3: add info "go_running" (used by script input_lock.rb)
  57. # 2010-11-01, Sébastien Helleu <flashcode@flashtux.org>:
  58. #     version 1.2: use high priority for hooks to prevent conflict with other
  59. #                  plugins/scripts (WeeChat >= 0.3.4 only)
  60. # 2010-03-25, Elián Hanisch <lambdae2@gmail.com>:
  61. #     version 1.1: use a space to match the end of a string
  62. # 2009-11-16, Sébastien Helleu <flashcode@flashtux.org>:
  63. #     version 1.0: add new option to display short names
  64. # 2009-06-15, Sébastien Helleu <flashcode@flashtux.org>:
  65. #     version 0.9: fix typo in /help go with command /key
  66. # 2009-05-16, Sébastien Helleu <flashcode@flashtux.org>:
  67. #     version 0.8: search buffer by number, fix bug when window is split
  68. # 2009-05-03, Sébastien Helleu <flashcode@flashtux.org>:
  69. #     version 0.7: eat tab key (do not complete input, just move buffer
  70. #                  pointer)
  71. # 2009-05-02, Sébastien Helleu <flashcode@flashtux.org>:
  72. #     version 0.6: sync with last API changes
  73. # 2009-03-22, Sébastien Helleu <flashcode@flashtux.org>:
  74. #     version 0.5: update modifier signal name for input text display,
  75. #                  fix arguments for function string_remove_color
  76. # 2009-02-18, Sébastien Helleu <flashcode@flashtux.org>:
  77. #     version 0.4: do not hook command and init options if register failed
  78. # 2009-02-08, Sébastien Helleu <flashcode@flashtux.org>:
  79. #     version 0.3: case insensitive search for buffers names
  80. # 2009-02-08, Sébastien Helleu <flashcode@flashtux.org>:
  81. #     version 0.2: add help about Tab key
  82. # 2009-02-08, Sébastien Helleu <flashcode@flashtux.org>:
  83. #     version 0.1: initial release
  84. #
  86. """
  87. Quick jump to buffers.
  88. (this script requires WeeChat 0.3.0 or newer)
  89. """
  91. from __future__ import print_function
  93. SCRIPT_NAME = 'go'
  94. SCRIPT_AUTHOR = 'Sébastien Helleu <flashcode@flashtux.org>'
  95. SCRIPT_VERSION = '2.5'
  96. SCRIPT_LICENSE = 'GPL3'
  97. SCRIPT_DESC = 'Quick jump to buffers'
  99. SCRIPT_COMMAND = 'go'
  101. IMPORT_OK = True
  103. try:
  104.     import weechat
  105. except ImportError:
  106.     print('This script must be run under WeeChat.')
  107.     print('Get WeeChat now at: http://www.weechat.org/')
  108.     IMPORT_OK = False
  110. import re
  112. # script options
  113. SETTINGS = {
  114.     'color_number': (
  115.         'yellow,magenta',
  116.         'color for buffer number (not selected)'),
  117.     'color_number_selected': (
  118.         'yellow,red',
  119.         'color for selected buffer number'),
  120.     'color_name': (
  121.         'black,cyan',
  122.         'color for buffer name (not selected)'),
  123.     'color_name_selected': (
  124.         'black,brown',
  125.         'color for a selected buffer name'),
  126.     'color_name_highlight': (
  127.         'red,cyan',
  128.         'color for highlight in buffer name (not selected)'),
  129.     'color_name_highlight_selected': (
  130.         'red,brown',
  131.         'color for highlight in a selected buffer name'),
  132.     'message': (
  133.         'Go to: ',
  134.         'message to display before list of buffers'),
  135.     'short_name': (
  136.         'off',
  137.         'display and search in short names instead of buffer name'),
  138.     'sort': (
  139.         'number,beginning',
  140.         'comma-separated list of keys to sort buffers '
  141.         '(the order is important, sorts are performed in the given order): '
  142.         'name = sort by name (or short name), ',
  143.         'hotlist = sort by hotlist order, '
  144.         'number = first match a buffer number before digits in name, '
  145.         'beginning = first match at beginning of names (or short names); '
  146.         'the default sort of buffers is by numbers'),
  147.     'use_core_instead_weechat': (
  148.         'off',
  149.         'use name "core" instead of "weechat" for core buffer'),
  150.     'auto_jump': (
  151.         'off',
  152.         'automatically jump to buffer when it is uniquely selected'),
  153.     'fuzzy_search': (
  154.         'off',
  155.         'search buffer matches using approximation'),
  156.     'buffer_number': (
  157.         'on',
  158.         'display buffer number'),
  159. }
  161. # hooks management
  162. HOOK_COMMAND_RUN = {
  163.     'input': ('/input *', 'go_command_run_input'),
  164.     'buffer': ('/buffer *', 'go_command_run_buffer'),
  165.     'window': ('/window *', 'go_command_run_window'),
  166. }
  167. hooks = {}
  169. # input before command /go (we'll restore it later)
  170. saved_input = ''
  171. saved_input_pos = 0
  173. # last user input (if changed, we'll update list of matching buffers)
  174. old_input = None
  176. # matching buffers
  177. buffers = []
  178. buffers_pos = 0
  181. def go_option_enabled(option):
  182.     """Checks if a boolean script option is enabled or not."""
  183.     return weechat.config_string_to_boolean(weechat.config_get_plugin(option))
  186. def go_info_running(data, info_name, arguments):
  187.     """Returns "1" if go is running, otherwise "0"."""
  188.     return '1' if 'modifier' in hooks else '0'
  191. def go_unhook_one(hook):
  192.     """Unhook something hooked by this script."""
  193.     global hooks
  194.     if hook in hooks:
  195.         weechat.unhook(hooks[hook])
  196.         del hooks[hook]
  199. def go_unhook_all():
  200.     """Unhook all."""
  201.     go_unhook_one('modifier')
  202.     for hook in HOOK_COMMAND_RUN:
  203.         go_unhook_one(hook)
  206. def go_hook_all():
  207.     """Hook command_run and modifier."""
  208.     global hooks
  209.     priority = ''
  210.     version = weechat.info_get('version_number', '') or 0
  211.     # use high priority for hook to prevent conflict with other plugins/scripts
  212.     # (WeeChat >= 0.3.4 only)
  213.     if int(version) >= 0x00030400:
  214.         priority = '2000|'
  215.     for hook, value in HOOK_COMMAND_RUN.items():
  216.         if hook not in hooks:
  217.             hooks[hook] = weechat.hook_command_run(
  218.                 '%s%s' % (priority, value[0]),
  219.                 value[1], '')
  220.     if 'modifier' not in hooks:
  221.         hooks['modifier'] = weechat.hook_modifier(
  222.             'input_text_display_with_cursor', 'go_input_modifier', '')
  225. def go_start(buf):
  226.     """Start go on buffer."""
  227.     global saved_input, saved_input_pos, old_input, buffers_pos
  228.     go_hook_all()
  229.     saved_input = weechat.buffer_get_string(buf, 'input')
  230.     saved_input_pos = weechat.buffer_get_integer(buf, 'input_pos')
  231.     weechat.buffer_set(buf, 'input', '')
  232.     old_input = None
  233.     buffers_pos = 0
  236. def go_end(buf):
  237.     """End go on buffer."""
  238.     global saved_input, saved_input_pos, old_input
  239.     go_unhook_all()
  240.     weechat.buffer_set(buf, 'input', saved_input)
  241.     weechat.buffer_set(buf, 'input_pos', str(saved_input_pos))
  242.     old_input = None
  245. def go_match_beginning(buf, string):
  246.     """Check if a string matches the beginning of buffer name/short name."""
  247.     if not string:
  248.         return False
  249.     esc_str = re.escape(string)
  250.     if re.search(r'^#?' + esc_str, buf['name']) \
  251.             or re.search(r'^#?' + esc_str, buf['short_name']):
  252.         return True
  253.     return False
  256. def go_match_fuzzy(name, string):
  257.     """Check if string matches name using approximation."""
  258.     if not string:
  259.         return False
  261.     name_len = len(name)
  262.     string_len = len(string)
  264.     if string_len > name_len:
  265.         return False
  266.     if name_len == string_len:
  267.         return name == string
  269.     # Attempt to match all chars somewhere in name
  270.     prev_index = -1
  271.     for i, char in enumerate(string):
  272.         index = name.find(char, prev_index+1)
  273.         if index == -1:
  274.             return False
  275.         prev_index = index
  276.     return True
  279. def go_now(buf, args):
  280.     """Go to buffer specified by args."""
  281.     listbuf = go_matching_buffers(args)
  282.     if not listbuf:
  283.         return
  285.     # prefer buffer that matches at beginning (if option is enabled)
  286.     if 'beginning' in weechat.config_get_plugin('sort').split(','):
  287.         for index in range(len(listbuf)):
  288.             if go_match_beginning(listbuf[index], args):
  289.                 weechat.command(buf,
  290.                                 '/buffer ' + str(listbuf[index]['full_name']))
  291.                 return
  293.     # jump to first buffer in matching buffers by default
  294.     weechat.command(buf, '/buffer ' + str(listbuf[0]['full_name']))
  297. def go_cmd(data, buf, args):
  298.     """Command "/go": just hook what we need."""
  299.     global hooks
  300.     if args:
  301.         go_now(buf, args)
  302.     elif 'modifier' in hooks:
  303.         go_end(buf)
  304.     else:
  305.         go_start(buf)
  306.     return weechat.WEECHAT_RC_OK
  309. def go_matching_buffers(strinput):
  310.     """Return a list with buffers matching user input."""
  311.     global buffers_pos
  312.     listbuf = []
  313.     if len(strinput) == 0:
  314.         buffers_pos = 0
  315.     strinput = strinput.lower()
  316.     infolist = weechat.infolist_get('buffer', '', '')
  317.     while weechat.infolist_next(infolist):
  318.         short_name = weechat.infolist_string(infolist, 'short_name')
  319.         if go_option_enabled('short_name'):
  320.             name = weechat.infolist_string(infolist, 'short_name')
  321.         else:
  322.             name = weechat.infolist_string(infolist, 'name')
  323.         if name == 'weechat' \
  324.                 and go_option_enabled('use_core_instead_weechat') \
  325.                 and weechat.infolist_string(infolist, 'plugin_name') == 'core':
  326.             name = 'core'
  327.         number = weechat.infolist_integer(infolist, 'number')
  328.         full_name = weechat.infolist_string(infolist, 'full_name')
  329.         if not full_name:
  330.             full_name = '%s.%s' % (
  331.                 weechat.infolist_string(infolist, 'plugin_name'),
  332.                 weechat.infolist_string(infolist, 'name'))
  333.         pointer = weechat.infolist_pointer(infolist, 'pointer')
  334.         matching = name.lower().find(strinput) >= 0
  335.         if not matching and strinput[-1] == ' ':
  336.             matching = name.lower().endswith(strinput.strip())
  337.         if not matching and go_option_enabled('fuzzy_search'):
  338.             matching = go_match_fuzzy(name.lower(), strinput)
  339.         if not matching and strinput.isdigit():
  340.             matching = str(number).startswith(strinput)
  341.         if len(strinput) == 0 or matching:
  342.             listbuf.append({
  343.                 'number': number,
  344.                 'short_name': short_name,
  345.                 'name': name,
  346.                 'full_name': full_name,
  347.                 'pointer': pointer,
  348.             })
  349.     weechat.infolist_free(infolist)
  351.     # sort buffers
  352.     hotlist = []
  353.     infolist = weechat.infolist_get('hotlist', '', '')
  354.     while weechat.infolist_next(infolist):
  355.         hotlist.append(
  356.             weechat.infolist_pointer(infolist, 'buffer_pointer'))
  357.     weechat.infolist_free(infolist)
  358.     last_index_hotlist = len(hotlist)
  360.     def _sort_name(buf):
  361.         """Sort buffers by name (or short name)."""
  362.         return buf['name']
  364.     def _sort_hotlist(buf):
  365.         """Sort buffers by hotlist order."""
  366.         try:
  367.             return hotlist.index(buf['pointer'])
  368.         except ValueError:
  369.             # not in hotlist, always last.
  370.             return last_index_hotlist
  372.     def _sort_match_number(buf):
  373.         """Sort buffers by match on number."""
  374.         return 0 if str(buf['number']) == strinput else 1
  376.     def _sort_match_beginning(buf):
  377.         """Sort buffers by match at beginning."""
  378.         return 0 if go_match_beginning(buf, strinput) else 1
  380.     funcs = {
  381.         'name': _sort_name,
  382.         'hotlist': _sort_hotlist,
  383.         'number': _sort_match_number,
  384.         'beginning': _sort_match_beginning,
  385.     }
  387.     for key in weechat.config_get_plugin('sort').split(','):
  388.         if key in funcs:
  389.             listbuf = sorted(listbuf, key=funcs[key])
  391.     if not strinput:
  392.         index = [i for i, buf in enumerate(listbuf)
  393.                  if buf['pointer'] == weechat.current_buffer()]
  394.         if index:
  395.             buffers_pos = index[0]
  397.     return listbuf
  400. def go_buffers_to_string(listbuf, pos, strinput):
  401.     """Return string built with list of buffers found (matching user input)."""
  402.     string = ''
  403.     strinput = strinput.lower()
  404.     for i in range(len(listbuf)):
  405.         selected = '_selected' if i == pos else ''
  406.         buffer_name = listbuf[i]['name']
  407.         index = buffer_name.lower().find(strinput)
  408.         if index >= 0:
  409.             index2 = index + len(strinput)
  410.             name = '%s%s%s%s%s' % (
  411.                 buffer_name[:index],
  412.                 weechat.color(weechat.config_get_plugin(
  413.                     'color_name_highlight' + selected)),
  414.                 buffer_name[index:index2],
  415.                 weechat.color(weechat.config_get_plugin(
  416.                     'color_name' + selected)),
  417.                 buffer_name[index2:])
  418.         elif go_option_enabled("fuzzy_search") and \
  419.                 go_match_fuzzy(buffer_name.lower(), strinput):
  420.             name = ""
  421.             prev_index = -1
  422.             for char in strinput.lower():
  423.                 index = buffer_name.lower().find(char, prev_index+1)
  424.                 if prev_index < 0:
  425.                     name += buffer_name[:index]
  426.                     name += weechat.color(weechat.config_get_plugin(
  427.                         'color_name_highlight' + selected))
  428.                 if prev_index >= 0 and index > prev_index+1:
  429.                     name += weechat.color(weechat.config_get_plugin(
  430.                         'color_name' + selected))
  431.                     name += buffer_name[prev_index+1:index]
  432.                     name += weechat.color(weechat.config_get_plugin(
  433.                         'color_name_highlight' + selected))
  434.                 name += buffer_name[index]
  435.                 prev_index = index
  437.             name += weechat.color(weechat.config_get_plugin(
  438.                 'color_name' + selected))
  439.             name += buffer_name[prev_index+1:]
  440.         else:
  441.             name = buffer_name
  442.         string += ' '
  443.         if go_option_enabled('buffer_number'):
  444.             string += '%s%s' % (
  445.                 weechat.color(weechat.config_get_plugin(
  446.                     'color_number' + selected)),
  447.                 str(listbuf[i]['number']))
  448.         string += '%s%s%s' % (
  449.             weechat.color(weechat.config_get_plugin(
  450.                 'color_name' + selected)),
  451.             name,
  452.             weechat.color('reset'))
  453.     return '  ' + string if string else ''
  456. def go_input_modifier(data, modifier, modifier_data, string):
  457.     """This modifier is called when input text item is built by WeeChat.
  459.     This is commonly called after changes in input or cursor move: it builds
  460.     a new input with prefix ("Go to:"), and suffix (list of buffers found).
  461.     """
  462.     global old_input, buffers, buffers_pos
  463.     if modifier_data != weechat.current_buffer():
  464.         return ''
  465.     names = ''
  466.     new_input = weechat.string_remove_color(string, '')
  467.     new_input = new_input.lstrip()
  468.     if old_input is None or new_input != old_input:
  469.         old_buffers = buffers
  470.         buffers = go_matching_buffers(new_input)
  471.         if buffers != old_buffers and len(new_input) > 0:
  472.             if len(buffers) == 1 and go_option_enabled('auto_jump'):
  473.                 weechat.command(modifier_data, '/wait 1ms /input return')
  474.             buffers_pos = 0
  475.         old_input = new_input
  476.     names = go_buffers_to_string(buffers, buffers_pos, new_input.strip())
  477.     return weechat.config_get_plugin('message') + string + names
  480. def go_command_run_input(data, buf, command):
  481.     """Function called when a command "/input xxx" is run."""
  482.     global buffers, buffers_pos
  483.     if command == '/input search_text' or command.find('/input jump') == 0:
  484.         # search text or jump to another buffer is forbidden now
  485.         return weechat.WEECHAT_RC_OK_EAT
  486.     elif command == '/input complete_next':
  487.         # choose next buffer in list
  488.         buffers_pos += 1
  489.         if buffers_pos >= len(buffers):
  490.             buffers_pos = 0
  491.         weechat.hook_signal_send('input_text_changed',
  492.                                  weechat.WEECHAT_HOOK_SIGNAL_STRING, '')
  493.         return weechat.WEECHAT_RC_OK_EAT
  494.     elif command == '/input complete_previous':
  495.         # choose previous buffer in list
  496.         buffers_pos -= 1
  497.         if buffers_pos < 0:
  498.             buffers_pos = len(buffers) - 1
  499.         weechat.hook_signal_send('input_text_changed',
  500.                                  weechat.WEECHAT_HOOK_SIGNAL_STRING, '')
  501.         return weechat.WEECHAT_RC_OK_EAT
  502.     elif command == '/input return':
  503.         # switch to selected buffer (if any)
  504.         go_end(buf)
  505.         if len(buffers) > 0:
  506.             weechat.command(
  507.                 buf, '/buffer ' + str(buffers[buffers_pos]['full_name']))
  508.         return weechat.WEECHAT_RC_OK_EAT
  509.     return weechat.WEECHAT_RC_OK
  512. def go_command_run_buffer(data, buf, command):
  513.     """Function called when a command "/buffer xxx" is run."""
  514.     return weechat.WEECHAT_RC_OK_EAT
  517. def go_command_run_window(data, buf, command):
  518.     """Function called when a command "/window xxx" is run."""
  519.     return weechat.WEECHAT_RC_OK_EAT
  522. def go_unload_script():
  523.     """Function called when script is unloaded."""
  524.     go_unhook_all()
  525.     return weechat.WEECHAT_RC_OK
  528. def go_main():
  529.     """Entry point."""
  530.     if not weechat.register(SCRIPT_NAME, SCRIPT_AUTHOR, SCRIPT_VERSION,
  531.                             SCRIPT_LICENSE, SCRIPT_DESC,
  532.                             'go_unload_script', ''):
  533.         return
  534.     weechat.hook_command(
  535.         SCRIPT_COMMAND,
  536.         'Quick jump to buffers', '[name]',
  537.         'name: directly jump to buffer by name (without argument, list is '
  538.         'displayed)\n\n'
  539.         'You can bind command to a key, for example:\n'
  540.         '  /key bind meta-g /go\n\n'
  541.         'You can use completion key (commonly Tab and shift-Tab) to select '
  542.         'next/previous buffer in list.',
  543.         '%(buffers_names)',
  544.         'go_cmd', '')
  546.     # set default settings
  547.     version = weechat.info_get('version_number', '') or 0
  548.     for option, value in SETTINGS.items():
  549.         if not weechat.config_is_set_plugin(option):
  550.             weechat.config_set_plugin(option, value[0])
  551.         if int(version) >= 0x00030500:
  552.             weechat.config_set_desc_plugin(
  553.                 option, '%s (default: "%s")' % (value[1], value[0]))
  554.     weechat.hook_info('go_running',
  555.                       'Return "1" if go is running, otherwise "0"',
  556.                       '',
  557.                       'go_info_running', '')
  560. if __name__ == "__main__" and IMPORT_OK:
  561.     go_main()