3aa6d851e180b9c71519046495e99f1471a8efd1
[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 Persist settings
55         # @todo Favorites
56         # @todo Fullscreen support (showFullscreen, showNormal)
57         # @todo Close Window / Quit keyboard shortcuts
58         # @todo Ctrl+l support
59         # @todo Unit conversion window: focus always on input, arrows switch units
60
61         _DATA_PATHS = [
62                 os.path.dirname(__file__),
63                 os.path.join(os.path.dirname(__file__), "../data"),
64                 os.path.join(os.path.dirname(__file__), "../lib"),
65                 '/usr/share/gonvert',
66                 '/usr/lib/gonvert',
67         ]
68
69         def __init__(self):
70                 self._dataPath = ""
71                 for dataPath in self._DATA_PATHS:
72                         appIconPath = os.path.join(dataPath, "pixmaps", "gonvert.png")
73                         if os.path.isfile(appIconPath):
74                                 self._dataPath = dataPath
75                                 break
76                 else:
77                         raise RuntimeError("UI Descriptor not found!")
78                 self._appIconPath = appIconPath
79                 self._recent = []
80
81                 self._jumpWindow = None
82                 self._recentWindow = None
83                 self._catWindow = None
84
85                 self._jumpAction = QtGui.QAction(None)
86                 self._jumpAction.setText("Quick Jump")
87                 self._jumpAction.setStatusTip("Search for a unit and jump straight to it")
88                 self._jumpAction.setToolTip("Search for a unit and jump straight to it")
89                 self._jumpAction.setShortcut(QtGui.QKeySequence("CTRL+j"))
90                 self._jumpAction.triggered.connect(self._on_jump_start)
91
92                 self._recentAction = QtGui.QAction(None)
93                 self._recentAction.setText("Recent Units")
94                 self._recentAction.setStatusTip("View the recent units")
95                 self._recentAction.setToolTip("View the recent units")
96                 self._recentAction.setShortcut(QtGui.QKeySequence("CTRL+r"))
97                 self._recentAction.triggered.connect(self._on_recent_start)
98
99                 self.request_category()
100
101         def request_category(self):
102                 if self._catWindow is not None:
103                         self._catWindow.close()
104                         self._catWindow = None
105                 self._catWindow = CategoryWindow(None, self)
106                 return self._catWindow
107
108         def search_units(self):
109                 if self._jumpWindow is not None:
110                         self._jumpWindow.close()
111                         self._jumpWindow = None
112                 self._jumpWindow = QuickJump(None, self)
113                 return self._jumpWindow
114
115         def show_recent(self):
116                 if self._recentWindow is not None:
117                         self._recentWindow.close()
118                         self._recentWindow = None
119                 self._recentWindow = Recent(None, self)
120                 return self._recentWindow
121
122         def add_recent(self, categoryName, unitName):
123                 catUnit = categoryName, unitName
124                 try:
125                         self._recent.remove(catUnit)
126                 except ValueError:
127                         pass # ignore if its not already in the recent history
128                 self._recent.append(catUnit)
129
130         def get_recent_unit(self, categoryName):
131                 for catName, unitName in reversed(self._recent):
132                         if catName == categoryName:
133                                 return unitName
134                 else:
135                         return ""
136
137         def get_recent(self):
138                 return reversed(self._recent)
139
140         @property
141         def appIconPath(self):
142                 return self._appIconPath
143
144         @property
145         def jumpAction(self):
146                 return self._jumpAction
147
148         @property
149         def recentAction(self):
150                 return self._recentAction
151
152         @misc_utils.log_exception(_moduleLogger)
153         def _on_jump_start(self, checked = False):
154                 self.search_units()
155
156         @misc_utils.log_exception(_moduleLogger)
157         def _on_recent_start(self, checked = False):
158                 self.show_recent()
159
160
161 class CategoryWindow(object):
162
163         def __init__(self, parent, app):
164                 self._app = app
165                 self._unitWindow = None
166
167                 self._categories = QtGui.QTreeWidget()
168                 self._categories.setHeaderLabels(["Categories"])
169                 self._categories.itemClicked.connect(self._on_category_clicked)
170                 self._categories.setHeaderHidden(True)
171                 self._categories.setAlternatingRowColors(True)
172                 for catName in unit_data.UNIT_CATEGORIES:
173                         twi = QtGui.QTreeWidgetItem(self._categories)
174                         twi.setText(0, catName)
175
176                 self._layout = QtGui.QVBoxLayout()
177                 self._layout.addWidget(self._categories)
178
179                 centralWidget = QtGui.QWidget()
180                 centralWidget.setLayout(self._layout)
181
182                 self._window = QtGui.QMainWindow(parent)
183                 if parent is not None:
184                         self._window.setWindowModality(QtCore.Qt.WindowModal)
185                 self._window.setWindowTitle("%s - Categories" % constants.__pretty_app_name__)
186                 self._window.setWindowIcon(QtGui.QIcon(self._app.appIconPath))
187                 self._window.setCentralWidget(centralWidget)
188
189                 viewMenu = self._window.menuBar().addMenu("&View")
190                 viewMenu.addAction(self._app.jumpAction)
191                 viewMenu.addAction(self._app.recentAction)
192
193                 self._window.show()
194
195         def close(self):
196                 if self._unitWindow is not None:
197                         self._unitWindow.close()
198                         self._unitWindow = None
199                 self._window.close()
200
201         def selectCategory(self, categoryName):
202                 if self._unitWindow is not None:
203                         self._unitWindow.close()
204                         self._unitWindow = None
205                 self._unitWindow = UnitWindow(self._window, categoryName, self._app)
206                 return self._unitWindow
207
208         @misc_utils.log_exception(_moduleLogger)
209         def _on_category_clicked(self, item, columnIndex):
210                 categoryName = unicode(item.text(0))
211                 self.selectCategory(categoryName)
212
213
214 class QuickJump(object):
215
216         MINIMAL_ENTRY = 3
217
218         def __init__(self, parent, app):
219                 self._app = app
220
221                 self._searchLabel = QtGui.QLabel("Search:")
222                 self._searchEntry = QtGui.QLineEdit("")
223                 self._searchEntry.textEdited.connect(self._on_search_edited)
224
225                 self._entryLayout = QtGui.QHBoxLayout()
226                 self._entryLayout.addWidget(self._searchLabel)
227                 self._entryLayout.addWidget(self._searchEntry)
228
229                 self._resultsBox = QtGui.QTreeWidget()
230                 self._resultsBox.setHeaderLabels(["Categories", "Units"])
231                 self._resultsBox.setHeaderHidden(True)
232                 self._resultsBox.setAlternatingRowColors(True)
233                 self._resultsBox.itemClicked.connect(self._on_result_clicked)
234
235                 self._layout = QtGui.QVBoxLayout()
236                 self._layout.addLayout(self._entryLayout)
237                 self._layout.addWidget(self._resultsBox)
238
239                 centralWidget = QtGui.QWidget()
240                 centralWidget.setLayout(self._layout)
241
242                 self._window = QtGui.QMainWindow(parent)
243                 if parent is not None:
244                         self._window.setWindowModality(QtCore.Qt.WindowModal)
245                 self._window.setWindowTitle("%s - Quick Jump" % constants.__pretty_app_name__)
246                 self._window.setWindowIcon(QtGui.QIcon(self._app.appIconPath))
247                 self._window.setCentralWidget(centralWidget)
248
249                 self._window.show()
250
251         def close(self):
252                 self._window.close()
253
254         @misc_utils.log_exception(_moduleLogger)
255         def _on_result_clicked(self, item, columnIndex):
256                 categoryName = unicode(item.text(0))
257                 unitName = unicode(item.text(1))
258                 catWindow = self._app.request_category()
259                 unitsWindow = catWindow.selectCategory(categoryName)
260                 unitsWindow.select_unit(unitName)
261                 self.close()
262
263         @misc_utils.log_exception(_moduleLogger)
264         def _on_search_edited(self, *args):
265                 userInput = self._searchEntry.text()
266                 if len(userInput) <  self.MINIMAL_ENTRY:
267                         return
268
269                 self._resultsBox.clear()
270                 lowerInput = str(userInput).lower()
271                 for catIndex, category in enumerate(unit_data.UNIT_CATEGORIES):
272                         units = unit_data.get_units(category)
273                         for unitIndex, unit in enumerate(units):
274                                 loweredUnit = unit.lower()
275                                 if lowerInput in loweredUnit:
276                                         twi = QtGui.QTreeWidgetItem(self._resultsBox)
277                                         twi.setText(0, category)
278                                         twi.setText(1, unit)
279
280
281 class Recent(object):
282
283         def __init__(self, parent, app):
284                 self._app = app
285
286                 self._resultsBox = QtGui.QTreeWidget()
287                 self._resultsBox.setHeaderLabels(["Categories", "Units"])
288                 self._resultsBox.setHeaderHidden(True)
289                 self._resultsBox.setAlternatingRowColors(True)
290                 self._resultsBox.itemClicked.connect(self._on_result_clicked)
291
292                 self._layout = QtGui.QVBoxLayout()
293                 self._layout.addWidget(self._resultsBox)
294
295                 centralWidget = QtGui.QWidget()
296                 centralWidget.setLayout(self._layout)
297
298                 self._window = QtGui.QMainWindow(parent)
299                 if parent is not None:
300                         self._window.setWindowModality(QtCore.Qt.WindowModal)
301                 self._window.setWindowTitle("%s - Recent" % constants.__pretty_app_name__)
302                 self._window.setWindowIcon(QtGui.QIcon(self._app.appIconPath))
303                 self._window.setCentralWidget(centralWidget)
304
305                 for cat, unit in self._app.get_recent():
306                         twi = QtGui.QTreeWidgetItem(self._resultsBox)
307                         twi.setText(0, cat)
308                         twi.setText(1, unit)
309
310                 self._window.show()
311
312         def close(self):
313                 self._window.close()
314
315         @misc_utils.log_exception(_moduleLogger)
316         def _on_result_clicked(self, item, columnIndex):
317                 categoryName = unicode(item.text(0))
318                 unitName = unicode(item.text(1))
319                 catWindow = self._app.request_category()
320                 unitsWindow = catWindow.selectCategory(categoryName)
321                 unitsWindow.select_unit(unitName)
322                 self.close()
323
324
325 class UnitData(object):
326
327         HEADERS = ["Name", "Value", "", "Unit"]
328         ALIGNMENT = [QtCore.Qt.AlignLeft, QtCore.Qt.AlignRight, QtCore.Qt.AlignLeft, QtCore.Qt.AlignLeft]
329
330         def __init__(self, name, unit, description, conversion):
331                 self._name = name
332                 self._unit = unit
333                 self._description = description
334                 self._conversion = conversion
335
336                 self._value = 0.0
337                 self._integerDisplay, self._fractionalDisplay = split_number(self._value)
338
339         @property
340         def name(self):
341                 return self._name
342
343         @property
344         def value(self):
345                 return self._value
346
347         def update_value(self, newValue):
348                 self._value = newValue
349                 self._integerDisplay, self._fractionalDisplay = split_number(newValue)
350
351         @property
352         def unit(self):
353                 return self._unit
354
355         @property
356         def conversion(self):
357                 return self._conversion
358
359         def data(self, column):
360                 try:
361                         return [self._name, self._integerDisplay, self._fractionalDisplay, self._unit][column]
362                 except IndexError:
363                         return None
364
365
366 class UnitModel(QtCore.QAbstractItemModel):
367
368         def __init__(self, categoryName, parent=None):
369                 super(UnitModel, self).__init__(parent)
370                 self._categoryName = categoryName
371                 self._unitData = unit_data.UNIT_DESCRIPTIONS[self._categoryName]
372
373                 self._children = []
374                 for key in unit_data.get_units(self._categoryName):
375                         conversion, unit, description = self._unitData[key]
376                         self._children.append(UnitData(key, unit, description, conversion))
377
378         @misc_utils.log_exception(_moduleLogger)
379         def columnCount(self, parent):
380                 if parent.isValid():
381                         return 0
382                 else:
383                         return len(UnitData.HEADERS)
384
385         @misc_utils.log_exception(_moduleLogger)
386         def data(self, index, role):
387                 if not index.isValid():
388                         return None
389                 elif role == QtCore.Qt.TextAlignmentRole:
390                         return UnitData.ALIGNMENT[index.column()]
391                 elif role != QtCore.Qt.DisplayRole:
392                         return None
393
394                 item = index.internalPointer()
395                 if isinstance(item, UnitData):
396                         return item.data(index.column())
397                 elif item is UnitData.HEADERS:
398                         return item[index.column()]
399
400         @misc_utils.log_exception(_moduleLogger)
401         def sort(self, column, order = QtCore.Qt.AscendingOrder):
402                 isReverse = order == QtCore.Qt.AscendingOrder
403                 if column == 0:
404                         key_func = lambda item: item.name
405                 elif column in [1, 2]:
406                         key_func = lambda item: item.value
407                 elif column == 3:
408                         key_func = lambda item: item.unit
409                 self._children.sort(key=key_func, reverse = isReverse)
410
411                 self._all_changed()
412
413         @misc_utils.log_exception(_moduleLogger)
414         def flags(self, index):
415                 if not index.isValid():
416                         return QtCore.Qt.NoItemFlags
417
418                 return QtCore.Qt.ItemIsEnabled | QtCore.Qt.ItemIsSelectable
419
420         @misc_utils.log_exception(_moduleLogger)
421         def headerData(self, section, orientation, role):
422                 if orientation == QtCore.Qt.Horizontal and role == QtCore.Qt.DisplayRole:
423                         return UnitData.HEADERS[section]
424
425                 return None
426
427         @misc_utils.log_exception(_moduleLogger)
428         def index(self, row, column, parent):
429                 if not self.hasIndex(row, column, parent):
430                         return QtCore.QModelIndex()
431
432                 if parent.isValid():
433                         return QtCore.QModelIndex()
434
435                 parentItem = UnitData.HEADERS
436                 childItem = self._children[row]
437                 if childItem:
438                         return self.createIndex(row, column, childItem)
439                 else:
440                         return QtCore.QModelIndex()
441
442         @misc_utils.log_exception(_moduleLogger)
443         def parent(self, index):
444                 if not index.isValid():
445                         return QtCore.QModelIndex()
446
447                 childItem = index.internalPointer()
448                 if isinstance(childItem, UnitData):
449                         return QtCore.QModelIndex()
450                 elif childItem is UnitData.HEADERS:
451                         return None
452
453         @misc_utils.log_exception(_moduleLogger)
454         def rowCount(self, parent):
455                 if 0 < parent.column():
456                         return 0
457
458                 if not parent.isValid():
459                         return len(self._children)
460                 else:
461                         return len(self._children)
462
463         def get_unit(self, index):
464                 return self._children[index]
465
466         def index_unit(self, unitName):
467                 for i, child in enumerate(self._children):
468                         if child.name == unitName:
469                                 return i
470                 else:
471                         raise RuntimeError("Unit not found")
472
473         def update_values(self, fromIndex, userInput):
474                 value = self._sanitize_value(userInput)
475                 func, arg = self._children[fromIndex].conversion
476                 base = func.to_base(value, arg)
477                 for i, child in enumerate(self._children):
478                         if i == fromIndex:
479                                 continue
480                         func, arg = child.conversion
481                         newValue = func.from_base(base, arg)
482                         child.update_value(newValue)
483
484                 self._all_changed()
485
486         def _all_changed(self):
487                 topLeft = self.createIndex(0, 1, self._children[0])
488                 bottomRight = self.createIndex(len(self._children)-1, 2, self._children[-1])
489                 self.dataChanged.emit(topLeft, bottomRight)
490
491         def _sanitize_value(self, userEntry):
492                 if self._categoryName == "Computer Numbers":
493                         if userEntry == '':
494                                 value = '0'
495                         else:
496                                 value = userEntry
497                 else:
498                         if userEntry == '':
499                                 value = 0.0
500                         else:
501                                 value = float(userEntry)
502                 return value
503
504
505 class UnitWindow(object):
506
507         def __init__(self, parent, category, app):
508                 self._app = app
509                 self._categoryName = category
510                 self._selectedIndex = 0
511
512                 self._selectedUnitName = QtGui.QLabel()
513                 self._selectedUnitValue = QtGui.QLineEdit()
514                 self._selectedUnitValue.textEdited.connect(self._on_value_edited)
515                 self._selectedUnitSymbol = QtGui.QLabel()
516
517                 self._selectedUnitLayout = QtGui.QHBoxLayout()
518                 self._selectedUnitLayout.addWidget(self._selectedUnitName)
519                 self._selectedUnitLayout.addWidget(self._selectedUnitValue)
520                 self._selectedUnitLayout.addWidget(self._selectedUnitSymbol)
521
522                 self._unitsModel = UnitModel(self._categoryName)
523                 self._unitsView = QtGui.QTreeView()
524                 self._unitsView.setModel(self._unitsModel)
525                 self._unitsView.clicked.connect(self._on_unit_clicked)
526                 self._unitsView.setUniformRowHeights(True)
527                 self._unitsView.header().setSortIndicatorShown(True)
528                 self._unitsView.header().setClickable(True)
529                 self._unitsView.setSortingEnabled(True)
530                 self._unitsView.setAlternatingRowColors(True)
531                 if True:
532                         self._unitsView.setHeaderHidden(True)
533
534                 self._layout = QtGui.QVBoxLayout()
535                 self._layout.addLayout(self._selectedUnitLayout)
536                 self._layout.addWidget(self._unitsView)
537
538                 centralWidget = QtGui.QWidget()
539                 centralWidget.setLayout(self._layout)
540
541                 self._window = QtGui.QMainWindow(parent)
542                 if parent is not None:
543                         self._window.setWindowModality(QtCore.Qt.WindowModal)
544                 self._window.setWindowTitle("%s - %s" % (constants.__pretty_app_name__, category))
545                 self._window.setWindowIcon(QtGui.QIcon(app.appIconPath))
546                 self._window.setCentralWidget(centralWidget)
547
548                 defaultUnitName = self._app.get_recent_unit(self._categoryName)
549                 if defaultUnitName:
550                         self.select_unit(defaultUnitName)
551                 else:
552                         self._select_unit(0)
553                 self._unitsModel.sort(1)
554
555                 self._sortActionGroup = QtGui.QActionGroup(None)
556                 self._sortByNameAction = QtGui.QAction(self._sortActionGroup)
557                 self._sortByNameAction.setText("Sort By Name")
558                 self._sortByNameAction.setStatusTip("Sort the units by name")
559                 self._sortByNameAction.setToolTip("Sort the units by name")
560                 self._sortByValueAction = QtGui.QAction(self._sortActionGroup)
561                 self._sortByValueAction.setText("Sort By Value")
562                 self._sortByValueAction.setStatusTip("Sort the units by value")
563                 self._sortByValueAction.setToolTip("Sort the units by value")
564                 self._sortByUnitAction = QtGui.QAction(self._sortActionGroup)
565                 self._sortByUnitAction.setText("Sort By Unit")
566                 self._sortByUnitAction.setStatusTip("Sort the units by unit")
567                 self._sortByUnitAction.setToolTip("Sort the units by unit")
568
569                 self._sortByValueAction.setChecked(True)
570
571                 viewMenu = self._window.menuBar().addMenu("&View")
572                 viewMenu.addAction(self._app.jumpAction)
573                 viewMenu.addAction(self._app.recentAction)
574                 viewMenu.addSeparator()
575                 viewMenu.addAction(self._sortByNameAction)
576                 viewMenu.addAction(self._sortByValueAction)
577                 viewMenu.addAction(self._sortByUnitAction)
578
579                 self._sortByNameAction.triggered.connect(self._on_sort_by_name)
580                 self._sortByValueAction.triggered.connect(self._on_sort_by_value)
581                 self._sortByUnitAction.triggered.connect(self._on_sort_by_unit)
582
583                 self._window.show()
584
585         def close(self):
586                 self._window.close()
587
588         def select_unit(self, unitName):
589                 index = self._unitsModel.index_unit(unitName)
590                 self._select_unit(index)
591
592         @misc_utils.log_exception(_moduleLogger)
593         def _on_sort_by_name(self, checked = False):
594                 self._unitsModel.sort(0, QtCore.Qt.DescendingOrder)
595
596         @misc_utils.log_exception(_moduleLogger)
597         def _on_sort_by_value(self, checked = False):
598                 self._unitsModel.sort(1)
599
600         @misc_utils.log_exception(_moduleLogger)
601         def _on_sort_by_unit(self, checked = False):
602                 self._unitsModel.sort(3, QtCore.Qt.DescendingOrder)
603
604         @misc_utils.log_exception(_moduleLogger)
605         def _on_unit_clicked(self, index):
606                 self._select_unit(index.row())
607
608         @misc_utils.log_exception(_moduleLogger)
609         def _on_value_edited(self, *args):
610                 userInput = self._selectedUnitValue.text()
611                 self._unitsModel.update_values(self._selectedIndex, str(userInput))
612
613         def _select_unit(self, index):
614                 unit = self._unitsModel.get_unit(index)
615                 self._selectedUnitName.setText(unit.name)
616                 self._selectedUnitValue.setText(str(unit.value))
617                 self._selectedUnitSymbol.setText(unit.unit)
618
619                 self._selectedIndex = index
620                 qindex = self._unitsModel.createIndex(index, 0, self._unitsModel.get_unit(index))
621                 self._unitsView.scrollTo(qindex)
622                 self._app.add_recent(self._categoryName, self._unitsModel.get_unit(index).name)
623
624
625 def run_gonvert():
626         app = QtGui.QApplication([])
627         handle = Gonvert()
628         return app.exec_()
629
630
631 if __name__ == "__main__":
632         logging.basicConfig(level = logging.DEBUG)
633         try:
634                 os.makedirs(constants._data_path_)
635         except OSError, e:
636                 if e.errno != 17:
637                         raise
638
639         val = run_gonvert()
640         sys.exit(val)