From e90aa50001b8014497651628666455ab5c12c7b0 Mon Sep 17 00:00:00 2001 From: Federico Mena Quintero Date: Tue, 19 Dec 2000 18:13:34 +0000 Subject: Added proper dependency lists to the gtk-doc mess. 2000-12-19 Federico Mena Quintero Added proper dependency lists to the gtk-doc mess. * calendar/cal-client/Makefile.am (TARGET_DIR): Removed unused variable. (SOURCE_FILES): New variable with the list of source files we depend on. (IGNORED_SOURCE_HEADERS): New variable with the headers we ignore for the gtkdoc-scan phase. (scan_generated): (tmpl_dependencies): (tmpl_sources): (tmpl_generated); (sgml_dependencies): (sgml_generated): Lists of stuff that is generated and that other stuff depends on. (all): Added the $(sgml_generated) as the final target. (install-data-local): Added an installation hook; gtk-doc seems to want some of its generated files to be installed. * calendar/cal-client/evolution-cal-client-sections.txt: Updated. * calendar/cal-util/Makefile.am: Made the same changes as for calendar/cal-client/Makefile.am. * calendar/cal-util/evolution-cal-util-sections.txt: Updated. * Makefile.am (local_entities): Added alarm-generation.sgml. (all): Made the main target be the html/index.html. svn path=/trunk/; revision=7084 --- doc/devel/ChangeLog | 31 ++ doc/devel/Makefile.am | 12 +- doc/devel/calendar/alarm-generation.sgml | 87 +++++- doc/devel/calendar/cal-client/Makefile.am | 101 +++++-- .../cal-client/evolution-cal-client-decl.txt | 47 ++- .../cal-client/evolution-cal-client-sections.txt | 12 +- doc/devel/calendar/cal-client/tmpl/cal-client.sgml | 71 +++-- .../tmpl/evolution-cal-client-unused.sgml | 20 ++ doc/devel/calendar/cal-util/Makefile.am | 115 ++++++-- .../calendar/cal-util/evolution-cal-util-decl.txt | 320 +++++++-------------- .../cal-util/evolution-cal-util-sections.txt | 51 ++-- .../calendar/cal-util/tmpl/cal-component.sgml | 189 +++++++----- doc/devel/calendar/cal-util/tmpl/cal-recur.sgml | 52 +--- doc/devel/calendar/cal-util/tmpl/cal-util.sgml | 14 - .../cal-util/tmpl/evolution-cal-util-unused.sgml | 231 +++++++++++++++ doc/devel/calendar/cal-util/tmpl/timeutil.sgml | 84 ------ help/devel/ChangeLog | 31 ++ help/devel/Makefile.am | 12 +- help/devel/calendar/alarm-generation.sgml | 87 +++++- help/devel/calendar/cal-client/Makefile.am | 101 +++++-- .../cal-client/evolution-cal-client-decl.txt | 47 ++- .../cal-client/evolution-cal-client-sections.txt | 12 +- .../devel/calendar/cal-client/tmpl/cal-client.sgml | 71 +++-- .../tmpl/evolution-cal-client-unused.sgml | 20 ++ help/devel/calendar/cal-util/Makefile.am | 115 ++++++-- .../calendar/cal-util/evolution-cal-util-decl.txt | 320 +++++++-------------- .../cal-util/evolution-cal-util-sections.txt | 51 ++-- .../calendar/cal-util/tmpl/cal-component.sgml | 189 +++++++----- help/devel/calendar/cal-util/tmpl/cal-recur.sgml | 52 +--- help/devel/calendar/cal-util/tmpl/cal-util.sgml | 14 - .../cal-util/tmpl/evolution-cal-util-unused.sgml | 231 +++++++++++++++ help/devel/calendar/cal-util/tmpl/timeutil.sgml | 84 ------ 32 files changed, 1750 insertions(+), 1124 deletions(-) diff --git a/doc/devel/ChangeLog b/doc/devel/ChangeLog index 85b7341bf0..fcad430d33 100644 --- a/doc/devel/ChangeLog +++ b/doc/devel/ChangeLog @@ -1,3 +1,34 @@ +2000-12-19 Federico Mena Quintero + + Added proper dependency lists to the gtk-doc mess. + + * calendar/cal-client/Makefile.am (TARGET_DIR): Removed unused + variable. + (SOURCE_FILES): New variable with the list of source files we + depend on. + (IGNORED_SOURCE_HEADERS): New variable with the headers we ignore + for the gtkdoc-scan phase. + (scan_generated): + (tmpl_dependencies): + (tmpl_sources): + (tmpl_generated); + (sgml_dependencies): + (sgml_generated): Lists of stuff that is generated and that other + stuff depends on. + (all): Added the $(sgml_generated) as the final target. + (install-data-local): Added an installation hook; gtk-doc seems to + want some of its generated files to be installed. + + * calendar/cal-client/evolution-cal-client-sections.txt: Updated. + + * calendar/cal-util/Makefile.am: Made the same changes as for + calendar/cal-client/Makefile.am. + + * calendar/cal-util/evolution-cal-util-sections.txt: Updated. + + * Makefile.am (local_entities): Added alarm-generation.sgml. + (all): Made the main target be the html/index.html. + 2000-12-18 Federico Mena Quintero * calendar/alarm-generation.sgml: New file with a description of diff --git a/doc/devel/Makefile.am b/doc/devel/Makefile.am index 0dd533057e..8e8ca1085c 100644 --- a/doc/devel/Makefile.am +++ b/doc/devel/Makefile.am @@ -22,6 +22,7 @@ content_files = \ # are used for dependency tracking. local_entities = \ + calendar/alarm-generation.sgml \ calendar/architecture.sgml \ calendar/evolution-calendar.sgml \ calendar/public-reference.sgml \ @@ -36,18 +37,15 @@ local_entities = \ EXTRA_DIST = \ $(content_files) -all: evolution-devel-guide.html +all: html/index.html if ENABLE_GTK_DOC -evolution-devel-guide.html: html/index.html - -cd $(srcdir) && cp html/index.html evolution-devel-guide.html -else -evolution-devel-guide.html: -endif - html/index.html: $(content_files) $(local_entities) test -d $(srcdir)/html || mkdir $(srcdir)/html -cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) +else +html/index.html: +endif clean-local: rm -f *~ *.bak *.signals *-unused.txt diff --git a/doc/devel/calendar/alarm-generation.sgml b/doc/devel/calendar/alarm-generation.sgml index 60bc78343e..77d35258da 100644 --- a/doc/devel/calendar/alarm-generation.sgml +++ b/doc/devel/calendar/alarm-generation.sgml @@ -41,7 +41,92 @@ Generating trigger instances - + Generating absolute triggers is trivial; you just use the date + and time they specify. However, relative triggers are + associated to recurrence instances, so in order to generate + trigger instances we must generate the corresponding + recurrence instances and compute the trigger times based on + those. + + + + Since relative triggers are specified as occurring a certain + amount of time before or after each of a calendar component's + recurrence instances, we can compute a trigger time by adding + or subtracting that amount of time to the corresponding + recurrence instance's time. + + + + Recurrence instances are generated by specifying a range of + time and asking the Wombat to generate the instances that + occur within that range. We shall see that the range of time + in which instances occur is not necessarily the same range of + time in which those instances' alarm triggers occur. + + + + Consider an alarm that is set to trigger 10 minutes before the + start time of an event's occurrence, that is, the trigger has + an offset of -10 minutes. Say this event recurs every hour at + 5 minutes past the hour: it would occur at 1:05, 2:05, 3:05, + etc.; the corresponding triggers would occur at 12:55, 1:55, + 2:55, etc. If we wish to compute the alarm triggers that + occur between 4:00 and 6:00 (which would be at 4:55 and 5:55), + then we cannot just generate recurrence instances between 4:00 + and 6:00 because we will miss the 6:05 occurrence which + corresponds to the 5:55 trigger. + + + + The solution is to expand the range of time on both sides to + fit the relative triggers that have the largest time periods. + If a trigger's offset is negative, like the -10 minutes in the + example above, then we must expand the + end of the time range: in the case above, + the range's ending time of 6:00 must be grown by 10 minutes to + 6:10 so that the last recurrence instance will be that of + 6:05; computing the trigger's offset we will get the 5:55 + trigger, which is what we wanted. For triggers with positive + offsets, like if an alarm were to trigger 20 minutes after an + event's occurrence, we must expand the + start of the time range in an analogous + way, by subtracting the time offset from it. + + + + Again, absolute triggers need no special computation. We can + just see if the trigger time is within the requested range of + time, and if so, we take that trigger occurrence into account + for the final result. + + + + + Alarm trigger generation code + + + The main function to generate alarm trigger instances is + generate_alarms_for_comp() in + evolution/calendar/pcs/cal-backend-file.c. + This function calls compute_alarm_range() + to expand the specified range of time in the way described in + the previous section. It then generates the instances for + relative alarm triggers inside the + add_alarm_occurrences_cb() callback, + which is used by + cal_recur_generate_instances() with the + expanded range of time. The callback goes through all of the + calendar component's relative alarm triggers and adds the + trigger offsets to the occurrence's time; the results are + added as CalAlarmInstance structures + to the final list of trigger instances. Finally, + generate_alarms_for_comp() calls + generate_absolute_triggers(), which + simply adds the instances for absolute alarm triggers; these + are the absolute times that are within the time range that was + requested originally. In the very end, the list of instances + is sorted to produce nicer results. diff --git a/doc/devel/calendar/cal-client/Makefile.am b/doc/devel/calendar/cal-client/Makefile.am index 44d43639a8..363c15b326 100644 --- a/doc/devel/calendar/cal-client/Makefile.am +++ b/doc/devel/calendar/cal-client/Makefile.am @@ -1,11 +1,6 @@ -## Process this file with automake to produce Makefile.in - # The name of the module. DOC_MODULE=evolution-cal-client -# The top-level SGML file. -DOC_MAIN_SGML_FILE=evolution-cal-client.sgml - # The directory containing the source code (if it contains documentation). DOC_SOURCE_DIR=$(EVOLUTION_DIR)/calendar/cal-client @@ -22,41 +17,87 @@ LDFLAGS=" \ $(BONOBO_VFS_GNOME_LIBS) \ $(top_builddir)/calendar/cal-client/.libs/libcal-client.a \ $(top_builddir)/calendar/cal-util/.libs/libcal-util.a \ - $(top_builddir)/libical/src/libical/libical.a \ + $(top_builddir)/libical/src/libical/.libs/libical.a \ $(top_builddir)/libversit/.libs/libversit.al \ " -HTML_DIR=$(datadir)/gnome/html +DOC_DIR=$(datadir)/gnome/html -TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) +DOC_DIR_INSTALL_FILES = \ + evolution-cal-client.args \ + evolution-cal-client.hierarchy \ + evolution-cal-client.signals \ + evolution-cal-client.types \ + evolution-cal-client-decl.txt \ + evolution-cal-client-sections.txt -tmpl_sources = \ - tmpl/cal-client.sgml \ - tmpl/evolution-cal-client-unused.sgml +SOURCE_FILES = \ + $(top_srcdir)/calendar/cal-client/cal-client.c \ + $(top_srcdir)/calendar/cal-client/cal-client.h \ + $(top_srcdir)/calendar/cal-client/cal-client-types.c \ + $(top_srcdir)/calendar/cal-client/cal-client-types.h -evolution_cal_client_docdir = $(HTML_DIR) -evolution_cal_client_doc_DATA = \ +IGNORED_HEADER_FILES = \ + cal-listener.h \ + evolution-calendar.h + +scan_generated = \ + evolution-cal-client-decl.txt \ + evolution-cal-client.args \ evolution-cal-client.hierarchy \ - evolution-cal-client.types \ + evolution-cal-client.signals \ + evolution-cal-client.types + +tmpl_dependencies = \ evolution-cal-client-decl.txt \ - evolution-cal-client-sections.txt + evolution-cal-client-sections.txt \ + evolution-cal-client.args \ + evolution-cal-client.hierarchy \ + evolution-cal-client.signals -EXTRA_DIST = \ - $(evolution_cal_client_doc_DATA) +tmpl_sources = \ + tmpl/cal-client.sgml \ + tmpl/evolution-cal-client-unused.sgml -sgml/evolution-cal-client-doc.bottom: $(tmpl_sources) - $(MAKE) sgml +tmpl_generated = \ + evolution-cal-client-unused.txt -scan: - -(cd $(srcdir) \ - && env CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) \ - gtkdoc-scanobj --module=$(DOC_MODULE) \ - && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="cal-listener.h evolution-calendar.h" ) +sgml_dependencies = \ + evolution-cal-client-decl.txt \ + evolution-cal-client-sections.txt \ + evolution-cal-client.args \ + evolution-cal-client.hierarchy \ + evolution-cal-client.signals \ + tmpl/cal-client.sgml + +sgml_generated = \ + sgml/cal-client.sgml \ + sgml/evolution-cal-client-doc.bottom \ + sgml/evolution-cal-client-doc.top \ + sgml/object_index.sgml \ + sgml/tree_index.sgml -templates: scan +EXTRA_DIST = \ + evolution-cal-client.args \ + evolution-cal-client.hierarchy \ + evolution-cal-client.signals \ + evolution-cal-client.types \ + evolution-cal-client-decl.txt \ + evolution-cal-client-sections.txt + +all: $(sgml_generated) + +scan $(scan_generated): $(SOURCE_FILES) + -(cd $(srcdir) \ + && env CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) \ + gtkdoc-scanobj --module=$(DOC_MODULE) \ + && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) \ + --ignore-headers="$(IGNORED_HEADER_FILES)" ) + +templates $(tmpl_sources) $(tmpl_generated): $(tmpl_dependencies) cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) -sgml: +sgml $(sgml_generated): $(sgml_dependencies) cd $(srcdir) \ && gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) @@ -66,6 +107,12 @@ clean-local: maintainer-clean-local: clean cd $(srcdir) && rm -rf sgml $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt +install-data-local: + $(mkinstalldirs) $(DOC_DIR) + for i in $(DOC_DIR_INSTALL_FILES); do \ + $(INSTALL_DATA) $$i $(DOC_DIR); \ + done + dist-hook: mkdir $(distdir)/sgml mkdir $(distdir)/tmpl @@ -73,4 +120,4 @@ dist-hook: -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml -cp $(srcdir)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml -.PHONY : sgml templates scan +.PHONY: scan templates sgml diff --git a/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt b/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt index 0574d70678..498285a370 100644 --- a/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt +++ b/doc/devel/calendar/cal-client/evolution-cal-client-decl.txt @@ -24,6 +24,9 @@ CalClientClass + +CalClientPrivate + CalClientLoadStatus typedef enum { @@ -47,7 +50,7 @@ struct CalClient { GtkObject object; /* Private data */ - gpointer priv; + CalClientPrivate *priv; }; @@ -76,6 +79,11 @@ CalClient *client, const char *str_uri CalClient *client, const char *str_uri +cal_client_is_loaded +gboolean +CalClient *client + + cal_client_get_n_objects int CalClient *client, CalObjType type @@ -86,21 +94,16 @@ CalClient *client, CalObjType type CalClient *client,const char *uid,CalComponent **comp -cal_client_get_uid_by_pilot_id -CalClientGetStatus -CalClient *client,unsigned long pilot_id,char **uid - - -cal_client_update_pilot_id -void -CalClient *client, char *uid,unsigned long pilot_id,unsigned long pilot_status - - cal_client_get_uids GList * CalClient *client, CalObjType type +cal_client_get_changes +GList * +CalClient *client, CalObjType type, const char *change_id + + cal_client_get_objects_in_range GList * CalClient *client, CalObjType type,time_t start, time_t end @@ -112,13 +115,18 @@ CalClient *client, CalObjType type,time_t start, time_t end,CalRecurInstanceFn c cal_client_get_alarms_in_range -GList * +GSList * CalClient *client, time_t start, time_t end +cal_client_free_alarms +void +GSList *comp_alarms + + cal_client_get_alarms_for_object gboolean -CalClient *client, const char *uid,time_t start, time_t end,GList **alarms +CalClient *client, const char *uid,time_t start, time_t end,CalComponentAlarms **alarms cal_client_update_object @@ -130,3 +138,16 @@ CalClient *client, CalComponent *comp gboolean CalClient *client, const char *uid + +CalClientChangeType +typedef enum { + CAL_CLIENT_CHANGE_ADDED = 1 << 0, + CAL_CLIENT_CHANGE_MODIFIED = 1 << 1, + CAL_CLIENT_CHANGE_DELETED = 1 << 2 +} CalClientChangeType; + + +cal_client_change_list_free +void +GList *list + diff --git a/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt b/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt index c37b223247..3e4eafbf48 100644 --- a/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt +++ b/doc/devel/calendar/cal-client/evolution-cal-client-sections.txt @@ -7,17 +7,22 @@ CAL_CLIENT CalClientLoadStatus CalClientGetStatus + +CalClientChangeType + cal_client_new cal_client_load_calendar cal_client_create_calendar +cal_client_is_loaded cal_client_get_n_objects +cal_client_get_uids cal_client_get_object +cal_client_get_changes +cal_client_change_list_free cal_client_get_objects_in_range cal_client_generate_instances -cal_client_get_uid_by_pilot_id -cal_client_update_pilot_id -cal_client_get_uids cal_client_get_alarms_in_range +cal_client_free_alarms cal_client_get_alarms_for_object cal_client_update_object cal_client_remove_object @@ -33,5 +38,6 @@ cal_client_construct CalClient +CalClientPrivate diff --git a/doc/devel/calendar/cal-client/tmpl/cal-client.sgml b/doc/devel/calendar/cal-client/tmpl/cal-client.sgml index 06469ff3ee..6de1ab8045 100644 --- a/doc/devel/calendar/cal-client/tmpl/cal-client.sgml +++ b/doc/devel/calendar/cal-client/tmpl/cal-client.sgml @@ -84,6 +84,15 @@ GTK+ object for communication with personal calendar server. the requested object. This could indicate a bug in the calendar client libraries or in the Wombat server. + + + + + +@CAL_CLIENT_CHANGE_ADDED: +@CAL_CLIENT_CHANGE_MODIFIED: +@CAL_CLIENT_CHANGE_DELETED: + @@ -112,6 +121,15 @@ GTK+ object for communication with personal calendar server. @Returns: + + + + + +@client: +@Returns: + + @@ -122,6 +140,16 @@ GTK+ object for communication with personal calendar server. @Returns: + + + + + +@client: +@type: +@Returns: + + @@ -135,72 +163,67 @@ GTK+ object for communication with personal calendar server. @ico: - + @client: @type: -@start: -@end: +@change_id: @Returns: - + -@client: -@type: -@start: -@end: -@cb: -@cb_data: +@list: - + @client: -@pilot_id: -@uid: +@type: +@start: +@end: @Returns: - + @client: -@uid: -@pilot_id: -@pilot_status: +@type: +@start: +@end: +@cb: +@cb_data: - + @client: -@type: +@start: +@end: @Returns: - + -@client: -@start: -@end: -@Returns: +@comp_alarms: diff --git a/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml b/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml index 5576dbd57f..a0c23894d9 100644 --- a/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml +++ b/doc/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml @@ -1,3 +1,13 @@ + + + + + +@client: +@uid: +@pilot_id: +@pilot_status: + @@ -8,3 +18,13 @@ @end: @Returns: + + + + + +@client: +@pilot_id: +@uid: +@Returns: + diff --git a/doc/devel/calendar/cal-util/Makefile.am b/doc/devel/calendar/cal-util/Makefile.am index 8861aa03cb..b7308800c8 100644 --- a/doc/devel/calendar/cal-util/Makefile.am +++ b/doc/devel/calendar/cal-util/Makefile.am @@ -1,11 +1,6 @@ -## Process this file with automake to produce Makefile.in - # The name of the module. DOC_MODULE=evolution-cal-util -# The top-level SGML file. -DOC_MAIN_SGML_FILE=evolution-cal-util.sgml - # The directory containing the source code (if it contains documentation). DOC_SOURCE_DIR=$(EVOLUTION_DIR)/calendar/cal-util @@ -21,41 +16,99 @@ CFLAGS =" \ LDFLAGS=" \ $(BONOBO_VFS_GNOME_LIBS) \ $(top_builddir)/calendar/cal-util/.libs/libcal-util.a \ - $(top_builddir)/libical/src/libical/libical.a \ + $(top_builddir)/libical/src/libical/.libs/libical.a \ $(top_builddir)/libversit/.libs/libversit.al \ " -HTML_DIR=$(datadir)/gnome/html +DOC_DIR=$(datadir)/gnome/html + +DOC_DIR_INSTALL_FILES = \ + evolution-cal-util.args \ + evolution-cal-util.hierarchy \ + evolution-cal-util.signals \ + evolution-cal-util.types \ + evolution-cal-util-decl.txt \ + evolution-cal-util-sections.txt + +SOURCE_FILES = \ + $(top_srcdir)/calendar/cal-util/cal-component.c \ + $(top_srcdir)/calendar/cal-util/cal-component.h \ + $(top_srcdir)/calendar/cal-util/cal-recur.c \ + $(top_srcdir)/calendar/cal-util/cal-recur.h \ + $(top_srcdir)/calendar/cal-util/cal-util.c \ + $(top_srcdir)/calendar/cal-util/cal-util.h \ + $(top_srcdir)/calendar/cal-util/timeutil.c \ + $(top_srcdir)/calendar/cal-util/timeutil.h + +IGNORED_HEADER_FILES = \ + calobj.h + +scan_generated = \ + evolution-cal-util-decl.txt \ + evolution-cal-util.args \ + evolution-cal-util.hierarchy \ + evolution-cal-util.signals \ + evolution-cal-util.types -TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) +tmpl_dependencies = \ + evolution-cal-util-decl.txt \ + evolution-cal-util-sections.txt \ + evolution-cal-util.args \ + evolution-cal-util.hierarchy \ + evolution-cal-util.signals tmpl_sources = \ + tmpl/cal-component.sgml \ + tmpl/cal-recur.sgml \ tmpl/cal-util.sgml \ - tmpl/evolution-cal-util-unused.sgml + tmpl/evolution-cal-util-unused.sgml \ + tmpl/timeutil.sgml -evolution_cal_util_docdir = $(HTML_DIR) -evolution_cal_util_doc_DATA = \ - evolution-cal-util.hierarchy \ - evolution-cal-util.types \ +tmpl_generated = \ + evolution-cal-util-unused.txt + +sgml_dependencies = \ evolution-cal-util-decl.txt \ - evolution-cal-util-sections.txt + evolution-cal-util-sections.txt \ + evolution-cal-util.args \ + evolution-cal-util.hierarchy \ + evolution-cal-util.signals \ + tmpl/cal-component.sgml \ + tmpl/cal-recur.sgml \ + tmpl/cal-util.sgml \ + tmpl/timeutil.sgml + +sgml_generated = \ + sgml/cal-component.sgml \ + sgml/cal-recur.sgml \ + sgml/cal-util.sgml \ + sgml/evolution-cal-util-doc.bottom \ + sgml/evolution-cal-util-doc.top \ + sgml/object_index.sgml \ + sgml/timeutil.sgml \ + sgml/tree_index.sgml EXTRA_DIST = \ - $(evolution_cal_util_doc_DATA) - -sgml/evolution-cal-util-doc.bottom: $(tmpl_sources) - $(MAKE) sgml - -scan: - -(cd $(srcdir) \ - && env CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) \ - gtkdoc-scanobj --module=$(DOC_MODULE) \ - && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="calobj.h icalendar-save.h icalendar.h" ) - -templates: scan + evolution-cal-util.args \ + evolution-cal-util.hierarchy \ + evolution-cal-util.signals \ + evolution-cal-util.types \ + evolution-cal-util-decl.txt \ + evolution-cal-util-sections.txt + +all: $(sgml_generated) + +scan $(scan_generated): $(SOURCE_FILES) + -(cd $(srcdir) \ + && env CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) \ + gtkdoc-scanobj --module=$(DOC_MODULE) \ + && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) \ + --ignore-headers="$(IGNORED_HEADER_FILES)" ) + +templates $(tmpl_sources) $(tmpl_generated): $(tmpl_dependencies) cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) -sgml: +sgml $(sgml_generated): $(sgml_dependencies) cd $(srcdir) \ && gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) @@ -65,6 +118,12 @@ clean-local: maintainer-clean-local: clean cd $(srcdir) && rm -rf sgml $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt +install-data-local: + $(mkinstalldirs) $(DOC_DIR) + for i in $(DOC_DIR_INSTALL_FILES); do \ + $(INSTALL_DATA) $$i $(DOC_DIR); \ + done + dist-hook: mkdir $(distdir)/sgml mkdir $(distdir)/tmpl @@ -72,4 +131,4 @@ dist-hook: -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml -cp $(srcdir)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml -.PHONY : sgml templates scan +.PHONY: scan templates sgml diff --git a/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt b/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt index eb108b868f..f190d325fc 100644 --- a/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt +++ b/doc/devel/calendar/cal-util/evolution-cal-util-decl.txt @@ -114,9 +114,6 @@ typedef enum { } CalComponentTransparency; -CalComponentAlarm - - CalComponent @@ -305,16 +302,36 @@ CalComponent *comp, GSList **exdate_list CalComponent *comp, GSList *exdate_list +cal_component_has_exdates +gboolean +CalComponent *comp + + cal_component_get_exrule_list void CalComponent *comp, GSList **recur_list +cal_component_get_exrule_property_list +void +CalComponent *comp, GSList **recur_list + + cal_component_set_exrule_list void CalComponent *comp, GSList *recur_list +cal_component_has_exrules +gboolean +CalComponent *comp + + +cal_component_has_exceptions +gboolean +CalComponent *comp + + cal_component_get_geo void CalComponent *comp, struct icalgeotype **geo @@ -375,6 +392,11 @@ CalComponent *comp CalComponent *comp, GSList **recur_list +cal_component_get_rrule_property_list +void +CalComponent *comp, GSList **recur_list + + cal_component_set_rrule_list void CalComponent *comp, GSList *recur_list @@ -385,6 +407,11 @@ CalComponent *comp, GSList *recur_list CalComponent *comp +cal_component_has_recurrences +gboolean +CalComponent *comp + + cal_component_get_sequence void CalComponent *comp, int **sequence @@ -395,6 +422,16 @@ CalComponent *comp, int **sequence CalComponent *comp, int *sequence +cal_component_get_status +void +CalComponent *comp, icalproperty_status *status + + +cal_component_set_status +void +CalComponent *comp, icalproperty_status status + + cal_component_get_summary void CalComponent *comp, CalComponentText *summary @@ -425,26 +462,6 @@ CalComponent *comp, const char **url CalComponent *comp, const char *url -cal_component_get_pilot_id -void -CalComponent *comp, unsigned long *pilot_id - - -cal_component_set_pilot_id -void -CalComponent *comp, unsigned long pilot_id - - -cal_component_get_pilot_status -void -CalComponent *comp, unsigned long *pilot_status - - -cal_component_set_pilot_status -void -CalComponent *comp, unsigned long pilot_status - - cal_component_free_categories_list void GSList *categ_list @@ -499,167 +516,119 @@ int *sequence void GSList *text_list + +CalComponentAlarm + + +CalAlarmInstance +typedef struct { + /* UID of the alarm that triggered */ + const char *auid; + + /* Trigger time, i.e. "5 minutes before the appointment" */ + time_t trigger; + + /* Actual event occurrence to which this trigger corresponds */ + time_t occur; +} CalAlarmInstance; + + +CalComponentAlarms +typedef struct { + /* The actual component */ + CalComponent *comp; + + /* List of CalAlarmInstance structures */ + GSList *alarms; +} CalComponentAlarms; + -CalComponentAlarmAction -typedef enum { - CAL_COMPONENT_ALARM_NONE, - CAL_COMPONENT_ALARM_AUDIO, - CAL_COMPONENT_ALARM_DISPLAY, - CAL_COMPONENT_ALARM_EMAIL, - CAL_COMPONENT_ALARM_PROCEDURE, - CAL_COMPONENT_ALARM_UNKNOWN -} CalComponentAlarmAction; - - -CalComponentAlarmTriggerType +CalAlarmAction typedef enum { - CAL_COMPONENT_ALARM_TRIGGER_RELATIVE, - CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE -} CalComponentAlarmTriggerType; + CAL_ALARM_NONE, + CAL_ALARM_AUDIO, + CAL_ALARM_DISPLAY, + CAL_ALARM_EMAIL, + CAL_ALARM_PROCEDURE, + CAL_ALARM_UNKNOWN +} CalAlarmAction; -CalComponentAlarmTriggerRelated +CalAlarmTriggerType typedef enum { - CAL_COMPONENT_ALARM_TRIGGER_RELATED_START, - CAL_COMPONENT_ALARM_TRIGGER_RELATED_END -} CalComponentAlarmTriggerRelated; + CAL_ALARM_TRIGGER_NONE, + CAL_ALARM_TRIGGER_RELATIVE_START, + CAL_ALARM_TRIGGER_RELATIVE_END, + CAL_ALARM_TRIGGER_ABSOLUTE +} CalAlarmTriggerType; -CalComponentAlarmTrigger +CalAlarmTrigger typedef struct { - CalComponentAlarmTriggerType type; + CalAlarmTriggerType type; union { - struct { - struct icaldurationtype duration; - CalComponentAlarmTriggerRelated related; - } relative; - - struct icaltimetype absolute; + struct icaldurationtype rel_duration; + struct icaltimetype abs_time; } u; -} CalComponentAlarmTrigger; +} CalAlarmTrigger; -cal_component_get_first_alarm -CalComponentAlarm * +cal_component_has_alarms +gboolean CalComponent *comp -cal_component_get_next_alarm -CalComponentAlarm * +cal_component_get_alarm_uids +GList * CalComponent *comp +cal_component_get_alarm +CalComponentAlarm * +CalComponent *comp, const char *auid + + cal_component_alarm_free void CalComponentAlarm *alarm +cal_component_alarms_free +void +CalComponentAlarms *alarms + + +cal_component_alarm_get_uid +const char * +CalComponentAlarm *alarm + + cal_component_alarm_get_action void -CalComponentAlarm *alarm, CalComponentAlarmAction *action +CalComponentAlarm *alarm, CalAlarmAction *action cal_component_alarm_set_action void -CalComponentAlarm *alarm, CalComponentAlarmAction action +CalComponentAlarm *alarm, CalAlarmAction action cal_component_alarm_get_trigger void -CalComponentAlarm *alarm, CalComponentAlarmTrigger **trigger +CalComponentAlarm *alarm, CalAlarmTrigger *trigger cal_component_alarm_set_trigger void -CalComponentAlarm *alarm, CalComponentAlarmTrigger *trigger - - -cal_component_alarm_free_trigger -void -CalComponentAlarmTrigger *trigger +CalComponentAlarm *alarm, CalAlarmTrigger trigger - -CalRecurType -typedef enum { - CAL_RECUR_YEARLY, - CAL_RECUR_MONTHLY, - CAL_RECUR_WEEKLY, - CAL_RECUR_DAILY, - CAL_RECUR_HOURLY, - CAL_RECUR_MINUTELY, - CAL_RECUR_SECONDLY -} CalRecurType; - - -CalRecurrence -typedef struct { - CalRecurType type; - - int interval; - - /* Specifies the end of the recurrence. No occurrences are generated - after this date. If it is 0, the event recurs forever. */ - time_t enddate; - - /* WKST property - the week start day: 0 = Monday to 6 = Sunday. */ - gint week_start_day; - - - /* NOTE: I've used GList's here, but it doesn't matter if we use - other data structures like arrays. The code should be easy to - change. So long as it is easy to see if the modifier is set. */ - - /* For BYMONTH modifier. A list of GINT_TO_POINTERs, 0-11. */ - GList *bymonth; - - /* For BYWEEKNO modifier. A list of GINT_TO_POINTERs, [+-]1-53. */ - GList *byweekno; - - /* For BYYEARDAY modifier. A list of GINT_TO_POINTERs, [+-]1-366. */ - GList *byyearday; - - /* For BYMONTHDAY modifier. A list of GINT_TO_POINTERs, [+-]1-31. */ - GList *bymonthday; - - /* For BYDAY modifier. A list of GINT_TO_POINTERs, in pairs. - The first of each pair is the weekday, 0 = Monday to 6 = Sunday. - The second of each pair is the week number [+-]0-53. */ - GList *byday; - - /* For BYHOUR modifier. A list of GINT_TO_POINTERs, 0-23. */ - GList *byhour; - - /* For BYMINUTE modifier. A list of GINT_TO_POINTERs, 0-59. */ - GList *byminute; - - /* For BYSECOND modifier. A list of GINT_TO_POINTERs, 0-60. */ - GList *bysecond; - - /* For BYSETPOS modifier. A list of GINT_TO_POINTERs, +ve or -ve. */ - GList *bysetpos; -} CalRecurrence; - - -CalObjTime - - -CalObjTime -struct CalObjTime { - guint16 year; - guint8 month; /* 0 - 11 */ - guint8 day; /* 1 - 31 */ - guint8 hour; /* 0 - 23 */ - guint8 minute; /* 0 - 59 */ - guint8 second; /* 0 - 59 (maybe 60 for leap second) */ -}; - CalRecurInstanceFn gboolean CalComponent *comp, time_t instance_start, - time_t instace_end, + time_t instance_end, gpointer data @@ -667,16 +636,6 @@ CalComponent *comp, void CalComponent *comp,time_t start,time_t end,CalRecurInstanceFn cb,gpointer cb_data - -cal_recur_from_icalrecurrencetype -CalRecurrence * -struct icalrecurrencetype *ir - - -cal_recur_free -void -CalRecurrence *r - CalObjInstance typedef struct { @@ -690,22 +649,6 @@ typedef struct { void GList *list - -CalAlarmInstance -typedef struct { - char *uid; /* UID of object */ -#if 0 - enum AlarmType type; /* Type of alarm */ -#endif - time_t trigger; /* Alarm trigger time */ - time_t occur; /* Occurrence time */ -} CalAlarmInstance; - - -cal_alarm_instance_list_free -void -GList *list - CalObjType typedef enum { @@ -721,41 +664,11 @@ typedef enum { GList *list -time_from_icaltimetype -time_t -struct icaltimetype itt - - -time_from_isodate -time_t -char *str - - -time_from_start_duration -time_t -time_t start, char *duration - - isodate_from_time_t char * time_t t -get_time_t_hour -int -time_t t - - -isodiff_to_secs -int -char *str - - -isodiff_from_secs -char * -int secs - - time_add_minutes time_t time_t time, int minutes @@ -781,11 +694,6 @@ time_t time, int months time_t time, int years -format_simple_hour -char * -int hour, int use_am_pm - - time_days_in_month int int year, int month @@ -796,11 +704,6 @@ int year, int month int year, int month, int day -time_day_hour -time_t -time_t t, int hour - - time_year_begin time_t time_t t @@ -841,11 +744,6 @@ time_t t time_t t -parse_date -time_t -char *str - - print_time_t void time_t t diff --git a/doc/devel/calendar/cal-util/evolution-cal-util-sections.txt b/doc/devel/calendar/cal-util/evolution-cal-util-sections.txt index cd928fc7e3..130209e71c 100644 --- a/doc/devel/calendar/cal-util/evolution-cal-util-sections.txt +++ b/doc/devel/calendar/cal-util/evolution-cal-util-sections.txt @@ -11,8 +11,6 @@ CalComponentPeriodType CalComponentPeriod CalComponentText CalComponentTransparency -CalComponentAlarm -CalComponentPrivate cal_component_gen_uid cal_component_new @@ -47,8 +45,12 @@ cal_component_get_due cal_component_set_due cal_component_get_exdate_list cal_component_set_exdate_list +cal_component_has_exdates cal_component_get_exrule_list +cal_component_get_exrule_property_list cal_component_set_exrule_list +cal_component_has_exrules +cal_component_has_exceptions cal_component_get_geo cal_component_set_geo cal_component_get_last_modified @@ -61,21 +63,22 @@ cal_component_get_rdate_list cal_component_set_rdate_list cal_component_has_rdates cal_component_get_rrule_list +cal_component_get_rrule_property_list cal_component_set_rrule_list cal_component_has_rrules +cal_component_has_recurrences cal_component_get_sequence cal_component_set_sequence +cal_component_get_status +cal_component_set_status cal_component_get_summary cal_component_set_summary cal_component_get_transparency cal_component_set_transparency cal_component_get_url cal_component_set_url -cal_component_get_pilot_id -cal_component_set_pilot_id -cal_component_get_pilot_status -cal_component_set_pilot_status + cal_component_free_categories_list cal_component_free_datetime cal_component_free_exdate_list @@ -88,19 +91,24 @@ cal_component_free_recur_list cal_component_free_sequence cal_component_free_text_list -CalComponentAlarmAction -CalComponentAlarmTriggerType -CalComponentAlarmTriggerRelated -CalComponentAlarmTrigger + +CalComponentAlarm +CalAlarmInstance +CalComponentAlarms +CalAlarmAction +CalAlarmTriggerType +CalAlarmTrigger -cal_component_get_first_alarm -cal_component_get_next_alarm +cal_component_has_alarms +cal_component_get_alarm_uids +cal_component_get_alarm cal_component_alarm_free +cal_component_alarms_free +cal_component_alarm_get_uid cal_component_alarm_get_action cal_component_alarm_set_action cal_component_alarm_get_trigger cal_component_alarm_set_trigger -cal_component_alarm_free_trigger CAL_COMPONENT_TYPE @@ -111,48 +119,34 @@ cal_component_get_type CalComponent +CalComponentPrivate
cal-recur -CalRecurType -CalRecurrence -CalObjTime CalRecurInstanceFn cal_recur_generate_instances -cal_recur_from_icalrecurrencetype -cal_recur_free
cal-util CalObjInstance cal_obj_instance_list_free -CalAlarmInstance -cal_alarm_instance_list_free CalObjType cal_obj_uid_list_free
timeutil -time_from_icaltimetype -time_from_isodate -time_from_start_duration isodate_from_time_t -get_time_t_hour -isodiff_to_secs -isodiff_from_secs time_add_minutes time_add_day time_add_week time_add_month time_add_year -format_simple_hour time_days_in_month time_from_day -time_day_hour time_year_begin time_year_end time_month_begin @@ -161,6 +155,5 @@ time_week_begin time_week_end time_day_begin time_day_end -parse_date print_time_t
diff --git a/doc/devel/calendar/cal-util/tmpl/cal-component.sgml b/doc/devel/calendar/cal-util/tmpl/cal-component.sgml index 56a04b02a0..c429e22a9c 100644 --- a/doc/devel/calendar/cal-util/tmpl/cal-component.sgml +++ b/doc/devel/calendar/cal-util/tmpl/cal-component.sgml @@ -85,7 +85,6 @@ RFC 2445 iCalendar component object. @CAL_COMPONENT_NO_TYPE: Returned from cal_component_get_vtype() to indicate an uninitialized #CalComponent object. - @CAL_COMPONENT_EVENT: Indicates a VEVENT component. @CAL_COMPONENT_TODO: Indicates a VTODO component. @CAL_COMPONENT_JOURNAL: Indicates a VJOURNAL component. @@ -126,11 +125,9 @@ RFC 2445 iCalendar component object. @CAL_COMPONENT_CLASS_NONE: Indicates that no access classification has been set for the corresponding component. - @CAL_COMPONENT_CLASS_PUBLIC: Public access. @CAL_COMPONENT_CLASS_PRIVATE: Private access. @CAL_COMPONENT_CLASS_CONFIDENTIAL: Confidential access. - @CAL_COMPONENT_CLASS_UNKNOWN: Unknown access classification value, used when &libical; returns something #CalComponent does not know about. @@ -148,7 +145,6 @@ RFC 2445 iCalendar component object. @CAL_COMPONENT_PERIOD_DATETIME: Indicates that the period is specified by starting and ending date/time values. - @CAL_COMPONENT_PERIOD_DURATION: Indicates that the period is specified as a starding date/time and a duration value. @@ -175,18 +171,6 @@ RFC 2445 iCalendar component object. @CAL_COMPONENT_TRANSP_OPAQUE: @CAL_COMPONENT_TRANSP_UNKNOWN: - - - - - - - - - - - - @@ -482,6 +466,15 @@ RFC 2445 iCalendar component object. @exdate_list: + + + + + +@comp: +@Returns: + + @@ -491,6 +484,15 @@ RFC 2445 iCalendar component object. @recur_list: + + + + + +@comp: +@recur_list: + + @@ -500,6 +502,24 @@ RFC 2445 iCalendar component object. @recur_list: + + + + + +@comp: +@Returns: + + + + + + + +@comp: +@Returns: + + @@ -608,7 +628,7 @@ RFC 2445 iCalendar component object. @recur_list: - + @@ -617,121 +637,121 @@ RFC 2445 iCalendar component object. @recur_list: - + @comp: -@Returns: +@recur_list: - + @comp: -@sequence: +@Returns: - + @comp: -@sequence: +@Returns: - + @comp: -@summary: +@sequence: - + @comp: -@summary: +@sequence: - + @comp: -@transp: +@status: - + @comp: -@transp: +@status: - + @comp: -@url: +@summary: - + @comp: -@url: +@summary: - + @comp: -@pilot_id: +@transp: - + @comp: -@pilot_id: +@transp: - + @comp: -@pilot_status: +@url: - + @comp: -@pilot_status: +@url: @@ -822,41 +842,62 @@ RFC 2445 iCalendar component object. @text_list: - + + + + + + + + + + + + + + + + + + + -@CAL_COMPONENT_ALARM_NONE: -@CAL_COMPONENT_ALARM_AUDIO: -@CAL_COMPONENT_ALARM_DISPLAY: -@CAL_COMPONENT_ALARM_EMAIL: -@CAL_COMPONENT_ALARM_PROCEDURE: -@CAL_COMPONENT_ALARM_UNKNOWN: +@CAL_ALARM_NONE: +@CAL_ALARM_AUDIO: +@CAL_ALARM_DISPLAY: +@CAL_ALARM_EMAIL: +@CAL_ALARM_PROCEDURE: +@CAL_ALARM_UNKNOWN: - + -@CAL_COMPONENT_ALARM_TRIGGER_RELATIVE: -@CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE: +@CAL_ALARM_TRIGGER_NONE: +@CAL_ALARM_TRIGGER_RELATIVE_START: +@CAL_ALARM_TRIGGER_RELATIVE_END: +@CAL_ALARM_TRIGGER_ABSOLUTE: - + -@CAL_COMPONENT_ALARM_TRIGGER_RELATED_START: -@CAL_COMPONENT_ALARM_TRIGGER_RELATED_END: - + +@comp: +@Returns: + - + @@ -865,12 +906,13 @@ RFC 2445 iCalendar component object. @Returns: - + @comp: +@auid: @Returns: @@ -882,16 +924,24 @@ RFC 2445 iCalendar component object. @alarm: - + + + + + +@alarms: + + + @alarm: -@action: +@Returns: - + @@ -900,16 +950,16 @@ RFC 2445 iCalendar component object. @action: - + @alarm: -@trigger: +@action: - + @@ -918,17 +968,12 @@ RFC 2445 iCalendar component object. @trigger: - + +@alarm: @trigger: - diff --git a/doc/devel/calendar/cal-util/tmpl/cal-recur.sgml b/doc/devel/calendar/cal-util/tmpl/cal-recur.sgml index 703f8b2b85..092b547809 100644 --- a/doc/devel/calendar/cal-util/tmpl/cal-recur.sgml +++ b/doc/devel/calendar/cal-util/tmpl/cal-recur.sgml @@ -14,37 +14,6 @@ cal-recur - - - - - -@CAL_RECUR_YEARLY: -@CAL_RECUR_MONTHLY: -@CAL_RECUR_WEEKLY: -@CAL_RECUR_DAILY: -@CAL_RECUR_HOURLY: -@CAL_RECUR_MINUTELY: -@CAL_RECUR_SECONDLY: - - - - - - - - - - - - -@year: -@month: -@day: -@hour: -@minute: -@second: - @@ -52,9 +21,11 @@ cal-recur @comp: @instance_start: -@instace_end: +@instance_end: @data: @Returns: + +@instace_end: @@ -69,20 +40,3 @@ cal-recur @cb_data: - - - - - -@ir: -@Returns: - - - - - - - -@r: - - diff --git a/doc/devel/calendar/cal-util/tmpl/cal-util.sgml b/doc/devel/calendar/cal-util/tmpl/cal-util.sgml index bc349a377f..ccd35fac2e 100644 --- a/doc/devel/calendar/cal-util/tmpl/cal-util.sgml +++ b/doc/devel/calendar/cal-util/tmpl/cal-util.sgml @@ -28,20 +28,6 @@ Miscellaneous utilities @list: - - - - - - - - - - - -@list: - - diff --git a/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml b/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml index e69de29bb2..f2c70d526d 100644 --- a/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml +++ b/doc/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml @@ -0,0 +1,231 @@ + + + + + +@CAL_COMPONENT_ALARM_TRIGGER_RELATED_START: +@CAL_COMPONENT_ALARM_TRIGGER_RELATED_END: + + + + + + +@r: + + + + + + +@CAL_RECUR_YEARLY: +@CAL_RECUR_MONTHLY: +@CAL_RECUR_WEEKLY: +@CAL_RECUR_DAILY: +@CAL_RECUR_HOURLY: +@CAL_RECUR_MINUTELY: +@CAL_RECUR_SECONDLY: + + + + + + + + + + + + +@comp: +@pilot_id: + + + + + + +@t: +@Returns: + + + + + + +@trigger: + + + + + + + + + +@t: +@hour: +@Returns: + + + + + + +@str: +@Returns: + + + + + + +@comp: +@pilot_status: + + + + + + +@year: +@month: +@day: +@hour: +@minute: +@second: + + + + + + + + + + + + +@CAL_COMPONENT_ALARM_TRIGGER_RELATIVE: +@CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE: + + + + + + +@ir: +@Returns: + + + + + + +@list: + + + + + + +@str: +@Returns: + + + + + + +@comp: +@Returns: + + + + + + + + + + + + +@itt: +@Returns: + + + + + + +@comp: +@Returns: + + + + + + +@CAL_COMPONENT_ALARM_NONE: +@CAL_COMPONENT_ALARM_AUDIO: +@CAL_COMPONENT_ALARM_DISPLAY: +@CAL_COMPONENT_ALARM_EMAIL: +@CAL_COMPONENT_ALARM_PROCEDURE: +@CAL_COMPONENT_ALARM_UNKNOWN: + + + + + + +@start: +@duration: +@Returns: + + + + + + +@comp: +@pilot_id: + + + + + + +@secs: +@Returns: + + + + + + +@hour: +@use_am_pm: +@Returns: + + + + + + +@comp: +@pilot_status: + + + + + + +@str: +@Returns: + diff --git a/doc/devel/calendar/cal-util/tmpl/timeutil.sgml b/doc/devel/calendar/cal-util/tmpl/timeutil.sgml index 3b62fbba3f..2b197ad685 100644 --- a/doc/devel/calendar/cal-util/tmpl/timeutil.sgml +++ b/doc/devel/calendar/cal-util/tmpl/timeutil.sgml @@ -14,34 +14,6 @@ timeutil - - - - - -@itt: -@Returns: - - - - - - - -@str: -@Returns: - - - - - - - -@start: -@duration: -@Returns: - - @@ -51,33 +23,6 @@ timeutil @Returns: - - - - - -@t: -@Returns: - - - - - - - -@str: -@Returns: - - - - - - - -@secs: -@Returns: - - @@ -128,16 +73,6 @@ timeutil @Returns: - - - - - -@hour: -@use_am_pm: -@Returns: - - @@ -159,16 +94,6 @@ timeutil @Returns: - - - - - -@t: -@hour: -@Returns: - - @@ -241,15 +166,6 @@ timeutil @Returns: - - - - - -@str: -@Returns: - - diff --git a/help/devel/ChangeLog b/help/devel/ChangeLog index 85b7341bf0..fcad430d33 100644 --- a/help/devel/ChangeLog +++ b/help/devel/ChangeLog @@ -1,3 +1,34 @@ +2000-12-19 Federico Mena Quintero + + Added proper dependency lists to the gtk-doc mess. + + * calendar/cal-client/Makefile.am (TARGET_DIR): Removed unused + variable. + (SOURCE_FILES): New variable with the list of source files we + depend on. + (IGNORED_SOURCE_HEADERS): New variable with the headers we ignore + for the gtkdoc-scan phase. + (scan_generated): + (tmpl_dependencies): + (tmpl_sources): + (tmpl_generated); + (sgml_dependencies): + (sgml_generated): Lists of stuff that is generated and that other + stuff depends on. + (all): Added the $(sgml_generated) as the final target. + (install-data-local): Added an installation hook; gtk-doc seems to + want some of its generated files to be installed. + + * calendar/cal-client/evolution-cal-client-sections.txt: Updated. + + * calendar/cal-util/Makefile.am: Made the same changes as for + calendar/cal-client/Makefile.am. + + * calendar/cal-util/evolution-cal-util-sections.txt: Updated. + + * Makefile.am (local_entities): Added alarm-generation.sgml. + (all): Made the main target be the html/index.html. + 2000-12-18 Federico Mena Quintero * calendar/alarm-generation.sgml: New file with a description of diff --git a/help/devel/Makefile.am b/help/devel/Makefile.am index 0dd533057e..8e8ca1085c 100644 --- a/help/devel/Makefile.am +++ b/help/devel/Makefile.am @@ -22,6 +22,7 @@ content_files = \ # are used for dependency tracking. local_entities = \ + calendar/alarm-generation.sgml \ calendar/architecture.sgml \ calendar/evolution-calendar.sgml \ calendar/public-reference.sgml \ @@ -36,18 +37,15 @@ local_entities = \ EXTRA_DIST = \ $(content_files) -all: evolution-devel-guide.html +all: html/index.html if ENABLE_GTK_DOC -evolution-devel-guide.html: html/index.html - -cd $(srcdir) && cp html/index.html evolution-devel-guide.html -else -evolution-devel-guide.html: -endif - html/index.html: $(content_files) $(local_entities) test -d $(srcdir)/html || mkdir $(srcdir)/html -cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) +else +html/index.html: +endif clean-local: rm -f *~ *.bak *.signals *-unused.txt diff --git a/help/devel/calendar/alarm-generation.sgml b/help/devel/calendar/alarm-generation.sgml index 60bc78343e..77d35258da 100644 --- a/help/devel/calendar/alarm-generation.sgml +++ b/help/devel/calendar/alarm-generation.sgml @@ -41,7 +41,92 @@ Generating trigger instances - + Generating absolute triggers is trivial; you just use the date + and time they specify. However, relative triggers are + associated to recurrence instances, so in order to generate + trigger instances we must generate the corresponding + recurrence instances and compute the trigger times based on + those. + + + + Since relative triggers are specified as occurring a certain + amount of time before or after each of a calendar component's + recurrence instances, we can compute a trigger time by adding + or subtracting that amount of time to the corresponding + recurrence instance's time. + + + + Recurrence instances are generated by specifying a range of + time and asking the Wombat to generate the instances that + occur within that range. We shall see that the range of time + in which instances occur is not necessarily the same range of + time in which those instances' alarm triggers occur. + + + + Consider an alarm that is set to trigger 10 minutes before the + start time of an event's occurrence, that is, the trigger has + an offset of -10 minutes. Say this event recurs every hour at + 5 minutes past the hour: it would occur at 1:05, 2:05, 3:05, + etc.; the corresponding triggers would occur at 12:55, 1:55, + 2:55, etc. If we wish to compute the alarm triggers that + occur between 4:00 and 6:00 (which would be at 4:55 and 5:55), + then we cannot just generate recurrence instances between 4:00 + and 6:00 because we will miss the 6:05 occurrence which + corresponds to the 5:55 trigger. + + + + The solution is to expand the range of time on both sides to + fit the relative triggers that have the largest time periods. + If a trigger's offset is negative, like the -10 minutes in the + example above, then we must expand the + end of the time range: in the case above, + the range's ending time of 6:00 must be grown by 10 minutes to + 6:10 so that the last recurrence instance will be that of + 6:05; computing the trigger's offset we will get the 5:55 + trigger, which is what we wanted. For triggers with positive + offsets, like if an alarm were to trigger 20 minutes after an + event's occurrence, we must expand the + start of the time range in an analogous + way, by subtracting the time offset from it. + + + + Again, absolute triggers need no special computation. We can + just see if the trigger time is within the requested range of + time, and if so, we take that trigger occurrence into account + for the final result. + + + + + Alarm trigger generation code + + + The main function to generate alarm trigger instances is + generate_alarms_for_comp() in + evolution/calendar/pcs/cal-backend-file.c. + This function calls compute_alarm_range() + to expand the specified range of time in the way described in + the previous section. It then generates the instances for + relative alarm triggers inside the + add_alarm_occurrences_cb() callback, + which is used by + cal_recur_generate_instances() with the + expanded range of time. The callback goes through all of the + calendar component's relative alarm triggers and adds the + trigger offsets to the occurrence's time; the results are + added as CalAlarmInstance structures + to the final list of trigger instances. Finally, + generate_alarms_for_comp() calls + generate_absolute_triggers(), which + simply adds the instances for absolute alarm triggers; these + are the absolute times that are within the time range that was + requested originally. In the very end, the list of instances + is sorted to produce nicer results. diff --git a/help/devel/calendar/cal-client/Makefile.am b/help/devel/calendar/cal-client/Makefile.am index 44d43639a8..363c15b326 100644 --- a/help/devel/calendar/cal-client/Makefile.am +++ b/help/devel/calendar/cal-client/Makefile.am @@ -1,11 +1,6 @@ -## Process this file with automake to produce Makefile.in - # The name of the module. DOC_MODULE=evolution-cal-client -# The top-level SGML file. -DOC_MAIN_SGML_FILE=evolution-cal-client.sgml - # The directory containing the source code (if it contains documentation). DOC_SOURCE_DIR=$(EVOLUTION_DIR)/calendar/cal-client @@ -22,41 +17,87 @@ LDFLAGS=" \ $(BONOBO_VFS_GNOME_LIBS) \ $(top_builddir)/calendar/cal-client/.libs/libcal-client.a \ $(top_builddir)/calendar/cal-util/.libs/libcal-util.a \ - $(top_builddir)/libical/src/libical/libical.a \ + $(top_builddir)/libical/src/libical/.libs/libical.a \ $(top_builddir)/libversit/.libs/libversit.al \ " -HTML_DIR=$(datadir)/gnome/html +DOC_DIR=$(datadir)/gnome/html -TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) +DOC_DIR_INSTALL_FILES = \ + evolution-cal-client.args \ + evolution-cal-client.hierarchy \ + evolution-cal-client.signals \ + evolution-cal-client.types \ + evolution-cal-client-decl.txt \ + evolution-cal-client-sections.txt -tmpl_sources = \ - tmpl/cal-client.sgml \ - tmpl/evolution-cal-client-unused.sgml +SOURCE_FILES = \ + $(top_srcdir)/calendar/cal-client/cal-client.c \ + $(top_srcdir)/calendar/cal-client/cal-client.h \ + $(top_srcdir)/calendar/cal-client/cal-client-types.c \ + $(top_srcdir)/calendar/cal-client/cal-client-types.h -evolution_cal_client_docdir = $(HTML_DIR) -evolution_cal_client_doc_DATA = \ +IGNORED_HEADER_FILES = \ + cal-listener.h \ + evolution-calendar.h + +scan_generated = \ + evolution-cal-client-decl.txt \ + evolution-cal-client.args \ evolution-cal-client.hierarchy \ - evolution-cal-client.types \ + evolution-cal-client.signals \ + evolution-cal-client.types + +tmpl_dependencies = \ evolution-cal-client-decl.txt \ - evolution-cal-client-sections.txt + evolution-cal-client-sections.txt \ + evolution-cal-client.args \ + evolution-cal-client.hierarchy \ + evolution-cal-client.signals -EXTRA_DIST = \ - $(evolution_cal_client_doc_DATA) +tmpl_sources = \ + tmpl/cal-client.sgml \ + tmpl/evolution-cal-client-unused.sgml -sgml/evolution-cal-client-doc.bottom: $(tmpl_sources) - $(MAKE) sgml +tmpl_generated = \ + evolution-cal-client-unused.txt -scan: - -(cd $(srcdir) \ - && env CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) \ - gtkdoc-scanobj --module=$(DOC_MODULE) \ - && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="cal-listener.h evolution-calendar.h" ) +sgml_dependencies = \ + evolution-cal-client-decl.txt \ + evolution-cal-client-sections.txt \ + evolution-cal-client.args \ + evolution-cal-client.hierarchy \ + evolution-cal-client.signals \ + tmpl/cal-client.sgml + +sgml_generated = \ + sgml/cal-client.sgml \ + sgml/evolution-cal-client-doc.bottom \ + sgml/evolution-cal-client-doc.top \ + sgml/object_index.sgml \ + sgml/tree_index.sgml -templates: scan +EXTRA_DIST = \ + evolution-cal-client.args \ + evolution-cal-client.hierarchy \ + evolution-cal-client.signals \ + evolution-cal-client.types \ + evolution-cal-client-decl.txt \ + evolution-cal-client-sections.txt + +all: $(sgml_generated) + +scan $(scan_generated): $(SOURCE_FILES) + -(cd $(srcdir) \ + && env CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) \ + gtkdoc-scanobj --module=$(DOC_MODULE) \ + && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) \ + --ignore-headers="$(IGNORED_HEADER_FILES)" ) + +templates $(tmpl_sources) $(tmpl_generated): $(tmpl_dependencies) cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) -sgml: +sgml $(sgml_generated): $(sgml_dependencies) cd $(srcdir) \ && gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) @@ -66,6 +107,12 @@ clean-local: maintainer-clean-local: clean cd $(srcdir) && rm -rf sgml $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt +install-data-local: + $(mkinstalldirs) $(DOC_DIR) + for i in $(DOC_DIR_INSTALL_FILES); do \ + $(INSTALL_DATA) $$i $(DOC_DIR); \ + done + dist-hook: mkdir $(distdir)/sgml mkdir $(distdir)/tmpl @@ -73,4 +120,4 @@ dist-hook: -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml -cp $(srcdir)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml -.PHONY : sgml templates scan +.PHONY: scan templates sgml diff --git a/help/devel/calendar/cal-client/evolution-cal-client-decl.txt b/help/devel/calendar/cal-client/evolution-cal-client-decl.txt index 0574d70678..498285a370 100644 --- a/help/devel/calendar/cal-client/evolution-cal-client-decl.txt +++ b/help/devel/calendar/cal-client/evolution-cal-client-decl.txt @@ -24,6 +24,9 @@ CalClientClass + +CalClientPrivate + CalClientLoadStatus typedef enum { @@ -47,7 +50,7 @@ struct CalClient { GtkObject object; /* Private data */ - gpointer priv; + CalClientPrivate *priv; }; @@ -76,6 +79,11 @@ CalClient *client, const char *str_uri CalClient *client, const char *str_uri +cal_client_is_loaded +gboolean +CalClient *client + + cal_client_get_n_objects int CalClient *client, CalObjType type @@ -86,21 +94,16 @@ CalClient *client, CalObjType type CalClient *client,const char *uid,CalComponent **comp -cal_client_get_uid_by_pilot_id -CalClientGetStatus -CalClient *client,unsigned long pilot_id,char **uid - - -cal_client_update_pilot_id -void -CalClient *client, char *uid,unsigned long pilot_id,unsigned long pilot_status - - cal_client_get_uids GList * CalClient *client, CalObjType type +cal_client_get_changes +GList * +CalClient *client, CalObjType type, const char *change_id + + cal_client_get_objects_in_range GList * CalClient *client, CalObjType type,time_t start, time_t end @@ -112,13 +115,18 @@ CalClient *client, CalObjType type,time_t start, time_t end,CalRecurInstanceFn c cal_client_get_alarms_in_range -GList * +GSList * CalClient *client, time_t start, time_t end +cal_client_free_alarms +void +GSList *comp_alarms + + cal_client_get_alarms_for_object gboolean -CalClient *client, const char *uid,time_t start, time_t end,GList **alarms +CalClient *client, const char *uid,time_t start, time_t end,CalComponentAlarms **alarms cal_client_update_object @@ -130,3 +138,16 @@ CalClient *client, CalComponent *comp gboolean CalClient *client, const char *uid + +CalClientChangeType +typedef enum { + CAL_CLIENT_CHANGE_ADDED = 1 << 0, + CAL_CLIENT_CHANGE_MODIFIED = 1 << 1, + CAL_CLIENT_CHANGE_DELETED = 1 << 2 +} CalClientChangeType; + + +cal_client_change_list_free +void +GList *list + diff --git a/help/devel/calendar/cal-client/evolution-cal-client-sections.txt b/help/devel/calendar/cal-client/evolution-cal-client-sections.txt index c37b223247..3e4eafbf48 100644 --- a/help/devel/calendar/cal-client/evolution-cal-client-sections.txt +++ b/help/devel/calendar/cal-client/evolution-cal-client-sections.txt @@ -7,17 +7,22 @@ CAL_CLIENT CalClientLoadStatus CalClientGetStatus + +CalClientChangeType + cal_client_new cal_client_load_calendar cal_client_create_calendar +cal_client_is_loaded cal_client_get_n_objects +cal_client_get_uids cal_client_get_object +cal_client_get_changes +cal_client_change_list_free cal_client_get_objects_in_range cal_client_generate_instances -cal_client_get_uid_by_pilot_id -cal_client_update_pilot_id -cal_client_get_uids cal_client_get_alarms_in_range +cal_client_free_alarms cal_client_get_alarms_for_object cal_client_update_object cal_client_remove_object @@ -33,5 +38,6 @@ cal_client_construct CalClient +CalClientPrivate diff --git a/help/devel/calendar/cal-client/tmpl/cal-client.sgml b/help/devel/calendar/cal-client/tmpl/cal-client.sgml index 06469ff3ee..6de1ab8045 100644 --- a/help/devel/calendar/cal-client/tmpl/cal-client.sgml +++ b/help/devel/calendar/cal-client/tmpl/cal-client.sgml @@ -84,6 +84,15 @@ GTK+ object for communication with personal calendar server. the requested object. This could indicate a bug in the calendar client libraries or in the Wombat server. + + + + + +@CAL_CLIENT_CHANGE_ADDED: +@CAL_CLIENT_CHANGE_MODIFIED: +@CAL_CLIENT_CHANGE_DELETED: + @@ -112,6 +121,15 @@ GTK+ object for communication with personal calendar server. @Returns: + + + + + +@client: +@Returns: + + @@ -122,6 +140,16 @@ GTK+ object for communication with personal calendar server. @Returns: + + + + + +@client: +@type: +@Returns: + + @@ -135,72 +163,67 @@ GTK+ object for communication with personal calendar server. @ico: - + @client: @type: -@start: -@end: +@change_id: @Returns: - + -@client: -@type: -@start: -@end: -@cb: -@cb_data: +@list: - + @client: -@pilot_id: -@uid: +@type: +@start: +@end: @Returns: - + @client: -@uid: -@pilot_id: -@pilot_status: +@type: +@start: +@end: +@cb: +@cb_data: - + @client: -@type: +@start: +@end: @Returns: - + -@client: -@start: -@end: -@Returns: +@comp_alarms: diff --git a/help/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml b/help/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml index 5576dbd57f..a0c23894d9 100644 --- a/help/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml +++ b/help/devel/calendar/cal-client/tmpl/evolution-cal-client-unused.sgml @@ -1,3 +1,13 @@ + + + + + +@client: +@uid: +@pilot_id: +@pilot_status: + @@ -8,3 +18,13 @@ @end: @Returns: + + + + + +@client: +@pilot_id: +@uid: +@Returns: + diff --git a/help/devel/calendar/cal-util/Makefile.am b/help/devel/calendar/cal-util/Makefile.am index 8861aa03cb..b7308800c8 100644 --- a/help/devel/calendar/cal-util/Makefile.am +++ b/help/devel/calendar/cal-util/Makefile.am @@ -1,11 +1,6 @@ -## Process this file with automake to produce Makefile.in - # The name of the module. DOC_MODULE=evolution-cal-util -# The top-level SGML file. -DOC_MAIN_SGML_FILE=evolution-cal-util.sgml - # The directory containing the source code (if it contains documentation). DOC_SOURCE_DIR=$(EVOLUTION_DIR)/calendar/cal-util @@ -21,41 +16,99 @@ CFLAGS =" \ LDFLAGS=" \ $(BONOBO_VFS_GNOME_LIBS) \ $(top_builddir)/calendar/cal-util/.libs/libcal-util.a \ - $(top_builddir)/libical/src/libical/libical.a \ + $(top_builddir)/libical/src/libical/.libs/libical.a \ $(top_builddir)/libversit/.libs/libversit.al \ " -HTML_DIR=$(datadir)/gnome/html +DOC_DIR=$(datadir)/gnome/html + +DOC_DIR_INSTALL_FILES = \ + evolution-cal-util.args \ + evolution-cal-util.hierarchy \ + evolution-cal-util.signals \ + evolution-cal-util.types \ + evolution-cal-util-decl.txt \ + evolution-cal-util-sections.txt + +SOURCE_FILES = \ + $(top_srcdir)/calendar/cal-util/cal-component.c \ + $(top_srcdir)/calendar/cal-util/cal-component.h \ + $(top_srcdir)/calendar/cal-util/cal-recur.c \ + $(top_srcdir)/calendar/cal-util/cal-recur.h \ + $(top_srcdir)/calendar/cal-util/cal-util.c \ + $(top_srcdir)/calendar/cal-util/cal-util.h \ + $(top_srcdir)/calendar/cal-util/timeutil.c \ + $(top_srcdir)/calendar/cal-util/timeutil.h + +IGNORED_HEADER_FILES = \ + calobj.h + +scan_generated = \ + evolution-cal-util-decl.txt \ + evolution-cal-util.args \ + evolution-cal-util.hierarchy \ + evolution-cal-util.signals \ + evolution-cal-util.types -TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) +tmpl_dependencies = \ + evolution-cal-util-decl.txt \ + evolution-cal-util-sections.txt \ + evolution-cal-util.args \ + evolution-cal-util.hierarchy \ + evolution-cal-util.signals tmpl_sources = \ + tmpl/cal-component.sgml \ + tmpl/cal-recur.sgml \ tmpl/cal-util.sgml \ - tmpl/evolution-cal-util-unused.sgml + tmpl/evolution-cal-util-unused.sgml \ + tmpl/timeutil.sgml -evolution_cal_util_docdir = $(HTML_DIR) -evolution_cal_util_doc_DATA = \ - evolution-cal-util.hierarchy \ - evolution-cal-util.types \ +tmpl_generated = \ + evolution-cal-util-unused.txt + +sgml_dependencies = \ evolution-cal-util-decl.txt \ - evolution-cal-util-sections.txt + evolution-cal-util-sections.txt \ + evolution-cal-util.args \ + evolution-cal-util.hierarchy \ + evolution-cal-util.signals \ + tmpl/cal-component.sgml \ + tmpl/cal-recur.sgml \ + tmpl/cal-util.sgml \ + tmpl/timeutil.sgml + +sgml_generated = \ + sgml/cal-component.sgml \ + sgml/cal-recur.sgml \ + sgml/cal-util.sgml \ + sgml/evolution-cal-util-doc.bottom \ + sgml/evolution-cal-util-doc.top \ + sgml/object_index.sgml \ + sgml/timeutil.sgml \ + sgml/tree_index.sgml EXTRA_DIST = \ - $(evolution_cal_util_doc_DATA) - -sgml/evolution-cal-util-doc.bottom: $(tmpl_sources) - $(MAKE) sgml - -scan: - -(cd $(srcdir) \ - && env CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) \ - gtkdoc-scanobj --module=$(DOC_MODULE) \ - && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="calobj.h icalendar-save.h icalendar.h" ) - -templates: scan + evolution-cal-util.args \ + evolution-cal-util.hierarchy \ + evolution-cal-util.signals \ + evolution-cal-util.types \ + evolution-cal-util-decl.txt \ + evolution-cal-util-sections.txt + +all: $(sgml_generated) + +scan $(scan_generated): $(SOURCE_FILES) + -(cd $(srcdir) \ + && env CFLAGS=$(CFLAGS) LDFLAGS=$(LDFLAGS) \ + gtkdoc-scanobj --module=$(DOC_MODULE) \ + && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) \ + --ignore-headers="$(IGNORED_HEADER_FILES)" ) + +templates $(tmpl_sources) $(tmpl_generated): $(tmpl_dependencies) cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) -sgml: +sgml $(sgml_generated): $(sgml_dependencies) cd $(srcdir) \ && gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) @@ -65,6 +118,12 @@ clean-local: maintainer-clean-local: clean cd $(srcdir) && rm -rf sgml $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt +install-data-local: + $(mkinstalldirs) $(DOC_DIR) + for i in $(DOC_DIR_INSTALL_FILES); do \ + $(INSTALL_DATA) $$i $(DOC_DIR); \ + done + dist-hook: mkdir $(distdir)/sgml mkdir $(distdir)/tmpl @@ -72,4 +131,4 @@ dist-hook: -cp $(srcdir)/sgml/*.sgml $(distdir)/sgml -cp $(srcdir)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml -.PHONY : sgml templates scan +.PHONY: scan templates sgml diff --git a/help/devel/calendar/cal-util/evolution-cal-util-decl.txt b/help/devel/calendar/cal-util/evolution-cal-util-decl.txt index eb108b868f..f190d325fc 100644 --- a/help/devel/calendar/cal-util/evolution-cal-util-decl.txt +++ b/help/devel/calendar/cal-util/evolution-cal-util-decl.txt @@ -114,9 +114,6 @@ typedef enum { } CalComponentTransparency; -CalComponentAlarm - - CalComponent @@ -305,16 +302,36 @@ CalComponent *comp, GSList **exdate_list CalComponent *comp, GSList *exdate_list +cal_component_has_exdates +gboolean +CalComponent *comp + + cal_component_get_exrule_list void CalComponent *comp, GSList **recur_list +cal_component_get_exrule_property_list +void +CalComponent *comp, GSList **recur_list + + cal_component_set_exrule_list void CalComponent *comp, GSList *recur_list +cal_component_has_exrules +gboolean +CalComponent *comp + + +cal_component_has_exceptions +gboolean +CalComponent *comp + + cal_component_get_geo void CalComponent *comp, struct icalgeotype **geo @@ -375,6 +392,11 @@ CalComponent *comp CalComponent *comp, GSList **recur_list +cal_component_get_rrule_property_list +void +CalComponent *comp, GSList **recur_list + + cal_component_set_rrule_list void CalComponent *comp, GSList *recur_list @@ -385,6 +407,11 @@ CalComponent *comp, GSList *recur_list CalComponent *comp +cal_component_has_recurrences +gboolean +CalComponent *comp + + cal_component_get_sequence void CalComponent *comp, int **sequence @@ -395,6 +422,16 @@ CalComponent *comp, int **sequence CalComponent *comp, int *sequence +cal_component_get_status +void +CalComponent *comp, icalproperty_status *status + + +cal_component_set_status +void +CalComponent *comp, icalproperty_status status + + cal_component_get_summary void CalComponent *comp, CalComponentText *summary @@ -425,26 +462,6 @@ CalComponent *comp, const char **url CalComponent *comp, const char *url -cal_component_get_pilot_id -void -CalComponent *comp, unsigned long *pilot_id - - -cal_component_set_pilot_id -void -CalComponent *comp, unsigned long pilot_id - - -cal_component_get_pilot_status -void -CalComponent *comp, unsigned long *pilot_status - - -cal_component_set_pilot_status -void -CalComponent *comp, unsigned long pilot_status - - cal_component_free_categories_list void GSList *categ_list @@ -499,167 +516,119 @@ int *sequence void GSList *text_list + +CalComponentAlarm + + +CalAlarmInstance +typedef struct { + /* UID of the alarm that triggered */ + const char *auid; + + /* Trigger time, i.e. "5 minutes before the appointment" */ + time_t trigger; + + /* Actual event occurrence to which this trigger corresponds */ + time_t occur; +} CalAlarmInstance; + + +CalComponentAlarms +typedef struct { + /* The actual component */ + CalComponent *comp; + + /* List of CalAlarmInstance structures */ + GSList *alarms; +} CalComponentAlarms; + -CalComponentAlarmAction -typedef enum { - CAL_COMPONENT_ALARM_NONE, - CAL_COMPONENT_ALARM_AUDIO, - CAL_COMPONENT_ALARM_DISPLAY, - CAL_COMPONENT_ALARM_EMAIL, - CAL_COMPONENT_ALARM_PROCEDURE, - CAL_COMPONENT_ALARM_UNKNOWN -} CalComponentAlarmAction; - - -CalComponentAlarmTriggerType +CalAlarmAction typedef enum { - CAL_COMPONENT_ALARM_TRIGGER_RELATIVE, - CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE -} CalComponentAlarmTriggerType; + CAL_ALARM_NONE, + CAL_ALARM_AUDIO, + CAL_ALARM_DISPLAY, + CAL_ALARM_EMAIL, + CAL_ALARM_PROCEDURE, + CAL_ALARM_UNKNOWN +} CalAlarmAction; -CalComponentAlarmTriggerRelated +CalAlarmTriggerType typedef enum { - CAL_COMPONENT_ALARM_TRIGGER_RELATED_START, - CAL_COMPONENT_ALARM_TRIGGER_RELATED_END -} CalComponentAlarmTriggerRelated; + CAL_ALARM_TRIGGER_NONE, + CAL_ALARM_TRIGGER_RELATIVE_START, + CAL_ALARM_TRIGGER_RELATIVE_END, + CAL_ALARM_TRIGGER_ABSOLUTE +} CalAlarmTriggerType; -CalComponentAlarmTrigger +CalAlarmTrigger typedef struct { - CalComponentAlarmTriggerType type; + CalAlarmTriggerType type; union { - struct { - struct icaldurationtype duration; - CalComponentAlarmTriggerRelated related; - } relative; - - struct icaltimetype absolute; + struct icaldurationtype rel_duration; + struct icaltimetype abs_time; } u; -} CalComponentAlarmTrigger; +} CalAlarmTrigger; -cal_component_get_first_alarm -CalComponentAlarm * +cal_component_has_alarms +gboolean CalComponent *comp -cal_component_get_next_alarm -CalComponentAlarm * +cal_component_get_alarm_uids +GList * CalComponent *comp +cal_component_get_alarm +CalComponentAlarm * +CalComponent *comp, const char *auid + + cal_component_alarm_free void CalComponentAlarm *alarm +cal_component_alarms_free +void +CalComponentAlarms *alarms + + +cal_component_alarm_get_uid +const char * +CalComponentAlarm *alarm + + cal_component_alarm_get_action void -CalComponentAlarm *alarm, CalComponentAlarmAction *action +CalComponentAlarm *alarm, CalAlarmAction *action cal_component_alarm_set_action void -CalComponentAlarm *alarm, CalComponentAlarmAction action +CalComponentAlarm *alarm, CalAlarmAction action cal_component_alarm_get_trigger void -CalComponentAlarm *alarm, CalComponentAlarmTrigger **trigger +CalComponentAlarm *alarm, CalAlarmTrigger *trigger cal_component_alarm_set_trigger void -CalComponentAlarm *alarm, CalComponentAlarmTrigger *trigger - - -cal_component_alarm_free_trigger -void -CalComponentAlarmTrigger *trigger +CalComponentAlarm *alarm, CalAlarmTrigger trigger - -CalRecurType -typedef enum { - CAL_RECUR_YEARLY, - CAL_RECUR_MONTHLY, - CAL_RECUR_WEEKLY, - CAL_RECUR_DAILY, - CAL_RECUR_HOURLY, - CAL_RECUR_MINUTELY, - CAL_RECUR_SECONDLY -} CalRecurType; - - -CalRecurrence -typedef struct { - CalRecurType type; - - int interval; - - /* Specifies the end of the recurrence. No occurrences are generated - after this date. If it is 0, the event recurs forever. */ - time_t enddate; - - /* WKST property - the week start day: 0 = Monday to 6 = Sunday. */ - gint week_start_day; - - - /* NOTE: I've used GList's here, but it doesn't matter if we use - other data structures like arrays. The code should be easy to - change. So long as it is easy to see if the modifier is set. */ - - /* For BYMONTH modifier. A list of GINT_TO_POINTERs, 0-11. */ - GList *bymonth; - - /* For BYWEEKNO modifier. A list of GINT_TO_POINTERs, [+-]1-53. */ - GList *byweekno; - - /* For BYYEARDAY modifier. A list of GINT_TO_POINTERs, [+-]1-366. */ - GList *byyearday; - - /* For BYMONTHDAY modifier. A list of GINT_TO_POINTERs, [+-]1-31. */ - GList *bymonthday; - - /* For BYDAY modifier. A list of GINT_TO_POINTERs, in pairs. - The first of each pair is the weekday, 0 = Monday to 6 = Sunday. - The second of each pair is the week number [+-]0-53. */ - GList *byday; - - /* For BYHOUR modifier. A list of GINT_TO_POINTERs, 0-23. */ - GList *byhour; - - /* For BYMINUTE modifier. A list of GINT_TO_POINTERs, 0-59. */ - GList *byminute; - - /* For BYSECOND modifier. A list of GINT_TO_POINTERs, 0-60. */ - GList *bysecond; - - /* For BYSETPOS modifier. A list of GINT_TO_POINTERs, +ve or -ve. */ - GList *bysetpos; -} CalRecurrence; - - -CalObjTime - - -CalObjTime -struct CalObjTime { - guint16 year; - guint8 month; /* 0 - 11 */ - guint8 day; /* 1 - 31 */ - guint8 hour; /* 0 - 23 */ - guint8 minute; /* 0 - 59 */ - guint8 second; /* 0 - 59 (maybe 60 for leap second) */ -}; - CalRecurInstanceFn gboolean CalComponent *comp, time_t instance_start, - time_t instace_end, + time_t instance_end, gpointer data @@ -667,16 +636,6 @@ CalComponent *comp, void CalComponent *comp,time_t start,time_t end,CalRecurInstanceFn cb,gpointer cb_data - -cal_recur_from_icalrecurrencetype -CalRecurrence * -struct icalrecurrencetype *ir - - -cal_recur_free -void -CalRecurrence *r - CalObjInstance typedef struct { @@ -690,22 +649,6 @@ typedef struct { void GList *list - -CalAlarmInstance -typedef struct { - char *uid; /* UID of object */ -#if 0 - enum AlarmType type; /* Type of alarm */ -#endif - time_t trigger; /* Alarm trigger time */ - time_t occur; /* Occurrence time */ -} CalAlarmInstance; - - -cal_alarm_instance_list_free -void -GList *list - CalObjType typedef enum { @@ -721,41 +664,11 @@ typedef enum { GList *list -time_from_icaltimetype -time_t -struct icaltimetype itt - - -time_from_isodate -time_t -char *str - - -time_from_start_duration -time_t -time_t start, char *duration - - isodate_from_time_t char * time_t t -get_time_t_hour -int -time_t t - - -isodiff_to_secs -int -char *str - - -isodiff_from_secs -char * -int secs - - time_add_minutes time_t time_t time, int minutes @@ -781,11 +694,6 @@ time_t time, int months time_t time, int years -format_simple_hour -char * -int hour, int use_am_pm - - time_days_in_month int int year, int month @@ -796,11 +704,6 @@ int year, int month int year, int month, int day -time_day_hour -time_t -time_t t, int hour - - time_year_begin time_t time_t t @@ -841,11 +744,6 @@ time_t t time_t t -parse_date -time_t -char *str - - print_time_t void time_t t diff --git a/help/devel/calendar/cal-util/evolution-cal-util-sections.txt b/help/devel/calendar/cal-util/evolution-cal-util-sections.txt index cd928fc7e3..130209e71c 100644 --- a/help/devel/calendar/cal-util/evolution-cal-util-sections.txt +++ b/help/devel/calendar/cal-util/evolution-cal-util-sections.txt @@ -11,8 +11,6 @@ CalComponentPeriodType CalComponentPeriod CalComponentText CalComponentTransparency -CalComponentAlarm -CalComponentPrivate cal_component_gen_uid cal_component_new @@ -47,8 +45,12 @@ cal_component_get_due cal_component_set_due cal_component_get_exdate_list cal_component_set_exdate_list +cal_component_has_exdates cal_component_get_exrule_list +cal_component_get_exrule_property_list cal_component_set_exrule_list +cal_component_has_exrules +cal_component_has_exceptions cal_component_get_geo cal_component_set_geo cal_component_get_last_modified @@ -61,21 +63,22 @@ cal_component_get_rdate_list cal_component_set_rdate_list cal_component_has_rdates cal_component_get_rrule_list +cal_component_get_rrule_property_list cal_component_set_rrule_list cal_component_has_rrules +cal_component_has_recurrences cal_component_get_sequence cal_component_set_sequence +cal_component_get_status +cal_component_set_status cal_component_get_summary cal_component_set_summary cal_component_get_transparency cal_component_set_transparency cal_component_get_url cal_component_set_url -cal_component_get_pilot_id -cal_component_set_pilot_id -cal_component_get_pilot_status -cal_component_set_pilot_status + cal_component_free_categories_list cal_component_free_datetime cal_component_free_exdate_list @@ -88,19 +91,24 @@ cal_component_free_recur_list cal_component_free_sequence cal_component_free_text_list -CalComponentAlarmAction -CalComponentAlarmTriggerType -CalComponentAlarmTriggerRelated -CalComponentAlarmTrigger + +CalComponentAlarm +CalAlarmInstance +CalComponentAlarms +CalAlarmAction +CalAlarmTriggerType +CalAlarmTrigger -cal_component_get_first_alarm -cal_component_get_next_alarm +cal_component_has_alarms +cal_component_get_alarm_uids +cal_component_get_alarm cal_component_alarm_free +cal_component_alarms_free +cal_component_alarm_get_uid cal_component_alarm_get_action cal_component_alarm_set_action cal_component_alarm_get_trigger cal_component_alarm_set_trigger -cal_component_alarm_free_trigger CAL_COMPONENT_TYPE @@ -111,48 +119,34 @@ cal_component_get_type CalComponent +CalComponentPrivate
cal-recur -CalRecurType -CalRecurrence -CalObjTime CalRecurInstanceFn cal_recur_generate_instances -cal_recur_from_icalrecurrencetype -cal_recur_free
cal-util CalObjInstance cal_obj_instance_list_free -CalAlarmInstance -cal_alarm_instance_list_free CalObjType cal_obj_uid_list_free
timeutil -time_from_icaltimetype -time_from_isodate -time_from_start_duration isodate_from_time_t -get_time_t_hour -isodiff_to_secs -isodiff_from_secs time_add_minutes time_add_day time_add_week time_add_month time_add_year -format_simple_hour time_days_in_month time_from_day -time_day_hour time_year_begin time_year_end time_month_begin @@ -161,6 +155,5 @@ time_week_begin time_week_end time_day_begin time_day_end -parse_date print_time_t
diff --git a/help/devel/calendar/cal-util/tmpl/cal-component.sgml b/help/devel/calendar/cal-util/tmpl/cal-component.sgml index 56a04b02a0..c429e22a9c 100644 --- a/help/devel/calendar/cal-util/tmpl/cal-component.sgml +++ b/help/devel/calendar/cal-util/tmpl/cal-component.sgml @@ -85,7 +85,6 @@ RFC 2445 iCalendar component object. @CAL_COMPONENT_NO_TYPE: Returned from cal_component_get_vtype() to indicate an uninitialized #CalComponent object. - @CAL_COMPONENT_EVENT: Indicates a VEVENT component. @CAL_COMPONENT_TODO: Indicates a VTODO component. @CAL_COMPONENT_JOURNAL: Indicates a VJOURNAL component. @@ -126,11 +125,9 @@ RFC 2445 iCalendar component object. @CAL_COMPONENT_CLASS_NONE: Indicates that no access classification has been set for the corresponding component. - @CAL_COMPONENT_CLASS_PUBLIC: Public access. @CAL_COMPONENT_CLASS_PRIVATE: Private access. @CAL_COMPONENT_CLASS_CONFIDENTIAL: Confidential access. - @CAL_COMPONENT_CLASS_UNKNOWN: Unknown access classification value, used when &libical; returns something #CalComponent does not know about. @@ -148,7 +145,6 @@ RFC 2445 iCalendar component object. @CAL_COMPONENT_PERIOD_DATETIME: Indicates that the period is specified by starting and ending date/time values. - @CAL_COMPONENT_PERIOD_DURATION: Indicates that the period is specified as a starding date/time and a duration value. @@ -175,18 +171,6 @@ RFC 2445 iCalendar component object. @CAL_COMPONENT_TRANSP_OPAQUE: @CAL_COMPONENT_TRANSP_UNKNOWN: - - - - - - - - - - - - @@ -482,6 +466,15 @@ RFC 2445 iCalendar component object. @exdate_list: + + + + + +@comp: +@Returns: + + @@ -491,6 +484,15 @@ RFC 2445 iCalendar component object. @recur_list: + + + + + +@comp: +@recur_list: + + @@ -500,6 +502,24 @@ RFC 2445 iCalendar component object. @recur_list: + + + + + +@comp: +@Returns: + + + + + + + +@comp: +@Returns: + + @@ -608,7 +628,7 @@ RFC 2445 iCalendar component object. @recur_list: - + @@ -617,121 +637,121 @@ RFC 2445 iCalendar component object. @recur_list: - + @comp: -@Returns: +@recur_list: - + @comp: -@sequence: +@Returns: - + @comp: -@sequence: +@Returns: - + @comp: -@summary: +@sequence: - + @comp: -@summary: +@sequence: - + @comp: -@transp: +@status: - + @comp: -@transp: +@status: - + @comp: -@url: +@summary: - + @comp: -@url: +@summary: - + @comp: -@pilot_id: +@transp: - + @comp: -@pilot_id: +@transp: - + @comp: -@pilot_status: +@url: - + @comp: -@pilot_status: +@url: @@ -822,41 +842,62 @@ RFC 2445 iCalendar component object. @text_list: - + + + + + + + + + + + + + + + + + + + -@CAL_COMPONENT_ALARM_NONE: -@CAL_COMPONENT_ALARM_AUDIO: -@CAL_COMPONENT_ALARM_DISPLAY: -@CAL_COMPONENT_ALARM_EMAIL: -@CAL_COMPONENT_ALARM_PROCEDURE: -@CAL_COMPONENT_ALARM_UNKNOWN: +@CAL_ALARM_NONE: +@CAL_ALARM_AUDIO: +@CAL_ALARM_DISPLAY: +@CAL_ALARM_EMAIL: +@CAL_ALARM_PROCEDURE: +@CAL_ALARM_UNKNOWN: - + -@CAL_COMPONENT_ALARM_TRIGGER_RELATIVE: -@CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE: +@CAL_ALARM_TRIGGER_NONE: +@CAL_ALARM_TRIGGER_RELATIVE_START: +@CAL_ALARM_TRIGGER_RELATIVE_END: +@CAL_ALARM_TRIGGER_ABSOLUTE: - + -@CAL_COMPONENT_ALARM_TRIGGER_RELATED_START: -@CAL_COMPONENT_ALARM_TRIGGER_RELATED_END: - + +@comp: +@Returns: + - + @@ -865,12 +906,13 @@ RFC 2445 iCalendar component object. @Returns: - + @comp: +@auid: @Returns: @@ -882,16 +924,24 @@ RFC 2445 iCalendar component object. @alarm: - + + + + + +@alarms: + + + @alarm: -@action: +@Returns: - + @@ -900,16 +950,16 @@ RFC 2445 iCalendar component object. @action: - + @alarm: -@trigger: +@action: - + @@ -918,17 +968,12 @@ RFC 2445 iCalendar component object. @trigger: - + +@alarm: @trigger: - diff --git a/help/devel/calendar/cal-util/tmpl/cal-recur.sgml b/help/devel/calendar/cal-util/tmpl/cal-recur.sgml index 703f8b2b85..092b547809 100644 --- a/help/devel/calendar/cal-util/tmpl/cal-recur.sgml +++ b/help/devel/calendar/cal-util/tmpl/cal-recur.sgml @@ -14,37 +14,6 @@ cal-recur - - - - - -@CAL_RECUR_YEARLY: -@CAL_RECUR_MONTHLY: -@CAL_RECUR_WEEKLY: -@CAL_RECUR_DAILY: -@CAL_RECUR_HOURLY: -@CAL_RECUR_MINUTELY: -@CAL_RECUR_SECONDLY: - - - - - - - - - - - - -@year: -@month: -@day: -@hour: -@minute: -@second: - @@ -52,9 +21,11 @@ cal-recur @comp: @instance_start: -@instace_end: +@instance_end: @data: @Returns: + +@instace_end: @@ -69,20 +40,3 @@ cal-recur @cb_data: - - - - - -@ir: -@Returns: - - - - - - - -@r: - - diff --git a/help/devel/calendar/cal-util/tmpl/cal-util.sgml b/help/devel/calendar/cal-util/tmpl/cal-util.sgml index bc349a377f..ccd35fac2e 100644 --- a/help/devel/calendar/cal-util/tmpl/cal-util.sgml +++ b/help/devel/calendar/cal-util/tmpl/cal-util.sgml @@ -28,20 +28,6 @@ Miscellaneous utilities @list: - - - - - - - - - - - -@list: - - diff --git a/help/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml b/help/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml index e69de29bb2..f2c70d526d 100644 --- a/help/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml +++ b/help/devel/calendar/cal-util/tmpl/evolution-cal-util-unused.sgml @@ -0,0 +1,231 @@ + + + + + +@CAL_COMPONENT_ALARM_TRIGGER_RELATED_START: +@CAL_COMPONENT_ALARM_TRIGGER_RELATED_END: + + + + + + +@r: + + + + + + +@CAL_RECUR_YEARLY: +@CAL_RECUR_MONTHLY: +@CAL_RECUR_WEEKLY: +@CAL_RECUR_DAILY: +@CAL_RECUR_HOURLY: +@CAL_RECUR_MINUTELY: +@CAL_RECUR_SECONDLY: + + + + + + + + + + + + +@comp: +@pilot_id: + + + + + + +@t: +@Returns: + + + + + + +@trigger: + + + + + + + + + +@t: +@hour: +@Returns: + + + + + + +@str: +@Returns: + + + + + + +@comp: +@pilot_status: + + + + + + +@year: +@month: +@day: +@hour: +@minute: +@second: + + + + + + + + + + + + +@CAL_COMPONENT_ALARM_TRIGGER_RELATIVE: +@CAL_COMPONENT_ALARM_TRIGGER_ABSOLUTE: + + + + + + +@ir: +@Returns: + + + + + + +@list: + + + + + + +@str: +@Returns: + + + + + + +@comp: +@Returns: + + + + + + + + + + + + +@itt: +@Returns: + + + + + + +@comp: +@Returns: + + + + + + +@CAL_COMPONENT_ALARM_NONE: +@CAL_COMPONENT_ALARM_AUDIO: +@CAL_COMPONENT_ALARM_DISPLAY: +@CAL_COMPONENT_ALARM_EMAIL: +@CAL_COMPONENT_ALARM_PROCEDURE: +@CAL_COMPONENT_ALARM_UNKNOWN: + + + + + + +@start: +@duration: +@Returns: + + + + + + +@comp: +@pilot_id: + + + + + + +@secs: +@Returns: + + + + + + +@hour: +@use_am_pm: +@Returns: + + + + + + +@comp: +@pilot_status: + + + + + + +@str: +@Returns: + diff --git a/help/devel/calendar/cal-util/tmpl/timeutil.sgml b/help/devel/calendar/cal-util/tmpl/timeutil.sgml index 3b62fbba3f..2b197ad685 100644 --- a/help/devel/calendar/cal-util/tmpl/timeutil.sgml +++ b/help/devel/calendar/cal-util/tmpl/timeutil.sgml @@ -14,34 +14,6 @@ timeutil - - - - - -@itt: -@Returns: - - - - - - - -@str: -@Returns: - - - - - - - -@start: -@duration: -@Returns: - - @@ -51,33 +23,6 @@ timeutil @Returns: - - - - - -@t: -@Returns: - - - - - - - -@str: -@Returns: - - - - - - - -@secs: -@Returns: - - @@ -128,16 +73,6 @@ timeutil @Returns: - - - - - -@hour: -@use_am_pm: -@Returns: - - @@ -159,16 +94,6 @@ timeutil @Returns: - - - - - -@t: -@hour: -@Returns: - - @@ -241,15 +166,6 @@ timeutil @Returns: - - - - - -@str: -@Returns: - - -- cgit v1.2.3