Source

thg / tortoisehg / hgtk / gtklib.py

Full commit
   1
   2
   3
   4
   5
   6
   7
   8
   9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  25
  26
  27
  28
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45
  46
  47
  48
  49
  50
  51
  52
  53
  54
  55
  56
  57
  58
  59
  60
  61
  62
  63
  64
  65
  66
  67
  68
  69
  70
  71
  72
  73
  74
  75
  76
  77
  78
  79
  80
  81
  82
  83
  84
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
# gtklib.py - miscellaneous PyGTK classes and functions for TortoiseHg
#
# Copyright 2008 TK Soh <teekaysoh@gmail.com>
# Copyright 2009 Steve Borho <steve@borho.org>
#
# This software may be used and distributed according to the terms of the
# GNU General Public License version 2, incorporated herein by reference.

import os
import sys
import gtk
import gobject
import pango
import Queue
import urllib
import threading

from mercurial import util, extensions

from tortoisehg.util.i18n import _
from tortoisehg.util import paths, hglib, thread2

from tortoisehg.hgtk import hgtk

if gtk.gtk_version < (2, 14, 0):
    # at least on 2.12.12, gtk widgets can be confused by control
    # char markups (like "&#x1;"), so use cgi.escape instead
    from cgi import escape as markup_escape_text
else:
    from gobject import markup_escape_text

if gobject.pygobject_version <= (2,12,1):
    # http://www.mail-archive.com/tortoisehg-develop@lists.sourceforge.net/msg06900.html
    raise Exception('incompatible version of gobject')

if gtk.pygtk_version < (2, 12, 0):
    # old nasty
    Tooltips = gtk.Tooltips
else:
    # new shiny
    class Tooltips(object):
        def __init__(self):
            pass
        def set_tip(self, widget, tip):
            widget.set_tooltip_text(tip)

# common colors

DRED = '#900000'
DGREEN = '#006400'
DBLUE = '#000090'
DYELLOW = '#969600'
DLIME = '#4a9500'
DORANGE = '#AA5000'
DPINK = '#C83838'
DTURQUOISE = '#007070'
DVIOLET = '#6F466F'
DBROWN = '#702F17'

DGRAY = '#404040'

PRED = '#ffcccc'
PGREEN = '#aaffaa'
PBLUE = '#aaddff'
PYELLOW = '#ffffaa'
PLIME = '#80FF00'
PORANGE = '#ffddaa'
PPINK = '#ff5555'
PTURQUOISE = '#00ffee'
PVIOLET = '#F198F1'
PBROWN = '#CA4C1A'

RED = 'red'
GREEN = 'green'
BLUE = 'blue'
YELLOW = 'yellow'
ORANGE = 'orange'
BROWN = 'brown'
PINK = 'pink'
VIOLET = 'violet'
MAGENTA = 'magenta'
INDIGO = 'indigo'
BLACK = 'black'
WHITE = 'white'
GREY = 'grey'


NORMAL = BLACK
NEW_REV_COLOR = DGREEN
CHANGE_HEADER = GREY

try:
    from hgext.color import _styles
    _styles.keys()
except ImportError:
    # hg <= 1.5
    _styles = {'grep.match': 'red bold',
               'diff.changed': 'white',
               'diff.deleted': 'red',
               'diff.diffline': 'bold',
               'diff.extended': 'cyan bold',
               'diff.file_a': 'red bold',
               'diff.file_b': 'green bold',
               'diff.hunk': 'magenta',
               'diff.inserted': 'green',
               'diff.trailingwhitespace': 'bold red_background',
               'diffstat.deleted': 'red',
               'diffstat.inserted': 'green',
               'log.changeset': 'yellow',
               'resolve.resolved': 'green bold',
               'resolve.unresolved': 'red bold',
               'status.added': 'green bold',
               'status.clean': 'none',
               'status.copied': 'none',
               'status.deleted': 'cyan bold underline',
               'status.ignored': 'black bold',
               'status.modified': 'blue bold',
               'status.removed': 'red bold',
               'status.unknown': 'magenta bold underline'}

TextBufferTags = {
    'red':              dict(foreground=DRED),
    'black':            dict(foreground=BLACK),
    'green':            dict(foreground=GREEN),
    'yellow':           dict(foreground=YELLOW),
    'blue':             dict(foreground=BLUE),
    'magenta':          dict(foreground='magenta'),
    'cyan':             dict(foreground='cyan'),
    'white':            dict(foreground='white'),
    'bold':             dict(weight=pango.WEIGHT_HEAVY),
    'italic':           dict(style=pango.STYLE_ITALIC),
    'underline':        dict(underline=pango.UNDERLINE_SINGLE),
    'black_background': dict(background=BLACK),
    'red_background':   dict(background=RED),
    'green_background': dict(background=GREEN),
    'yellow_background': dict(background=YELLOW),
    'blue_background':  dict(background=BLUE),
    'purple_background': dict(background='purple'),
    'cyan_background':  dict(background='cyan'),
    'white_background': dict(background=WHITE)
}

