FIxing some issues with quick jump
[gonvert] / src / gonvert_qt.py
1 #!/usr/bin/env python
2 # -*- coding: UTF8 -*-
3
4 from __future__ import with_statement
5
6 import sys
7 import os
8 import math
9 import logging
10
11 from PyQt4 import QtGui
12 from PyQt4 import QtCore
13
14 import constants
15 from util import misc as misc_utils
16 import unit_data
17
18
19 _moduleLogger = logging.getLogger("gonvert_glade")
20
21
22 def change_menu_label(widgets, labelname, newtext):
23         item_label = widgets.get_widget(labelname).get_children()[0]
24         item_label.set_text(newtext)
25
26
27 def split_number(number):
28         try:
29                 fractional, integer = math.modf(number)
30         except TypeError:
31                 integerDisplay = number
32                 fractionalDisplay = ""
33         else:
34                 integerDisplay = str(integer)
35                 fractionalDisplay = str(fractional)
36                 if "e+" in integerDisplay:
37                         integerDisplay = number
38                         fractionalDisplay = ""
39                 elif "e-" in fractionalDisplay and 0.0 < integer:
40                         integerDisplay = number
41                         fractionalDisplay = ""
42                 elif "e-" in fractionalDisplay:
43                         integerDisplay = ""
44                         fractionalDisplay = number
45                 else:
46                         integerDisplay = integerDisplay.split(".", 1)[0] + "."
47                         fractionalDisplay = fractionalDisplay.rsplit(".", 1)[-1]
48
49         return integerDisplay, fractionalDisplay
50
51
52 class Gonvert(object):
53
54         # @todo Remember last selection
55         # @todo Recent
56         # @todo Favorites
57         # @todo Fullscreen support (showFullscreen, showNormal)
58         # @todo Close Window / Quit keyboard shortcuts
59         # @todo Ctrl+l support
60         # @todo Unit conversion window: focus always on input, arrows switch units
61
62         _DATA_PATHS = [
63                 os.path.dirname(__file__),
64                 os.path.join(os.path.dirname(__file__), "../data"),
65                 os.path.join(os.path.dirname(__file__), "../lib"),
66                 '/usr/share/gonvert',
67                 '/usr/lib/gonvert',
68         ]
69
70         def __init__(self):
71                 self._dataPath = ""
72                 for dataPath in self._DATA_PATHS:
73                         appIconPath = os.path.join(dataPath, "pixmaps", "gonvert.png")
74                         if os.path.isfile(appIconPath):
75                                 self._dataPath = dataPath
76                                 break
77                 else:
78                         raise RuntimeError("UI Descriptor not found!")
79                 self._appIconPath = appIconPath
80
81                 self._jumpWindow = None
82                 self._catWindow = None
83
84                 self._jumpAction = QtGui.QAction(None)
85                 self._jumpAction.setText("Quick Jump")
86                 self._jumpAction.setStatusTip("Search for a unit and jump straight to it")
87                 self._jumpAction.setToolTip("Search for a unit and jump straight to it")
88                 self._jumpAction.setShortcut(QtGui.QKeySequence("CTRL+j"))
89                 self._jumpAction.triggered.connect(self._on_jump_start)
90
91                 self.request_category()
92
93         def request_category(self):
94                 if self._catWindow is not None:
95                         self._catWindow.close()
96                         self._catWindow = None
97                 self._catWindow = CategoryWindow(None, self)
98                 return self._catWindow
99
100         def search_units(self):
101                 if self._jumpWindow is not None:
102                         self._jumpWindow.close()
103                         self._jumpWindow = None
104                 self._jumpWindow = QuickJump(None, self)
105                 return self._jumpWindow
106
107         @property
108         def appIconPath(self):
109                 return self._appIconPath
110
111         @property
112         def jumpAction(self):
113                 return self._jumpAction
114
115         @misc_utils.log_exception(_moduleLogger)
116         def _on_jump_start(self, checked = False):
117                 self.search_units()
118
119
120 class CategoryWindow(object):
121
122         def __init__(self, parent, app):
123                 self._app = app
124                 self._unitWindow = None
125
126                 self._categories = QtGui.QTreeWidget()
127                 self._categories.setHeaderLabels(["Categories"])
128                 self._categories.itemClicked.connect(self._on_category_clicked)
129                 self._categories.setHeaderHidden(True)
130                 self._categories.setAlternatingRowColors(True)
131                 for catName in unit_data.UNIT_CATEGORIES:
132                         twi = QtGui.QTreeWidgetItem(self._categories)
133                         twi.setText(0, catName)
134
135                 self._layout = QtGui.QVBoxLayout()
136                 self._layout.addWidget(self._categories)
137
138                 centralWidget = QtGui.QWidget()
139                 centralWidget.setLayout(self._layout)
140
141                 self._window = QtGui.QMainWindow(parent)
142                 if parent is not None:
143                         self._window.setWindowModality(QtCore.Qt.WindowModal)
144                 self._window.setWindowTitle("%s - Categories" % constants.__pretty_app_name__)
145                 self._window.setWindowIcon(QtGui.QIcon(self._app.appIconPath))
146                 self._window.setCentralWidget(centralWidget)
147
148                 viewMenu = self._window.menuBar().addMenu("&View")
149                 viewMenu.addAction(self._app.jumpAction)
150
151                 self._window.show()
152
153         def close(self):
154                 if self._unitWindow is not None:
155                         self._unitWindow.close()
156                         self._unitWindow = None
157                 self._window.close()
158
159         def selectCategory(self, categoryName):
160                 if self._unitWindow is not None:
161                         self._unitWindow.close()
162                         self._unitWindow = None
163                 self._unitWindow = UnitWindow(self._window, categoryName, self._app)
164                 return self._unitWindow
165
166         @misc_utils.log_exception(_moduleLogger)
167         def _on_category_clicked(self, item, columnIndex):
168                 categoryName = unicode(item.text(0))
169                 self.selectCategory(categoryName)
170
171
172 class QuickJump(object):
173
174         MINIMAL_ENTRY = 3
175
176         def __init__(self, parent, app):
177                 self._app = app
178
179                 self._searchLabel = QtGui.QLabel("Search:")
180                 self._searchEntry = QtGui.QLineEdit("")
181                 self._searchEntry.textEdited.connect(self._on_search_edited)
182
183                 self._entryLayout = QtGui.QHBoxLayout()
184                 self._entryLayout.addWidget(self._searchLabel)
185                 self._entryLayout.addWidget(self._searchEntry)
186
187                 self._resultsBox = QtGui.QTreeWidget()
188                 self._resultsBox.setHeaderLabels(["Categories", "Units"])
189                 self._resultsBox.setHeaderHidden(True)
190                 self._resultsBox.setAlternatingRowColors(True)
191                 self._resultsBox.itemClicked.connect(self._on_result_clicked)
192
193                 self._layout = QtGui.QVBoxLayout()
194                 self._layout.addLayout(self._entryLayout)
195                 self._layout.addWidget(self._resultsBox)
196
197                 centralWidget = QtGui.QWidget()
198                 centralWidget.setLayout(self._layout)
199
200                 self._window = QtGui.QMainWindow(parent)
201                 if parent is not None:
202                         self._window.setWindowModality(QtCore.Qt.WindowModal)
203                 self._window.setWindowTitle("%s - Quick Jump" % constants.__pretty_app_name__)
204                 self._window.setWindowIcon(QtGui.QIcon(self._app.appIconPath))
205                 self._window.setCentralWidget(centralWidget)
206
207                 self._window.show()
208
209         def close(self):
210                 self._window.close()
211
212         @misc_utils.log_exception(_moduleLogger)
213         def _on_result_clicked(self, item, columnIndex):
214                 categoryName = unicode(item.text(0))
215                 unitName = unicode(item.text(1))
216                 catWindow = self._app.request_category()
217                 unitsWindow = catWindow.selectCategory(categoryName)
218                 unitsWindow.select_unit(unitName)
219                 self.close()
220
221         @misc_utils.log_exception(_moduleLogger)
222         def _on_search_edited(self, *args):
223                 userInput = self._searchEntry.text()
224                 if len(userInput) <  self.MINIMAL_ENTRY:
225                         return
226
227                 self._resultsBox.clear()
228                 lowerInput = str(userInput).lower()
229                 for catIndex, category in enumerate(unit_data.UNIT_CATEGORIES):
230                         units = unit_data.get_units(category)
231                         for unitIndex, unit in enumerate(units):
232                                 loweredUnit = unit.lower()
233                                 if lowerInput in loweredUnit:
234                                         twi = QtGui.QTreeWidgetItem(self._resultsBox)
235                                         twi.setText(0, category)
236                                         twi.setText(1, unit)
237
238
239 class UnitData(object):
240
241         HEADERS = ["Name", "Value", "", "Unit"]
242         ALIGNMENT = [QtCore.Qt.AlignLeft, QtCore.Qt.AlignRight, QtCore.Qt.AlignLeft, QtCore.Qt.AlignLeft]
243
244         def __init__(self, name, unit, description, conversion):
245                 self._name = name
246                 self._unit = unit
247                 self._description = description
248                 self._conversion = conversion
249
250                 self._value = 0.0
251                 self._integerDisplay, self._fractionalDisplay = split_number(self._value)
252
253         @property
254         def name(self):
255                 return self._name
256
257         @property
258         def value(self):
259                 return self._value
260
261         def update_value(self, newValue):
262                 self._value = newValue
263                 self._integerDisplay, self._fractionalDisplay = split_number(newValue)
264
265         @property
266         def unit(self):
267                 return self._unit
268
269         @property
270         def conversion(self):
271                 return self._conversion
272
273         def data(self, column):
274                 try:
275                         return [self._name, self._integerDisplay, self._fractionalDisplay, self._unit][column]
276                 except IndexError:
277                         return None
278
279
280 class UnitModel(QtCore.QAbstractItemModel):
281
282         def __init__(self, categoryName, parent=None):
283                 super(UnitModel, self).__init__(parent)
284                 self._categoryName = categoryName
285                 self._unitData = unit_data.UNIT_DESCRIPTIONS[self._categoryName]
286
287                 self._children = []
288                 for key in unit_data.get_units(self._categoryName):
289                         conversion, unit, description = self._unitData[key]
290                         self._children.append(UnitData(key, unit, description, conversion))
291
292         @misc_utils.log_exception(_moduleLogger)
293         def columnCount(self, parent):
294                 if parent.isValid():
295                         return 0
296                 else:
297                         return len(UnitData.HEADERS)
298
299         @misc_utils.log_exception(_moduleLogger)
300         def data(self, index, role):
301                 if not index.isValid():
302                         return None
303                 elif role == QtCore.Qt.TextAlignmentRole:
304                         return UnitData.ALIGNMENT[index.column()]
305                 elif role != QtCore.Qt.DisplayRole:
306                         return None
307
308                 item = index.internalPointer()
309                 if isinstance(item, UnitData):
310                         return item.data(index.column())
311                 elif item is UnitData.HEADERS:
312                         return item[index.column()]
313
314         @misc_utils.log_exception(_moduleLogger)
315         def sort(self, column, order = QtCore.Qt.AscendingOrder):
316                 isReverse = order == QtCore.Qt.AscendingOrder
317                 if column == 0:
318                         key_func = lambda item: item.name
319                 elif column in [1, 2]:
320                         key_func = lambda item: item.value
321                 elif column == 3:
322                         key_func = lambda item: item.unit
323                 self._children.sort(key=key_func, reverse = isReverse)
324
325                 self._all_changed()
326
327         @misc_utils.log_exception(_moduleLogger)
328         def flags(self, index):
329                 if not index.isValid():
330                         return QtCore.Qt.NoItemFlags
331
332                 return QtCore.Qt.ItemIsEnabled | QtCore.Qt.ItemIsSelectable
333
334         @misc_utils.log_exception(_moduleLogger)
335         def headerData(self, section, orientation, role):
336                 if orientation == QtCore.Qt.Horizontal and role == QtCore.Qt.DisplayRole:
337                         return UnitData.HEADERS[section]
338
339                 return None
340
341         @misc_utils.log_exception(_moduleLogger)
342         def index(self, row, column, parent):
343                 if not self.hasIndex(row, column, parent):
344                         return QtCore.QModelIndex()
345
346                 if parent.isValid():
347                         return QtCore.QModelIndex()
348
349                 parentItem = UnitData.HEADERS
350                 childItem = self._children[row]
351                 if childItem:
352                         return self.createIndex(row, column, childItem)
353                 else:
354                         return QtCore.QModelIndex()
355
356         @misc_utils.log_exception(_moduleLogger)
357         def parent(self, index):
358                 if not index.isValid():
359                         return QtCore.QModelIndex()
360
361                 childItem = index.internalPointer()
362                 if isinstance(childItem, UnitData):
363                         return QtCore.QModelIndex()
364                 elif childItem is UnitData.HEADERS:
365                         return None
366
367         @misc_utils.log_exception(_moduleLogger)
368         def rowCount(self, parent):
369                 if 0 < parent.column():
370                         return 0
371
372                 if not parent.isValid():
373                         return len(self._children)
374                 else:
375                         return len(self._children)
376
377         def get_unit(self, index):
378                 return self._children[index]
379
380         def index_unit(self, unitName):
381                 for i, child in enumerate(self._children):
382                         if child.name == unitName:
383                                 return i
384                 else:
385                         raise RuntimeError("Unit not found")
386
387         def update_values(self, fromIndex, userInput):
388                 value = self._sanitize_value(userInput)
389                 func, arg = self._children[fromIndex].conversion
390                 base = func.to_base(value, arg)
391                 for i, child in enumerate(self._children):
392                         if i == fromIndex:
393                                 continue
394                         func, arg = child.conversion
395                         newValue = func.from_base(base, arg)
396                         child.update_value(newValue)
397
398                 self._all_changed()
399
400         def _all_changed(self):
401                 topLeft = self.createIndex(0, 1, self._children[0])
402                 bottomRight = self.createIndex(len(self._children)-1, 2, self._children[-1])
403                 self.dataChanged.emit(topLeft, bottomRight)
404
405         def _sanitize_value(self, userEntry):
406                 if self._categoryName == "Computer Numbers":
407                         if userEntry == '':
408                                 value = '0'
409                         else:
410                                 value = userEntry
411                 else:
412                         if userEntry == '':
413                                 value = 0.0
414                         else:
415                                 value = float(userEntry)
416                 return value
417
418
419 class UnitWindow(object):
420
421         def __init__(self, parent, category, app):
422                 self._app = app
423                 self._categoryName = category
424                 self._selectedIndex = 0
425
426                 self._selectedUnitName = QtGui.QLabel()
427                 self._selectedUnitValue = QtGui.QLineEdit()
428                 self._selectedUnitValue.textEdited.connect(self._on_value_edited)
429                 self._selectedUnitSymbol = QtGui.QLabel()
430
431                 self._selectedUnitLayout = QtGui.QHBoxLayout()
432                 self._selectedUnitLayout.addWidget(self._selectedUnitName)
433                 self._selectedUnitLayout.addWidget(self._selectedUnitValue)
434                 self._selectedUnitLayout.addWidget(self._selectedUnitSymbol)
435
436                 self._unitsModel = UnitModel(self._categoryName)
437                 self._unitsView = QtGui.QTreeView()
438                 self._unitsView.setModel(self._unitsModel)
439                 self._unitsView.clicked.connect(self._on_unit_clicked)
440                 self._unitsView.setUniformRowHeights(True)
441                 self._unitsView.header().setSortIndicatorShown(True)
442                 self._unitsView.header().setClickable(True)
443                 self._unitsView.setSortingEnabled(True)
444                 self._unitsView.setAlternatingRowColors(True)
445                 if True:
446                         self._unitsView.setHeaderHidden(True)
447
448                 self._layout = QtGui.QVBoxLayout()
449                 self._layout.addLayout(self._selectedUnitLayout)
450                 self._layout.addWidget(self._unitsView)
451
452                 centralWidget = QtGui.QWidget()
453                 centralWidget.setLayout(self._layout)
454
455                 self._window = QtGui.QMainWindow(parent)
456                 if parent is not None:
457                         self._window.setWindowModality(QtCore.Qt.WindowModal)
458                 self._window.setWindowTitle("%s - %s" % (constants.__pretty_app_name__, category))
459                 self._window.setWindowIcon(QtGui.QIcon(app.appIconPath))
460                 self._window.setCentralWidget(centralWidget)
461
462                 self._select_unit(0)
463                 self._unitsModel.sort(1)
464
465                 self._sortActionGroup = QtGui.QActionGroup(None)
466                 self._sortByNameAction = QtGui.QAction(self._sortActionGroup)
467                 self._sortByNameAction.setText("Sort By Name")
468                 self._sortByNameAction.setStatusTip("Sort the units by name")
469                 self._sortByNameAction.setToolTip("Sort the units by name")
470                 self._sortByValueAction = QtGui.QAction(self._sortActionGroup)
471                 self._sortByValueAction.setText("Sort By Value")
472                 self._sortByValueAction.setStatusTip("Sort the units by value")
473                 self._sortByValueAction.setToolTip("Sort the units by value")
474                 self._sortByUnitAction = QtGui.QAction(self._sortActionGroup)
475                 self._sortByUnitAction.setText("Sort By Unit")
476                 self._sortByUnitAction.setStatusTip("Sort the units by unit")
477                 self._sortByUnitAction.setToolTip("Sort the units by unit")
478
479                 self._sortByValueAction.setChecked(True)
480
481                 viewMenu = self._window.menuBar().addMenu("&View")
482                 viewMenu.addAction(self._app.jumpAction)
483                 viewMenu.addSeparator()
484                 viewMenu.addAction(self._sortByNameAction)
485                 viewMenu.addAction(self._sortByValueAction)
486                 viewMenu.addAction(self._sortByUnitAction)
487
488                 self._sortByNameAction.triggered.connect(self._on_sort_by_name)
489                 self._sortByValueAction.triggered.connect(self._on_sort_by_value)
490                 self._sortByUnitAction.triggered.connect(self._on_sort_by_unit)
491
492                 self._window.show()
493
494         def close(self):
495                 self._window.close()
496
497         def select_unit(self, unitName):
498                 index = self._unitsModel.index_unit(unitName)
499                 self._select_unit(index)
500
501         @misc_utils.log_exception(_moduleLogger)
502         def _on_sort_by_name(self, checked = False):
503                 self._unitsModel.sort(0, QtCore.Qt.DescendingOrder)
504
505         @misc_utils.log_exception(_moduleLogger)
506         def _on_sort_by_value(self, checked = False):
507                 self._unitsModel.sort(1)
508
509         @misc_utils.log_exception(_moduleLogger)
510         def _on_sort_by_unit(self, checked = False):
511                 self._unitsModel.sort(3, QtCore.Qt.DescendingOrder)
512
513         @misc_utils.log_exception(_moduleLogger)
514         def _on_unit_clicked(self, index):
515                 self._select_unit(index.row())
516
517         @misc_utils.log_exception(_moduleLogger)
518         def _on_value_edited(self, *args):
519                 userInput = self._selectedUnitValue.text()
520                 self._unitsModel.update_values(self._selectedIndex, str(userInput))
521
522         def _select_unit(self, index):
523                 unit = self._unitsModel.get_unit(index)
524                 self._selectedUnitName.setText(unit.name)
525                 self._selectedUnitValue.setText(str(unit.value))
526                 self._selectedUnitSymbol.setText(unit.unit)
527
528                 self._selectedIndex = index
529                 qindex = self._unitsModel.createIndex(index, 0, self._unitsModel.get_unit(index))
530                 self._unitsView.scrollTo(qindex)
531
532
533 def run_gonvert():
534         app = QtGui.QApplication([])
535         handle = Gonvert()
536         return app.exec_()
537
538
539 if __name__ == "__main__":
540         logging.basicConfig(level = logging.DEBUG)
541         try:
542                 os.makedirs(constants._data_path_)
543         except OSError, e:
544                 if e.errno != 17:
545                         raise
546
547         val = run_gonvert()
548         sys.exit(val)