iCalendar.hpp

Go to the documentation of this file.

// 
// BEGIN_DOUGLAS_MARK_ROYER_COPYRIGHT
//
// Copyright (C) 1993-2012 Douglas Mark Royer, All Rights Reserved.
// 
// NOTICE:
// 
// THIS SOURCE CODE BELONGS TO DOUGLAS MARK ROYER
// THIS CODE IS CONSIDERED A
// TRADE SECRET AND IS NOT TO BE DIVULGED OR USED BY PARTIES WHO HAVE
// NOT RECEIVED WRITTEN AUTHORIZATION FROM THE OWNER.
// 
// 
// THIS SOFTWARE AND MANUAL ARE BOTH PROTECTED BY UNITED STATES
// COPYRIGHT LAW (TITLE 17 UNITED STATES CODE). UNAUTHORIZED REPRODUCTION
// AND/OR SALE MAY RESULT IN IMPRISONMENT OF UP TO ONE YEAR AND FINES
// OF UP TO $100,000 (17 USC 506). COPYRIGHT INFRINGERS MAY ALSO
// BE SUBJECT TO CIVIL LIABILITY.
// 
// THIS NOTICE AND THE ABOVE COPYRIGHT NOTICE MUST REMAIN IN ALL
// COPIES AND ANY DERIVED WORK.
// 
// ALL OF THIS CODE IS ORIGINAL WORK BY THE COPYRIGHT HOLDER.
// 
// THIS  DOCUMENT  AND  THE  INFORMATION  CONTAINED  HEREIN  IS
// PROVIDED  ON  AN "AS IS" BASIS AND INET-CONSULTING.COM, INC.
// DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,  INCLUDING  BUT
// NOT  LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
// HEREIN  WILL  NOT  INFRINGE  ANY  RIGHTS  OR   ANY   IMPLIED
// WARRANTIES  OF  MERCHANTABILITY  OR FITNESS FOR A PARTICULAR
// PURPOSE.  ANY SERVICE CONTRACT  WILL  BE  UNDER  A  SEPARATE
// LICENSE.
//
// END_DOUGLAS_MARK_ROYER_COPYRIGHT
//
#ifndef __DOUGLAS_MARK_ROYER_LIBRARY_ICALENDAR_HPP__
#define __DOUGLAS_MARK_ROYER_LIBRARY_ICALENDAR_HPP__

#ifndef EXPORT_ICALENDAR
#ifdef BUILDING_LIBRARY_ICALENDAR
#define EXPORT_ICALENDAR EXPORT_OUT
#else
#define EXPORT_ICALENDAR EXPORT_IN
#endif
#endif

#include <SaS/Common/osver.h>
#include <SaS/Common/String.hpp>
#include <SaS/Common/StringCache.hpp>
#include <SaS/Common/Parse.hpp>
#include <SaS/Common/DateTime.hpp>
#include <SaS/RfcBasic/Uri.hpp>
#include <SaS/Common/Error.hpp>
#include <SaS/Common/File.hpp>

/**
 * dbiCalTokens is included here as this file is automatically
 * generated during the top level build process. The 
 * values are in a database. A program opens up the database
 * and generates the dbiCalTokens.hpp file. Then the
 * directory containing the source to this file are built.
 */
#ifdef BUILDING_LIBRARY_ICALENDAR
#include "dbiCalTokens.hpp"
#else
#include <SaS/iCalendar/dbiCalTokens.hpp>
#endif

#include <memory.h>
#include <stdlib.h>
#include <sys/types.h>
#include <string>
#include <vector>
#include <map>
#include <SaS/Common/winWrappers.hpp>

#include <assert.h>

#include <SaS/iCalendar/BaseValueType.hpp>

using namespace std;
using namespace SoftwareAndServices::Library::Common;
using namespace SoftwareAndServices::Library::RfcBasic;
//using namespace SoftwareAndServices::Library::iCalendar;

#ifdef ComponentId_t
#undef ComponentId_t
#endif

#ifdef PropertyId_t
#undef PropertyId_t
#endif

#ifdef ParameterId_t
#undef ParameterId_t
#endif

