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
|
'''
Task Coach - Your friendly task manager
Copyright (C) 2004-2014 Task Coach developers <developers@taskcoach.org>
Task Coach 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, either version 3 of the License, or
(at your option) any later version.
Task Coach 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 this program. If not, see <http://www.gnu.org/licenses/>.
'''
from taskcoachlib import patterns
from wx.lib.pubsub import pub
class Sorter(patterns.ListDecorator):
''' This class decorates a list and sorts its contents. '''
def __init__(self, *args, **kwargs):
self._sortKeys = kwargs.pop('sortBy', ['subject'])
self._sortCaseSensitive = kwargs.pop('sortCaseSensitive', True)
super(Sorter, self).__init__(*args, **kwargs)
for sortKey in self._sortKeys:
self._registerObserverForAttribute(sortKey.lstrip('-'))
self.reset()
def thaw(self):
super(Sorter, self).thaw()
if not self.isFrozen():
self.reset()
def detach(self):
super(Sorter, self).detach()
for sortKey in self._sortKeys:
self._removeObserverForAttribute(sortKey.lstrip('-'))
@classmethod
def sortEventType(cls):
return 'pubsub.%s.sorted' % cls.__name__
@patterns.eventSource
def extendSelf(self, items, event=None):
super(Sorter, self).extendSelf(items, event)
self.reset()
def isAscending(self):
if self._sortKeys:
return not self._sortKeys[0].startswith('-')
return True
def sortKeys(self):
return self._sortKeys
# We don't implement removeItemsFromSelf() because there is no need
# to resort when items are removed since after removing items the
# remaining items are still in the right order.
def sortBy(self, sortKey):
if self._sortKeys and self._sortKeys[0] == sortKey:
if sortKey == 'ordering':
return
self._sortKeys[0] = '-' + sortKey
elif self._sortKeys and self._sortKeys[0] == '-' + sortKey:
self._sortKeys[0] = sortKey
elif self._sortKeys and sortKey in self._sortKeys:
self._sortKeys.remove(sortKey)
self._sortKeys.insert(0, sortKey)
elif self._sortKeys and ('-' + sortKey) in self._sortKeys:
self._sortKeys.remove('-' + sortKey)
self._sortKeys.insert(0, sortKey)
else:
self._sortKeys.insert(0, sortKey)
self._registerObserverForAttribute(sortKey)
self.reset()
def sortCaseSensitive(self, sortCaseSensitive):
self._sortCaseSensitive = sortCaseSensitive
self.reset()
def sortAscending(self, ascending=True):
if self._sortKeys:
if (ascending and self._sortKeys[0].startswith('-')) or \
(not ascending and not self._sortKeys[0].startswith('-')):
self.sortBy(self._sortKeys[0].lstrip('-'))
def reset(self, forceEvent=False):
''' reset does the actual sorting. If the order of the list changes,
observers are notified by means of the list-sorted event. '''
if self.isFrozen():
return
oldSelf = self[:]
# XXXTODO: create only one function with all keys ? Reversing may
# be problematic.
for sortKey in reversed(self._sortKeys):
self.sort(key=self.createSortKeyFunction(sortKey.lstrip('-')), reverse=sortKey.startswith('-'))
if forceEvent or self != oldSelf:
pub.sendMessage(self.sortEventType(), sender=self)
def createSortKeyFunction(self, sortKey):
''' createSortKeyFunction returns a function that is passed to the
builtin list.sort method to extract the sort key from each element
in the list. We expect the domain object class to provide a
<sortKey>SortFunction(sortCaseSensitive) method that returns the
sortKeyFunction for the sortKey. '''
return self._getSortKeyFunction(sortKey)(sortCaseSensitive=self._sortCaseSensitive)
def _getSortKeyFunction(self, sortKey):
try:
return getattr(self.DomainObjectClass,
'%sSortFunction' % sortKey)
except AttributeError:
return self._getSortKeyFunction('subject')
def _registerObserverForAttribute(self, attribute):
for eventType in self._getSortEventTypes(attribute):
if eventType.startswith('pubsub'):
pub.subscribe(self.onAttributeChanged, eventType)
else:
patterns.Publisher().registerObserver(self.onAttributeChanged_Deprecated,
eventType=eventType)
def _removeObserverForAttribute(self, attribute):
for eventType in self._getSortEventTypes(attribute):
if eventType.startswith('pubsub'):
pub.unsubscribe(self.onAttributeChanged, eventType)
else:
patterns.Publisher().removeObserver(self.onAttributeChanged_Deprecated,
eventType=eventType)
def onAttributeChanged(self, newValue, sender): # pylint: disable=W0613
self.reset()
def onAttributeChanged_Deprecated(self, event): # pylint: disable=W0613
self.reset()
def _getSortEventTypes(self, attribute):
try:
return getattr(self.DomainObjectClass, '%sSortEventTypes' % attribute)()
except AttributeError:
return []
class TreeSorter(Sorter):
def __init__(self, *args, **kwargs):
self.__rootItems = None # Cached root items
super(TreeSorter, self).__init__(*args, **kwargs)
def treeMode(self):
return True
def createSortKeyFunction(self, key):
''' createSortKeyFunction returns a function that is passed to the
builtin list.sort method to extract the sort key from each element
in the list. We expect the domain object class to provide a
<sortKey>SortFunction(sortCaseSensitive, treeMode) method that
returns the sortKeyFunction for the sortKey. '''
return self._getSortKeyFunction(key)(sortCaseSensitive=self._sortCaseSensitive,
treeMode=self.treeMode())
def reset(self, *args, **kwargs): # pylint: disable=W0221
self.__invalidateRootItemCache()
return super(TreeSorter, self).reset(*args, **kwargs)
@patterns.eventSource
def extendSelf(self, items, event=None):
self.__invalidateRootItemCache()
return super(TreeSorter, self).extendSelf(items, event=event)
@patterns.eventSource
def removeItemsFromSelf(self, itemsToRemove, event=None):
self.__invalidateRootItemCache()
# FIXME: Why is it necessary to remove all children explicitly?
itemsToRemove = set(itemsToRemove)
if self.treeMode():
for item in itemsToRemove.copy():
itemsToRemove.update(item.children(recursive=True))
itemsToRemove = [item for item in itemsToRemove if item in self]
return super(TreeSorter, self).removeItemsFromSelf(itemsToRemove, event=event)
def rootItems(self):
''' Return the root items, i.e. items without a parent. '''
if self.__rootItems is None:
self.__rootItems = [item for item in self if item.parent() is None]
return self.__rootItems
def __invalidateRootItemCache(self):
self.__rootItems = None
|
