windows.py 50 KB
Newer Older
1
# Copyright 2010-2011 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
        self.pos = 0
95 96 97
        self.color_role = {'moderator': theme.COLOR_USER_MODERATOR,
                           'participant':theme.COLOR_USER_PARTICIPANT,
                           'visitor':theme.COLOR_USER_VISITOR,
98 99
                           'none':theme.COLOR_USER_NONE,
                           '':theme.COLOR_USER_NONE
100
                           }
101
        self.color_show = {'xa':theme.COLOR_STATUS_XA,
102 103
                           'none':theme.COLOR_STATUS_NONE,
                           '':theme.COLOR_STATUS_NONE,
104 105 106
                           'dnd':theme.COLOR_STATUS_DND,
                           'away':theme.COLOR_STATUS_AWAY,
                           'chat':theme.COLOR_STATUS_CHAT
107
                           }
108

109 110 111 112 113 114 115 116 117 118 119
    def scroll_up(self):
        self.pos += 4

    def scroll_down(self):
        self.pos -= 4
        if self.pos < 0:
            self.pos = 0

    def draw_plus(self, y):
        self.addstr(y, self.width-2, '++', curses.color_pair(42))

120
    def refresh(self, users):
121
        with g_lock:
122
            self._win.erase()
123
            y = 0
124 125 126 127
            users = sorted(users)
            if self.pos >= len(users) and self.pos != 0:
                self.pos = len(users)-1
            for user in users[self.pos:]:
128 129 130 131 132 133 134 135 136
                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))
137
                self.addstr(y, 1, user.nick, curses.color_pair(role_col))
138 139 140
                y += 1
                if y == self.height:
                    break
141 142 143 144 145
            # draw indicators of position in the list
            if self.pos > 0:
                self.draw_plus(0)
            if self.pos + self.height < len(users):
                self.draw_plus(self.height-1)
146
            self._refresh()
147

148 149
    def resize(self, height, width, y, x, stdscr):
        self._resize(height, width, y, x, stdscr)
150 151 152
        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))
153

154
class Topic(Win):
155 156
    def __init__(self):
        Win.__init__(self)
157

158 159
    def resize(self, height, width, y, x, stdscr):
        self._resize(height, width, y, x, stdscr)
160

161
    def refresh(self, topic):
162
        with g_lock:
163
            self._win.erase()
164
            self.addstr(0, 0, topic[:self.width-1], curses.color_pair(theme.COLOR_TOPIC_BAR))
165
            (y, x) = self._win.getyx()
166 167 168 169
            remaining_size = self.width - x
            if remaining_size:
                self.addnstr(' '*remaining_size, remaining_size,
                             curses.color_pair(theme.COLOR_INFORMATION_BAR))
170
            self._refresh()
171

172
class GlobalInfoBar(Win):
173 174
    def __init__(self):
        Win.__init__(self)
175

176 177
    def resize(self, height, width, y, x, stdscr):
        self._resize(height, width, y, x, stdscr)
178

179
    def refresh(self, tabs, current):
180 181 182 183
        def compare_room(a):
            # return a.nb - b.nb
            return a.nb
        comp = lambda x: x.nb
184
        with g_lock:
185
            self._win.erase()
186
            self.addstr(0, 0, "[", curses.color_pair(theme.COLOR_INFORMATION_BAR))
187 188 189
            sorted_tabs = sorted(tabs, key=comp)
            for tab in sorted_tabs:
                color = tab.get_color_state()
190 191 192
                if config.get('show_inactive_tabs', 'true') == 'false' and\
                        color == theme.COLOR_TAB_NORMAL:
                    continue
193 194 195 196 197
                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
198
            (y, x) = self._win.getyx()
199
            self.addstr(y, x-1, '] ', curses.color_pair(theme.COLOR_INFORMATION_BAR))
200
            (y, x) = self._win.getyx()
201 202 203
            remaining_size = self.width - x
            self.addnstr(' '*remaining_size, remaining_size,
                         curses.color_pair(theme.COLOR_INFORMATION_BAR))
204
            self._refresh()
205

206 207 208 209 210
class InfoWin(Win):
    """
    Base class for all the *InfoWin, used in various tabs. For example
    MucInfoWin, etc. Provides some useful methods.
    """
211 212
    def __init__(self):
        Win.__init__(self)
213

214
    def print_scroll_position(self, window):
215 216 217 218 219
        """
        Print, link in Weechat, a -PLUS(n)- where n
        is the number of available lines to scroll
        down
        """