#ifdef WIN32
///** 
// * This warning message tells us that data members that
// * use the vector<> std template, can not be accessible
// * from outside the class (from a derived class) unless the
// * data type is EXPORTED, yet MS-.NET rejects the EXPORT tag
// * for ALL vector typedefs. If this is an issue make the member
// * variable private and create a method to return the value
//* and not the <vector> array.
// */
#pragma warning(disable: 4251)

/** 
 * These are defined and unrelated in WIN32
 * So they are UNDEFINED here to avoid conflicts.
 */
#ifdef OPAQUE
#undef OPAQUE
#endif
#ifdef TRANSPARENT
#undef TRANSPARENT
#endif
#ifdef DEFAULT_CHARSET
#undef DEFAULT_CHARSET
#endif

#endif

extern "C" {
    void        _BaseValueType_once_proc();
    void        _iCalendar_once_proc();
}

/**
 * @author Doug Royer / SoftwareAndServices
 * @file
 * This is a class and interfaces in C and C++ that represents iCalendar
 * object. It is designed to be compatible with RFC-iCalendar, RFC-iTIP, RFC-iMIP,
 * CAP, and current WebDAV and CalDAV calendars. 
 */

namespace SoftwareAndServices
{
    namespace Library 
    {
        namespace iCalendar
        {
             /**
              * These are some shortcut variables that are defined
              * so that multiple instances of const strings are not
              * in the built library.
              */
            EXPORT_ICALENDAR  extern const char         *       CRLF_s;
            EXPORT_ICALENDAR  extern const String       *       CRLF_S;

            EXPORT_ICALENDAR  extern const char         *       L_COLON_s;

            EXPORT_ICALENDAR  extern const char         *       L_H_s;
            EXPORT_ICALENDAR  extern const char         *       L_M_s;
            EXPORT_ICALENDAR  extern const char         *       L_MINUS_s;
            EXPORT_ICALENDAR  extern const char         *       L_P_s;
            EXPORT_ICALENDAR  extern const char         *       L_PLUS_s;
            EXPORT_ICALENDAR  extern const char         *       L_S_s;
            EXPORT_ICALENDAR  extern const char         *       L_SEMICOLON_s;
            EXPORT_ICALENDAR  extern const char         *       L_SLASH_s;
            EXPORT_ICALENDAR  extern const char         *       L_T_s;
            EXPORT_ICALENDAR  extern const char         *       L_W_s;
            EXPORT_ICALENDAR  extern const char         *       L_Z_s;


