19 _moduleLogger = logging.getLogger("gonvert_glade")
21 gettext.bindtextdomain('gonvert', '/usr/share/locale')
22 gettext.textdomain('gonvert')
26 def change_menu_label(widgets, labelname, newtext):
27 item_label = widgets.get_widget(labelname).get_children()[0]
28 item_label.set_text(newtext)
31 class Gonvert(object):
34 os.path.join(os.path.dirname(__file__), "gonvert.glade"),
35 os.path.join(os.path.dirname(__file__), "../data/gonvert.glade"),
36 os.path.join(os.path.dirname(__file__), "../lib/gonvert.glade"),
37 '/usr/lib/gonvert/gonvert.glade',
41 self._unitDataInCategory = None
42 self._calcsuppress = False
43 self._unit_sort_direction = False
44 self._value_sort_direction = False
45 self._units_sort_direction = False
47 self._find_result = [] # empty find result list
48 self._findIndex = 0 # default to find result number zero
50 self._selected_category = '' # preset to no selected category
51 self._selected_units = {} # empty dictionary for later use
53 #check to see if glade file is in current directory (user must be
54 # running from download untar directory)
55 for gladePath in self._glade_files:
56 if os.path.isfile(gladePath):
57 homepath = os.path.dirname(gladePath)
58 pixmapspath = "/".join((homepath, "pixmaps"))
59 widgets = gtk.glade.XML(gladePath)
64 self._mainWindow = widgets.get_widget('mainWindow')
66 change_menu_label(widgets, 'fileMenuItem', _('File'))
67 change_menu_label(widgets, 'exitMenuItem', _('Exit'))
68 change_menu_label(widgets, 'toolsMenuItem', _('Tools'))
69 change_menu_label(widgets, 'clearSelectionMenuItem', _('Clear selections'))
70 change_menu_label(widgets, 'writeUnitsMenuItem', _('Write Units'))
71 change_menu_label(widgets, 'helpMenuItem', _('Help'))
72 change_menu_label(widgets, 'aboutMenuItem', _('About'))
73 change_menu_label(widgets, 'findButton', _('Find'))
75 self._shortlistcheck = widgets.get_widget('shortlistcheck')
76 self._toggleShortList = widgets.get_widget('toggleShortList')
78 self._categoryView = widgets.get_widget('categoryView')
80 self._unitsView = widgets.get_widget('unitsView')
81 self._unitsView.set_property('rules_hint', 1)
82 self._unitsView_selection = self._unitsView.get_selection()
84 self._unitName = widgets.get_widget('unitName')
85 self._unitValue = widgets.get_widget('unitValue')
86 self._previousUnitName = widgets.get_widget('previousUnitName')
87 self._previousUnitValue = widgets.get_widget('previousUnitValue')
88 messagebox = widgets.get_widget('msgbox')
89 messageboxtext = widgets.get_widget('msgboxtext')
91 self._unitSymbol = widgets.get_widget('unitSymbol')
92 self._previousUnitSymbol = widgets.get_widget('previousUnitSymbol')
94 self._unitDescription = widgets.get_widget('unitDescription')
96 self._findEntry = widgets.get_widget('findEntry')
97 self._findLabel = widgets.get_widget('findLabel')
98 findButton = widgets.get_widget('findButton')
99 ToolTips = gtk.Tooltips()
100 ToolTips.set_tip(findButton, _(u'Find unit (F6)'))
102 #insert a self._categoryColumnumn into the units list even though the heading will not be seen
103 renderer = gtk.CellRendererText()
104 self._unitNameColumn = gtk.TreeViewColumn(_('Unit Name'), renderer)
105 self._unitNameColumn.set_property('resizable', 1)
106 self._unitNameColumn.add_attribute(renderer, 'text', 0)
107 self._unitNameColumn.set_clickable(True)
108 self._unitNameColumn.connect("clicked", self._on_click_unit_column)
109 self._unitsView.append_column(self._unitNameColumn)
111 self._unitValueColumn = gtk.TreeViewColumn(_('Value'), renderer)
112 self._unitValueColumn.set_property('resizable', 1)
113 self._unitValueColumn.add_attribute(renderer, 'text', 1)
114 self._unitValueColumn.set_clickable(True)
115 self._unitValueColumn.connect("clicked", self._on_click_unit_column)
116 self._unitsView.append_column(self._unitValueColumn)
118 self._unitSymbolColumn = gtk.TreeViewColumn(_('Units'), renderer)
119 self._unitSymbolColumn.set_property('resizable', 1)
120 self._unitSymbolColumn.add_attribute(renderer, 'text', 2)
121 self._unitSymbolColumn.set_clickable(True)
122 self._unitSymbolColumn.connect("clicked", self._on_click_unit_column)
123 self._unitsView.append_column(self._unitSymbolColumn)
125 self._unitModel = gtk.ListStore(gobject.TYPE_STRING, gobject.TYPE_STRING, gobject.TYPE_STRING)
126 self._sortedUnitModel = gtk.TreeModelSort(self._unitModel)
127 columns = self._get_column_sort_stuff()
128 for columnIndex, (column, sortDirection, col_cmp) in enumerate(columns):
129 self._sortedUnitModel.set_sort_func(columnIndex, col_cmp)
130 self._unitsView.set_model(self._sortedUnitModel)
132 #Insert a column into the category list even though the heading will not be seen
133 renderer = gtk.CellRendererText()
134 self._categoryColumn = gtk.TreeViewColumn('Title', renderer)
135 self._categoryColumn.set_property('resizable', 1)
136 self._categoryColumn.add_attribute(renderer, 'text', 0)
137 self._categoryView.append_column(self._categoryColumn)
139 self._categoryModel = gtk.ListStore(gobject.TYPE_STRING)
140 self._categoryView.set_model(self._categoryModel)
141 #colourize each row differently for easier reading
142 self._categoryView.set_property('rules_hint', 1)
144 #Populate the catagories list
145 for key in unit_data.UNIT_CATEGORIES:
146 iter = self._categoryModel.append()
147 self._categoryModel.set(iter, 0, key)
149 #--------- connections to GUI ----------------
151 "on_exit_menu_activate": self._on_user_exit,
152 "on_main_window_destroy": self._on_user_exit,
153 "on_categoryView_select_row": self._on_click_category,
154 "on_unitValue_changed": self._on_unit_value_changed,
155 "on_previousUnitValue_changed": self._on_previous_unit_value_changed,
156 "on_writeUnitsMenuItem_activate": self._on_user_write_units,
157 "on_findButton_clicked": self._on_find_activate,
158 "on_findEntry_activated": self._on_find_activate,
159 "on_findEntry_changed": self._on_findEntry_changed,
160 "on_aboutMenuItem_activate": self._on_about_clicked,
161 "on_messagebox_ok_clicked": self.messagebox_ok_clicked,
162 "on_clearSelectionMenuItem_activate": self._on_user_clear_selections,
163 "on_unitsView_cursor_changed": self._on_click_unit,
164 "on_shortlistcheck_toggled": self._on_shortlist_changed,
165 "on_toggleShortList_activate": self._on_edit_shortlist,
167 widgets.signal_autoconnect(dic)
169 self._mainWindow.set_title('gonvert- %s - Unit Conversion Utility' % constants.__version__)
170 iconPath = pixmapspath + '/gonvert.png'
171 if os.path.exists(iconPath):
172 self._mainWindow.set_icon(gtk.gdk.pixbuf_new_from_file(iconPath))
174 _moduleLogger.warn("Error: Could not find gonvert icon: %s" % iconPath)
176 self._load_settings()
178 def _load_settings(self):
179 #Restore window size from previously saved settings if it exists and is valid.
180 windowDatPath = "/".join((constants._data_path_, "window.dat"))
181 if os.path.exists(windowDatPath):
182 #Retrieving previous window settings from ~/.gonvert/window.dat
183 saved_window = pickle.load(open(windowDatPath, "r"))
184 #If the 'size' has been stored, then extract size from saved_window.
185 if 'size' in saved_window:
186 a, b = saved_window['size']
187 self._mainWindow.resize(a, b)
189 #Maximize if no previous size was found
190 #self._mainWindow.maximize()
193 #Maximize if no previous window.dat file was found
194 #self._mainWindow.maximize()
197 #Restore selections from previously saved settings if it exists and is valid.
198 historical_catergory_found = False
199 selectionsDatPath = "/".join((constants._data_path_, "selections.dat"))
200 if os.path.exists(selectionsDatPath):
201 #Retrieving previous selections from ~/.gonvert/selections.dat
202 selections = pickle.load(open(selectionsDatPath, 'r'))
203 #Restoring previous selections.
204 #If the 'selected_unts' has been stored, then extract self._selected_units from selections.
205 if 'selected_units' in selections:
206 self._selected_units = selections['selected_units']
207 #Make sure that the 'self._selected_category' has been stored.
208 if 'selected_category' in selections:
209 #Match an available category to the previously selected category.
210 for counter in range(len(unit_data.UNIT_CATEGORIES)):
211 if selections['selected_category'] == unit_data.UNIT_CATEGORIES[counter]:
212 # Restore the previously selected category.
213 self._categoryView.set_cursor(counter, self._categoryColumn, False)
214 self._categoryView.grab_focus()
215 historical_catergory_found = True
217 if not historical_catergory_found:
218 print "Couldn't find saved category, using default."
219 #If historical records were not kept then default to
220 # put the focus on the first category
221 self._categoryView.set_cursor(0, self._categoryColumn, False)
222 self._categoryView.grab_focus()
226 def _save_settings(self):
228 This routine saves the selections to a file, and
229 should therefore only be called when exiting the program.
231 Update selections dictionary which consists of the following keys:
232 'self._selected_category': full name of selected category
233 'self._selected_units': self._selected_units dictionary which contains:
234 [categoryname: #1 displayed unit, #2 displayed unit]
236 #Determine the contents of the selected category row
237 selected, iter = self._categoryView.get_selection().get_selected()
238 self._selected_category = self._categoryModel.get_value(iter, 0)
241 'selected_category': self._selected_category,
242 'selected_units': self._selected_units
244 selectionsDatPath = "/".join((constants._data_path_, "selections.dat"))
245 pickle.dump(selections, open(selectionsDatPath, 'w'))
247 #Get last size of app and save it
249 'size': self._mainWindow.get_size()
251 windowDatPath = "/".join((constants._data_path_, "window.dat"))
252 pickle.dump(window_settings, open(windowDatPath, 'w'))
254 def _clear_find(self):
255 # switch to "new find" state
256 self._find_result = []
259 # Clear our user message
260 self._findLabel.set_text('')
262 def _find_first(self):
263 assert len(self._find_result) == 0
264 assert self._findIndex == 0
265 findString = string.lower(string.strip(self._findEntry.get_text()))
269 # Gather info on all the matching units from all categories
270 for catIndex, category in enumerate(unit_data.UNIT_CATEGORIES):
271 units = unit_data.get_units(category)
272 for unitIndex, unit in enumerate(units):
273 loweredUnit = unit.lower()
274 if loweredUnit in findString or findString in loweredUnit:
275 self._find_result.append((category, unit, catIndex, unitIndex))
277 if not self._find_result:
280 self._update_find_selection()
282 def _find_wrap_around(self):
283 assert 0 < len(self._find_result)
284 assert self._findIndex + 1 == len(self._find_result)
287 self._update_find_selection()
289 def _find_next(self):
290 assert 0 < len(self._find_result)
291 assert self._findIndex + 1 < len(self._find_result)
293 self._update_find_selection()
295 def _update_find_selection(self):
296 assert 0 < len(self._find_result)
298 #check if next find is in a new category (prevent category changes when unnecessary
299 if self._selected_category != self._find_result[self._findIndex][0]:
300 self._categoryView.set_cursor(
301 self._find_result[self._findIndex][2], self._categoryColumn, False
304 self._unitsView.set_cursor(
305 self._find_result[self._findIndex][3], self._unitNameColumn, True
308 def _on_shortlist_changed(self, *args):
310 raise NotImplementedError("%s" % self._shortlistcheck.get_active())
312 _moduleLogger.exception()
314 def _on_edit_shortlist(self, *args):
316 raise NotImplementedError("%s" % self._toggleShortList.get_active())
318 _moduleLogger.exception()
320 def _on_user_clear_selections(self, *args):
322 selectionsDatPath = "/".join((constants._data_path_, "selections.dat"))
323 os.remove(selectionsDatPath)
324 self._selected_units = {}
326 _moduleLogger.exception()
328 def _on_findEntry_changed(self, *args):
330 Clear out find results since the user wants to look for something new
335 _moduleLogger.exception()
337 def _on_find_activate(self, a):
339 check if 'new find' or 'last find' or 'next-find'
341 new-find = run the find algorithm which also selects the first found unit
342 = self._findIndex = 0 and self._find_result = []
344 last-find = restart from top again
345 = self._findIndex = len(self._find_result)
347 next-find = continue to next found location
348 = self._findIndex = 0 and len(self._find_result)>0
351 if len(self._find_result) == 0:
354 if self._findIndex == len(self._find_result)-1:
355 self._find_wrap_around()
359 if not self._find_result:
360 self._findLabel.set_text('Text not found')
362 resultsLeft = len(self._find_result) - self._findIndex - 1
363 self._findLabel.set_text(
364 '%s result(s) left' % (resultsLeft, )
367 _moduleLogger.exception()
369 def _unit_model_cmp(self, sortedModel, leftItr, rightItr):
370 leftUnitText = self._unitModel.get_value(leftItr, 0)
371 rightUnitText = self._unitModel.get_value(rightItr, 0)
372 return cmp(leftUnitText, rightUnitText)
374 def _symbol_model_cmp(self, sortedModel, leftItr, rightItr):
375 leftSymbolText = self._unitModel.get_value(leftItr, 2)
376 rightSymbolText = self._unitModel.get_value(rightItr, 2)
377 return cmp(leftSymbolText, rightSymbolText)
379 def _value_model_cmp(self, sortedModel, leftItr, rightItr):
380 #special sorting exceptions for ascii values (instead of float values)
381 if self._selected_category == "Computer Numbers":
382 leftValue = self._unitModel.get_value(leftItr, 1)
383 rightValue = self._unitModel.get_value(rightItr, 1)
385 leftValueText = self._unitModel.get_value(leftItr, 1)
386 leftValue = float(leftValueText) if leftValueText else 0.0
388 rightValueText = self._unitModel.get_value(rightItr, 1)
389 rightValue = float(rightValueText) if rightValueText else 0.0
390 return cmp(leftValue, rightValue)
392 def _get_column_sort_stuff(self):
394 (self._unitNameColumn, "_unit_sort_direction", self._unit_model_cmp),
395 (self._unitValueColumn, "_value_sort_direction", self._value_model_cmp),
396 (self._unitSymbolColumn, "_units_sort_direction", self._symbol_model_cmp),
400 def _on_click_unit_column(self, col):
402 Sort the contents of the col when the user clicks on the title.
405 #Determine which column requires sorting
406 columns = self._get_column_sort_stuff()
407 for column, directionName, col_cmp in columns:
408 column.set_sort_indicator(False)
409 for columnIndex, (maybeCol, directionName, col_cmp) in enumerate(columns):
411 direction = getattr(self, directionName)
412 gtkDirection = gtk.SORT_ASCENDING if direction else gtk.SORT_DESCENDING
415 self._sortedUnitModel.set_sort_column_id(columnIndex, gtkDirection)
417 # set the visual for sorting
418 col.set_sort_indicator(True)
419 col.set_sort_order(not direction)
421 setattr(self, directionName, not direction)
424 assert False, "Unknown column: %s" % (col.get_title(), )
426 _moduleLogger.exception()
428 def _on_click_category(self, row):
429 #Clear out the description
430 text_model = gtk.TextBuffer(None)
431 self._unitDescription.set_buffer(text_model)
433 #Determine the contents of the selected category row
434 selected, iter = row.get_selection().get_selected()
436 self._selected_category = self._categoryModel.get_value(iter, 0)
438 self._unit_sort_direction = False
439 self._value_sort_direction = False
440 self._units_sort_direction = False
441 self._unitNameColumn.set_sort_indicator(False)
442 self._unitValueColumn.set_sort_indicator(False)
443 self._unitSymbolColumn.set_sort_indicator(False)
445 self._unitDataInCategory = unit_data.UNIT_DESCRIPTIONS[selected.get_value(iter, 0)]
446 keys = self._unitDataInCategory.keys()
448 del keys[0] # do not display .base_unit description key
450 #Fill up the units descriptions and clear the value cells
451 self._unitModel.clear()
453 iter = self._unitModel.append()
454 self._unitModel.set(iter, 0, key, 1, '', 2, self._unitDataInCategory[key][1])
455 self._sortedUnitModel.sort_column_changed()
457 self._unitName.set_text('')
458 self._unitValue.set_text('')
459 self._previousUnitName.set_text('')
460 self._previousUnitValue.set_text('')
461 self._unitSymbol.set_text('')
462 self._previousUnitSymbol.set_text('')
466 def restore_units(self):
467 # Restore the previous historical settings of previously selected units in this newly selected category
468 #Since category has just been clicked, the list will be sorted already.
469 if self._selected_category in self._selected_units:
470 if self._selected_units[self._selected_category][0]:
471 #self._selected_units[self._selected_category] = [selected_unit, self._selected_units[self._selected_category][0]]
473 units = unit_data.UNIT_DESCRIPTIONS[self._selected_category].keys()
475 del units[0] # do not display .base_unit description key
477 #Restore oldest selection first.
478 if self._selected_units[self._selected_category][1]:
481 if unit == self._selected_units[self._selected_category][1]:
482 self._unitsView.set_cursor(unit_no, self._unitNameColumn, True)
485 #Restore newest selection second.
488 if unit == self._selected_units[self._selected_category][0]:
489 self._unitsView.set_cursor(unit_no, self._unitNameColumn, True)
492 # select the text so user can start typing right away
493 self._unitValue.grab_focus()
494 self._unitValue.select_region(0, -1)
496 def _on_click_unit(self, row):
497 self._calcsuppress = True #suppress calculations
499 #Determine the contents of the selected row.
500 selected, iter = self._unitsView.get_selection().get_selected()
502 selected_unit = selected.get_value(iter, 0)
504 unit_spec = self._unitDataInCategory[selected_unit]
506 #Clear out the description
507 text_model = gtk.TextBuffer(None)
508 self._unitDescription.set_buffer(text_model)
510 enditer = text_model.get_end_iter()
511 text_model.insert(enditer, unit_spec[2])
513 if self._unitName.get_text() != selected_unit:
514 self._previousUnitName.set_text(self._unitName.get_text())
515 self._previousUnitValue.set_text(self._unitValue.get_text())
516 if self._unitSymbol.get() == None:
517 self._previousUnitSymbol.set_text('')
519 self._previousUnitSymbol.set_text(self._unitSymbol.get())
520 self._unitName.set_text(selected_unit)
522 self._unitValue.set_text(selected.get_value(iter, 1))
524 self._unitSymbol.set_text(unit_spec[1]) # put units into label text
525 if self._unitValue.get_text() == '':
526 if self._selected_category == "Computer Numbers":
527 self._unitValue.set_text("0")
529 self._unitValue.set_text("0.0")
531 #For historical purposes, record this unit as the most recent one in this category.
532 # Also, if a previous unit exists, then shift that previous unit to oldest unit.
533 if self._selected_category in self._selected_units:
534 if self._selected_units[self._selected_category][0]:
535 self._selected_units[self._selected_category] = [selected_unit, self._selected_units[self._selected_category][0]]
537 self._selected_units[self._selected_category] = [selected_unit, '']
539 # select the text so user can start typing right away
540 self._unitValue.grab_focus()
541 self._unitValue.select_region(0, -1)
543 self._calcsuppress = False #enable calculations
545 def messagebox_ok_clicked(self, a):
548 def _on_user_write_units(self, a):
549 ''"Write the list of categories and units to stdout for documentation purposes.''"
550 messagebox_model = gtk.TextBuffer(None)
551 messageboxtext.set_buffer(messagebox_model)
552 messagebox_model.insert_at_cursor(_(u'The units are being written to stdout. You can capture this printout by starting gonvert from the command line as follows: \n$ gonvert > file.txt'), -1)
554 while gtk.events_pending():
555 gtk.mainiteration(False)
559 print 'gonvert-%s%s' % (
560 constants.__version__,
561 _(u' - Unit Conversion Utility - Convertible units listing: ')
563 for category_key in unit_data.UNIT_CATEGORIES:
564 total_categories = total_categories + 1
565 print category_key, ": "
566 self._unitDataInCategory = unit_data.UNIT_DESCRIPTIONS[category_key]
567 unit_keys = self._unitDataInCategory.keys()
569 del unit_keys[0] # do not display .base_unit description key
570 for unit_key in unit_keys:
571 total_units = total_units + 1
573 print total_categories, ' categories'
574 print total_units, ' units'
576 def _on_unit_value_changed(self, a):
577 if self._calcsuppress:
578 #self._calcsuppress = False
580 # determine if value to be calculated is empty
581 if self._selected_category == "Computer Numbers":
582 if self._unitValue.get_text() == '':
585 value = self._unitValue.get_text()
587 if self._unitValue.get_text() == '':
590 value = float(self._unitValue.get_text())
592 if self._unitName.get_text() != '':
593 func, arg = self._unitDataInCategory[self._unitName.get_text()][0] #retrieve the conversion function and value from the selected unit
594 base = apply(func.to_base, (value, arg, )) #determine the base unit value
596 keys = self._unitDataInCategory.keys()
601 #point to the first row
602 iter = self._unitModel.get_iter_first()
605 #get the formula from the name at the row
606 func, arg = self._unitDataInCategory[self._unitModel.get_value(iter, 0)][0]
608 #set the result in the value column
609 self._unitModel.set(iter, 1, str(apply(func.from_base, (base, arg, ))))
611 #point to the next row in the self._unitModel
612 iter = self._unitModel.iter_next(iter)
614 # if the second row has a unit then update its value
615 if self._previousUnitName.get_text() != '':
616 self._calcsuppress = True
617 func, arg = self._unitDataInCategory[self._previousUnitName.get_text()][0]
618 self._previousUnitValue.set_text(str(apply(func.from_base, (base, arg, ))))
619 self._calcsuppress = False
621 def _on_previous_unit_value_changed(self, a):
622 if self._calcsuppress == True:
623 #self._calcsuppress = False
625 # determine if value to be calculated is empty
626 if self._selected_category == "Computer Numbers":
627 if self._previousUnitValue.get_text() == '':
630 value = self._previousUnitValue.get_text()
632 if self._previousUnitValue.get_text() == '':
635 value = float(self._previousUnitValue.get_text())
637 if self._previousUnitName.get_text() != '':
638 func, arg = self._unitDataInCategory[self._previousUnitName.get_text()][0] #retrieve the conversion function and value from the selected unit
639 base = apply(func.to_base, (value, arg, )) #determine the base unit value
641 keys = self._unitDataInCategory.keys()
646 #point to the first row
647 iter = self._unitModel.get_iter_first()
650 #get the formula from the name at the row
651 func, arg = self._unitDataInCategory[self._unitModel.get_value(iter, 0)][0]
653 #set the result in the value column
654 self._unitModel.set(iter, 1, str(apply(func.from_base, (base, arg, ))))
656 #point to the next row in the self._unitModel
657 iter = self._unitModel.iter_next(iter)
659 # if the second row has a unit then update its value
660 if self._unitName.get_text() != '':
661 self._calcsuppress = True
662 func, arg = self._unitDataInCategory[self._unitName.get_text()][0]
663 self._unitValue.set_text(str(apply(func.from_base, (base, arg, ))))
664 self._calcsuppress = False
666 def _on_about_clicked(self, a):
667 dlg = gtk.AboutDialog()
668 dlg.set_name(constants.__pretty_app_name__)
669 dlg.set_version("%s-%d" % (constants.__version__, constants.__build__))
670 dlg.set_copyright("Copyright 2009 - GPL")
672 dlg.set_website("http://unihedron.com/projects/gonvert/gonvert.php")
673 dlg.set_authors(["Anthony Tekatch <anthony@unihedron.com>", "Ed Page <edpage@byu.net>"])
677 def _on_user_exit(self, *args):
679 self._save_settings()
681 _moduleLogger.exception()
687 logging.basicConfig(level = logging.DEBUG)
689 os.makedirs(constants._data_path_)
698 if __name__ == "__main__":