220 221
        if window.pos > 0:
            plus = ' -PLUS(%s)-' % window.pos
222
            self.addstr(plus, curses.color_pair(theme.COLOR_SCROLLABLE_NUMBER) | curses.A_BOLD)
223 224 225 226 227 228

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

232 233
    def resize(self, height, width, y, x, stdscr):
        self._resize(height, width, y, x, stdscr)
234

235
    def refresh(self, room, window):
236

237
        with g_lock:
238
            self._win.erase()
239
            self.write_room_name(room)
240
            self.print_scroll_position(window)
241
            self.finish_line(theme.COLOR_INFORMATION_BAR)
242
            self._refresh()
243 244

    def write_room_name(self, room):
245 246
        jid = JID(room.name)
        room_name, nick = jid.bare, jid.resource
247
        self.addstr(nick, curses.color_pair(13))
248
        txt = ' from room %s' % room_name
249
        self.addstr(txt, curses.color_pair(theme.COLOR_INFORMATION_BAR))
250

251 252 253
class ConversationInfoWin(InfoWin):
    """
    The line above the information window, displaying informations
254
    about the user we are talking to
255
    """
256 257 258 259 260 261 262 263 264 265
    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
                  }

266 267
    def __init__(self):
        InfoWin.__init__(self)
268

269 270
    def resize(self, height, width, y, x, stdscr):
        self._resize(height, width, y, x, stdscr)
271

272
    def refresh(self, jid, contact, text_buffer, window):
273 274 275
        # 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.
276 277 278 279 280 281 282 283 284 285 286 287 288
        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
289
        with g_lock:
290
            self._win.erase()
291 292 293
            self.write_contact_jid(jid)
            self.write_contact_informations(contact)
            self.write_resource_information(resource)
294
            self.print_scroll_position(window)
295
            self.finish_line(theme.COLOR_INFORMATION_BAR)
296
            self._refresh()
297

298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
    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
        """
315
        if not contact:
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
            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
    """
333 334
    def __init__(self):
        InfoWin.__init__(self)
335

336 337
    def resize(self, height, width, y, x, stdscr):
        self._resize(height, width, y, x, stdscr)
338 339 340 341 342 343 344 345

    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()
346
        else:
347 348 349 350 351 352 353 354 355 356
            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))
357

358 359 360 361 362
class MucInfoWin(InfoWin):
    """
    The line just above the information window, displaying informations
    about the MUC we are viewing
    """
363 364
    def __init__(self):
        InfoWin.__init__(self)
365

366 367
    def resize(self, height, width, y, x, stdscr):
        self._resize(height, width, y, x, stdscr)
368

369
    def refresh(self, room, window=None):
370
        with g_lock:
371
            self._win.erase()
372 373 374 375
            self.write_room_name(room)
            self.write_own_nick(room)
            self.write_disconnected(room)
            self.write_role(room)
376 377
            if window:
                self.print_scroll_position(window)
378
            self.finish_line(theme.COLOR_INFORMATION_BAR)
379
            self._refresh()
380 381 382 383

    def write_room_name(self, room):
        """
        """
384
        self.addstr('[', curses.color_pair(theme.COLOR_INFORMATION_BAR))
385
        self.addnstr(room.name, len(room.name), curses.color_pair(13))
386
        self.addstr('] ', curses.color_pair(theme.COLOR_INFORMATION_BAR))
387 388 389 390 391 392

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

395 396 397 398 399 400 401 402 403
    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]+'…'
404
        self.addstr(nick, curses.color_pair(theme.COLOR_INFORMATION_BAR))
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420

    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+')'
421
        self.addstr(txt, curses.color_pair(theme.COLOR_INFORMATION_BAR))
422

423
class TextWin(Win):
424 425
    def __init__(self):
        Win.__init__(self)
426 427 428 429 430 431
        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
432 433 434 435
        if self.pos + self.height > len(self.built_lines):
            self.pos = len(self.built_lines) - self.height
            if self.pos < 0:
                self.pos = 0
436 437 438 439 440 441

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

442 443 444 445 446 447 448 449 450 451 452 453 454 455
    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)

456 457 458 459 460 461 462 463 464 465 466 467
    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
468
            # length of the time
469 470 471 472 473 474 475 476 477 478 479 480 481
        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')
482
            else:
483 484 485 486 487 488
                # 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
489 490
                        this_line_was_broken_by_space = False
                else:
491 492
                    limit = self.width-offset-1
                    this_line_was_broken_by_space = False