_thgstyles = {
    'ui.error':      'red bold',
    'control':       'black bold',
}

def configstyles(ui):
    # extensions may provide more labels and default effects
    for name, ext in extensions.extensions():
        _styles.update(getattr(ext, 'colortable', {}))

    # tortoisehg defines a few labels and default effects
    _styles.update(_thgstyles)

    # allow the user to override
    for status, cfgeffects in ui.configitems('color'):
        if '.' not in status:
            continue
        cfgeffects = ui.configlist('color', status)
        good = []
        for e in cfgeffects:
            if e in TextBufferTags:
                good.append(e)
        if good:
            _styles[status] = ' '.join(good)

def gettags(labels):
    'map labels like "log.date" to pango tags'
    tags = []
    # Multiple labels may be requested
    for l in labels.split():
        if not l:
            continue
        # Each label may request multiple effects
        es = _styles.get(l, '')
        for e in es.split():
            if e in TextBufferTags:
                tags.append(e)
    return tags


UP_ARROW_COLOR = '#feaf3e'
DOWN_ARROW_COLOR = '#8ae234'
STAR_COLOR = '#fce94f'
CELL_GREY = '#2e3436'
STATUS_HEADER = '#DDDDDD'
STATUS_REJECT_BACKGROUND = '#EEEEEE'
STATUS_REJECT_FOREGROUND = '#888888'

# line colors
MAINLINE_COLOR = ( 0.0, 0.0, 0.0 )
LINE_COLORS = [
    ( 1.0, 0.0, 0.0 ),
    ( 1.0, 1.0, 0.0 ),
    ( 0.0, 1.0, 0.0 ),
    ( 0.0, 1.0, 1.0 ),
    ( 0.0, 0.0, 1.0 ),
    ( 1.0, 0.0, 1.0 ),
    ]

def get_gtk_colors():
    color_scheme = gtk.settings_get_default().get_property('gtk-color-scheme')
    colors = {}
    for color in color_scheme.split('\n'):
        color = color.strip()
        if color:
            name, color = color.split(':')
            colors[name.strip()] = gtk.gdk.color_parse(color.strip())
    return colors

def get_gtk_text_color():
    w = gtk.Window()
    w.realize()
    style = w.get_style()
    return style.text[gtk.STATE_NORMAL].to_string()

def is_dark_theme():
    global NORMAL, MAINLINE_COLOR
    if gtk.pygtk_version < (2, 12, 0):
        gtk_colors = get_gtk_colors()
        normal = gtk_colors.get('fg_color', gtk.gdk.color_parse('black'))
    else:
        normal = gtk.gdk.color_parse(get_gtk_text_color())
    NORMAL = str(normal)
    MAINLINE_COLOR = (
            normal.red / 65535.0,
            normal.green / 65535.0,
            normal.blue / 65535.0
        )
    return hasattr(normal, 'value') \
               and normal.value > 0.5 or max(MAINLINE_COLOR) > 0.5

def _init_colors():

    if is_dark_theme():

        global RED, GREEN, BLUE, BLACK, WHITE, \
               DRED, DGREEN, DBLUE, DYELLOW, DORANGE, DPINK, \
               DTURQUOISE, DLIME, DBROWN, DVIOLET, \
               PRED, PGREEN, PBLUE, PYELLOW, PORANGE, PPINK, \
               PTURQUOISE, PLIME, PBROWN, PVIOLET, \
               NEW_REV_COLOR, LINE_COLORS, \
               CHANGE_HEADER

        RED = PRED
        GREEN = NEW_REV_COLOR = PGREEN
        BLUE = PBLUE
        PRED = DRED
        DRED = '#FF6161'
#            DRED, PRED = PRED, DRED
        DGREEN, PGREEN = PGREEN, DGREEN
        DBLUE, PBLUE = PBLUE, DBLUE
        DYELLOW, PYELLOW = PYELLOW, DYELLOW
        DORANGE, PORANGE = PORANGE, DORANGE
        DPINK, PPINK = PPINK, DPINK
        DTURQUOISE, PTURQUOISE = PTURQUOISE, DTURQUOISE
        DLIME, PLIME = PLIME, DLIME
        DBROWN, PBROWN = PBROWN, DBROWN
        DVIOLET, PVIOLET = PVIOLET, DVIOLET
        BLACK, WHITE = WHITE, BLACK

        CHANGE_HEADER = '#404040'

        LINE_COLORS = [
            ( 1.0, 0.3804, 0.3804 ),
            ( 1.0, 1.0, 0.0 ),
            ( 0.0, 1.0, 0.0 ),
            ( 0.0, 1.0, 1.0 ),
            ( 0.2902, 0.4863, 0.851 ),
            ( 1.0, 0.3882, 1.0 ),
            ]

        # TODO: dark color scheme for:
        # UP_ARROW_COLOR, DOWN_ARROW_COLOR, STAR_COLOR,
        # CELL_GREY, STATUS_HEADER, STATUS_REJECT_BACKGROUND,
        # STATUS_REJECT_FOREGROUND

_init_colors()

def set_tortoise_icon(window, thgicon):
    ico = paths.get_tortoise_icon(thgicon)
    if ico: window.set_icon_from_file(ico)

def get_thg_modifier():
    if sys.platform == 'darwin':
        return '<Mod1>'
    else:
        return '<Control>'

def add_accelerator(widget, signal, accelgroup, accelerator,
                    accel_flags=gtk.ACCEL_VISIBLE):
    """Add an accelerator for signal to widget.

    accelerator is the key string parsed by gtk.accelerator_parse; the
    other parameters are passed to gtk.Widget.add_accelerator"""
    key, modifier = gtk.accelerator_parse(accelerator)
    widget.add_accelerator(signal, accelgroup, key, modifier, accel_flags)

def set_tortoise_keys(window, connect=True):
    'Set default TortoiseHg keyboard accelerators'
    if sys.platform == 'darwin':
        mask = gtk.accelerator_get_default_mod_mask()
        mask |= gtk.gdk.MOD1_MASK;
        gtk.accelerator_set_default_mod_mask(mask)
    mod = get_thg_modifier()
    accelgroup = gtk.AccelGroup()
    window.add_accel_group(accelgroup)

    default_accelerators = [
        (mod+'w', 'thg-close'),
        (mod+'q', 'thg-exit'),
        ('F5', 'thg-refresh'),
        (mod+'r', 'thg-refresh'),
        (mod+'Return', 'thg-accept'),
    ]

    for accelerator, signal in default_accelerators:
        add_accelerator(window, signal, accelgroup, accelerator)

    # connect ctrl-w and ctrl-q to every window
    if connect:
        window.connect('thg-close', thgclose)
        window.connect('thg-exit', thgexit)

    return accelgroup, mod

def thgexit(window):
    if thgclose(window):
        gobject.idle_add(hgtk.thgexit, window)

def thgclose(window):
    if hasattr(window, 'should_live'):
        if window.should_live():
            return False
    window.destroy()
    return True

def move_treeview_selection(window, treeview, distance=1):
    """Accelerator handler to move a treeview's cursor and selection

    Moves the treeview's cursor by distance and selects the row on which
    the cursor lands.

    distance: an integer number of rows to move the cursor, positive to
              move the selection down, negative for up.  A distance of
              0 will reset the selection to the current row."""
    row = 0
    path = treeview.get_cursor()[0]
    if path:
        row = path[0]
    model = treeview.get_model()

    # make sure new row is within bounds
    new_row = min((row + distance), len(model) - 1)
    new_row = max(0, new_row)

    selected = model.get_iter_from_string(str(new_row))
    selection = treeview.get_selection()
    selection.unselect_all()
    selection.select_iter(selected)
    treeview.set_cursor(model.get_path(selected))

_renderer = gtk.HBox()
def get_icon_pixbuf(name, size=gtk.ICON_SIZE_MENU):
    if name.startswith('gtk'):
        return _renderer.render_icon(name, size)
    else:
        path = paths.get_tortoise_icon(name)
        if path:
            try:
                w, h = gtk.icon_size_lookup(size)
                return gtk.gdk.pixbuf_new_from_file_at_size(path, w, h)
            except:
                pass
    return None

def get_icon_image(name):
    if name.startswith('gtk'):
        img = gtk.image_new_from_stock(name, gtk.ICON_SIZE_MENU)
    else:
        img = gtk.Image()
        pixbuf = get_icon_pixbuf(name)
        if pixbuf:
            img.set_from_pixbuf(pixbuf)
    return img

def normalize_dnd_paths(rawstr):
    paths = []
    for line in rawstr.rstrip('\x00').splitlines():
        if line.startswith('file:'):
            path = os.path.normpath(urllib.url2pathname(line[5:]))
            paths.append(path)
    return paths

def open_with_editor(ui, file, parent=None):
    def doedit():
        util.system('%s "%s"' % (editor, file))
    editor = (ui.config('tortoisehg', 'editor') or
            ui.config('gtools', 'editor') or
            os.environ.get('HGEDITOR') or
            ui.config('ui', 'editor') or
            os.environ.get('EDITOR', 'vi'))
    if os.path.basename(editor) in ('vi', 'vim', 'hgeditor'):
        from tortoisehg.hgtk import gdialog
        gdialog.Prompt(_('No visual editor configured'),
               _('Please configure a visual editor.'), parent).run()
        return False
    thread = threading.Thread(target=doedit, name='edit')
    thread.setDaemon(True)
    thread.start()
    return True

