gramps/gramps2/src/DateDisplay.py

# -*- coding: iso-8859-1 -*- 
#
# 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$

"""
U.S English date display class. Should serve as the base class for all
localized tasks.
"""

__author__ = "Donald N. Allingham"
__version__ = "$Revision$"

import Date

class DateDisplay:
    """
    U.S English date display class. 
    """

    formats = (
        "YYYY-MM-DD",
        "MM/DD/YYYY",
        "Month Day, Year",
        "MON DAY, YEAR",
        "Day Month Year",
        "DAY MON YEAR"
        )

    _calendar = (
        "",
        " (Julian)",
        " (Hebrew)",
        " (French Republican)",
        " (Persian)",
        " (Islamic)"
        )
    
    _mod_str = (
        "",
        "before ",
        "after ",
        "about ",
        "estimated ",
        "calculated ",
        ""
        )
    
    _months = (
        "",
        "January",
        "February",
        "March",
        "April",
        "May",
        "June",
        "July",
        "August",
        "September",
        "October",
        "November",
        "December"
        )

    _MONS = (
        "",
        "JAN",
        "FEB",
        "MAR",
        "APR",
        "MAY",
        "JUN",
        "JUL",
        "AUG",
        "SEP",
        "OCT",
        "NOV",
        "DEC"
        )
    
    _hebrew = (
        "",
        "Tishri",
        "Heshvan",
        "Kislev",
        "Tevet",
        "Shevat",
        "AdarI",
        "AdarII",
        "Nisan",
        "Iyyar",
        "Sivan",
        "Tammuz",
        "Av",
        "Elul"
        )
    
    _french = (
        unicode("Vend<EFBFBD>miaire",'latin-1'),
        unicode("Brumaire",'latin-1'),
        unicode("Frimaire",'latin-1'),
        unicode("Niv<EFBFBD>se",'latin-1'),
        unicode("Pluvi<EFBFBD>se",'latin-1'),
        unicode("Vent<EFBFBD>se",'latin-1'),
        unicode("Germinal",'latin-1'),
        unicode("Flor<EFBFBD>al",'latin-1'),
        unicode("Prairial",'latin-1'),
        unicode("Messidor",'latin-1'),
        unicode("Thermidor",'latin-1'),
        unicode("Fructidor",'latin-1'),
        unicode("Extra",'latin-1'),
        )
    
    _persian = (
        "Farvardin",
        "Ordibehesht",
        "Khordad",
        "Tir",
        "Mordad",
        "Shahrivar",
        "Mehr",
        "Aban",
        "Azar",
        "Dey",
        "Bahman",
        "Esfand"
        )
    
    _islamic = (
        "Muharram",
        "Safar",
        "Rabi`al-Awwal",
        "Rabi`ath-Thani",
        "Jumada l-Ula",
        "Jumada t-Tania",
        "Rajab",
        "Sha`ban",
        "Ramadan",
        "Shawwal",
        "Dhu l-Qa`da",
        "Dhu l-Hijja"
        )

    def __init__(self,format=None):
        """
        Creates a DateDisplay class that converts a Date object to a string
        of the desired format. The format value must correspond to the format
        list value (DateDisplay.format[]).
        """
        self.verify_format(format)
        if format == None:
            self.format = 0
        else:
            self.format = format
            
        self.display_cal = [
            self._display_gregorian,
            self._display_julian,
            self._display_hebrew,
            self._display_french,
            self._display_persian,
            self._display_islamic,
            ]
        
    def verify_format(self,format):
        """
        Verifies that the format value is within the correct range.
        """
        assert(format < len(self.formats))

    def quote_display(self,date):
        """
        Similar to the display task, except that if the value is a text only
        value, it is enclosed in quotes.
        """
        if date.get_modifier() == Date.MOD_TEXTONLY:
            return '"%s"' % self.display(date)
        else:
            return self.display(date)

    def text_display(self,date):
        """
        Similar to the display task, except that if the value is a text only
        value, it is enclosed in quotes.
        """
        return date.get_text()
        
    def display(self,date):
        """
        Returns a text string representing the date.
        """
        mod = date.get_modifier()
        cal = date.get_calendar()
        start = date.get_start_date()
        if start == Date.EMPTY:
            return u""
        if mod == Date.MOD_SPAN:
            d1 = self.display_cal[cal](start)
            d2 = self.display_cal[cal](date.get_stop_date())
            return "from %s to %s%s" % (d1,d2,self._calendar[cal])
        elif mod == Date.MOD_RANGE:
            d1 = self.display_cal[cal](start)
            d2 = self.display_cal[cal](date.get_stop_date())
            return "between %s and %s%s" % (d1,d2,self._calendar[cal])
        else:
            text = self.display_cal[date.get_calendar()](start)
            return "%s%s%s" % (self._mod_str[mod],text,self._calendar[cal])

    def _slash_year(self,val,slash):
        if slash:
            return "%d/%d" % (val,(val%10)+1)
        else:
            return str(val)
        
    def _display_gregorian(self,date_val):
        year = self._slash_year(date_val[2],date_val[3])
        if self.format == 0:
            # YYYY-MM-DD (ISO)
            if date_val[0] == 0:
                if date_val[1] == 0:
                    return year
                else:
                    return "%s-%d" % (year,date_val[1])
            else:
                return "%s-%d-%d" % (year,date_val[1],date_val[0])
        elif self.format == 1:
            # MM/DD/YYYY (American numericalO)
            if date_val[0] == 0:
                if date_val[1] == 0:
                    return "%d" % date_val[2]
                else:
                    return "%d/%d" % (date_val[1],date_val[2])
            else:
                return "%d/%d/%d" % (date_val[1],date_val[0],date_val[2])
        elif self.format == 2:
            # Month Day, Year
            if date_val[0] == 0:
                if date_val[1] == 0:
                    return year
                else:
                    return "%s %s" % (self._months[date_val[1]],year)
            else:
                return "%s %d, %s" % (self._months[date_val[1]],date_val[0],year)
        elif self.format == 3:
            # MON Day, Year
            if date_val[0] == 0:
                if date_val[1] == 0:
                    return year
                else:
                    return "%s %s" % (self._MONS[date_val[1]],year)
            else:
                return "%s %d, %s" % (self._MONS[date_val[1]],date_val[0],year)
        elif self.format == 4:
            # Day Month Year
            if date_val[0] == 0:
                if date_val[1] == 0:
                    return year
                else:
                    return "%s %s" % (self._months[date_val[1]],year)
            else:
                return "%d %s %s" % (date_val[0],self._months[date_val[1]],year)
        else:
            # Day MON Year
            if date_val[0] == 0:
                if date_val[1] == 0:
                    return year
                else:
                    return "%s %s" % (self._MONS[date_val[1]],year)
            else:
                return "%d %s %s" % (date_val[0],self._MONS[date_val[1]],year)

    def _display_julian(self,date_val):
        # Julian date display is the same as Gregorian
        return self._display_gregorian(date_val)

    def _display_calendar(self,date_val,month_list):
        year = date_val[2]
        if self.format == 0 or self.format == 1:
            # YYYY-MM-DD (ISO)
            if date_val[0] == 0:
                if date_val[1] == 0:
                    return year
                else:
                    return "%d-%d" % (year,date_val[1])
            else:
                return "%d-%d-%d" % (year,date_val[1],date_val[0])
        else:
            if date_val[0] == 0:
                if date_val[1] == 0:
                    return year
                else:
                    return "%s %d" % (month_list[date_val[1]],year)
            else:
                return "%s %d, %s" % (month_list[date_val[1]],date_val[0],year)

    def _display_french(self,date_val):
        return self._display_calendar(date_val,self._french)

    def _display_hebrew(self,date_val):
        return self._display_calendar(date_val,self._hebrew)

    def _display_persian(self,date_val):
        return self._display_calendar(date_val,self._persian)

    def _display_islamic(self,date_val):
        return self._display_calendar(date_val,self._islamic)