            class EXPORT_ICALENDAR                              action;
            class EXPORT_ICALENDAR                              action_param;
            class EXPORT_ICALENDAR                              allow_conflict;
            class EXPORT_ICALENDAR                              altrep;
            class EXPORT_ICALENDAR                              att_counter;
            class EXPORT_ICALENDAR                              attach;
            class EXPORT_ICALENDAR                              attendee;
            class EXPORT_ICALENDAR                              binary;
            class EXPORT_ICALENDAR                              binary_parameter;
            class EXPORT_ICALENDAR                              binary_property;
            class EXPORT_ICALENDAR                              boolean;
            class EXPORT_ICALENDAR                              boolean_parameter;
            class EXPORT_ICALENDAR                              boolean_property;
            class EXPORT_ICALENDAR                              cal_address;
            class EXPORT_ICALENDAR                              cal_address_parameter;
            class EXPORT_ICALENDAR                              cal_address_property;
            class EXPORT_ICALENDAR                              cal_query;
            class EXPORT_ICALENDAR                              cal_query_parameter;
            class EXPORT_ICALENDAR                              cal_query_property;
            class EXPORT_ICALENDAR                              calid;
            class EXPORT_ICALENDAR                              calmaster;
            class EXPORT_ICALENDAR                              calscale;
            class EXPORT_ICALENDAR                              cap_version;
            class EXPORT_ICALENDAR                              car_level;
            class EXPORT_ICALENDAR                              carid;
            class EXPORT_ICALENDAR                              categories;
            class EXPORT_ICALENDAR                              class_prop;
            class EXPORT_ICALENDAR                              cmd;
            class EXPORT_ICALENDAR                              comment;
            class EXPORT_ICALENDAR                              component;
            class EXPORT_ICALENDAR                              components;
            class EXPORT_ICALENDAR                              contact;
            class EXPORT_ICALENDAR                              create;
            class EXPORT_ICALENDAR                              created;
            class EXPORT_ICALENDAR                              csid;
            class EXPORT_ICALENDAR                              cutype;
            class EXPORT_ICALENDAR                              date;
            class EXPORT_ICALENDAR                              date_parameter;
            class EXPORT_ICALENDAR                              date_property;
            class EXPORT_ICALENDAR                              date_time;
            class EXPORT_ICALENDAR                              date_time_parameter;
            class EXPORT_ICALENDAR                              date_time_property;
            class EXPORT_ICALENDAR                              daylightValue;
            class EXPORT_ICALENDAR                              decreed;
            class EXPORT_ICALENDAR                              default_charset;
            class EXPORT_ICALENDAR                              default_locale;
            class EXPORT_ICALENDAR                              default_tzid;
            class EXPORT_ICALENDAR                              default_vcars;
            class EXPORT_ICALENDAR                              delegated_from;
            class EXPORT_ICALENDAR                              delegated_to;
            class EXPORT_ICALENDAR                              deny;
            class EXPORT_ICALENDAR                              description;
            class EXPORT_ICALENDAR                              dir;
            class EXPORT_ICALENDAR                              dtend;
            class EXPORT_ICALENDAR                              dtstamp;
            class EXPORT_ICALENDAR                              dtstart;
            class EXPORT_ICALENDAR                              due;
            class EXPORT_ICALENDAR                              dur_parameter;
            class EXPORT_ICALENDAR                              dur_property;
            class EXPORT_ICALENDAR                              dur_value;
            class EXPORT_ICALENDAR                              duration;
            class EXPORT_ICALENDAR                              enable;
            class EXPORT_ICALENDAR                              encoding;
            class EXPORT_ICALENDAR                              exdate;
            class EXPORT_ICALENDAR                              expand;
            class EXPORT_ICALENDAR                              exrule;
            class EXPORT_ICALENDAR                              fbtype;
            class EXPORT_ICALENDAR                              float_parameter;
            class EXPORT_ICALENDAR                              float_property;
            class EXPORT_ICALENDAR                              float_value;
            class EXPORT_ICALENDAR                              fmttype;
            class EXPORT_ICALENDAR                              fn;
            class EXPORT_ICALENDAR                              freebush;
            class EXPORT_ICALENDAR                              geo;
            class EXPORT_ICALENDAR                              grant;
            class EXPORT_ICALENDAR                              iCalError;
            class EXPORT_ICALENDAR                              iCalendar;
            class EXPORT_ICALENDAR                              icalbody;
            class EXPORT_ICALENDAR                              icaldata;
            class EXPORT_ICALENDAR                              id;
            class EXPORT_ICALENDAR                              integer;
            class EXPORT_ICALENDAR                              integer_parameter;
            class EXPORT_ICALENDAR                              integer_property;
            class EXPORT_ICALENDAR                              itip_version;
            class EXPORT_ICALENDAR                              label;
            class EXPORT_ICALENDAR                              language;
            class EXPORT_ICALENDAR                              last_modified;
            class EXPORT_ICALENDAR                              latency;
            class EXPORT_ICALENDAR                              local;
            class EXPORT_ICALENDAR                              localize;
            class EXPORT_ICALENDAR                              location;
            class EXPORT_ICALENDAR                              max_comp_size;
            class EXPORT_ICALENDAR                              maxdate;
            class EXPORT_ICALENDAR                              member;
            class EXPORT_ICALENDAR                              method;
            class EXPORT_ICALENDAR                              mindate;
            class EXPORT_ICALENDAR                              multipart;
            class EXPORT_ICALENDAR                              name;
            class EXPORT_ICALENDAR                              options;
            class EXPORT_ICALENDAR                              organizer;
            class EXPORT_ICALENDAR                              owner;
            class EXPORT_ICALENDAR                              parameter;
            class EXPORT_ICALENDAR                              parser;
            class EXPORT_ICALENDAR                              partstat;
            class EXPORT_ICALENDAR                              percent_complete;
            class EXPORT_ICALENDAR                              period;
            class EXPORT_ICALENDAR                              period_parameter;
            class EXPORT_ICALENDAR                              period_property;
            class EXPORT_ICALENDAR                              permission;
            class EXPORT_ICALENDAR                              photo;
            class EXPORT_ICALENDAR                              priority;
            class EXPORT_ICALENDAR                              property;
            class EXPORT_ICALENDAR                              query;
            class EXPORT_ICALENDAR                              query_level;
            class EXPORT_ICALENDAR                              queryid;
            class EXPORT_ICALENDAR                              range;
            class EXPORT_ICALENDAR                              rdate;
            class EXPORT_ICALENDAR                              recur;
            class EXPORT_ICALENDAR                              recur_accepted;
            class EXPORT_ICALENDAR                              recur_expanded;
            class EXPORT_ICALENDAR                              recur_limit;
            class EXPORT_ICALENDAR                              recur_parameter;
            class EXPORT_ICALENDAR                              recur_property;
            class EXPORT_ICALENDAR                              recurrence_id;
            class EXPORT_ICALENDAR                              related;
            class EXPORT_ICALENDAR                              related_to;
            class EXPORT_ICALENDAR                              reltype;
            class EXPORT_ICALENDAR                              repeat;
            class EXPORT_ICALENDAR                              request_status;
            class EXPORT_ICALENDAR                              resources;
            class EXPORT_ICALENDAR                              restriction;
            class EXPORT_ICALENDAR                              role;
            class EXPORT_ICALENDAR                              rrule;
            class EXPORT_ICALENDAR                              rsvp;
            class EXPORT_ICALENDAR                              scope;
            class EXPORT_ICALENDAR                              sent_by;
            class EXPORT_ICALENDAR                              sequence;
            class EXPORT_ICALENDAR                              sort_string;
            class EXPORT_ICALENDAR                              sound;
            class EXPORT_ICALENDAR                              standardValue;
            class EXPORT_ICALENDAR                              status;
            class EXPORT_ICALENDAR                              stores_expanded;
            class EXPORT_ICALENDAR                              summary;
            class EXPORT_ICALENDAR                              target;
            class EXPORT_ICALENDAR                              text;
            class EXPORT_ICALENDAR                              text_parameter;
            class EXPORT_ICALENDAR                              text_property;
            class EXPORT_ICALENDAR                              time;
            class EXPORT_ICALENDAR                              time_parameter;
            class EXPORT_ICALENDAR                              time_property;
            class EXPORT_ICALENDAR                              title;
            class EXPORT_ICALENDAR                              transp;
            class EXPORT_ICALENDAR                              trigger;
            class EXPORT_ICALENDAR                              tzid;
            class EXPORT_ICALENDAR                              tzid_param;
            class EXPORT_ICALENDAR                              tznameValue;
            class EXPORT_ICALENDAR                              tzoffsetfrom;
            class EXPORT_ICALENDAR                              tzoffsetto;
            class EXPORT_ICALENDAR                              tzurl;
            class EXPORT_ICALENDAR                              uid;
            class EXPORT_ICALENDAR                              upn_filter;
            class EXPORT_ICALENDAR                              upn_filter_parameter;
            class EXPORT_ICALENDAR                              upn_filter_property;
            class EXPORT_ICALENDAR                              upn_parameter;
            class EXPORT_ICALENDAR                              upn_value;
            class EXPORT_ICALENDAR                              uri;
            class EXPORT_ICALENDAR                              uri_parameter;
            class EXPORT_ICALENDAR                              uri_property;
            class EXPORT_ICALENDAR                              url;
            class EXPORT_ICALENDAR                              utc_offset;
            class EXPORT_ICALENDAR                              utc_offset_parameter;
            class EXPORT_ICALENDAR                              utc_offset_property;
            class EXPORT_ICALENDAR                              vagenda;
            class EXPORT_ICALENDAR                              valarm;
            class EXPORT_ICALENDAR                              value;
            class EXPORT_ICALENDAR                              BaseValueType;
            class EXPORT_ICALENDAR                              value_datum;
            class EXPORT_ICALENDAR                              valuetype;
            class EXPORT_ICALENDAR                              vc_version;
            class EXPORT_ICALENDAR                              vcalendar;
            class EXPORT_ICALENDAR                              vcalstore;
            class EXPORT_ICALENDAR                              vcar;
            class EXPORT_ICALENDAR                              version;
            class EXPORT_ICALENDAR                              vevent;
            class EXPORT_ICALENDAR                              vfreebusy;
            class EXPORT_ICALENDAR                              vjournal;
            class EXPORT_ICALENDAR                              vquery;
            class EXPORT_ICALENDAR                              vreply;
            class EXPORT_ICALENDAR                              vrights;
            class EXPORT_ICALENDAR                              vtimezone;
            class EXPORT_ICALENDAR                              vtodo;
            class EXPORT_ICALENDAR                              x_component;
            class EXPORT_ICALENDAR                              x_inet_color;
            class EXPORT_ICALENDAR                              x_inet_fixed_recur;
            class EXPORT_ICALENDAR                              x_inet_id;
            class EXPORT_ICALENDAR                              x_inet_invited;
            class EXPORT_ICALENDAR                              x_inet_local;
            class EXPORT_ICALENDAR                              x_inet_parent;
            class EXPORT_ICALENDAR                              x_intellical_group;
            class EXPORT_ICALENDAR                              x_intellical_image;
            class EXPORT_ICALENDAR                              x_intellical_photo;
            class EXPORT_ICALENDAR                              x_intellical_sound;
            class EXPORT_ICALENDAR                              x_param;
            class EXPORT_ICALENDAR                              x_prop;

