windows.py 49.2 KB
Newer Older
1
# Copyright 2010 Le Coz Florent <louiz@louiz.org>
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
#
# This file is part of Poezio.
#
# Poezio is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, version 3 of the License.
#
# Poezio is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Poezio.  If not, see <http://www.gnu.org/licenses/>.

17
"""
18 19 20 21
Define all the windows.
A window is a little part of the screen, for example the input window,
the text window, the roster window, etc.
A Tab (see tab.py) is composed of multiple Windows
22 23
"""

24 25
from gettext import (bindtextdomain, textdomain, bind_textdomain_codeset,
                     gettext as _)
26
from os.path import isfile
27

28 29 30
import logging
log = logging.getLogger(__name__)

31 32 33
import locale
locale.setlocale(locale.LC_ALL, '')

34
import shlex
35
import curses
36
from config import config
37

38 39
from threading import Lock

40
from contact import Contact, Resource
41
from roster import RosterGroup, roster
42

43
from message import Line
44
from tabs import MIN_WIDTH, MIN_HEIGHT
45

46 47
from sleekxmpp.xmlstream.stanzabase import JID

48
import theme
49

50 51
g_lock = Lock()

52
LINES_NB_LIMIT = 4096
53

54
class Win(object):
55 56
    def __init__(self):
        pass
57

58
    def _resize(self, height, width, y, x, parent_win):
59
        self.height, self.width, self.x, self.y = height, width, x, y
60 61 62 63
        self._win = curses.newwin(height, width, y, x)

    def _refresh(self):
        self._win.noutrefresh()
64

65 66
    def addnstr(self, *args):
        """
67
        Safe call to addnstr
68 69
        """
        try:
70
            self._win.addnstr(*args)
71 72 73 74 75
        except:
            pass

    def addstr(self, *args):
        """
76
        Safe call to addstr
77
        """
78
        try:
79
            self._win.addstr(*args)
80 81
        except:
            pass
82

83 84 85 86
    def finish_line(self, color):
        """
        Write colored spaces until the end of line
        """
87
        (y, x) = self._win.getyx()
88 89 90
        size = self.width-x
        self.addnstr(' '*size, size, curses.color_pair(color))

91
class UserList(Win):
92 93
    def __init__(self):
        Win.__init__(self)
94 95 96
        self.color_role = {'moderator': theme.COLOR_USER_MODERATOR,
                           'participant':theme.COLOR_USER_PARTICIPANT,
                           'visitor':theme.COLOR_USER_VISITOR,
97 98
                           'none':theme.COLOR_USER_NONE,
                           '':theme.COLOR_USER_NONE
99
                           }
100
        self.color_show = {'xa':theme.COLOR_STATUS_XA,
101 102
                           'none':theme.COLOR_STATUS_NONE,
                           '':theme.COLOR_STATUS_NONE,
103 104 105
                           'dnd':theme.COLOR_STATUS_DND,
                           'away':theme.COLOR_STATUS_AWAY,
                           'chat':theme.COLOR_STATUS_CHAT
106
                           }
107 108

    def refresh(self, users):
109
        with g_lock:
110
            self._win.erase()
111 112 113 114 115 116 117 118 119 120 121
            y = 0
            for user in sorted(users):
                if not user.role in self.color_role:
                    role_col = theme.COLOR_USER_NONE
                else:
                    role_col = self.color_role[user.role]
                if not user.show in self.color_show:
                    show_col = theme.COLOR_STATUS_NONE
                else:
                    show_col = self.color_show[user.show]
                self.addstr(y, 0, theme.CHAR_STATUS, curses.color_pair(show_col))
122
                self.addnstr(y, 1, user.nick, self.width-1, curses.color_pair(role_col))
123 124 125
                y += 1
                if y == self.height:
                    break
126
            self._refresh()
127

128 129
    def resize(self, height, width, y, x, stdscr):
        self._resize(height, width, y, x, stdscr)
130 131 132
        self._win.attron(curses.color_pair(theme.COLOR_VERTICAL_SEPARATOR))
        self._win.vline(0, 0, curses.ACS_VLINE, self.height)
        self._win.attroff(curses.color_pair(theme.COLOR_VERTICAL_SEPARATOR))
133

134
class Topic(Win):
135 136
    def __init__(self):
        Win.__init__(self)
137

138 139
    def resize(self, height, width, y, x, stdscr):
        self._resize(height, width, y, x, stdscr)