class MessageDialog(gtk.Dialog):
    button_map = {
            gtk.BUTTONS_NONE: None,
            gtk.BUTTONS_OK: (gtk.STOCK_OK, gtk.RESPONSE_OK),
            gtk.BUTTONS_CLOSE : (gtk.STOCK_CLOSE, gtk.RESPONSE_CLOSE),
            gtk.BUTTONS_CANCEL: (gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL),
            gtk.BUTTONS_YES_NO : (gtk.STOCK_YES, gtk.RESPONSE_YES,
                    gtk.STOCK_NO, gtk.RESPONSE_NO),
            gtk.BUTTONS_OK_CANCEL: (gtk.STOCK_OK, gtk.RESPONSE_OK,
                    gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL),
    }
    image_map = {
            gtk.MESSAGE_INFO : gtk.STOCK_DIALOG_INFO,
            gtk.MESSAGE_WARNING : gtk.STOCK_DIALOG_WARNING,
            gtk.MESSAGE_QUESTION : gtk.STOCK_DIALOG_QUESTION,
            gtk.MESSAGE_ERROR : gtk.STOCK_DIALOG_ERROR,
    }

    def __init__(self, parent=None, flags=0, type=gtk.MESSAGE_INFO,
            buttons=gtk.BUTTONS_NONE, message_format=None):
        gtk.Dialog.__init__(self,
                parent=parent,
                flags=flags | gtk.DIALOG_NO_SEPARATOR,
                buttons=MessageDialog.button_map[buttons])
        self.set_resizable(False)

        hbox = gtk.HBox()
        self._image_frame = gtk.Frame()
        self._image_frame.set_shadow_type(gtk.SHADOW_NONE)
        self._image = gtk.Image()
        self._image.set_from_stock(MessageDialog.image_map[type],
                gtk.ICON_SIZE_DIALOG)
        self._image_frame.add(self._image)
        hbox.pack_start(self._image_frame, padding=5)

        lblbox = gtk.VBox(spacing=10)
        self._primary = gtk.Label("")
        self._primary.set_alignment(0.0, 0.5)
        self._primary.set_line_wrap(True)
        lblbox.pack_start(self._primary)

        self._secondary = gtk.Label()
        lblbox.pack_end(self._secondary)
        self._secondary.set_line_wrap(True)
        hbox.pack_start(lblbox, padding=5)

        self.vbox.pack_start(hbox, False, False, 10)
        self.show_all()

    def set_markup(self, s):
        self._primary.set_markup(s)

    def format_secondary_markup(self, message_format):
        self._secondary.set_markup(message_format)

    def format_secondary_text(self, message_format):
        self._secondary.set_text(message_format)

    def set_image(self, image):
        self._image_frame.remove(self._image)
        self._image = image
        self._image_frame.add(self._image)
        self._image.show()

class NativeSaveFileDialogWrapper:
    """Wrap the windows file dialog, or display default gtk dialog if
    that isn't available"""
    def __init__(self, initial = None, title = _('Save File'),
                 filter = ((_('All files'), '*.*'),), filterindex = 1,
                 filename = '', open=False, multi=False):
        if initial is None:
            initial = os.path.expanduser("~")
        self.initial = initial
        self.filename = filename
        self.title = title
        self.filter = filter
        self.filterindex = filterindex
        self.open = open
        self.multi = multi

    def run(self):
        """run the file dialog, either return a file name, or False if
        the user aborted the dialog"""
        try:
            import win32gui, win32con, pywintypes            
            filepath = self.runWindows()
        except ImportError:
            filepath = self.runCompatible()
        if self.open:
            return filepath
        elif filepath:
            return self.overwriteConfirmation(filepath)
        else:
            return False

    def runWindows(self):

        def rundlg(q):
            import win32gui, win32con, pywintypes
            cwd = os.getcwd()
            fname = None
            try:
                f = ''
                for name, mask in self.filter:
                    f += '\0'.join([name, mask,''])
                flags = win32con.OFN_EXPLORER
                if self.multi:
                    flags |= win32con.OFN_ALLOWMULTISELECT
                opts = dict(InitialDir=self.initial,
                        Flags=flags,
                        File=self.filename,
                        DefExt=None,
                        Title=hglib.fromutf(self.title),
                        Filter= hglib.fromutf(f),
                        CustomFilter=None,
                        FilterIndex=self.filterindex)
                if self.open:
                    ret = win32gui.GetOpenFileNameW(**opts)
                else:
                    ret = win32gui.GetSaveFileNameW(**opts)
                fname = ret[0]
            except pywintypes.error:
                pass
            os.chdir(cwd)
            q.put(fname)

        q = Queue.Queue()
        thread = thread2.Thread(target=rundlg, args=(q,))
        thread.start()
        while thread.isAlive():
            # let gtk process events while we wait for rundlg finishing
            gtk.main_iteration(block=True)
        fname = False 
        if q.qsize():
            fname = q.get(0)
        if fname and self.multi and fname.find('\x00') != -1:
            splitted = fname.split('\x00')
            dir, fnames = splitted[0], splitted[1:]
            fname = []
            for fn in fnames:
                path = os.path.abspath(os.path.join(dir, fn))
                if os.path.exists(path):
                    fname.append(hglib.toutf(path))
        return fname

    def runCompatible(self):
        if self.open:
            action = gtk.FILE_CHOOSER_ACTION_OPEN
            buttons = (gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL,
                       gtk.STOCK_OPEN, gtk.RESPONSE_OK)
        else:
            action = gtk.FILE_CHOOSER_ACTION_SAVE
            buttons = (gtk.STOCK_CANCEL, gtk.RESPONSE_CANCEL,
                       gtk.STOCK_SAVE, gtk.RESPONSE_OK)
        dlg = gtk.FileChooserDialog(self.title, None, action, buttons)
        dlg.set_default_response(gtk.RESPONSE_OK)
        dlg.set_current_folder(self.initial)
        if self.multi:
            dlg.set_select_multiple(True)
        if not self.open:
            dlg.set_current_name(self.filename)
        for name, pattern in self.filter:
            fi = gtk.FileFilter()
            fi.set_name(name)
            fi.add_pattern(pattern)
            dlg.add_filter(fi)
        if dlg.run() == gtk.RESPONSE_OK:
            if self.multi:
                result = dlg.get_filenames()
            else:
                result = dlg.get_filename()
        else:
            result = False
        dlg.destroy()
        return result
    
    def overwriteConfirmation(self, filepath):        
        result = filepath
        if os.path.exists(filepath):
            from tortoisehg.hgtk import gdialog
            res = gdialog.Confirm(_('Confirm Overwrite'), [], None,
                _('The file "%s" already exists!\n\n'
                'Do you want to overwrite it?') % filepath).run()
            if res == gtk.RESPONSE_YES:
                os.remove(filepath)
            else:                
                result = False
        return result

class NativeFolderSelectDialog:
    """Wrap the windows folder dialog, or display default gtk dialog if
    that isn't available"""
    def __init__(self, initial = None, title = _('Select Folder')):
        self.initial = initial or os.getcwd()
        self.title = title

    def run(self):
        """run the file dialog, either return a file name, or False if
        the user aborted the dialog"""
        try:
            import win32com, win32gui, pywintypes
            return self.runWindows()
        except ImportError, e:
            return self.runCompatible()

    def runWindows(self):
    
        def rundlg(q):
            from win32com.shell import shell, shellcon
            import win32gui, pywintypes

            def BrowseCallbackProc(hwnd, msg, lp, data):
                if msg == shellcon.BFFM_INITIALIZED:
                    win32gui.SendMessage(
                        hwnd, shellcon.BFFM_SETSELECTION, 1, data)
                elif msg == shellcon.BFFM_SELCHANGED:
                    # Set the status text of the
                    # For this message, 'lp' is the address of the PIDL.
                    pidl = shell.AddressAsPIDL(lp)
                    try:
                        path = shell.SHGetPathFromIDList(pidl)
                        win32gui.SendMessage(
                            hwnd, shellcon.BFFM_SETSTATUSTEXT, 0, path)
                    except shell.error:
                        # No path for this PIDL
                        pass

            fname = None
            try: 
                flags = shellcon.BIF_EDITBOX | 0x40 #shellcon.BIF_NEWDIALOGSTYLE
                pidl, _, _ = shell.SHBrowseForFolder(
                   0,
                   None,
                   hglib.fromutf(self.title),
                   flags,
                   BrowseCallbackProc, # callback function
                   self.initial)       # 'data' param for the callback
                if pidl:
                    fname = hglib.toutf(shell.SHGetPathFromIDList(pidl))
            except (pywintypes.error, pywintypes.com_error):
                pass
            q.put(fname)

        q = Queue.Queue()
        thread = thread2.Thread(target=rundlg, args=(q,))
        thread.start()
        while thread.isAlive():
            # let gtk process events while we wait for rundlg finishing
            gtk.main_iteration(block=True)
        fname = None
        if q.qsize():
            fname = q.get(0)
        return fname

    def runCompatible(self):
        dialog = gtk.FileChooserDialog(title=self.title,
                action=gtk.FILE_CHOOSER_ACTION_SELECT_FOLDER,
                buttons=(gtk.STOCK_CANCEL,gtk.RESPONSE_CANCEL,
                         gtk.STOCK_OPEN,gtk.RESPONSE_OK))
        dialog.set_default_response(gtk.RESPONSE_OK)
        response = dialog.run()
        fname = dialog.get_filename()
        dialog.destroy()
        if response == gtk.RESPONSE_OK:
            return fname
        return None

class NativeFileManager:
    """
    Wrapper for opening the specific file manager; Explorer on Windows,
    Nautilus File Manager on Linux.
    """
    def __init__(self, path):
        self.path = path

    def run(self):
        try:
            import pywintypes
            self.runExplorer()
        except ImportError:
            self.runNautilus()

    def runExplorer(self):
        import subprocess
        subprocess.Popen('explorer "%s"' % self.path)

    def runNautilus(self):
        import subprocess
        subprocess.Popen('nautilus --browser "%s"' % self.path)