            /**
             * @typedef CalendarId_t An identifier for all calendars.
             */
            EXPORT_ICALENDAR typedef uint64_t           CalendarId_t;

            /**
             * @typedef ComponentId_t An identifier for all components
             * including VCALENDAR, VCALSTORE, VEVENT, VALARM, ...
             */
            EXPORT_ICALENDAR typedef uint64_t           ComponentId_t;

            /**
             * @typedef PropertyId_t An identifier for any property.
             */
            EXPORT_ICALENDAR typedef uint64_t           PropertyId_t;

            /**
             * @typedef ParameterId_t An identifier for any parameter.
             */
            EXPORT_ICALENDAR typedef uint64_t           ParameterId_t;
            
            /**
             * @typedef GroupId_t An identifier for a group.
             */
            EXPORT_ICALENDAR typedef uint64_t           GroupId_t;

            /**
             * @typedef time_tVec Used to represent an array of instances.
             */
            EXPORT_ICALENDAR typedef vector<time_t>             time_tVec;
          
            /**
             * @typedef time_tVec Used to represent an array of instances.
             */
            EXPORT_ICALENDAR typedef vector<icalbody*>          icalbodyVec;

            /** 
             * @typedef iCalendarVec
             * An array of iCalendar.
             */
            EXPORT_ICALENDAR typedef vector<iCalendar*>         iCalendarVec;