140

141
    def refresh(self, topic):
142
        with g_lock:
143
            self._win.erase()
144
            self.addstr(0, 0, topic[:self.width-1], curses.color_pair(theme.COLOR_TOPIC_BAR))
145
            (y, x) = self._win.getyx()
146 147 148 149
            remaining_size = self.width - x
            if remaining_size:
                self.addnstr(' '*remaining_size, remaining_size,
                             curses.color_pair(theme.COLOR_INFORMATION_BAR))
150
            self._refresh()
151

152
class GlobalInfoBar(Win):
153 154
    def __init__(self):
        Win.__init__(self)
155

156 157
    def resize(self, height, width, y, x, stdscr):
        self._resize(height, width, y, x, stdscr)
158

159
    def refresh(self, tabs, current):
160 161 162 163
        def compare_room(a):
            # return a.nb - b.nb
            return a.nb
        comp = lambda x: x.nb
164
        with g_lock:
165
            self._win.erase()
166
            self.addstr(0, 0, "[", curses.color_pair(theme.COLOR_INFORMATION_BAR))
167 168 169 170 171 172 173 174
            sorted_tabs = sorted(tabs, key=comp)
            for tab in sorted_tabs:
                color = tab.get_color_state()
                try:
                    self.addstr("%s" % str(tab.nb), curses.color_pair(color))
                    self.addstr("|", curses.color_pair(theme.COLOR_INFORMATION_BAR))
                except:             # end of line
                    break
175
            (y, x) = self._win.getyx()
176
            self.addstr(y, x-1, '] ', curses.color_pair(theme.COLOR_INFORMATION_BAR))
177
            (y, x) = self._win.getyx()
178 179 180
            remaining_size = self.width - x
            self.addnstr(' '*remaining_size, remaining_size,
                         curses.color_pair(theme.COLOR_INFORMATION_BAR))
181
            self._refresh()
182

183 184 185 186 187
class InfoWin(Win):
    """
    Base class for all the *InfoWin, used in various tabs. For example
    MucInfoWin, etc. Provides some useful methods.
    """
188 189
    def __init__(self):
        Win.__init__(self)
190

191
    def print_scroll_position(self, window):
192 193 194 195 196
        """
        Print, link in Weechat, a -PLUS(n)- where n
        is the number of available lines to scroll
        down
        """
197 198
        if window.pos > 0:
            plus = ' -PLUS(%s)-' % window.pos
199
            self.addstr(plus, curses.color_pair(theme.COLOR_SCROLLABLE_NUMBER) | curses.A_BOLD)
200 201 202 203 204 205

class PrivateInfoWin(InfoWin):
    """
    The live above the information window, displaying informations
    about the MUC user we are talking to
    """
206 207
    def __init__(self):
        InfoWin.__init__(self)
208

209 210
    def resize(self, height, width, y, x, stdscr):
        self._resize(height, width, y, x, stdscr)
211

212
    def refresh(self, room, window):
213

214
        with g_lock:
215
            self._win.erase()
216
            self.write_room_name(room)
217
            self.print_scroll_position(window)
218
            self.finish_line(theme.COLOR_INFORMATION_BAR)
219
            self._refresh()
220 221

    def write_room_name(self, room):
222 223
        jid = JID(room.name)
        room_name, nick = jid.bare, jid.resource
224
        self.addstr(nick, curses.color_pair(13))
225
        txt = ' from room %s' % room_name
226
        self.addstr(txt, curses.color_pair(theme.COLOR_INFORMATION_BAR))
227

228 229 230
class ConversationInfoWin(InfoWin):
    """
    The line above the information window, displaying informations
231
    about the user we are talking to
232
    """
233 234 235 236 237 238 239 240 241 242
    color_show = {'xa':theme.COLOR_STATUS_XA,
                  'none':theme.COLOR_STATUS_ONLINE,
                  '':theme.COLOR_STATUS_ONLINE,
                  'available':theme.COLOR_STATUS_ONLINE,
                  'dnd':theme.COLOR_STATUS_DND,
                  'away':theme.COLOR_STATUS_AWAY,
                  'chat':theme.COLOR_STATUS_CHAT,
                  'unavailable':theme.COLOR_STATUS_UNAVAILABLE
                  }

243 244
    def __init__(self):
        InfoWin.__init__(self)
245

246 247
    def resize(self, height, width, y, x, stdscr):
        self._resize(height, width, y, x, stdscr)