def markup(text, **kargs):
    """
    A wrapper function for Pango Markup Language.

    All options must be passed as keywork arguments.
    """
    if len(kargs) == 0:
        return markup_escape_text(str(text))
    attr = ''
    for name, value in kargs.items():
        attr += ' %s="%s"' % (name, value)
    text = markup_escape_text(text)
    return '<span%s>%s</span>' % (attr, text)

class LayoutGroup(object):

    def __init__(self, width=0):
        self.width = width
        self.tables = []

    def add(self, *tables, **kargs):
        self.tables.extend(tables)
        if kargs.get('adjust', True):
            self.adjust(**kargs)

    def adjust(self, force=False):
        def realized():
            '''check all tables realized or not'''
            for table in self.tables:
                if tuple(table.allocation) == (-1, -1, 1, 1):
                    return False
            return True
        def trylater():
            '''retry when occurred "size-allocate" signal'''
            adjusted = [False]
            def allocated(table, rect, hid):
                table.disconnect(hid[0])
                if not adjusted[0] and realized():
                    adjusted[0] = True
                    self.adjust()
            for table in self.tables:
                hid = [None]
                hid[0] = table.connect('size-allocate', allocated, hid)
        # check all realized
        if not force and not realized():
            trylater()
            return
        # find out max width
        max = self.width
        for table in self.tables:
            first = table.get_first_header()
            w = first.allocation.width
            max = w > max and w or max
        # apply width
        for table in self.tables:
            first = table.get_first_header()
            first.set_size_request(max, -1)
            first.size_request()

class LayoutTable(gtk.VBox):
    """
    Provide 2 columns layout table.

    This table has 2 columns; first column is used for header, second
    is used for body. In default, the header will be aligned right and
    the body will be aligned left with expanded padding.
    """

    def __init__(self, **kargs):
        gtk.VBox.__init__(self)

        self.table = gtk.Table(1, 2)
        self.pack_start(self.table)
        self.headers = []

        self.set_default_paddings(kargs.get('xpad', -1),
                                  kargs.get('ypad', -1))
        self.set_default_options(kargs.get('headopts', None),
                                 kargs.get('bodyopts', None))

    def set_default_paddings(self, xpad=None, ypad=None):
        """
        Set default paddings between cells.

        LayoutTable has xpad=4, ypad=2 as preset padding values.

        xpad: Number. Pixcel value of padding for x-axis.
              Use -1 to reset padding to preset value.
              Default: None (no change).
        ypad: Number. Pixcel value of padding for y-axis.
              Use -1 to reset padding to preset value.
              Default: None (no change).
        """
        if xpad is not None:
            self.xpad = xpad >= 0 and xpad or 4
        if ypad is not None:
            self.ypad = ypad >= 0 and ypad or 2

    def set_default_options(self, headopts=None, bodyopts=None):
        """
        Set default options for markups of label.

        In default, LayoutTable doesn't use any markups and set the test
        as plane text.  See markup()'s description for more details of
        option parameters.  Note that if called add_row() with just one
        widget, it will be tried to apply 'bodyopts', not 'headopts'.

        headopts: Dictionary. Options used for markups of gtk.Label.
                  This option is only availabled for the label.
                  The text will be escaped automatically.  Default: None.
        bodyopts: [same as 'headopts']
        """
        self.headopts = headopts
        self.bodyopts = bodyopts

    def get_first_header(self):
        """
        Return the cell at top-left corner if exists.
        """
        if len(self.headers) > 0:
            return self.headers[0]
        return None

    def clear_rows(self):
        for child in self.table.get_children():
            self.table.remove(child)

    def add_row(self, *widgets, **kargs):
        """
        Append a new row to the table.

        widgets: mixed list of widget, string, number or None;
                 i.e. ['host:', gtk.Entry(), 20, 'port:', gtk.Entry()]
                 First item will be header, and the rest will be body
                 after packed into a gtk.HBox.

            widget: Standard GTK+ widget.
            string: Label text, will be converted gtk.Label.
            number: Fixed width padding.
            None: Flexible padding.

        kargs: 'padding', 'expand', 'xpad' and 'ypad' are availabled.

            padding: Boolean. If False, the padding won't append the end
                     of body.  Default: True.
            expand: Number. Position of body element to expand.  If you
                    specify this option, 'padding' option will be changed
                    to False automatically.  Default: -1 (last element).
            xpad: Number. Override default 'xpad' value.
            ypad: Same as 'xpad'.
            xhopt: Number. Combination of gtk.EXPAND, gtk.SHRINK or gtk.FILL.
                   Note that this option is applied with only head element.
                   Default: gtk.FILL.
            yhopt: Same as 'xhopt' except default value. Default: 0.
            xopt: Number. Combination of gtk.EXPAND, gtk.SHRINK or gtk.FILL.
                  Note that this option is applied with only body elements.
                  Default: gtk.FILL|gtk.EXPAND.
            yopt: Same as 'xopt' except default value. Default: 0.
            headopts: Dictionary. Override default 'headopts' value.
            bodyopts: Same as 'headopts'.
        """
        if len(widgets) == 0:
            return
        t = self.table
        rows = t.get_property('n-rows')
        t.set_property('n-rows', rows + 1)
        xpad = kargs.get('xpad', self.xpad)
        ypad = kargs.get('ypad', self.ypad)
        xhopt = kargs.get('xhopt', gtk.FILL)
        yhopt = kargs.get('yhopt', 0)
        xopt = kargs.get('xopt', gtk.FILL|gtk.EXPAND)
        yopt = kargs.get('yopt', 0)
        hopts = kargs.get('headopts', self.headopts)
        bopts = kargs.get('bodyopts', self.bodyopts)
        def getwidget(obj, opts=None):
            '''element converter'''
            if obj == None:
                return gtk.Label('')
            elif isinstance(obj, (int, long)):
                lbl = gtk.Label('')
                lbl.set_size_request(obj, -1)
                lbl.size_request()
                return lbl
            elif isinstance(obj, basestring):
                if opts is None:
                    lbl = gtk.Label(obj)
                else:
                    obj = markup(obj, **opts)
                    lbl = gtk.Label()
                    lbl.set_markup(obj)
                return lbl
            return obj
        def pack(*widgets, **kargs):
            '''pack some of widgets and return HBox'''
            expand = kargs.get('expand', -1)
            if len(widgets) <= expand:
                expand = -1
            padding = kargs.get('padding', expand == -1)
            if padding is True:
                widgets += (None,)
            expmap = [ w is None for w in widgets ]
            expmap[expand] = True
            widgets = [ getwidget(w, bopts) for w in widgets ]
            hbox = gtk.HBox()
            for i, obj in enumerate(widgets):
                widget = getwidget(obj, bopts)
                pad = i != 0 and 2 or 0
                hbox.pack_start(widget, expmap[i], expmap[i], pad)
            return hbox
        if len(widgets) == 1:
            cols = t.get_property('n-columns')
            widget = pack(*widgets, **kargs)
            t.attach(widget, 0, cols, rows, rows + 1, xopt, yopt, xpad, ypad)
        else:
            first = getwidget(widgets[0], hopts)
            if isinstance(first, gtk.Label):
                first.set_alignment(1, 0.5)
            t.attach(first, 0, 1, rows, rows + 1, xhopt, yhopt, xpad, ypad)
            self.headers.append(first)
            rest = pack(*(widgets[1:]), **kargs)
            t.attach(rest, 1, 2, rows, rows + 1, xopt, yopt, xpad, ypad)

class SlimToolbar(gtk.HBox):
    """
    Slim Toolbar, allows to add the buttons with small icon.
    """
    def __init__(self, tooltips=None):
        gtk.HBox.__init__(self)
        self.tooltips = tooltips
        self.groups = {}

    ### public methods ###

    def append_button(self, icon, tooltip=None, toggle=False, group=None):
        """
        icon: stock id or file name bundled in TortoiseHg.
        """
        if toggle:
            button = gtk.ToggleButton()
        else:
            button = gtk.Button()
        button.set_image(get_icon_image(icon))
        button.set_relief(gtk.RELIEF_NONE)
        button.set_focus_on_click(False)
        if self.tooltips and tooltip:
            self.tooltips.set_tip(button, tooltip)
        self.append_widget(button, padding=0, group=group)
        return button

    def append_widget(self, widget, expand=False, padding=2, group=None):
        self.pack_start(widget, expand, expand, padding)
        self.add_group(group, widget)

    def append_space(self):
        self.append_widget(gtk.Label(), expand=True, padding=0)

    def append_separator(self, group=None):
        self.append_widget(gtk.VSeparator(), group=group)

    def set_enable(self, group, enable=True):
        if not group or not self.groups.has_key(group):
            return
        for widget in self.groups[group]:
            widget.set_sensitive(enable)

    def set_visible(self, group, visible=True):
        if not group or not self.groups.has_key(group):
            return
        for widget in self.groups[group]:
            if visible is True:
                widget.set_no_show_all(False)
            widget.set_property('visible', visible)
            if visible is False:
                widget.set_no_show_all(True)

    ### internal method ###

    def add_group(self, group, widget):
        if not group or not widget:
            return
        if not self.groups.has_key(group):
            self.groups[group] = []
        self.groups[group].append(widget)