            /** 
             * @typedef componentVec
             * An array of component.
             */
            EXPORT_ICALENDAR typedef vector<component*>         componentVec;

            /** 
             * @typedef propertyVec
             * An array of property.
             */
            EXPORT_ICALENDAR typedef vector<property*>          propertyVec;

            /**
             * @class iCalendar
             *
             * The base class for calendar objects.
             * Generally this would not be used by applications. Instead
             * they would use libINET-iCalFile, libINET-iCalXML, and so on.
             */
            class EXPORT_ICALENDAR iCalendar
                : virtual public instance<iCalendar>
            {

            public:

                /**
                 * iCalendar Constructor.
                 */
                iCalendar();

                /**
                 * iCalendar Constructor.
                 *
                 * @param ExistingiCalendarObject An existing VCALENDER/VCALSTORE object to be added to 'this' object.
                 */
                iCalendar(iCalendar * ExistingiCalendarObject);

                /**
                 * iCalendar Constructor.
                 *
                 * @param ExistingVCalendarObject An existing VCALENDER object to be added to 'this' object.
                 */
                iCalendar(icalbody * ExistingVCalendarObject);

                /**
                 * iCalendar Destructor
                 */
                virtual ~iCalendar();

                /**
                 * User data associated with this object. This is not iCal specific,
                 * it is to be used in any way needed by calling application.
                 *
                 * @param userData A pointer to any kind of data.
                 *
                 * @see getUserdata();
                 */
                void                    setUserData(const void * userData);

                /**
                 * Return the data set by a call to setUserData().
                 *
                 * @return The pointer set by a call to setUserData().
                 */
                void               *    getUserData() const;

                /**
                 * Parse a string of calendar data.
                 *
                 * @param in The already initialized Parse() object.
                 *
                 * @param errors An iCalendar formatted list of errors.
                 *
                 * @return Returns the number of octets parsed.
                 *
                 * @see Parse()
                 */
                bool                    parse(const char * in, component * errors);


                /**
                 * Parse an open File.
                 *
                 * @param in The already opened File that contains calendar data.
                 *
                 * @param errors An iCalendar formatted list of errors.
                 *
                 * @return Returns the number of octets parsed.
                 *
                 * @see File()
                 */
                bool                    parse(File * in, component * errors);

                /**
                 * Parse the contents of a already initialized Parse() object that
                 * contains calendar data.
                 *
                 * @param in The already initialized Parse() object.
                 *
                 * @param errors An iCalendar formatted list of errors.
                 *
                 * @return Returns the number of octets parsed.
                 *
                 * @see Parse()
                 */
                bool                    parse(Parse & in, component * errors);

                /**
                 * Do basic checking to determine if the data parsed looks like
                 * some kind of known iCalendar object.
                 *
                 * @return TRUE if it looks valid after parsing.
                 */
                bool                    valid() const;

                /**
                 * Add another iCalendar to this object.
                 *
                 * @param anotheriCal the other iCalendar pointer.
                 *
                 * @return TRUE if added.
                 */
                bool                    add(const iCalendar * anotheriCal);

                /**
                 * Add an icalbody to this iCalendar object.
                 *
                 * @param body The icalbody to add.
                 *
                 * @return TRUE if added.
                 */
                bool                    add(const icalbody * body);

                /**
                 * Add a component to this iCalendar object.
                 *
                 * @param comp The component to add.
                 *
                 * @return TRUE if added.
                 */
                bool                    add(const component * comp);

                /**
                 * Add a property to the iCalendar object.
                 *
                 * @param prop The property to add.
                 *
                 * @return TRUE if added.
                 */
                bool                    add(const property * prop);

                /**
                 * Convert this object to an RFC-iCalendar formatted string.
                 *
                 * @param Results A pointer to a String where the results will
                 * be appended to.
                 * 
                 * @return TRUE when something was added to Results.
                 */
                bool                    sprint(String * Results) const;


                /**
                 * Get the number of iCalender objects in this object.
                 *
                 * @return The number of iCalendar objects in this object.
                 */
                unsigned int            getiCalCount() const;

                /**
                 * Get the nTh ical object.
                 *
                 * @param nTh nTh starts at zero for the first object.
                 *
                 * @return NULL if the Nth iCalendar object does not exist.
                 */
                iCalendar           *   getiCal(unsigned int nTh) const;

                /**
                 * Get the number of icalbody objects in this object.
                 *
                 * @return The number of icalbody objects in this object.
                 */
                unsigned int            getBodyCount() const;

                /**
                 * Get the nTh icalbody object.
                 *
                 * @param nTh nTh starts at zero for the first object.
                 *
                 * @return NULL if the Nth icalbody object does not exist.
                 */
                icalbody            *   getiCalBody(unsigned int nTh) const;

                /**
                * Return the number of components in this object.
                *
                * @return The number of components in this object.
                */
                unsigned int            getComponentCount() const;

                /**
                 * Return the number of components in this object of type typeToCount.
                 *
                 * @param typeToCount Only count this kind of components in the results.
                 *
                 * @return The number of components in this object.
                 */
                unsigned int            getComponentCount(Tokens_t typeToCount) const;

                /**
                * Return the nTh component.
                *
                * @param nTh nTh starts from zero.
                *
                * @return NULL if not found, else the nTh component.
                */
                component           *   getComponent(unsigned int nTh) const;

                /**
                 * Return the nTh component that is typeToGet
                 *
                 * @param typeToGet Get the nTh component of this type.
                 *
                 * @param nTh nTh starts from zero.
                 *
                 * @return NULL if not found, else the nTh component.
                 */
                component           *   getComponent(Tokens_t typeToGet, unsigned int nTh) const;

                /**
                * Return the number of properties in this object.
                *
                * @return The number of properties in this object.
                */
                unsigned int            getPropertyCount() const;

                /**
                 * Return the nTh property.
                 *
                 * @param nTh nTh starts from zero.
                 *
                 * @return NULL if not found, else the nTh property.
                 */
                property            *   getProperty(unsigned int nTh) const;

            protected:
                iCalendarVec        *   _icalList;
                icalbodyVec         *   _bodyList;
                componentVec        *   _componentList;
                propertyVec         *   _propertyList;
                void                *   _userData;
            };

