gramps/src/DateHandler.py

#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2004  Donald N. Allingham
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
#

# $Id$

"""
Class handling language-specific selection for date parser and displayer.
"""

#-------------------------------------------------------------------------
#
# Standard python modules
#
#-------------------------------------------------------------------------
import os
import locale

#-------------------------------------------------------------------------
#
# GRAMPS modules
#
#-------------------------------------------------------------------------
import GrampsGconfKeys
import DateParser
import DateDisplay

#-------------------------------------------------------------------------
#
# Constants 
#
#-------------------------------------------------------------------------
_lang = locale.getlocale(locale.LC_TIME)[0]

_lang_to_parser = {
    'C'      : DateParser.DateParser,
    'en_US'  : DateParser.DateParser,
    'en_GB'  : DateParser.DateParser,
    'en_AU'  : DateParser.DateParser,
    'en_CA'  : DateParser.DateParser,
    'en_SE'  : DateParser.DateParser,
    'en'     : DateParser.DateParser,
    }

_lang_to_display = {
    'C'      : DateDisplay.DateDisplay,
    'en_US'  : DateDisplay.DateDisplay,
    'en_GB'  : DateDisplay.DateDisplay,
    'en_AU'  : DateDisplay.DateDisplay,
    'en_CA'  : DateDisplay.DateDisplay,
    'en_SE'  : DateDisplay.DateDisplay,
    'en'     : DateDisplay.DateDisplay,
    }

#-------------------------------------------------------------------------
#
# Functions 
#
#-------------------------------------------------------------------------
def create_parser():
    """
    Creates a new date parser class, based on the current locale.

    @returns: DateParser class specific to the locale specific. If
    no parser exists for the current locale, the English language
    parser is returned.
    @rtype: DateParser
    """
    try:
        return _lang_to_parser[_lang]()
    except:
        import traceback
        traceback.print_stack()
        print "Date parser for",_lang,"not available"
        return DateParser.DateParser()

def create_display():
    """
    Creates a new date displayer class, based on the current locale.

    @returns: DateDisplay class specific to the locale specific. If
    no parser exists for the current locale, the English language
    parser is returned.
    @rtype: DateDisplay
    """
    try:
        val = GrampsGconfKeys.get_date_format(_lang_to_display[_lang].formats)
        return _lang_to_display[_lang](val)
    except:
        print "Date displayer for",_lang,"not available"
        return DateDisplay.DateDisplay(3)

def get_date_formats():
    """
    Returns the lists supported formats for date parsers and displayers
    """
    try:
        return _lang_to_display[_lang].formats
    except:
        return DateDisplay.DateDisplay.formats

def set_format(val):
    try:
        _lang_to_display[_lang].formats = val
    except:
        pass

def register_datehandler(locales,parse_class,display_class):
    """
    Registers the passed date parser class and date displayer
    classes with the specfied language locales.

    @param locales: tuple of strings containing language codes.
        The character encoding is not included, so the langauge
        should be in the form of fr_FR, not fr_FR.utf8
    @type locales: tuple
    @param parse_class: Class to be associated with parsing
    @type parse_class: DateParse
    @param display_class: Class to be associated with displaying
    @type display_class: DateDisplay
    """
    for lang_str in locales:
        _lang_to_parser[lang_str] = parse_class
        _lang_to_display[lang_str] = display_class
    

#-------------------------------------------------------------------------
#
# Import localized date classes
#
#-------------------------------------------------------------------------
from Plugins import load_plugins
from const import datesDir
load_plugins(datesDir)