def create_menuitem(label, handler=None, icon=None, *args, **kargs):
    """
    Create a new menu item and append it the end of menu.

    label: a string to be shown as menu label.
    handler: a function to be connected with 'activate' signal.
             Default: None.
    icon: GKT+ stock item name or TortoiseHg's bundle icon name.
          Default: None.
    ascheck: whether enable toggle feature. Default: False.
    asradio: whether use radio menu item. Default: False.
    group: menu item instance to be used for group of radio menu item.
           Default: None.
    check: toggle or selection state for check/radio menu item.
           Default: False.
    sensitive: sensitive state on init. Default: True.
    use_underline: handle underline as accelerator key prefix.
                   Default: True.
    args: an argument list for 'handler' parameter.
          Default: [] (an empty list).
    """
    use_underline = kargs.get('use_underline', True)
    if gtk.gtk_version < (2, 14, 0) and not use_underline:
       # workaround (set_use_underline not available on gtk < 2.14)
       label = label.replace('_', '__')
    if kargs.get('asradio') or kargs.get('ascheck'):
        if kargs.get('asradio'):
            menu = gtk.RadioMenuItem(kargs.get('group'), label, use_underline=use_underline)
        else:
            menu = gtk.CheckMenuItem(label, use_underline=use_underline)
        menu.set_active(kargs.get('check', False))
    elif icon:
        menu = gtk.ImageMenuItem(label)
        menu.set_image(get_icon_image(icon))
    else:
        menu = gtk.MenuItem(label, use_underline=use_underline)
    if handler:
        args = kargs.get('args', [])
        menu.connect('activate', handler, *args)
    menu.set_sensitive(kargs.get('sensitive', True))
    menu.set_border_width(1)
    return menu

class MenuBuilder(object):
    '''controls creation of menus by ignoring separators at odd places'''
    def __init__(self):
        self.reset()

    ### public methods ###

    def reset(self):
        self.childs = []
        self.sep = None

    def append(self, *a, **k):
        menu = create_menuitem(*a, **k)
        self.append_child(menu)
        return menu

    def append_sep(self):
        self.append_child(gtk.SeparatorMenuItem())

    def append_submenu(self, label, submenu, icon=None, *a, **k):
        menu = create_menuitem(label, None, icon, *a, **k)
        menu.set_submenu(submenu)
        self.append_child(menu)

    def build(self):
        menu = gtk.Menu()
        for c in self.childs:
            menu.append(c)
        self.reset()
        return menu

    def get_menus(self):
        return self.childs[:]

    ### internal method ###

    def append_child(self, child):
        '''appends the child menu item, but ignores odd separators'''
        if isinstance(child, gtk.SeparatorMenuItem):
            if len(self.childs) > 0:
                self.sep = child
        else:
            if self.sep:
                self.childs.append(self.sep)
                self.sep = None
            self.childs.append(child)

def addspellcheck(textview, ui=None):
    lang = None
    if ui:
        lang = ui.config('tortoisehg', 'spellcheck', None)
    try:
        import gtkspell
        gtkspell.Spell(textview, lang)
    except ImportError:
        pass
    except Exception, e:
        print e
    else:
        def selectlang(senderitem):
            from tortoisehg.hgtk import dialog
            spell = gtkspell.get_from_text_view(textview)
            lang = ''
            while True:
                msg = _('Select language for spell checking.\n\n'
                        'Empty is for the default language.\n'
                        'When all text is highlited, the dictionary\n'
                        'is probably not installed.\n\n'
                        'examples: en, en_GB, en_US')
                if lang:
                    msg = _('Lang "%s" can not be set.\n') % lang + msg
                lang = dialog.entry_dialog(None, msg)
                if lang is None: # cancel
                    return
                lang = lang.strip()
                if not lang:
                    lang = None # set default language from $LANG
                try:
                    spell.set_language(lang)
                    return
                except Exception, e:
                    pass
        def langmenu(textview, menu):
            item = gtk.MenuItem(_('Spell Check Language'))
            item.connect('activate', selectlang)
            menuitems = menu.get_children()[:2]
            x = menuitems[0].get_submenu()
            if len(menuitems) >= 2 and menuitems[1].get_child() is None and menuitems[0].get_submenu():
                # the spellcheck language menu seems to be at the top
                menu.insert(item, 1)
            else:
                sep = gtk.SeparatorMenuItem()
                sep.show()
                menu.append(sep)
                menu.append(item)
            item.show()
        textview.connect('populate-popup', langmenu)

def hasspellcheck():
    try:
        import gtkspell
        gtkspell.Spell
        return True
    except ImportError:
        return False

def idle_add_single_call(f, *args):
    '''wrap function f for gobject.idle_add, so that f is guaranteed to be
    called only once, independent of its return value'''

    class single_call(object):
        def __init__(self, f, args):
           self.f = f
           self.args = args
        def __call__(self):
           self.f(*args)  # ignore return value of f
           return False   # return False to signal: don't call me again

    # functions passed to gobject.idle_add must return False, or they
    # will be called repeatedly. The single_call object wraps f and always
    # returns False when called. So the return value of f doesn't matter,
    # it can even return True (which would lead to gobject.idle_add
    # calling the function again, if used without single_call).
    gobject.idle_add(single_call(f, args))