            /** 
             * @typedef iCalendarVec
             * An array of iCalendar.
             */
            //typedef vector<iCalendar*>      iCalendarVec;

            /**
             * Convert the object token ID into a string.
             *
             * @param token The token ID to convert to a string.
             *
             * @return NULL if not a valid ID, or the text string that
             * token represents.
             */
            EXPORT_ICALENDAR const char *   token2text(Tokens_t token);

            /**
             * Convert a string into an object token ID.
             *
             * @param TokenString The string to convert.
             *
             * @param Length If Length is greater than zero, only convert up to Length characters.
             *
             * @return The token ID matching TokenString (up to Length), or UnknownToken_t if not known.
             */
             EXPORT_ICALENDAR Tokens_t      text2token(const char * TokenString, size_t Length = 0);

            /**
             * Many of the methods in the iCalendar namespace will define their own valid() function.
             * requiredList is an object that describes some basic validation information.
             */
            struct EXPORT_ICALENDAR requiredList {

                /**
                 * A token (type of object) that it can have.
                 */
                Tokens_t                    token;

                /**
                 * When TRUE, a component, property, parameter, or value of type 'token'
                 * must be supplied in the object.
                 */
                bool                        required;

                /**
                 * The maximum number of times the token type can be included.
                 * Unlimited = UCHAR_MAX
                 */
                unsigned char               maxInstances;

