holidayparserdriver_p.h

/*
  This file is part of the kholidays library.

  Copyright 2010 John Layt <john@layt.net>

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Library General Public
  License as published by the Free Software Foundation; either
  version 2 of the License, or (at your option) any later version.

  This library 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 Library General Public License for more details.

  You should have received a copy of the GNU Library General Public License
  along with this library; see the file COPYING.LIB.  If not, write to the
  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  Boston, MA 02110-1301, USA.
*/

#ifndef KHOLIDAYS_HOLIDAYPARSERDRIVER_P_H
#define KHOLIDAYS_HOLIDAYPARSERDRIVER_P_H

#include <QDate>
#include <QString>

#include "holiday.h"

class KCalendarSystem;

namespace KHolidays {

class HolidayParserDriver
{
  public:

    explicit HolidayParserDriver( const QString &filePath );

    virtual ~HolidayParserDriver();

    virtual QString fileCountryCode() const;

    virtual QString fileLanguageCode() const;

    virtual QString fileName() const;

    virtual QString fileDescription() const;

    virtual Holiday::List parseHolidays( const QDate &startDate, const QDate &endDate,
                                         Holiday::MultidayMode multidayMode );

    virtual Holiday::List parseHolidays( const QDate &date, Holiday::MultidayMode multidayMode );

    virtual Holiday::List parseHolidays( int calendarYear, const QString &calendarType,
                                         Holiday::MultidayMode multidayMode );

    virtual void error( const QString &errorMessage );

  protected:
    virtual void parse();

    virtual void parseMetadata();

    virtual void setParseCalendar( const QString &calendarType );

    virtual void setParseStartEnd();

    QString          m_filePath;           // File to be parsed

    QString          m_fileCountryCode;    // File country code in ISO 3166-2 standard
    QString          m_fileLanguageCode;   // File language
    QString          m_fileName;           // File name
    QString          m_fileDescription;    // File description

    QDate            m_requestStart;       // First day of period being requested
    QDate            m_requestEnd;         // Last day of period being requested

    Holiday::List    m_resultList;         // List of requested holidays

    KCalendarSystem *m_parseCalendar;      // Calendar system being parsed
    int              m_parseYear;          // Year currently being parsed
    int              m_parseStartYear;     // First year to parse in parse calendar
    int              m_parseEndYear;       // Last year to parse in parse calendar

    Holiday::MultidayMode m_multidayMode;   // How to return multiday holidays
};

}

#endif // KHOLIDAYS_HOLIDAYPARSERDRIVER_P_H