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

KHolidays Library

  • kholidays
  • parsers
  • plan2
holidayparserdriverplan_p.h
1/*
2 This file is part of the kholidays library.
3
4 Copyright 2010 John Layt <john@layt.net>
5
6 This library is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Library General Public
8 License as published by the Free Software Foundation; either
9 version 2 of the License, or (at your option) any later version.
10
11 This library is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU Library General Public License for more details.
15
16 You should have received a copy of the GNU Library General Public License
17 along with this library; see the file COPYING.LIB. If not, write to the
18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19 Boston, MA 02110-1301, USA.
20*/
21
22#ifndef KHOLIDAYS_HOLIDAYPARSERDRIVERPLAN_P_H
23#define KHOLIDAYS_HOLIDAYPARSERDRIVERPLAN_P_H
24
25#include <fstream>
26#include <string>
27
28#include <QByteArray>
29#include <QStringList>
30
31#include "../holidayparserdriver_p.h"
32
33namespace KHolidays {
34
35class HolidayScannerPlan;
36class HolidayParserPlan;
37class location;
38
53class HolidayParserDriverPlan : public HolidayParserDriver
54{
55public:
56
62 HolidayParserDriverPlan( const QString &planFilename );
63
67 ~HolidayParserDriverPlan();
68
74 void error( const KHolidays::location &errorLocation, const QString &errorMessage );
75
81 void error( const QString &errorMessage );
82
83protected:
87 void parse();
88
92 void parseMetadata();
93
94 // Bison C++ skeleton required friend for Bison parser class implementation
95 friend class HolidayParserPlan;
96
97 // Accessor methods for parser to talk to driver
98 QString filePath();
99 std::string *fileToParse() const;
100
101 // Calendar and date calculation utilities
102 int adjustedMonthNumber( int month );
103 bool isLeapYear( int year );
104 int parseYear();
105
106 // Utilities for parser to calculate interim Julian Day Number during parsing
107 int julianDayFromEventName( const QString &eventName );
108 int julianDayFromEaster();
109 int julianDayFromPascha();
110 int julianDayFromMonthDay( int month, int day );
111 int julianDayFromRelativeWeekday( int occurrence, int weekday, int jd );
112 int julianDayFromWeekdayInMonth( int occurrence, int weekday, int month );
113
114 // Utilities for parser to set variables during parsing
115 void setFileCountryCode( const QString &countryCode );
116 void setFileLanguageCode( const QString &languageCode );
117 void setFileName( const QString &ame );
118 void setFileDescription( const QString &description );
119 void setEventName( const QString &eventName );
120 void setEventCategory( const QString &category );
121 void setEventCalendarType( const QString &calendarType = "gregorian" );
122 void setEventDate( int eventYear, int eventMonth, int eventDay );
123 void setEventDate( int jd );
124
125 // Terminal functions for parser to create holidays from parsed variables
126 void setFromEaster( int offset, int duration );
127 void setFromPascha( int offset, int duration );
128 void setFromDate( int offset, int condition, int duration );
129 void setFromWeekdayInMonth( int occurrence, int weekday, int month, int offset, int duration );
130 void setFromRelativeWeekday( int occurrence, int weekday, int offset, int duration );
131 void setEvent( int event_jd, int observe_offset, int duration );
132
133private:
134 // Calendar and date calculation utilities
135 int monthsInYear( int year );
136 int daysInMonth( int year, int month );
137 int julianDay( int year, int month, int day );
138 void julianDayToDate( int jd, int *year, int *month, int *day );
139 QDate easter( int year );
140 QDate pascha( int year );
141
142 int conditionalOffset( int year, int month, int day, int condition );
143
144 void addHoliday( const QDate &date, int duration );
145
146 QByteArray m_scanData; // Holiday file stored as a string
147
148 QStringList m_fileCalendarTypes; // List of all Calendar Systems used in file
149
150 bool m_traceParsing; // Bison C++ skeleton enable tracing in Bison parser class
151 HolidayParserPlan *m_parser; // Bison C++ skeleton Bison parser class implementation
152
153 bool m_traceScanning; // Flex C++ enable tracing in Flex scanner class
154 HolidayScannerPlan *m_scanner; // Flex C++ scanner class implementation
155
156 bool m_parseMetadataOnly; // Only parse file for metadata
157 QDate m_parseYearStart; // First day of year being parsed
158 QDate m_parseYearEaster; // Easter in the parse year, Gregorian only
159 QDate m_parseYearPascha; // Orthodox Easter in the parse year, Gregorian only
160
161 QStringList m_eventCategories; // Event categories
162 QString m_eventCalendarType; // Calendar System for event rule
163 QString m_eventName; // Event name text
164 int m_eventYear; // Event date fields
165 int m_eventMonth; // Event date fields
166 int m_eventDay; // Event date fields
167
168 std::string *m_fileToParse;
169};
170
171}
172
173#endif // KHOLIDAYS_HOLIDAYPARSERDRIVERPLAN_P_H
KHolidays::HolidayParserDriverPlan
HolidayParserDriverPlan implementation class.
Definition: holidayparserdriverplan_p.h:54
KHolidays::HolidayParserDriverPlan::parseMetadata
void parseMetadata()
Parse the file for metadata only and populate the metadata variables.
Definition: holidayparserdriverplan.cpp:120
KHolidays::HolidayParserDriverPlan::parse
void parse()
Actually parse the file, new plan format implementation.
Definition: holidayparserdriverplan.cpp:94
KHolidays::HolidayParserDriverPlan::error
void error(const KHolidays::location &errorLocation, const QString &errorMessage)
Bison C++ skeleton error message handling.
Definition: holidayparserdriverplan.cpp:80
KHolidays::HolidayParserDriverPlan::~HolidayParserDriverPlan
~HolidayParserDriverPlan()
Destructor.
Definition: holidayparserdriverplan.cpp:72
KHolidays::HolidayParserDriver
HolidayParserDriver abstract base class.
Definition: holidayparserdriver_p.h:45
KHolidays::HolidayParserPlan
A Bison parser.
Definition: holidayparserplan.hpp:115
KHolidays::HolidayScannerPlan
HolidayScannerPlan implementation class.
Definition: holidayscannerplan_p.h:64
KHolidays::location
Abstract a location.
Definition: location.hh:57
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 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