248

249
    def refresh(self, jid, contact, text_buffer, window):
250 251 252
        # contact can be None, if we receive a message
        # from someone not in our roster. In this case, we display
        # only the maximum information from the message we can get.
253 254 255 256 257 258 259 260 261 262 263 264 265
        jid = JID(jid)
        if contact:
            if jid.resource:
                resource = contact.get_resource_by_fulljid(jid.full)
            else:
                resource = contact.get_highest_priority_resource()
        else:
            resource = None
        # if contact is None, then resource is None too: user is not in the roster
        # so we don't know almost anything about it
        # If contact is a Contact, then
        # resource can now be a Resource: user is in the roster and online
        # or resource is None: user is in the roster but offline
266
        with g_lock:
267
            self._win.erase()
268 269 270
            self.write_contact_jid(jid)
            self.write_contact_informations(contact)
            self.write_resource_information(resource)
271
            self.print_scroll_position(window)
272
            self.finish_line(theme.COLOR_INFORMATION_BAR)
273
            self._refresh()
274

275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
    def write_resource_information(self, resource):
        """
        Write the informations about the resource
        """
        if not resource:
            presence = "unavailable"
        else:
            presence = resource.get_presence()
        color = RosterWin.color_show[presence]
        self.addstr('[', curses.color_pair(theme.COLOR_INFORMATION_BAR))
        self.addstr(" ", curses.color_pair(color))
        self.addstr(']', curses.color_pair(theme.COLOR_INFORMATION_BAR))

    def write_contact_informations(self, contact):
        """
        Write the informations about the contact
        """
292
        if not contact:
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
            self.addstr("(contact not in roster)", curses.color_pair(theme.COLOR_INFORMATION_BAR))
            return
        display_name = contact.get_name() or contact.get_bare_jid()
        self.addstr('%s '%(display_name), curses.color_pair(theme.COLOR_INFORMATION_BAR))

    def write_contact_jid(self, jid):
        """
        Just write the jid that we are talking to
        """
        self.addstr('[', curses.color_pair(theme.COLOR_INFORMATION_BAR))
        self.addstr(jid.full, curses.color_pair(10))
        self.addstr('] ', curses.color_pair(theme.COLOR_INFORMATION_BAR))

class ConversationStatusMessageWin(InfoWin):
    """
    The upper bar displaying the status message of the contact
    """
310 311
    def __init__(self):
        InfoWin.__init__(self)
312

313 314
    def resize(self, height, width, y, x, stdscr):
        self._resize(height, width, y, x, stdscr)
315 316 317 318 319 320 321 322

    def refresh(self, jid, contact):
        jid = JID(jid)
        if contact:
            if jid.resource:
                resource = contact.get_resource_by_fulljid(jid.full)
            else:
                resource = contact.get_highest_priority_resource()
323
        else:
324 325 326 327 328 329 330 331 332 333
            resource = None
        with g_lock:
            self._win.erase()
            if resource:
                self.write_status_message(resource)
            self.finish_line(theme.COLOR_INFORMATION_BAR)
            self._refresh()

    def write_status_message(self, resource):
        self.addstr(resource.get_status(), curses.color_pair(theme.COLOR_INFORMATION_BAR))
334

335 336 337 338 339
class MucInfoWin(InfoWin):
    """
    The line just above the information window, displaying informations
    about the MUC we are viewing
    """
340 341
    def __init__(self):
        InfoWin.__init__(self)
342

343 344
    def resize(self, height, width, y, x, stdscr):
        self._resize(height, width, y, x, stdscr)
345

346
    def refresh(self, room, window=None):
347
        with g_lock:
348
            self._win.erase()
349 350 351 352
            self.write_room_name(room)
            self.write_own_nick(room)
            self.write_disconnected(room)
            self.write_role(room)
353 354
            if window:
                self.print_scroll_position(window)
355
            self.finish_line(theme.COLOR_INFORMATION_BAR)
356
            self._refresh()
357 358 359 360

    def write_room_name(self, room):
        """
        """
361
        self.addstr('[', curses.color_pair(theme.COLOR_INFORMATION_BAR))
362
        self.addnstr(room.name, len(room.name), curses.color_pair(13))
363
        self.addstr('] ', curses.color_pair(theme.COLOR_INFORMATION_BAR))
364 365 366 367 368 369

    def write_disconnected(self, room):
        """
        Shows a message if the room is not joined
        """
        if not room.joined:
