Kiln » TortoiseHg » TortoiseHg
Clone URL:  
iconoverlay.py
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
# Published under the GNU GPL, v2 or later. # Copyright (C) 2007 Henry Ludemann <misc@hl.id.au> # Copyright (C) 2007 TK Soh <teekaysoh@gmail.com> import os import win32api import win32con from win32com.shell import shell, shellcon import _winreg from mercurial import hg, cmdutil, util from mercurial import repo as _repo import thgutil import sys # FIXME: quick workaround traceback caused by missing "closed" # attribute in win32trace. from mercurial import ui def write_err(self, *args): for a in args: sys.stderr.write(str(a)) ui.ui.write_err = write_err # file/directory status UNCHANGED = "unchanged" ADDED = "added" MODIFIED = "modified" UNKNOWN = "unknown" NOT_IN_TREE = "not in tree" NO_DIRSTATE = "dirstate not found" CONTROL_FILE = "control file" # file status cache CACHE_TIMEOUT = 3000 overlay_cache = {} # some misc constants S_OK = 0 S_FALSE = 1 # overlay icons display setting show_overlay_icons = False def get_show_icons(): global show_overlay_icons val = ui.ui().config('tortoisehg', 'overlayicons', "enabled") show_overlay_icons = val == 'enabled' print "show_icons = ", show_overlay_icons def subdirs(p): oldp = "" if os.path.isdir(p): yield p while 1: oldp = p p = os.path.dirname(p) if p == oldp: return yield p def get_cache_list(path): """ get a list of file/folders which reside in the same directory as 'path' """ pathdir = os.path.dirname(path) return [os.path.join(pathdir, x) for x in os.listdir(pathdir) if x <> ".hg"] def get_dirs(list): return set([os.path.dirname(p) for p in list]) def add_dirs(list): dirs = set() for f in list: dir = os.path.dirname(f) if dir in dirs: continue while dir: dirs.add(dir) dir = os.path.dirname(dir) list.extend(dirs) class IconOverlayExtension(object): """ Class to implement icon overlays for source controlled files. Displays a different icon based on version control status. NOTE: The system allocates only 15 slots in _total_ for all icon overlays; we (will) use 6, tortoisecvs uses 7... not a good recipe for a happy system. """ counter = 0 _com_interfaces_ = [shell.IID_IShellIconOverlayIdentifier] _public_methods_ = [ "GetOverlayInfo", "GetPriority", "IsMemberOf" ] def GetOverlayInfo(self): # retrieve overlay icons display settting get_show_icons() icon = thgutil.get_icon_path("status", self.icon) print "icon = ", icon if icon: return (icon, 0, shellcon.ISIOI_ICONFILE) else: return ("", 0, 0) def GetPriority(self): return 0 def _get_installed_overlays(): key = win32api.RegOpenKeyEx(win32con.HKEY_LOCAL_MACHINE, "Software\\Microsoft\\Windows\\" + "CurrentVersion\\Explorer\\" + "ShellIconOverlayIdentifiers", 0, win32con.KEY_READ) keys = win32api.RegEnumKeyEx(key) handlercount = len(keys) print "number of overlay handlers installed = %d" % handlercount for i, k in enumerate(keys): print i, k win32api.RegCloseKey(key) return handlercount def _get_state(self, upath): """ Get the state of a given path in source control. """ global overlay_cache #print "called: _get_state(%s)" % path tc = win32api.GetTickCount() try: # handle some Asian charsets path = upath.encode('mbcs') except: path = upath # check if path is cached if path in overlay_cache: if tc - overlay_cache[path][1] < CACHE_TIMEOUT: status = overlay_cache[path][0] print "%s: %s (cached)" % (path, status) return status # path is a drive if path.endswith(":\\"): overlay_cache[path] = (UNKNOWN, tc) return NOT_IN_TREE if os.path.basename(path) == ".hg": print "%s: skip directory" % path overlay_cache[path] = (UNKNOWN, tc) return NOT_IN_TREE # ignore .hg directories (for efficiency) # open repo root = thgutil.find_root(path) #print "_get_state: root = ", root if root is None: #print "_get_state: not in repo" overlay_cache = {} for f in get_cache_list(path): overlay_cache[f] = (UNKNOWN, tc) return NOT_IN_TREE # skip root direcory to improve speed if root == path: #print "_get_state: skip repo root" overlay_cache[path] = (UNKNOWN, tc) return NOT_IN_TREE # can't get correct status without dirstate if not os.path.exists(os.path.join(root, ".hg", "dirstate")): #print "_get_state: dirstate not found" return NO_DIRSTATE try: repo = hg.repository(ui.ui(), path=root) except _repo.RepoError: # We aren't in a working tree print "%s: not in repo" % dir overlay_cache[path] = (UNKNOWN, tc) return NOT_IN_TREE # get file status tc1 = win32api.GetTickCount() cache_list = get_cache_list(path) #print "cache_list: ", "\n".join(cache_list) dirstate_list = [ os.path.normpath(os.path.join(root, x[0])) for x in repo.dirstate._map.items() ] ndirs = [] for d in get_dirs(dirstate_list): ndirs.extend(subdirs(d)) dirstate_list.extend(set(ndirs)) #print "dirstate_list: ", "\n".join(dirstate_list) tracked_list = [ x for x in cache_list if x in dirstate_list ] #print "tracked_list: ", "\n".join(tracked_list) modified, added, removed, deleted = [], [], [], [] unknown, ignored, clean = [], [], [] files = [] if tracked_list: try: files, matchfn, anypats = cmdutil.matchpats(repo, tracked_list) modified, added, removed, deleted, unknown, ignored, clean = [ n for n in repo.status(files=files, list_clean=True)] # add directory status to list add_dirs(clean) add_dirs(modified) add_dirs(added) add_dirs(removed) add_dirs(deleted) except util.Abort, inst: print "abort: %s" % inst print "treat as unknown : %s" % path return UNKNOWN print "status() took %d ticks" % (win32api.GetTickCount() - tc1) # cached file info tc = win32api.GetTickCount() overlay_cache = {} for f in files: if f in modified: status = MODIFIED elif f in added: status = ADDED elif f in clean: status = UNCHANGED else: status = UNKNOWN fpath = os.path.join(repo.root, os.path.normpath(f)) overlay_cache[fpath] = (status, tc) #print "cache:", fpath, status for f in cache_list: if not f in overlay_cache: overlay_cache[f] = (UNKNOWN, tc) if path in overlay_cache: status = overlay_cache[path][0] else: status = UNKNOWN print "%s: %s" % (path, status) return status def IsMemberOf(self, path, attrib): global show_overlay_icons if not show_overlay_icons: return S_FALSE if self._get_state(path) == self.state: return S_OK return S_FALSE def make_icon_overlay(name, icon, state, clsid): """ Make an icon overlay COM class. Used to create different COM server classes for highlighting the files with different source controlled states (eg: unchanged, modified, ...). """ classname = "%sOverlay" % name prog_id = "Mercurial.ShellExtension.%s" % classname desc = "Mercurial icon overlay shell extension for %s files" % name.lower() reg = [ (_winreg.HKEY_LOCAL_MACHINE, r"Software\Microsoft\Windows\CurrentVersion\Explorer\ShellIconOverlayIdentifiers\%s" % name) ] cls = type( classname, (IconOverlayExtension, ), dict(_reg_clsid_=clsid, _reg_progid_=prog_id, _reg_desc_=desc, registry_keys=reg, icon=icon, state=state)) _overlay_classes.append(cls) # We need to register the class as global, as pythoncom will # create an instance of it. globals()[classname] = cls _overlay_classes = [] make_icon_overlay("Changed", "changed.ico", MODIFIED, "{102C6A24-5F38-4186-B64A-237011809FAB}") make_icon_overlay("Unchanged", "unchanged.ico", UNCHANGED, "{00FEE959-5773-424B-88AC-A01BFC8E4555}") make_icon_overlay("Added", "added.ico", ADDED, "{8447DB75-5875-4BA8-9F38-A727DAA484A0}") def get_overlay_classes(): """ Get a list of all registerable icon overlay classes """ return _overlay_classes