• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

KHolidays Library

  • KHolidays
  • HolidayParserDriverPlan
Public Member Functions | Protected Member Functions | List of all members
KHolidays::HolidayParserDriverPlan Class Reference

#include <holidayparserdriverplan_p.h>

Inheritance diagram for KHolidays::HolidayParserDriverPlan:
KHolidays::HolidayParserDriver

Public Member Functions

 HolidayParserDriverPlan (const QString &planFilename)
 
 ~HolidayParserDriverPlan ()
 
void error (const KHolidays::location &errorLocation, const QString &errorMessage)
 
void error (const QString &errorMessage)
 
- Public Member Functions inherited from KHolidays::HolidayParserDriver
 HolidayParserDriver (const QString &filePath)
 
virtual ~HolidayParserDriver ()
 
virtual QString fileCountryCode () const
 
virtual QString fileDescription () const
 
virtual QString fileLanguageCode () const
 
virtual QString fileName () const
 
virtual Holiday::List parseHolidays (const QDate &date, Holiday::MultidayMode multidayMode)
 
virtual Holiday::List parseHolidays (const QDate &startDate, const QDate &endDate, Holiday::MultidayMode multidayMode)
 
virtual Holiday::List parseHolidays (int calendarYear, const QString &calendarType, Holiday::MultidayMode multidayMode)
 

Protected Member Functions

int adjustedMonthNumber (int month)
 
QString filePath ()
 
std::string * fileToParse () const
 
bool isLeapYear (int year)
 
int julianDayFromEaster ()
 
int julianDayFromEventName (const QString &eventName)
 
int julianDayFromMonthDay (int month, int day)
 
int julianDayFromPascha ()
 
int julianDayFromRelativeWeekday (int occurrence, int weekday, int jd)
 
int julianDayFromWeekdayInMonth (int occurrence, int weekday, int month)
 
void parse ()
 
void parseMetadata ()
 
int parseYear ()
 
void setEvent (int event_jd, int observe_offset, int duration)
 
void setEventCalendarType (const QString &calendarType="gregorian")
 
void setEventCategory (const QString &category)
 
void setEventDate (int eventYear, int eventMonth, int eventDay)
 
void setEventDate (int jd)
 
void setEventName (const QString &eventName)
 
void setFileCountryCode (const QString &countryCode)
 
void setFileDescription (const QString &description)
 
void setFileLanguageCode (const QString &languageCode)
 
void setFileName (const QString &ame)
 
void setFromDate (int offset, int condition, int duration)
 
void setFromEaster (int offset, int duration)
 
void setFromPascha (int offset, int duration)
 
void setFromRelativeWeekday (int occurrence, int weekday, int offset, int duration)
 
void setFromWeekdayInMonth (int occurrence, int weekday, int month, int offset, int duration)
 
- Protected Member Functions inherited from KHolidays::HolidayParserDriver
virtual void setParseCalendar (const QString &calendarType)
 
virtual void setParseStartEnd ()
 

Additional Inherited Members

- Protected Attributes inherited from KHolidays::HolidayParserDriver
QString m_fileCountryCode
 
QString m_fileDescription
 
QString m_fileLanguageCode
 
QString m_fileName
 
QString m_filePath
 
Holiday::MultidayMode m_multidayMode
 
KCalendarSystem * m_parseCalendar
 
int m_parseEndYear
 
int m_parseStartYear
 
int m_parseYear
 
QDate m_requestEnd
 
QDate m_requestStart
 
Holiday::List m_resultList
 

Detailed Description

HolidayParserDriverPlan implementation class.

Implements the standard driver interface for parsing Plan holiday files as implemented in KDE SC 4.5 onwards. This includes extensions to the file format to support non-Gregorian calendar systems, metadata, and other new features.

Implemented using Bison/Flex and the Bison C++ skeleton v2.1a, see README. While almost all code is new, the structure of the parser is based on the original Plan parser.

Private, for internal use only

Definition at line 53 of file holidayparserdriverplan_p.h.

Constructor & Destructor Documentation

◆ HolidayParserDriverPlan()

HolidayParserDriverPlan::HolidayParserDriverPlan ( const QString & planFilename)

Constructor of Plan file parser driver.

Parameters
filePathfull path to holiday file

Definition at line 53 of file holidayparserdriverplan.cpp.

◆ ~HolidayParserDriverPlan()

HolidayParserDriverPlan::~HolidayParserDriverPlan ( )

Destructor.

Definition at line 72 of file holidayparserdriverplan.cpp.

Member Function Documentation

◆ adjustedMonthNumber()

int HolidayParserDriverPlan::adjustedMonthNumber ( int month)
protected

Definition at line 181 of file holidayparserdriverplan.cpp.

◆ error() [1/2]

void HolidayParserDriverPlan::error ( const KHolidays::location & errorLocation,
const QString & errorMessage )

Bison C++ skeleton error message handling.

Parameters
errorMessageerror message to log

Definition at line 80 of file holidayparserdriverplan.cpp.

◆ error() [2/2]

void HolidayParserDriverPlan::error ( const QString & errorMessage)
virtual

Standard error message handling.

Parameters
errorMessageerror message to log

Reimplemented from KHolidays::HolidayParserDriver.

Definition at line 88 of file holidayparserdriverplan.cpp.

◆ filePath()

QString HolidayParserDriverPlan::filePath ( )
protected