370 371
            self.addstr(' -!- Not connected ', curses.color_pair(theme.COLOR_INFORMATION_BAR))

372 373 374 375 376 377 378 379 380
    def write_own_nick(self, room):
        """
        Write our own nick in the info bar
        """
        nick = room.own_nick
        if not nick:
            return
        if len(nick) > 13:
            nick = nick[:13]+'…'
381
        self.addstr(nick, curses.color_pair(theme.COLOR_INFORMATION_BAR))
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397

    def write_role(self, room):
        """
        Write our own role and affiliation
        """
        own_user = None
        for user in room.users:
            if user.nick == room.own_nick:
                own_user = user
                break
        if not own_user:
            return
        txt = ' ('
        if own_user.affiliation != 'none':
            txt += own_user.affiliation+', '
        txt += own_user.role+')'
398
        self.addstr(txt, curses.color_pair(theme.COLOR_INFORMATION_BAR))
399

400
class TextWin(Win):
401 402
    def __init__(self):
        Win.__init__(self)
403 404 405 406 407 408
        self.pos = 0
        self.built_lines = []   # Each new message is built and kept here.
        # on resize, we rebuild all the messages

    def scroll_up(self, dist=14):
        self.pos += dist
409 410 411 412
        if self.pos + self.height > len(self.built_lines):
            self.pos = len(self.built_lines) - self.height
            if self.pos < 0:
                self.pos = 0
413 414 415 416 417 418

    def scroll_down(self, dist=14):
        self.pos -= dist
        if self.pos <= 0:
            self.pos = 0

419 420 421 422 423 424 425 426 427 428 429 430 431 432
    def remove_line_separator(self):
        """
        Remove the line separator
        """
        if None in self.built_lines:
            self.built_lines.remove(None)

    def add_line_separator(self):
        """
        add a line separator at the end of messages list
        """
        if None not in self.built_lines:
            self.built_lines.append(None)

433 434 435 436 437 438 439 440 441 442 443 444
    def build_new_message(self, message):
        """
        Take one message, build it and add it to the list
        Return the number of lines that are built for the given
        message.
        """
        if message == None:  # line separator
            self.built_lines.append(None)
            return 0
        txt = message.txt
        if not txt:
            return 0
445
            # length of the time
446 447 448 449 450 451 452 453 454 455 456 457 458
        offset = 9+len(theme.CHAR_TIME_LEFT[:1])+len(theme.CHAR_TIME_RIGHT[:1])
        if message.nickname and len(message.nickname) >= 30:
            nick = message.nickname[:30]+'…'
        else:
            nick = message.nickname
        if nick:
            offset += len(nick) + 2 # + nick + spaces length
        first = True
        this_line_was_broken_by_space = False
        nb = 0
        while txt != '':
            if txt[:self.width-offset].find('\n') != -1:
                limit = txt[:self.width-offset].find('\n')
459
            else:
460 461 462 463 464 465
                # break between words if possible
                if len(txt) >= self.width-offset:
                    limit = txt[:self.width-offset].rfind(' ')
                    this_line_was_broken_by_space = True
                    if limit <= 0:
                        limit = self.width-offset
466 467
                        this_line_was_broken_by_space = False
                else:
468 469
                    limit = self.width-offset-1
                    this_line_was_broken_by_space = False
470
            color = message.nick_color
471 472 473
            if not first:
                nick = None
                time = None
474 475 476 477 478 479 480
            else:               # strftime is VERY slow, improve performance
                                # by calling it only one time here, and
                                # not at each refresh
                time = {'hour': '%s'%(message.time.strftime("%H"),),
                        'minute': '%s'%(message.time.strftime("%M"),),
                        'second': '%s'%(message.time.strftime("%S"),),
                        }
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
            l = Line(nick, color,
                     time,
                     txt[:limit], message.color,
                     offset,
                     message.colorized)
            self.built_lines.append(l)
            nb += 1
            if this_line_was_broken_by_space:
                txt = txt[limit+1:] # jump the space at the start of the line
            else:
                txt = txt[limit:]
            if txt.startswith('\n'):
                txt = txt[1:]
            first = False
        while len(self.built_lines) > LINES_NB_LIMIT:
            self.built_lines.pop(0)
        return nb
498

499
    def refresh(self, room):
500
        """
501 502
        Build the Line objects from the messages, and then write
        them in the text area
503
        """
504
        if self.height <= 0 or not self.built_lines:
505
            return
506 507 508 509 510
        if self.pos != 0:
            lines = self.built_lines[-self.height-self.pos:-self.pos]
        else:
            lines = self.built_lines[-self.height:]
        self._win.move(0, 0)
511
        with g_lock:
512
            self._win.erase()
513 514
            for y, line in enumerate(lines):
                if line is None:
515
                    self.write_line_separator()
516 517 518 519 520 521
                else:
                    if line.time:
                        self.write_time(line.time)
                    if line.nickname:
                        self.write_nickname(line.nickname, line.nickname_color)
                    self.write_text(y, line.text_offset, line.text, line.text_color, line.colorized)
522 523
                if y != self.height - 1:
                    self.addstr('\n')
524
            self._refresh()
525

526 527 528
    def write_line_separator(self):
        """
        """
529
        self.addnstr('- '*(self.width//2-1)+'-', self.width, curses.color_pair(theme.COLOR_NEW_TEXT_SEPARATOR))
530

531
    def write_text(self, y, x, txt, color, colorized):
532
        """
533
        write the text of a line.
534
        """
535
        txt = txt
536 537
        if not colorized:
            if color:
538
                self._win.attron(curses.color_pair(color))
539
            self.addstr(y, x, txt)
540
            if color:
541
                self._win.attroff(curses.color_pair(color))
542 543 544 545 546 547 548

        else:                   # Special messages like join or quit
            special_words = {
                theme.CHAR_JOIN: theme.COLOR_JOIN_CHAR,
                theme.CHAR_QUIT: theme.COLOR_QUIT_CHAR,
                theme.CHAR_KICK: theme.COLOR_KICK_CHAR,
                }
549 550 551
            try:
                splitted = shlex.split(txt)
            except ValueError:
552 553 554 555 556
                # FIXME colors are disabled on too long words
                txt = txt.replace('"[', '').replace(']"', '')\
                    .replace('"{', '').replace('}"', '')\
                    .replace('"(', '').replace(')"', '')
                splitted = txt.split()
557
            for word in splitted:
558
                if word in list(special_words.keys()):
559
                    self.addstr(word, curses.color_pair(special_words[word]))
560
                elif word.startswith('(') and word.endswith(')'):
561 562 563
                    self.addstr('(', curses.color_pair(color))
                    self.addstr(word[1:-1], curses.color_pair(theme.COLOR_CURLYBRACKETED_WORD))
                    self.addstr(')', curses.color_pair(color))
564
                elif word.startswith('{') and word.endswith('}'):
565
                    self.addstr(word[1:-1], curses.color_pair(theme.COLOR_ACCOLADE_WORD))
566
                elif word.startswith('[') and word.endswith(']'):
567
                    self.addstr(word[1:-1], curses.color_pair(theme.COLOR_BRACKETED_WORD))
568
                else:
569
                    self.addstr(word, curses.color_pair(color))
570
                self.addstr(' ')
571

572
    def write_nickname(self, nickname, color):
573 574 575 576
        """
        Write the nickname, using the user's color
        and return the number of written characters
        """
577
        if color:
578
            self._win.attron(curses.color_pair(color))
579
        self.addstr(nickname)
580
        if color:
581
            self._win.attroff(curses.color_pair(color))
582
        self.addstr("> ")
583

584
    def write_time(self, time):
585 586 587
        """
        Write the date on the yth line of the window
        """
588
        self.addstr(theme.CHAR_TIME_LEFT, curses.color_pair(theme.COLOR_TIME_LIMITER))
589
        self.addstr(time['hour'], curses.color_pair(theme.COLOR_TIME_NUMBERS))
590
        self.addstr(':', curses.color_pair(theme.COLOR_TIME_SEPARATOR))
591
        self.addstr(time['minute'], curses.color_pair(theme.COLOR_TIME_NUMBERS))
592
        self.addstr(':', curses.color_pair(theme.COLOR_TIME_SEPARATOR))
593 594
        self.addstr(time['second'], curses.color_pair(theme.COLOR_TIME_NUMBERS))
        self.addstr(theme.CHAR_TIME_RIGHT, curses.color_pair(theme.COLOR_TIME_LIMITER))
595
        self.addstr(' ')
596

597
    def resize(self, height, width, y, x, stdscr, room=None):
598
        self._resize(height, width, y, x, stdscr)
599 600 601 602 603 604 605
        if room:
            self.rebuild_everything(room)

    def rebuild_everything(self, room):
        self.built_lines = []
        for message in room.messages:
            self.build_new_message(message)
606

607 608
class HelpText(Win):
    """
609
    A Window just displaying a read-only message.
610 611 612
    Usually used to replace an Input when the tab is in
    command mode.
    """
613 614
    def __init__(self, text=''):
        Win.__init__(self)
615 616
        self.txt = text

617 618
    def resize(self, height, width, y, x, stdscr):
        self._resize(height, width, y, x, stdscr)
619 620 621 622 623 624 625 626 627 628 629

    def refresh(self):
        with g_lock:
            self._win.erase()
            self.addstr(0, 0, self.txt[:self.width-1], curses.color_pair(theme.COLOR_INFORMATION_BAR))
            self.finish_line(theme.COLOR_INFORMATION_BAR)
            self._refresh()

    def do_command(self, key):
        return False

630 631
class Input(Win):
    """
632 633 634 635 636 637 638 639 640
    The simplest Input possible, provides just a way to edit a single line
    of text. It also has a clipboard, common to all Inputs.
    Doesn't have any history.
    It doesn't do anything when enter is pressed either.
    This should be herited for all kinds of Inputs, for example MessageInput
    or the little inputs in dataforms, etc, adding specific features (completion etc)
    It features two kinds of completion, but they have to be called from outside (the Tab),
    passing the list of items that can be used to complete. The completion can be used
    in a very flexible way.
641
    """
642 643
    clipboard = '' # A common clipboard for all the inputs, this makes
    # it easy cut and paste text between various input
644
    def __init__(self):
645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
        self.key_func = {
            "KEY_LEFT": self.key_left,
            "M-D": self.key_left,
            "KEY_RIGHT": self.key_right,
            "M-C": self.key_right,
            "KEY_END": self.key_end,
            "KEY_HOME": self.key_home,
            "KEY_DC": self.key_dc,
            '^D': self.key_dc,
            'M-b': self.jump_word_left,
            '^W': self.delete_word,
            '^K': self.delete_end_of_line,
            '^U': self.delete_begining_of_line,
            '^Y': self.paste_clipboard,
            '^A': self.key_home,
            '^E': self.key_end,
            'M-f': self.jump_word_right,
            "KEY_BACKSPACE": self.key_backspace,
            '^?': self.key_backspace,
            }

666
        Win.__init__(self)
667
        self.text = ''
668 669
        self.pos = 0            # cursor position
        self.line_pos = 0 # position (in self.text) of
670

671 672 673
    def is_empty(self):
        return len(self.text) == 0

674 675 676
    def resize(self, height, width, y, x, stdscr):

        self._resize(height, width, y, x, stdscr)
677
        self._win.erase()
678
        self.addnstr(0, 0, self.text, self.width-1)
679

680 681 682 683 684 685 686 687 688 689
    def jump_word_left(self):
        """
        Move the cursor one word to the left
        """
        if not len(self.text) or self.pos == 0:
            return
        previous_space = self.text[:self.pos+self.line_pos].rfind(' ')
        if previous_space == -1:
            previous_space = 0
        diff = self.pos+self.line_pos-previous_space
690
        for i in range(diff):
691
            self.key_left()
692
        return True
693 694 695 696 697 698 699 700 701 702 703

    def jump_word_right(self):
        """
        Move the cursor one word to the right
        """
        if len(self.text) == self.pos+self.line_pos or not len(self.text):
            return
        next_space = self.text.find(' ', self.pos+self.line_pos+1)
        if next_space == -1:
            next_space = len(self.text)
        diff = next_space - (self.pos+self.line_pos)
704
        for i in range(diff):
705
            self.key_right()
706
        return True
707 708 709 710 711 712 713 714 715 716 717

    def delete_word(self):
        """
        Delete the word just before the cursor
        """
        if not len(self.text) or self.pos == 0:
            return
        previous_space = self.text[:self.pos+self.line_pos].rfind(' ')
        if previous_space == -1:
            previous_space = 0
        diff = self.pos+self.line_pos-previous_space
718
        for i in range(diff):
719 720
            self.key_backspace(False)
        self.rewrite_text()
721
        return True
722 723 724 725 726 727 728

    def delete_end_of_line(self):
        """
        Cut the text from cursor to the end of line
        """
        if len(self.text) == self.pos+self.line_pos:
            return              # nothing to cut
729
        Input.clipboard = self.text[self.pos+self.line_pos:]
730 731
        self.text = self.text[:self.pos+self.line_pos]
        self.key_end()
732
        return True
733 734 735 736 737 738 739

    def delete_begining_of_line(self):
        """
        Cut the text from cursor to the begining of line
        """
        if self.pos+self.line_pos == 0:
            return
740
        Input.clipboard = self.text[:self.pos+self.line_pos]
741 742
        self.text = self.text[self.pos+self.line_pos:]
        self.key_home()
743
        return True
744 745 746 747 748

    def paste_clipboard(self):
        """
        Insert what is in the clipboard at the cursor position
        """
749
        if not Input.clipboard or len(Input.clipboard) == 0:
750
            return
751
        for letter in Input.clipboard:
752
            self.do_command(letter)
753
        return True
754

755
    def key_dc(self):
756 757 758
        """
        delete char just after the cursor
        """
759
        self.reset_completion()
760 761 762 763
        if self.pos + self.line_pos == len(self.text):
            return              # end of line, nothing to delete
        self.text = self.text[:self.pos+self.line_pos]+self.text[self.pos+self.line_pos+1:]
        self.rewrite_text()
764
        return True
765 766

    def key_home(self):
767 768 769
        """
        Go to the begining of line
        """
770
        self.reset_completion()
771
        self.pos = 0
772 773
        self.line_pos = 0
        self.rewrite_text()
774
        return True
775

776 777 778 779 780 781
    def key_end(self, reset=False):
        """
        Go to the end of line
        """
        if reset:
            self.reset_completion()
782
        if len(self.text) >= self.width-1:
783 784
            self.pos = self.width-1
            self.line_pos = len(self.text)-self.pos
785
        else:
786 787 788
            self.pos = len(self.text)
            self.line_pos = 0
        self.rewrite_text()
789
        return True
790 791

    def key_left(self):
792 793 794
        """
        Move the cursor one char to the left
        """
795
        self.reset_completion()
796
        (y, x) = self._win.getyx()
797 798 799
        if self.pos == self.width-1 and self.line_pos > 0:
            self.line_pos -= 1
        elif self.pos >= 1:
800
            self.pos -= 1
801
        self.rewrite_text()
802
        return True
803 804

    def key_right(self):
805 806 807
        """
        Move the cursor one char to the right
        """
808
        self.reset_completion()
809
        (y, x) = self._win.getyx()
810 811 812 813
        if self.pos == self.width-1:
            if self.line_pos + self.width-1 < len(self.text):
                self.line_pos += 1
        elif self.pos < len(self.text):
814
            self.pos += 1
815
        self.rewrite_text()
816
        return True
817

818
    def key_backspace(self, reset=True):
819 820 821
        """
        Delete the char just before the cursor
        """
822
        self.reset_completion()
823
        (y, x) = self._win.getyx()
824 825 826 827
        if self.pos == 0:
            return
        self.text = self.text[:self.pos+self.line_pos-1]+self.text[self.pos+self.line_pos:]
        self.key_left()
828 829
        if reset:
            self.rewrite_text()
830
        return True
831

832
    def auto_completion(self, word_list, add_after):
833
        """
834 835 836 837
        Complete the input, from a list of words
        if add_after is None, we use the value defined in completion
        plus a space, after the completion. If it's a string, we use it after the
        completion (with no additional space)
838
        """
839
        if self.pos+self.line_pos != len(self.text): # or len(self.text) == 0
840
            return # we don't complete if cursor is not at the end of line
841
        completion_type = config.get('completion', 'normal')
842
        if completion_type == 'shell' and self.text != '':
843
            self.shell_completion(word_list, add_after)
844
        else:
845
            self.normal_completion(word_list, add_after)
846
        return True
847 848

    def reset_completion(self):
849 850 851
        """
        Reset the completion list (called on ALL keys except tab)
        """
852
        self.hit_list = []
853
        self.last_completion = None
854

855
    def normal_completion(self, word_list, after):
856 857 858
        """
        Normal completion
        """
859
        (y, x) = self._win.getyx()
860
        if not self.last_completion:
861 862
            # begin is the begining of the word we want to complete
            if self.text.strip() and not self.text.endswith(' '):
863
                begin = self.text.split()[-1].lower()
864 865
            else:
                begin = ''
866