class ChecksController(BaseController):
"""Controller for quality checks."""
__gtype_name__ = 'ChecksController'
__gsignals__ = {
'checker-set': (SIGNAL_RUN_FIRST, None, (object,)),
'unit-checked': (SIGNAL_RUN_FIRST, None, (object, object, object))
}
CHECK_TIMEOUT = 500
"""Time to wait before performing checks on the current unit."""
# INITIALIZERS #
def __init__(self, main_controller):
GObjectWrapper.__init__(self)
self.main_controller = main_controller
self.main_controller.checks_controller = self
self.store_controller = main_controller.store_controller
main_controller.store_controller.connect('store-loaded', self._on_store_loaded)
main_controller.unit_controller.connect('unit-modified', self._on_unit_modified)
if main_controller.lang_controller:
main_controller.lang_controller.connect('target-lang-changed', self._on_target_lang_changed)
else:
main_controller.connect('controller-registered', self._on_controller_registered)
self._check_timer_active = False
self.checker_info = {
# XXX: Add other checkers below with a localisable string as key
# (used on the GUI) and a checker class as the value.
_('Default'): checks.StandardChecker,
_('OpenOffice'): checks.OpenOfficeChecker,
_('Mozilla'): checks.MozillaChecker,
_('Drupal'): checks.DrupalChecker,
_('GNOME'): checks.GnomeChecker,
_('KDE'): checks.KdeChecker,
}
self._checker_menu_items = {}
self._cursor_connection = ()
self.last_unit = None
self.projview = ChecksProjectView(self)
self.unitview = ChecksUnitView(self)
self.projview.show()
self.unitview.show()
# ACCESSORS #
def get_checker(self):
return self.store_controller.get_store_checker()
def set_default_checker(self):
self.set_checker_by_name(_('Default'))
def set_checker_by_name(self, name):
target_lang = self.main_controller.lang_controller.target_lang.code
if not target_lang:
target_lang = None
checker = self.checker_info[name]()
checker.config.updatetargetlanguage(target_lang)
self.store_controller.update_store_stats(checker=checker)
self.emit('checker-set', self.get_checker())
self.projview.set_checker_name(name)
if self.main_controller.unit_controller.current_unit:
self.check_unit(self.main_controller.unit_controller.current_unit)
# METHODS #
def check_unit(self, unit):
checker = self.get_checker()
if not checker:
logging.debug('No checker instantiated :(')
return
self.last_failures = checker.run_filters(unit)
if self.last_failures:
logging.debug('Failures: %s' % (self.last_failures))
self.unitview.update(self.last_failures)
self.emit('unit-checked', unit, checker, self.last_failures)
return self.last_failures
def _check_timer_expired(self, unit):
self._check_timer_active = False
if unit is not self.last_unit:
return
self.check_unit(unit)
def _start_check_timer(self):
if self._check_timer_active:
return
self._check_timer_active = True
timeout_add(self.CHECK_TIMEOUT, self._check_timer_expired, self.last_unit)
def get_check_name(self, check):
"""Return the human readable form of the given check name."""
name = check_names.get(check, None)
if not name and check.startswith('check-'):
check = check[len('check-'):]
name = check_names.get(check, None)
if not name:
name = check
return name
# EVENT HANDLERS #
def _on_controller_registered(self, main_controller, controller):
if controller is main_controller.lang_controller:
controller.connect('target-lang-changed', self._on_target_lang_changed)
def _on_cursor_changed(self, cursor):
self.last_unit = cursor.deref()
self.check_unit(self.last_unit)
def _on_target_lang_changed(self, lang_controller, langcode):
current_checker = self.get_checker()
if current_checker:
current_checker.config.updatetargetlanguage(langcode)
if self.last_unit:
self.check_unit(self.last_unit)
def _on_store_loaded(self, store_controller):
self.set_default_checker()
if self._cursor_connection:
widget, connect_id = self._cursor_connection
widget.disconnect(connect_id)
self._cursor_connection = (
store_controller.cursor,
store_controller.cursor.connect('cursor-changed', self._on_cursor_changed)
)
self._on_cursor_changed(store_controller.cursor)
def _on_unit_modified(self, unit_controller, unit):
self._start_check_timer()