Definition at line 166 of file holidayparserdriverplan.cpp.

◆ fileToParse()

std::string * HolidayParserDriverPlan::fileToParse ( ) const
protected

Definition at line 171 of file holidayparserdriverplan.cpp.

◆ isLeapYear()

bool HolidayParserDriverPlan::isLeapYear ( int year)
protected

Definition at line 201 of file holidayparserdriverplan.cpp.

◆ julianDayFromEaster()

int HolidayParserDriverPlan::julianDayFromEaster ( void )
protected

Definition at line 314 of file holidayparserdriverplan.cpp.

◆ julianDayFromEventName()

int HolidayParserDriverPlan::julianDayFromEventName ( const QString & eventName)
protected

Definition at line 303 of file holidayparserdriverplan.cpp.

◆ julianDayFromMonthDay()

int HolidayParserDriverPlan::julianDayFromMonthDay ( int month,
int day )
protected

Definition at line 336 of file holidayparserdriverplan.cpp.

◆ julianDayFromPascha()

int HolidayParserDriverPlan::julianDayFromPascha ( void )
protected

Definition at line 325 of file holidayparserdriverplan.cpp.

◆ julianDayFromRelativeWeekday()

int HolidayParserDriverPlan::julianDayFromRelativeWeekday ( int occurrence,
int weekday,
int jd )
protected

Definition at line 341 of file holidayparserdriverplan.cpp.

◆ julianDayFromWeekdayInMonth()

int HolidayParserDriverPlan::julianDayFromWeekdayInMonth ( int occurrence,
int weekday,
int month )
protected

Definition at line 365 of file holidayparserdriverplan.cpp.

◆ parse()

void HolidayParserDriverPlan::parse ( )
protectedvirtual

Actually parse the file, new plan format implementation.

Reimplemented from KHolidays::HolidayParserDriver.

Definition at line 94 of file holidayparserdriverplan.cpp.

◆ parseMetadata()

void HolidayParserDriverPlan::parseMetadata ( )
protectedvirtual

Parse the file for metadata only and populate the metadata variables.

Reimplemented from KHolidays::HolidayParserDriver.

Definition at line 120 of file holidayparserdriverplan.cpp.

◆ parseYear()

int HolidayParserDriverPlan::parseYear ( )
protected

Definition at line 206 of file holidayparserdriverplan.cpp.

◆ setEvent()

void HolidayParserDriverPlan::setEvent ( int event_jd,
int observe_offset,
int duration )
protected

Definition at line 677 of file holidayparserdriverplan.cpp.

◆ setEventCalendarType()

void HolidayParserDriverPlan::setEventCalendarType ( const QString & calendarType = "gregorian")
protected

Definition at line 411 of file holidayparserdriverplan.cpp.

◆ setEventCategory()

void HolidayParserDriverPlan::setEventCategory ( const QString & category)
protected

Definition at line 406 of file holidayparserdriverplan.cpp.

◆ setEventDate() [1/2]

void HolidayParserDriverPlan::setEventDate ( int eventYear,
int eventMonth,
int eventDay )
protected

Definition at line 419 of file holidayparserdriverplan.cpp.

◆ setEventDate() [2/2]

void HolidayParserDriverPlan::setEventDate ( int jd)
protected

Definition at line 426 of file holidayparserdriverplan.cpp.

◆ setEventName()

void HolidayParserDriverPlan::setEventName ( const QString & eventName)
protected

Definition at line 399 of file holidayparserdriverplan.cpp.

◆ setFileCountryCode()

void HolidayParserDriverPlan::setFileCountryCode ( const QString & countryCode)
protected

Definition at line 379 of file holidayparserdriverplan.cpp.

◆ setFileDescription()

void HolidayParserDriverPlan::setFileDescription ( const QString & description)
protected

Definition at line 394 of file holidayparserdriverplan.cpp.

◆ setFileLanguageCode()

void HolidayParserDriverPlan::setFileLanguageCode ( const QString & languageCode)
protected

Definition at line 384 of file holidayparserdriverplan.cpp.

◆ setFileName()

void HolidayParserDriverPlan::setFileName ( const QString & ame)
protected

Definition at line 389 of file holidayparserdriverplan.cpp.

◆ setFromDate()

void HolidayParserDriverPlan::setFromDate ( int offset,
int condition,
int duration )
protected

Definition at line 582 of file holidayparserdriverplan.cpp.

◆ setFromEaster()

void HolidayParserDriverPlan::setFromEaster ( int offset,
int duration )
protected

Definition at line 642 of file holidayparserdriverplan.cpp.

◆ setFromPascha()

void HolidayParserDriverPlan::setFromPascha ( int offset,
int duration )
protected

Definition at line 662 of file holidayparserdriverplan.cpp.

◆ setFromRelativeWeekday()

void HolidayParserDriverPlan::setFromRelativeWeekday ( int occurrence,
int weekday,
int offset,
int duration )
protected

Definition at line 494 of file holidayparserdriverplan.cpp.

◆ setFromWeekdayInMonth()

void HolidayParserDriverPlan::setFromWeekdayInMonth ( int occurrence,
int weekday,
int month,
int offset,
int duration )
protected

Definition at line 441 of file holidayparserdriverplan.cpp.


The documentation for this class was generated from the following files:
  • holidayparserdriverplan_p.h
  • holidayparserdriverplan.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KHolidays Library

Skip menu "KHolidays Library"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal