7330c4a4549094f1510c5823c77aabd772d4f32c
[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
90                 self.request_category()
91
92         def request_category(self):
93                 if self._catWindow is not None:
94                         self._catWindow.close()
95                         self._catWindow = None
96                 self._catWindow = CategoryWindow(None, self)
97                 return self._catWindow
98
99         def search_units(self):
100                 if self._jumpWindow is not None:
101                         self._jumpWindow.close()
102                         self._jumpWindow = None
103                 self._jumpWindow = QuickJump(None, self)
104                 return self._jumpWindow
105
106         @property
107         def appIconPath(self):
108                 return self._appIconPath
109
110         @property
111         def jumpAction(self):
112                 return self._jumpAction
113
114
115 class CategoryWindow(object):
116
117         def __init__(self, parent, app):
118                 self._app = app
119                 self._unitWindow = None
120
121                 self._categories = QtGui.QTreeWidget()
122                 self._categories.setHeaderLabels(["Categories"])
123                 self._categories.itemClicked.connect(self._on_category_clicked)
124                 self._categories.setHeaderHidden(True)
125                 for catName in unit_data.UNIT_CATEGORIES:
126                         twi = QtGui.QTreeWidgetItem(self._categories)
127                         twi.setText(0, catName)
128
129                 self._layout = QtGui.QVBoxLayout()
130                 self._layout.addWidget(self._categories)
131
132                 centralWidget = QtGui.QWidget()
133                 centralWidget.setLayout(self._layout)
134
135                 self._window = QtGui.QMainWindow(parent)
136                 if parent is not None:
137                         self._window.setWindowModality(QtCore.Qt.WindowModal)
138                 self._window.setWindowTitle("%s - Categories" % constants.__pretty_app_name__)
139                 self._window.setWindowIcon(QtGui.QIcon(self._app.appIconPath))
140                 self._window.setCentralWidget(centralWidget)
141
142                 viewMenu = self._window.menuBar().addMenu("&View")
143                 viewMenu.addAction(self._app.jumpAction)
144
145                 self._app.jumpAction.triggered.connect(self._on_jump_start)
146
147                 self._window.show()
148
149         def close(self):
150                 self._window.close()
151
152         def selectCategory(self, categoryName):
153                 if self._unitWindow is not None:
154                         self._unitWindow.close()
155                         self._unitWindow = None
156                 self._unitWindow = UnitWindow(self._window, categoryName, self._app)
157                 return self._unitWindow
158
159         @misc_utils.log_exception(_moduleLogger)
160         def _on_jump_start(self, checked = False):
161                 self._app.search_units()
162
163         @misc_utils.log_exception(_moduleLogger)
164         def _on_category_clicked(self, item, columnIndex):
165                 categoryName = unicode(item.text(0))
166                 self.selectCategory(categoryName)
167
168
169 class QuickJump(object):
170
171         MINIMAL_ENTRY = 3
172
173         def __init__(self, parent, app):
174                 self._app = app
175
176                 self._searchLabel = QtGui.QLabel("Search:")
177                 self._searchEntry = QtGui.QLineEdit("")
178                 self._searchEntry.textEdited.connect(self._on_search_edited)
179
180                 self._entryLayout = QtGui.QHBoxLayout()
181                 self._entryLayout.addWidget(self._searchLabel)
182                 self._entryLayout.addWidget(self._searchEntry)
183
184                 self._resultsBox = QtGui.QTreeWidget()
185                 self._resultsBox.setHeaderLabels(["Categories", "Units"])
186                 self._resultsBox.setHeaderHidden(True)
187                 self._resultsBox.itemClicked.connect(self._on_result_clicked)
188
189                 self._layout = QtGui.QVBoxLayout()
190                 self._layout.addLayout(self._entryLayout)
191                 self._layout.addWidget(self._resultsBox)
192
193                 centralWidget = QtGui.QWidget()
194                 centralWidget.setLayout(self._layout)
195
196                 self._window = QtGui.QMainWindow(parent)
197                 if parent is not None:
198                         self._window.setWindowModality(QtCore.Qt.WindowModal)
199                 self._window.setWindowTitle("%s - Quick Jump" % constants.__pretty_app_name__)
200                 self._window.setWindowIcon(QtGui.QIcon(self._app.appIconPath))
201                 self._window.setCentralWidget(centralWidget)
202
203                 self._window.show()
204
205         def close(self):
206                 self._window.close()
207
208         @misc_utils.log_exception(_moduleLogger)
209         def _on_result_clicked(self, item, columnIndex):
210                 categoryName = unicode(item.text(0))
211                 unitName = unicode(item.text(1))
212                 catWindow = self._app.request_category()
213                 unitsWindow = catWindow.selectCategory(categoryName)
214                 unitsWindow.select_unit(unitName)
215
216         @misc_utils.log_exception(_moduleLogger)
217         def _on_search_edited(self, *args):
218                 userInput = self._searchEntry.text()
219                 if len(userInput) <  self.MINIMAL_ENTRY:
220                         return
221
222                 lowerInput = str(userInput).lower()
223                 for catIndex, category in enumerate(unit_data.UNIT_CATEGORIES):
224                         units = unit_data.get_units(category)
225                         for unitIndex, unit in enumerate(units):
226                                 loweredUnit = unit.lower()
227                                 if lowerInput in loweredUnit:
228                                         twi = QtGui.QTreeWidgetItem(self._resultsBox)
229                                         twi.setText(0, category)
230                                         twi.setText(1, unit)
231
232
233 class UnitData(object):
234
235         HEADERS = ["Name", "Value", "", "Unit"]
236         ALIGNMENT = [QtCore.Qt.AlignLeft, QtCore.Qt.AlignRight, QtCore.Qt.AlignLeft, QtCore.Qt.AlignLeft]
237
238         def __init__(self, name, unit, description, conversion):
239                 self._name = name
240                 self._unit = unit
241                 self._description = description
242                 self._conversion = conversion
243
244                 self._value = 0.0
245                 self._integerDisplay, self._fractionalDisplay = split_number(self._value)
246
247         @property
248         def name(self):
249                 return self._name
250
251         @property
252         def value(self):
253                 return self._value
254
255         def update_value(self, newValue):
256                 self._value = newValue
257                 self._integerDisplay, self._fractionalDisplay = split_number(newValue)
258
259         @property
260         def unit(self):
261                 return self._unit
262
263         @property
264         def conversion(self):
265                 return self._conversion
266
267         def data(self, column):
268                 try:
269                         return [self._name, self._integerDisplay, self._fractionalDisplay, self._unit][column]
270                 except IndexError:
271                         return None
272
273
274 class UnitModel(QtCore.QAbstractItemModel):
275
276         def __init__(self, categoryName, parent=None):
277                 super(UnitModel, self).__init__(parent)
278                 self._categoryName = categoryName
279                 self._unitData = unit_data.UNIT_DESCRIPTIONS[self._categoryName]
280
281                 self._children = []
282                 for key in unit_data.get_units(self._categoryName):
283                         conversion, unit, description = self._unitData[key]
284                         self._children.append(UnitData(key, unit, description, conversion))
285
286         @misc_utils.log_exception(_moduleLogger)
287         def columnCount(self, parent):
288                 if parent.isValid():
289                         return 0
290                 else:
291                         return len(UnitData.HEADERS)
292
293         @misc_utils.log_exception(_moduleLogger)
294         def data(self, index, role):
295                 if not index.isValid():
296                         return None
297                 elif role == QtCore.Qt.TextAlignmentRole:
298                         return UnitData.ALIGNMENT[index.column()]
299                 elif role != QtCore.Qt.DisplayRole:
300                         return None
301
302                 item = index.internalPointer()
303                 if isinstance(item, UnitData):
304                         return item.data(index.column())
305                 elif item is UnitData.HEADERS:
306                         return item[index.column()]
307
308         @misc_utils.log_exception(_moduleLogger)
309         def sort(self, column, order = QtCore.Qt.AscendingOrder):
310                 isReverse = order == QtCore.Qt.AscendingOrder
311                 if column == 0:
312                         key_func = lambda item: item.name
313                 elif column in [1, 2]:
314                         key_func = lambda item: item.value
315                 elif column == 3:
316                         key_func = lambda item: item.unit
317                 self._children.sort(key=key_func, reverse = isReverse)
318
319                 self._all_changed()
320
321         @misc_utils.log_exception(_moduleLogger)
322         def flags(self, index):
323                 if not index.isValid():
324                         return QtCore.Qt.NoItemFlags
325
326                 return QtCore.Qt.ItemIsEnabled | QtCore.Qt.ItemIsSelectable
327
328         @misc_utils.log_exception(_moduleLogger)
329         def headerData(self, section, orientation, role):
330                 if orientation == QtCore.Qt.Horizontal and role == QtCore.Qt.DisplayRole:
331                         return UnitData.HEADERS[section]
332
333                 return None
334
335         @misc_utils.log_exception(_moduleLogger)
336         def index(self, row, column, parent):
337                 if not self.hasIndex(row, column, parent):
338                         return QtCore.QModelIndex()
339
340                 if parent.isValid():
341                         return QtCore.QModelIndex()
342
343                 parentItem = UnitData.HEADERS
344                 childItem = self._children[row]
345                 if childItem:
346                         return self.createIndex(row, column, childItem)
347                 else:
348                         return QtCore.QModelIndex()
349
350         @misc_utils.log_exception(_moduleLogger)
351         def parent(self, index):
352                 if not index.isValid():
353                         return QtCore.QModelIndex()
354
355                 childItem = index.internalPointer()
356                 if isinstance(childItem, UnitData):
357                         return QtCore.QModelIndex()
358                 elif childItem is UnitData.HEADERS:
359                         return None
360
361         @misc_utils.log_exception(_moduleLogger)
362         def rowCount(self, parent):
363                 if 0 < parent.column():
364                         return 0
365
366                 if not parent.isValid():
367                         return len(self._children)
368                 else:
369                         return len(self._children)
370
371         def get_unit(self, index):
372                 return self._children[index]
373
374         def index_unit(self, unitName):
375                 for i, child in enumerate(self._children):
376                         if child.name == unitName:
377                                 return i
378                 else:
379                         raise RuntimeError("Unit not found")
380
381         def update_values(self, fromIndex, userInput):
382                 value = self._sanitize_value(userInput)
383                 func, arg = self._children[fromIndex].conversion
384                 base = func.to_base(value, arg)
385                 for i, child in enumerate(self._children):
386                         if i == fromIndex:
387                                 continue
388                         func, arg = child.conversion
389                         newValue = func.from_base(base, arg)
390                         child.update_value(newValue)
391
392                 self._all_changed()
393
394         def _all_changed(self):
395                 topLeft = self.createIndex(0, 1, self._children[0])
396                 bottomRight = self.createIndex(len(self._children)-1, 2, self._children[-1])
397                 self.dataChanged.emit(topLeft, bottomRight)
398
399         def _sanitize_value(self, userEntry):
400                 if self._categoryName == "Computer Numbers":
401                         if userEntry == '':
402                                 value = '0'
403                         else:
404                                 value = userEntry
405                 else:
406                         if userEntry == '':
407                                 value = 0.0
408                         else:
409                                 value = float(userEntry)
410                 return value
411
412
413 class UnitWindow(object):
414
415         def __init__(self, parent, category, app):
416                 self._app = app
417                 self._categoryName = category
418                 self._selectedIndex = 0
419
420                 self._selectedUnitName = QtGui.QLabel()
421                 self._selectedUnitValue = QtGui.QLineEdit()
422                 self._selectedUnitValue.textEdited.connect(self._on_value_edited)
423                 self._selectedUnitSymbol = QtGui.QLabel()
424
425                 self._selectedUnitLayout = QtGui.QHBoxLayout()
426                 self._selectedUnitLayout.addWidget(self._selectedUnitName)
427                 self._selectedUnitLayout.addWidget(self._selectedUnitValue)
428                 self._selectedUnitLayout.addWidget(self._selectedUnitSymbol)
429
430                 self._unitsModel = UnitModel(self._categoryName)
431                 self._unitsView = QtGui.QTreeView()
432                 self._unitsView.setModel(self._unitsModel)
433                 self._unitsView.clicked.connect(self._on_unit_clicked)
434                 self._unitsView.setUniformRowHeights(True)
435                 self._unitsView.header().setSortIndicatorShown(True)
436                 self._unitsView.header().setClickable(True)
437                 self._unitsView.setSortingEnabled(True)
438                 if True:
439                         self._unitsView.setHeaderHidden(True)
440
441                 self._layout = QtGui.QVBoxLayout()
442                 self._layout.addLayout(self._selectedUnitLayout)
443                 self._layout.addWidget(self._unitsView)
444
445                 centralWidget = QtGui.QWidget()
446                 centralWidget.setLayout(self._layout)
447
448                 self._window = QtGui.QMainWindow(parent)
449                 if parent is not None:
450                         self._window.setWindowModality(QtCore.Qt.WindowModal)
451                 self._window.setWindowTitle("%s - %s" % (constants.__pretty_app_name__, category))
452                 self._window.setWindowIcon(QtGui.QIcon(app.appIconPath))
453                 self._window.setCentralWidget(centralWidget)
454
455                 self._select_unit(0)
456
457                 self._sortActionGroup = QtGui.QActionGroup(None)
458                 self._sortByNameAction = QtGui.QAction(self._sortActionGroup)
459                 self._sortByNameAction.setText("Sort By Name")
460                 self._sortByNameAction.setStatusTip("Sort the units by name")
461                 self._sortByNameAction.setToolTip("Sort the units by name")
462                 self._sortByValueAction = QtGui.QAction(self._sortActionGroup)
463                 self._sortByValueAction.setText("Sort By Value")
464                 self._sortByValueAction.setStatusTip("Sort the units by value")
465                 self._sortByValueAction.setToolTip("Sort the units by value")
466                 self._sortByUnitAction = QtGui.QAction(self._sortActionGroup)
467                 self._sortByUnitAction.setText("Sort By Unit")
468                 self._sortByUnitAction.setStatusTip("Sort the units by unit")
469                 self._sortByUnitAction.setToolTip("Sort the units by unit")
470
471                 viewMenu = self._window.menuBar().addMenu("&View")
472                 viewMenu.addAction(self._app.jumpAction)
473                 viewMenu.addSeparator()
474                 viewMenu.addAction(self._sortByNameAction)
475                 viewMenu.addAction(self._sortByValueAction)
476                 viewMenu.addAction(self._sortByUnitAction)
477
478                 self._app.jumpAction.triggered.connect(self._on_jump_start)
479                 self._sortByNameAction.triggered.connect(self._on_sort_by_name)
480                 self._sortByValueAction.triggered.connect(self._on_sort_by_value)
481                 self._sortByUnitAction.triggered.connect(self._on_sort_by_unit)
482
483                 self._window.show()
484
485         def close(self):
486                 self._window.close()
487
488         def select_unit(self, unitName):
489                 index = self._unitsModel.index_unit(unitName)
490                 self._select_unit(index)
491
492         @misc_utils.log_exception(_moduleLogger)
493         def _on_sort_by_name(self, checked = False):
494                 self._unitsModel.sort(0, QtCore.Qt.DescendingOrder)
495
496         @misc_utils.log_exception(_moduleLogger)
497         def _on_sort_by_value(self, checked = False):
498                 self._unitsModel.sort(1)
499
500         @misc_utils.log_exception(_moduleLogger)
501         def _on_sort_by_unit(self, checked = False):
502                 self._unitsModel.sort(3, QtCore.Qt.DescendingOrder)
503
504         @misc_utils.log_exception(_moduleLogger)
505         def _on_jump_start(self, checked = False):
506                 self._app.search_units()
507
508         @misc_utils.log_exception(_moduleLogger)
509         def _on_unit_clicked(self, index):
510                 self._select_unit(index.row())
511
512         @misc_utils.log_exception(_moduleLogger)
513         def _on_value_edited(self, *args):
514                 userInput = self._selectedUnitValue.text()
515                 self._unitsModel.update_values(self._selectedIndex, str(userInput))
516
517         def _select_unit(self, index):
518                 unit = self._unitsModel.get_unit(index)
519                 self._selectedUnitName.setText(unit.name)
520                 self._selectedUnitValue.setText(str(unit.value))
521                 self._selectedUnitSymbol.setText(unit.unit)
522
523                 self._selectedIndex = index
524                 qindex = self._unitsModel.createIndex(index, 0, self._unitsModel.get_unit(index))
525                 self._unitsView.scrollTo(qindex)
526
527
528 def run_gonvert():
529         app = QtGui.QApplication([])
530         handle = Gonvert()
531         return app.exec_()
532
533
534 if __name__ == "__main__":
535         logging.basicConfig(level = logging.DEBUG)
536         try:
537                 os.makedirs(constants._data_path_)
538         except OSError, e:
539                 if e.errno != 17:
540                         raise
541
542         val = run_gonvert()
543         sys.exit(val)