493
            color = message.user.color if message.user else message.nick_color
494 495 496
            if not first:
                nick = None
                time = None
497 498 499 500 501 502 503
            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"),),
                        }
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
            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
521

522
    def refresh(self, room):
523
        """
524 525
        Build the Line objects from the messages, and then write
        them in the text area
526
        """
527
        if self.height <= 0 or not self.built_lines:
528
            return
529 530 531 532 533
        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)
534
        with g_lock:
535
            self._win.erase()
536 537
            for y, line in enumerate(lines):
                if line is None:
538
                    self.write_line_separator()
539 540 541 542 543 544
                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)
545 546
                if y != self.height - 1:
                    self.addstr('\n')
547
            self._refresh()
548

549 550 551
    def write_line_separator(self):
        """
        """
552
        self.addnstr('- '*(self.width//2-1)+'-', self.width, curses.color_pair(theme.COLOR_NEW_TEXT_SEPARATOR))
553

554
    def write_text(self, y, x, txt, color, colorized):
555
        """
556
        write the text of a line.
557
        """
558
        txt = txt
559 560
        if not colorized:
            if color:
561
                self._win.attron(curses.color_pair(color))
562
            self.addstr(y, x, txt)
563
            if color:
564
                self._win.attroff(curses.color_pair(color))
565 566 567 568 569 570 571

        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,
                }
572 573 574
            try:
                splitted = shlex.split(txt)
            except ValueError:
575 576 577 578 579
                # FIXME colors are disabled on too long words
                txt = txt.replace('"[', '').replace(']"', '')\
                    .replace('"{', '').replace('}"', '')\
                    .replace('"(', '').replace(')"', '')
                splitted = txt.split()
580
            for word in splitted:
581
                if word in list(special_words.keys()):
582
                    self.addstr(word, curses.color_pair(special_words[word]))
583
                elif word.startswith('(') and word.endswith(')'):
584 585 586
                    self.addstr('(', curses.color_pair(color))
                    self.addstr(word[1:-1], curses.color_pair(theme.COLOR_CURLYBRACKETED_WORD))
                    self.addstr(')', curses.color_pair(color))
587
                elif word.startswith('{') and word.endswith('}'):
588
                    self.addstr(word[1:-1], curses.color_pair(theme.COLOR_ACCOLADE_WORD))
589
                elif word.startswith('[') and word.endswith(']'):
590
                    self.addstr(word[1:-1], curses.color_pair(theme.COLOR_BRACKETED_WORD))
591
                else:
592
                    self.addstr(word, curses.color_pair(color))
593
                self.addstr(' ')
594

595
    def write_nickname(self, nickname, color):
596 597 598 599
        """
        Write the nickname, using the user's color
        and return the number of written characters
        """
600
        if color:
601
            self._win.attron(curses.color_pair(color))
602
        self.addstr(nickname)
603
        if color:
604
            self._win.attroff(curses.color_pair(color))
605
        self.addstr("> ")
606

607
    def write_time(self, time):
608 609 610
        """
        Write the date on the yth line of the window
        """
611
        self.addstr(theme.CHAR_TIME_LEFT, curses.color_pair(theme.COLOR_TIME_LIMITER))
612
        self.addstr(time['hour'], curses.color_pair(theme.COLOR_TIME_NUMBERS))
613
        self.addstr(':', curses.color_pair(theme.COLOR_TIME_SEPARATOR))
614
        self.addstr(time['minute'], curses.color_pair(theme.COLOR_TIME_NUMBERS))
615
        self.addstr(':', curses.color_pair(theme.COLOR_TIME_SEPARATOR))
616 617
        self.addstr(time['second'], curses.color_pair(theme.COLOR_TIME_NUMBERS))
        self.addstr(theme.CHAR_TIME_RIGHT, curses.color_pair(theme.COLOR_TIME_LIMITER))
618
        self.addstr(' ')
619

620
    def resize(self, height, width, y, x, stdscr, room=None):
621
        self._resize(height, width, y, x, stdscr)
622 623 624 625 626 627 628
        if room:
            self.rebuild_everything(room)

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

630 631
class HelpText(Win):
    """
632
    A Window just displaying a read-only message.
633 634 635
    Usually used to replace an Input when the tab is in
    command mode.
    """
636 637
    def __init__(self, text=''):
        Win.__init__(self)
638 639
        self.txt = text

640 641
    def resize(self, height, width, y, x, stdscr):
        self._resize(height, width, y, x, stdscr)
642 643 644 645 646 647 648 649 650 651 652

    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

653 654
class Input(Win):
    """
655 656 657 658 659 660 661 662 663
    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.
664
    """
665 666
    clipboard = '' # A common clipboard for all the inputs, this makes
    # it easy cut and paste text between various input
667
    def __init__(self):
668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688
        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,
            }

689
        Win.__init__(self)
690
        self.text = ''
691 692
        self.pos = 0            # cursor position
        self.line_pos = 0 # position (in self.text) of
693

694 695 696
    def is_empty(self):
        return len(self.text) == 0

697 698 699
    def resize(self, height, width, y, x, stdscr):

        self._resize(height, width, y, x, stdscr)
700
        self._win.erase()
701
        self.addnstr(0, 0, self.text, self.width-1)
702

703 704 705 706 707 708 709 710 711 712
    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
713
        for i in range(diff):
714
            self.key_left()
715
        return True
716 717 718 719 720 721 722 723 724 725 726

    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)
727
        for i in range(diff):
728
            self.key_right()
729
        return True
730 731 732 733 734 735 736 737 738 739 740

    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
741
        for i in range(diff):
742 743
            self.key_backspace(False)
        self.rewrite_text()
744
        return True
745 746 747 748 749 750 751

    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
752
        Input.clipboard = self.text[self.pos+self.line_pos:]
753 754
        self.text = self.text[:self.pos+self.line_pos]
        self.key_end()
755
        return True
756 757 758 759 760 761 762

    def delete_begining_of_line(self):
        """
        Cut the text from cursor to the begining of line
        """
        if self.pos+self.line_pos == 0:
            return
763
        Input.clipboard = self.text[:self.pos+self.line_pos]
764 765
        self.text = self.text[self.pos+self.line_pos:]
        self.key_home()
766
        return True
767 768 769 770 771

    def paste_clipboard(self):
        """
        Insert what is in the clipboard at the cursor position
        """
772
        if not Input.clipboard or len(Input.clipboard) == 0:
773
            return
774
        for letter in Input.clipboard:
775
            self.do_command(letter)
776
        return True
777

778
    def key_dc(self):
779 780 781
        """
        delete char just after the cursor
        """
782
        self.reset_completion()
783 784 785 786
        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()
787
        return True
788 789

    def key_home(self):
790 791 792
        """
        Go to the begining of line
        """
793
        self.reset_completion()
794
        self.pos = 0
795 796
        self.line_pos = 0
        self.rewrite_text()
797
        return True
798

799 800 801 802 803 804
    def key_end(self, reset=False):
        """
        Go to the end of line
        """
        if reset:
            self.reset_completion()
805
        if len(self.text) >= self.width-1:
806 807
            self.pos = self.width-1
            self.line_pos = len(self.text)-self.pos
808
        else:
809 810 811
            self.pos = len(self.text)
            self.line_pos = 0
        self.rewrite_text()
812
        return True
813 814

    def key_left(self):
815 816 817
        """
        Move the cursor one char to the left
        """
818
        self.reset_completion()
819
        (y, x) = self._win.getyx()
820 821 822
        if self.pos == self.width-1 and self.line_pos > 0:
            self.line_pos -= 1
        elif self.pos >= 1:
823
            self.pos -= 1
824
        self.rewrite_text()
825
        return True
826 827

    def key_right(self):
828 829 830
        """
        Move the cursor one char to the right
        """
831
        self.reset_completion()
832
        (y, x) = self._win.getyx()
833 834 835 836
        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):
837
            self.pos += 1
838
        self.rewrite_text()
839
        return True
840

841
    def key_backspace(self, reset=True):
842 843 844
        """
        Delete the char just before the cursor
        """
845
        self.reset_completion()
846
        (y, x) = self._win.getyx()
847 848 849 850
        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()
851 852
        if reset:
            self.rewrite_text()
853
        return True
854

855
    def auto_completion(self, word_list, add_after):
856
        """
857 858 859 860
        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)
861
        """
862
        if self.pos+self.line_pos != len(self.text): # or len(self.text) == 0
863
            return # we don't complete if cursor is not at the end of line
864
        completion_type = config.get('completion', 'normal')
865
        if completion_type == 'shell' and self.text != '':
866
            self.shell_completion(word_list, add_after)
867
        else:
868
            self.normal_completion(word_list, add_after)
869
        return True
870 871

    def reset_completion(self):
872 873 874
        """
        Reset the completion list (called on ALL keys except tab)
        """