                /**
                 * The minimum number of times the token type can be included.
                 */
                unsigned char               minInstances;

            };

            /**
             * This is the start of a parsing idea.
             * Each type of property or parameter will have a PAdispatch_f
             * or a POdispatch_f. The parse function will be called
             * from a top level parser, which will call the correct
             * property or parameter parser.
             *
             * C++ virtual functions were having a problem because
             * some of the object types are not known until after
             * they are parsed, so the runtime code does not know
             * which to call. A base + derived virtual parse
             * function will be implemented.
             */
            EXPORT_ICALENDAR typedef parameter  *   (*PAdispatch_f)(const char * text);
            EXPORT_ICALENDAR typedef property   *   (*POdispatch_f)(const char * text);

            /**
             * The dispatch table will contain the string  name (of 
             * a property pr parameter), then depending on the context
             * the pa_func or po_func will be called (if they exist).
             *
             *  - If no pa_function (for parameters) and we are parsing
             *      parameters, then xparam will be called.
             *
             *  - If no po_function (for properties) and we are parsing
             *      properties, then xprop will be called.
             */
            struct EXPORT_ICALENDAR dispatchTable {
                const char              *   string;
                PAdispatch_f                pa_func;
                POdispatch_f                po_func;
            };

        }
    }
}

#endif /*__DOUGLAS_MARK_ROYER_LIBRARY_ICALENDAR_HPP__ */