[evolution-patches] libeds API docs
- From: James Bowes <bowes cs dal ca>
- To: evolution-patches lists ximian com
- Subject: [evolution-patches] libeds API docs
- Date: Wed, 23 Mar 2005 13:16:52 -0400
Hi all:
Attached is a patch to evolution-data-server to generate API
documentation for files in libedataserver. I've only documented a few
files (e-trie, e-util, e-url, e-uid, md5-utils), but this patch also
includes some of the makefile alterations, etc. necessary to build the
docs.
-James
? depcomp
? evolution-data-server-1.2.0.tar.gz
? gtk-doc.make
? calendar/config.guess
? calendar/config.sub
? calendar/depcomp
? calendar/install-sh
? calendar/ltmain.sh
? calendar/missing
? calendar/mkinstalldirs
? calendar/ylwrap
? camel/camel-mime-tables.c
? docs/reference/libedataserver/tmpl
? libedataserver/libedataserver-1.0.pc
? libedataserverui/e-source-option-menu.loT
Index: configure.in
===================================================================
RCS file: /cvs/gnome/evolution-data-server/configure.in,v
retrieving revision 1.92
diff -u -r1.92 configure.in
--- configure.in 15 Mar 2005 01:48:03 -0000 1.92
+++ configure.in 23 Mar 2005 16:16:01 -0000
@@ -1233,6 +1233,7 @@
docs/reference/addressbook/libebook/Makefile
docs/reference/calendar/Makefile
docs/reference/calendar/libecal/Makefile
+docs/reference/libedataserver/Makefile
po/Makefile.in
])
Index: docs/reference/Makefile.am
===================================================================
RCS file: /cvs/gnome/evolution-data-server/docs/reference/Makefile.am,v
retrieving revision 1.2
diff -u -r1.2 Makefile.am
--- docs/reference/Makefile.am 25 Nov 2003 17:52:23 -0000 1.2
+++ docs/reference/Makefile.am 23 Mar 2005 16:16:03 -0000
@@ -1,3 +1,3 @@
-SUBDIRS = addressbook calendar
+SUBDIRS = addressbook calendar libedataserver
MKDB_OPTIONS=--output-format=xml
Index: docs/reference/libedataserver/Makefile.am
===================================================================
RCS file: /cvs/gnome/evolution-data-server/docs/reference/libedataserver/Makefile.am,v
retrieving revision 1.2
diff -u -r1.2 Makefile.am
--- docs/reference/libedataserver/Makefile.am 12 Jan 2005 16:55:52 -0000 1.2
+++ docs/reference/libedataserver/Makefile.am 23 Mar 2005 16:16:03 -0000
@@ -14,11 +14,11 @@
DOC_SOURCE_DIR = $(top_srcdir)/libedataserver
HFILE_GLOB = $(top_srcdir)/libedataserver/*.h
CFILE_GLOB = $(top_srcdir)/libedataserver/*.c
-IGNORE_HFILES = \
- e-account-list.h \
- e-msgport.h \
- e-sexp.h \
- md5-utils.h
+#IGNORE_HFILES = \
+# e-account-list.h \
+# e-msgport.h \
+# e-sexp.h \
+# md5-utils.h
GTKDOC_CFLAGS = \
-I$(top_srcdir)/libedataserver \
Index: docs/reference/libedataserver/libedataserver-docs.sgml
===================================================================
RCS file: /cvs/gnome/evolution-data-server/docs/reference/libedataserver/libedataserver-docs.sgml,v
retrieving revision 1.1
diff -u -r1.1 libedataserver-docs.sgml
--- docs/reference/libedataserver/libedataserver-docs.sgml 12 Jan 2005 16:28:07 -0000 1.1
+++ docs/reference/libedataserver/libedataserver-docs.sgml 23 Mar 2005 16:16:03 -0000
@@ -9,5 +9,9 @@
<chapter>
<title>Evolution API Reference: libedataserver, utility library</title>
<!--<xi:include href="xml/e-cal-view.xml"/>-->
+ <xi:include href="xml/e-trie.xml"/>
+ <xi:include href="xml/e-util.xml"/>
+ <xi:include href="xml/e-url.xml"/>
+ <xi:include href="xml/md5-utils.xml"/>
</chapter>
</book>
Index: docs/reference/libedataserver/libedataserver-sections.txt
===================================================================
RCS file: /cvs/gnome/evolution-data-server/docs/reference/libedataserver/libedataserver-sections.txt,v
retrieving revision 1.2
diff -u -r1.2 libedataserver-sections.txt
--- docs/reference/libedataserver/libedataserver-sections.txt 12 Jan 2005 16:55:52 -0000 1.2
+++ docs/reference/libedataserver/libedataserver-sections.txt 23 Mar 2005 16:16:03 -0000
@@ -1,396 +1,66 @@
-e_memchunk_new
-e_list_get_iterator
-E_COMPONENT_LISTENER_CLASS
-e_mutex_new
-EFileCachePrivate
-E_TYPE_SOURCE
-EListCopyFunc
-e_list_remove
-e_sexp_remove_symbol
-EMemChunk
-EListIterator
-e_source_get_readonly
-e_poolv_set
-e_xmlhash_foreach_key
-e_dbhash_compare
-EListIteratorClass
-e_mutex_cond_wait
-e_xmlhash_destroy
-e_file_cache_clean
-e_data_server_marshal_NONE__STRING
-e_source_list_remove_source_by_uid
-e_data_server_marshal_VOID__OBJECT
-E_TYPE_SOURCE_LIST
-e_dlist_length
-e_util_unicode_get_utf8
-e_xmlhash_write
-E_ITERATOR_GET_CLASS
-e_time_format_date_and_time
-E_IS_LIST
-e_sexp_unref
-eds_module_initialize
-ESExpClass
-e_file_cache_remove_object
-e_file_cache_new
-e_source_group_peek_source_by_name
-E_IS_FILE_CACHE
-e_msgport_new
-e_source_group_set_base_uri
-e_uri_to_string
-e_file_cache_replace_object
-e_sexp_add_ifunction
-e_source_peek_absolute_uri
-ESourceGroupClass
-E_SOURCE_LIST
-e_thread_set_queue_limit
-e_source_get_type
-e_dbhash_add
-EComponentListenerClass
-e_component_listener_get_component
-e_source_group_set_readonly
-e_sexp_input_text
-e_data_server_marshal_NONE__OBJECT
-e_sexp_result_free
-e_sexp_parse
-E_IS_COMPONENT_LISTENER
-e_source_update_from_xml_node
+<SECTION>
+<FILE>e-trie</FILE>
+<INCLUDE>libedataserver/e-trie.h</INCLUDE>
+<TITLE>ETrie</TITLE>
+ETrie
+<SUBSECTION>
+e_trie_new
+e_trie_free
+<SUBSECTION>
+e_trie_add
+e_trie_search
+</SECTION>
+
+<SECTION>
+<FILE>e-uid</FILE>
+<INCLUDE>libedataserver/e-uid.h</INCLUDE>
+<TITLE>User ID Generation</TITLE>
+e_uid_new
+</SECTION>
+
+<SECTION>
+<FILE>e-util</FILE>
+<INCLUDE>libedataserver/e-util.h</INCLUDE>
+<TITLE>Utility Functions</TITLE>
+e_util_mkdir_hier
+<SUBSECTION>
e_util_strstrcase
-e_file_cache_freeze_changes
-E_TYPE_FILE_CACHE
-e_dlist_addtail
-e_source_equal
-e_list_iterator_get_type
-e_categories_get_list
+e_util_unicode_get_utf8
+e_util_utf8_strstrcase
+e_util_utf8_strstrcasedecomp
+<SUBSECTION>
e_strftime
-e_source_group_remove_source_by_uid
-IS_E_SEXP
-EAccountList
-e_list_length
-e_mempool_strdup
-e_source_foreach_property
-e_source_group_new_from_xmldoc
-E_TYPE_SOURCE_GROUP
-E_ACCOUNT_CLASS
-em_cache_clear
-EDListNode
-e_source_group_peek_source_by_uid
-e_strv_new
-e_categories_add
-e_time_parse_date
-eds_module_shutdown
-EMemPoolFlags
-e_file_cache_add_object
-e_file_cache_remove
-e_source_list_peek_source_by_uid
-e_strv_pack
-EThreadFunc
-e_account_uid_from_xml
-e_uid_new
-e_sexp_new
-e_poolv_destroy
-e_thread_set_reply_port
-e_source_build_absolute_uri
-e_component_listener_get_type
-e_categories_remove
-e_source_get_color
-E_IS_LIST_CLASS
-E_IS_SOURCE_GROUP
-e_msgport_destroy
-e_iconv_locale_charset
-e_sexp_fatal_error
-e_account_import
-E_DLIST_INITIALISER
-e_source_group_peek_uid
-e_list_iterator_new
-e_iconv_open
-e_iterator_next
-e_file_cache_get_type
-e_source_list_peek_group_by_name
-e_uri_get_param
-EStrv
-E_IS_ITERATOR_CLASS
-EDbHashStatus
-e_dbhash_destroy
-e_msgport_wait
-e_sexp_get_type
-e_dbhash_new
-e_xmlhash_new
-e_strv_get
-e_memchunk_destroy
-E_COMPONENT_LISTENER
-EComponentListenerPrivate
-ESourceGroupPrivate
-e_thread_put
-ESourceListClass
-e_xmlhash_remove
-e_account_list_get_default
-e_account_list_change
-E_SOURCE
-e_sexp_input_file
-e_source_list_peek_source_any
-E_IS_SOURCE_LIST_CLASS
-e_source_group_get_type
-e_poolv_get
-e_mutex_unlock
-e_sexp_error
-E_ITERATOR_CLASS
-e_iterator_reset
-e_sexp_add_function
-E_IS_SOURCE
-e_source_set_group
-e_mutex_assert_locked
-e_source_peek_relative_uri
-E_SEXP_GET_CLASS
-e_dlist_remtail
-e_account_list_add
-E_SEXP
-E_LIST
-E_LIST_ITERATOR_CLASS
-e_source_list_sync
-EAccountClass
-e_source_new_with_absolute_uri
-e_msgport_put
-e_source_group_update_from_xml
-e_strv_set_ref
-ESExpResult
-e_msgport_reply
-em_cache_node_new
+e_utf8_strftime
+</SECTION>
+
+<SECTION>
+<FILE>e-url</FILE>
+<INCLUDE>libedataserver/e-url.h</INCLUDE>
+<TITLE>EUrl</TITLE>
+EUri
+<SUBSECTION>
e_url_shroud
-e_iterator_prev
-e_source_group_to_xml
-e_source_unset_color
-e_source_set_readonly
-E_IS_SOURCE_CLASS
-EAccountListClass
-EDbHashFunc
-e_source_peek_name
-e_trie_search
-e_time_format_time
-e_mempool_flush
-e_account_list_get_type
-EFileCacheClass
-E_SOURCE_GROUP
-e_strv_set_ref_free
-e_list_remove_iterator
-e_thread_destroy
-e_source_to_standalone_xml
-e_sexp_set_scope
-e_source_list_peek_group_by_uid
-e_trie_free
-e_sexp_ref
-E_LIST_ITERATOR
-e_data_server_extension_list_free
-e_sexp_result_new
-E_ITERATOR
-e_thread_busy
-ESExpTerm
-EThread
-e_dlist_remove
-e_account_list_new
-e_sexp_term_eval
-e_iconv_close
-e_db3_utils_maybe_recover
-e_dbhash_remove
-e_file_cache_get_object
-e_xmlhash_add
-e_source_get_uri
-EMutex
-E_FILE_CACHE_CLASS
-e_dlist_empty
-e_dlist_remhead
-e_data_server_marshal_NONE__NONE
-e_source_group_uid_from_xmldoc
-e_source_group_set_name
-e_source_list_remove_group_by_uid
-e_poolv_new
-e_list_get_type
-e_memchunk_alloc0
-e_source_set_property
-e_source_list_add_group
-e_list_duplicate
-e_categories_get_color_for
-e_list_remove_link
-e_source_group_new_from_xml
-E_ACCOUNT_LIST
-e_strv_destroy
-EMCache
-e_xml_destroy_hash
-e_file_cache_get_keys
-E_IS_LIST_ITERATOR
-e_iterator_delete
-e_sexp_resultv_free
-e_thread_t
-e_iconv_locale_language
-e_iconv_charset_name
-em_cache_lookup
-e_component_listener_new
-e_iterator_get_type
-E_TYPE_ACCOUNT
-e_poolv_cpy
-e_time_parse_time
-e_mutex_lock
-e_iterator_last
-IS_E_SEXP_CLASS
-e_xml_to_hash
-EAccountService
-ESExpTermType
-e_iterator_invalidate
-E_SEXP_CLASS
-E_SOURCE_LIST_CLASS
-e_source_list_peek_groups
-e_source_list_new_for_gconf
-ETimeParseStatus
-e_thread_new
-e_iterator_set
-e_list_construct
-e_msgport_fd
-E_ACCOUNT_LIST_CLASS
-E_IS_SOURCE_GROUP_CLASS
-em_cache_add
-e_data_server_marshal_VOID__VOID
-e_source_set_relative_uri
-e_source_list_new
-e_source_new_from_xml_node
-e_util_utf8_strstrcase
-e_list_new
-e_account_find_t
-e_mutex_destroy
-e_account_list_save
-e_xmlhash_compare
-e_db3_utils_upgrade_format
-E_IS_ACCOUNT
-e_thread_set_msg_received
-EDbHashPrivate
-EMemPool
-em_cache_new
-EAccount
-e_source_group_new
-e_trie_add
-ESourceGroup
-e_data_server_module_init
-E_IS_ACCOUNT_LIST_CLASS
-e_account_to_xml
-EXmlHashStatus
-e_dbhash_write
-E_LIST_GET_CLASS
-ESExp
-E_IS_COMPONENT_LISTENER_CLASS
-e_list_invalidate_iterators
-ESExpSymbol
-e_mktime_utc
-eds_module_list_types
-e_file_cache_get_filename
-e_memchunk_free
-e_source_group_peek_name
-EListClass
-e_time_parse_date_and_time
-E_IS_SOURCE_LIST
-e_sexp_encode_string
-e_localtime_with_offset
-E_FILE_CACHE
-e_dlist_init
+e_url_equal
+<SUBSECTION>
e_uri_new
-E_IS_FILE_CACHE_CLASS
-e_source_list_new_for_gconf_default
-e_data_server_module_add_type
-e_account_list_construct
-e_mutex_t
-E_SOURCE_GROUP_CLASS
-EUri
-e_file_cache_thaw_changes
-e_util_utf8_strstrcasedecomp
-e_memchunk_empty
-em_cache_node_unref
e_uri_free
-E_COMPONENT_LISTENER_TYPE
-e_trie_new
-EIteratorClass
-E_SOURCE_CLASS
-e_source_set_color
-E_IS_ACCOUNT_LIST
-e_source_list_remove_group
-EMsgPort
-e_mempool_alloc
-e_data_server_get_extensions_for_type
-e_iterator_is_valid
-e_memchunk_clean
-ESourceClass
-EListFreeFunc
-E_TYPE_SEXP
-EList
-e_thread_set_msg_destroy
-e_iterator_get
-e_source_get_property
-E_TYPE_ITERATOR
-EPoolv
-e_dlist_addhead
-e_source_list_get_type
-E_ACCOUNT
-E_TYPE_LIST
-e_source_group_remove_source
-e_source_new_from_standalone_xml
-EFileCache
+<SUBSECTION>
+e_uri_get_param
+<SUBSECTION>
e_uri_copy
-EAccountIdentity
-e_account_new
-e_source_peek_uid
-e_sexp_eval
-e_categories_get_icon_file_for
-EXmlHashFunc
-e_account_set_from_xml
-e_source_dump_to_xml_node
-e_account_list_find
-e_iconv_charset_language
-e_iconv
-EIterator
-em_cache_destroy
-ESourcePrivate
-e_component_listener_set_component
-e_util_mkdir_hier
-e_account_list_remove
-e_sexp_encode_bool
-e_account_get_type
-EMCacheNode
-e_mempool_new
-e_sexp_add_variable
-e_source_group_add_source
-e_account_list_set_default
-E_IS_ACCOUNT_CLASS
-ETrie
-e_source_group_peek_sources
-e_source_set_absolute_uri
-ESourceList
-EXmlHashType
-E_IS_LIST_ITERATOR_CLASS
-E_TYPE_ACCOUNT_LIST
-e_thread_set_msg_lost
-e_msgport_get
-e_dbhash_foreach_key
-ESource
-e_account_new_from_xml
-e_iterator_insert
-e_source_new
-E_LIST_CLASS
-e_mempool_destroy
-e_source_peek_group
-e_file_cache_get_objects
-EDbHash
-e_source_set_name
-e_categories_set_color_for
-e_url_equal
-E_TYPE_LIST_ITERATOR
-e_utf8_strftime
-e_memchunk_alloc
-e_list_append
-e_source_group_get_readonly
-E_IS_ITERATOR
-e_strv_set
-ESourceListPrivate
-e_xml_from_hash
-e_source_group_update_from_xmldoc
-e_source_group_peek_base_uri
-e_data_server_marshal_VOID__STRING
-e_categories_set_icon_file_for
-e_source_uid_from_xml_node
-EComponentListener
-e_source_copy
+e_uri_to_string
+</SECTION>
+
+<SECTION>
+<FILE>md5-utils</FILE>
+<INCLUDE>libedataserver/md5-utils.h</INCLUDE>
+<TITLE>MD5 Utility Functions</TITLE>
+MD5Context
+<SUBSECTION>
+md5_get_digest
+md5_get_digest_from_file
+<SUBSECTION>
+md5_init
+md5_update
+md5_final
+</SECTION>
\ No newline at end of file
Index: libedataserver/e-trie.c
===================================================================
RCS file: /cvs/gnome/evolution-data-server/libedataserver/e-trie.c,v
retrieving revision 1.2
diff -u -r1.2 e-trie.c
--- libedataserver/e-trie.c 3 Dec 2004 03:33:06 -0000 1.2
+++ libedataserver/e-trie.c 23 Mar 2005 16:16:03 -0000
@@ -47,6 +47,11 @@
gunichar c;
};
+/**
+ * ETrie:
+ *
+ * A trie data structure.
+ **/
struct _ETrie {
struct _trie_state root;
GPtrArray *fail_states;
@@ -100,7 +105,15 @@
return u;
}
-
+/**
+ * e_trie_new:
+ * @icase: Case sensitivity for the #ETrie.
+ *
+ * Creates a new #ETrie. If @icase is %TRUE, then pattern matching
+ * done by the ETrie will be case insensitive.
+ *
+ * Returns: The newly-created #ETrie.
+ **/
ETrie *
e_trie_new (gboolean icase)
{
@@ -121,6 +134,12 @@
return trie;
}
+/**
+ * e_trie_free:
+ * @trie: The #ETrie to free.
+ *
+ * Frees the memory associated with the #ETrie @trie.
+ **/
void
e_trie_free (ETrie *trie)
{
@@ -211,6 +230,14 @@
* ENDFOR
*/
+/**
+ * e_trie_add:
+ * @trie: The #ETrie to add a pattern to.
+ * @pattern: The pattern to add.
+ * @pattern_id: The id to use for the pattern.
+ *
+ * Add a new pattern to the #ETrie @trie.
+ **/
void
e_trie_add (ETrie *trie, const char *pattern, int pattern_id)
{
@@ -296,6 +323,17 @@
* RETURN FALSE
*/
+/**
+ * e_trie_search:
+ * @trie: The #ETrie to search in.
+ * @buffer: The string to match against a pattern in @trie.
+ * @buflen: The length of @buffer.
+ * @matched_id: An integer address to store the matched pattern id in.
+ *
+ * Try to match the string @buffer with a pattern in @trie.
+ *
+ * Returns: The matched pattern, or %NULL if no pattern is matched.
+ **/
const char *
e_trie_search (ETrie *trie, const char *buffer, size_t buflen, int *matched_id)
{
Index: libedataserver/e-uid.c
===================================================================
RCS file: /cvs/gnome/evolution-data-server/libedataserver/e-uid.c,v
retrieving revision 1.2
diff -u -r1.2 e-uid.c
--- libedataserver/e-uid.c 3 May 2004 19:43:22 -0000 1.2
+++ libedataserver/e-uid.c 23 Mar 2005 16:16:03 -0000
@@ -32,7 +32,7 @@
*
* Generate a new unique string for use e.g. in account lists.
*
- * Return value: the newly generated UID. The caller should free the string
+ * Return value: The newly generated UID. The caller should free the string
* when it's done with it.
**/
char *
Index: libedataserver/e-url.c
===================================================================
RCS file: /cvs/gnome/evolution-data-server/libedataserver/e-url.c,v
retrieving revision 1.2
diff -u -r1.2 e-url.c
--- libedataserver/e-url.c 12 Jan 2005 08:49:04 -0000 1.2
+++ libedataserver/e-url.c 23 Mar 2005 16:16:03 -0000
@@ -31,6 +31,14 @@
#include <string.h>
#include "e-url.h"
+/**
+ * e_url_shroud:
+ * @url: The url to shroud.
+ *
+ * Removes the moniker (i.e. mailto:) from a url.
+ *
+ * Returns: The newly-allocated shrouded url.
+ **/
char *
e_url_shroud (const char *url)
{
@@ -66,6 +74,16 @@
return shrouded;
}
+/**
+ * e_url_equal:
+ * @url1: The first url to compare.
+ * @url2: The second url to compare.
+ *
+ * Checks two urls for equality, after first removing any monikers on
+ * the urls.
+ *
+ * Returns: %TRUE if the urls are equal, %FALSE if they are not.
+ **/
gboolean
e_url_equal (const char *url1, const char *url2)
{
@@ -110,6 +128,14 @@
*d = '\0';
}
+/**
+ * e_uri_new:
+ * @uri_string: The uri to represent as an #EUri.
+ *
+ * Creates an #EUri representation of the uri given in @uri_string.
+ *
+ * Returns: The newly-allocated #EUri structure.
+ **/
EUri *
e_uri_new (const char *uri_string)
{
@@ -244,6 +270,12 @@
return uri;
}
+/**
+ * e_uri_free:
+ * @uri: A pointer to the #EUri to free.
+ *
+ * Frees the memory of an #EUri structure.
+ **/
void
e_uri_free (EUri *uri)
{
@@ -262,6 +294,15 @@
}
}
+/**
+ * e_uri_get_param:
+ * @uri: The #EUri to get the parameter from.
+ * @name: The name of the parameter to get.
+ *
+ * Retrieves the value of the parameter associated with @name in @uri.
+ *
+ * Returns: The value of the parameter.
+ **/
const char *
e_uri_get_param (EUri *uri, const char *name)
{
@@ -276,6 +317,14 @@
g_datalist_id_set_data_full (¶ms, key_id, g_strdup (data), g_free);
}
+/**
+ * e_uri_copy:
+ * @uri: The #EUri to copy.
+ *
+ * Makes a copy of @uri.
+ *
+ * Returns: The newly-allocated copy of @uri.
+ **/
EUri *
e_uri_copy (EUri *uri)
{
@@ -302,6 +351,16 @@
return uri_copy;
}
+/**
+ * e_uri_to_string:
+ * @uri: The #EUri to convert to a string.
+ * @show_password: Whether or not to show the password in the string.
+ *
+ * Creates a string representation of @uri. The password will only be
+ * included in the string if @show_password is set to %TRUE.
+ *
+ * Returns: The string representation of @uri.
+ **/
char *
e_uri_to_string (EUri *uri, gboolean show_password)
{
Index: libedataserver/e-url.h
===================================================================
RCS file: /cvs/gnome/evolution-data-server/libedataserver/e-url.h,v
retrieving revision 1.2
diff -u -r1.2 e-url.h
--- libedataserver/e-url.h 3 May 2004 16:44:56 -0000 1.2
+++ libedataserver/e-url.h 23 Mar 2005 16:16:03 -0000
@@ -35,6 +35,21 @@
char *e_url_shroud (const char *url);
gboolean e_url_equal (const char *url1, const char *url2);
+/**
+ * EUri:
+ * @protocol: The protocol to use.
+ * @user: A user name.
+ * @authmech: The authentication mechanism.
+ * @passwd: The connection password.
+ * @host: The host name.
+ * @port: The port number.
+ * @path: The file path on the host.
+ * @params: Additional parameters.
+ * @query:
+ * @fragment:
+ *
+ * A structure representing a URI.
+ **/
typedef struct {
char *protocol;
char *user;
Index: libedataserver/e-util.c
===================================================================
RCS file: /cvs/gnome/evolution-data-server/libedataserver/e-util.c,v
retrieving revision 1.5
diff -u -r1.5 e-util.c
--- libedataserver/e-util.c 3 Dec 2004 03:33:06 -0000 1.5
+++ libedataserver/e-util.c 23 Mar 2005 16:16:03 -0000
@@ -37,6 +37,18 @@
#include <glib/gconvert.h>
#include "e-util.h"
+/**
+ * e_util_mkdir_hier:
+ * @path: The directory hierarchy to create.
+ * @mode: The permissions to use for the directories.
+ *
+ * Creates a directory hierarchy based on the string @path. If @path
+ * is prefixed by a '/', the directories will be created relative to
+ * the root of the file system; otherwise, the directories will be
+ * created relative to the current directory.
+ *
+ * Returns: 0 on success; -1 on failure.
+ **/
int
e_util_mkdir_hier (const char *path, mode_t mode)
{
@@ -68,6 +80,16 @@
return 0;
}
+/**
+ * e_util_strstrcase:
+ * @haystack: The string to search in.
+ * @needle: The string to search for.
+ *
+ * Find the first instance of @needle in @haystack, ignoring case.
+ *
+ * Returns: A pointer to the start of @needle in @haystack, or NULL if
+ * @needle is not found.
+ **/
gchar *
e_util_strstrcase (const gchar *haystack, const gchar *needle)
{
@@ -92,6 +114,15 @@
return NULL;
}
+/**
+ * e_util_unicode_get_utf8:
+ * @text: The string to take the UTF-8 character from.
+ * @out: The location to store the UTF-8 character in.
+ *
+ * Get a UTF-8 character from the beginning of @text.
+ *
+ * Returns: A pointer to the next character in @text after @out.
+ **/
gchar *
e_util_unicode_get_utf8 (const gchar *text, gunichar *out)
{
@@ -99,6 +130,17 @@
return (*out == (gunichar)-1) ? NULL : g_utf8_next_char (text);
}
+/**
+ * e_util_utf8_strstrcase:
+ * @haystack: The string to search in.
+ * @needle: The string to search for.
+ *
+ * Find the first instance of @needle in @haystack, ignoring
+ * case. Both @needle and @haystack are UTF-8 strings.
+ *
+ * Returns: A pointer to the first instance of @needle in @haystack, or
+ * %NULL if either of the strings are not legal UTF-8 strings.
+ **/
const gchar *
e_util_utf8_strstrcase (const gchar *haystack, const gchar *needle)
{
@@ -1495,6 +1537,18 @@
return 0;
}
+/**
+ * e_util_utf8_strstrcasedecomp:
+ * @haystack: The string to search in.
+ * @needle: The string to search for.
+ *
+ * Find the first instance of @needle in @haystack, where both @needle
+ * and @haystack are UTF-8 strings. Both strings are stripped and
+ * decomposed for comparison, and case is ignored.
+ *
+ * Returns: A pointer to the first instance of @needle in @haystack, or
+ * %NULL if either of the strings are not legal UTF-8 strings.
+ **/
const gchar *
e_util_utf8_strstrcasedecomp (const gchar *haystack, const gchar *needle)
{
@@ -1550,6 +1604,18 @@
return NULL;
}
+/**
+ * e_strftime:
+ * @s: The string array to store the result in.
+ * @max: The size of array @s.
+ * @fmt: The formatting to use on @tm.
+ * @tm: The time value to format.
+ *
+ * This function is a wrapper around the strftime(3) function, which
+ * converts the %l and %k (12h and 24h) format variables if necessary.
+ *
+ * Returns: The number of characters placed in @s.
+ **/
size_t e_strftime(char *s, size_t max, const char *fmt, const struct tm *tm)
{
#ifdef HAVE_LKSTRFTIME
@@ -1577,6 +1643,17 @@
#endif
}
+/**
+ * e_utf8_strftime:
+ * @s: The string array to store the result in.
+ * @max: The size of array @s.
+ * @fmt: The formatting to use on @tm.
+ * @tm: The time value to format.
+ *
+ * The UTF-8 equivalent of e_strftime().
+ *
+ * Returns: The number of characters placed in @s.
+ **/
size_t
e_utf8_strftime(char *s, size_t max, const char *fmt, const struct tm *tm)
{
Index: libedataserver/e-util.h
===================================================================
RCS file: /cvs/gnome/evolution-data-server/libedataserver/e-util.h,v
retrieving revision 1.4
diff -u -r1.4 e-util.h
--- libedataserver/e-util.h 3 Dec 2004 03:33:06 -0000 1.4
+++ libedataserver/e-util.h 23 Mar 2005 16:16:03 -0000
@@ -35,7 +35,7 @@
gchar *e_util_strstrcase (const gchar *haystack, const gchar *needle);
gchar *e_util_unicode_get_utf8 (const gchar *text, gunichar *out);
-const gchar *e_util_utf8_strstrcase (const gchar *s1, const gchar *s2);
+const gchar *e_util_utf8_strstrcase (const gchar *haystack, const gchar *needle);
const gchar *e_util_utf8_strstrcasedecomp (const gchar *haystack, const gchar *needle);
size_t e_utf8_strftime(char *s, size_t max, const char *fmt, const struct tm *tm);
Index: libedataserver/md5-utils.c
===================================================================
RCS file: /cvs/gnome/evolution-data-server/libedataserver/md5-utils.c,v
retrieving revision 1.1.1.1
diff -u -r1.1.1.1 md5-utils.c
--- libedataserver/md5-utils.c 3 Nov 2003 18:23:56 -0000 1.1.1.1
+++ libedataserver/md5-utils.c 23 Mar 2005 16:16:03 -0000
@@ -79,7 +79,7 @@
/**
* md5_update: add a buffer to md5 hash computation
- * @ctx: conetxt object used for md5 computaion
+ * @ctx: context object used for md5 computaion
* @buf: buffer to add
* @len: buffer length
*
Index: libedataserver/md5-utils.h
===================================================================
RCS file: /cvs/gnome/evolution-data-server/libedataserver/md5-utils.h,v
retrieving revision 1.2
diff -u -r1.2 md5-utils.h
--- libedataserver/md5-utils.h 3 May 2004 16:44:56 -0000 1.2
+++ libedataserver/md5-utils.h 23 Mar 2005 16:16:03 -0000
@@ -30,7 +30,13 @@
G_BEGIN_DECLS
+/**
+ * MD5Context:
+ *
+ * A buffer structure used for md5 calculation.
+ **/
typedef struct _MD5Context {
+ /*< private >*/
guint32 buf[4];
guint32 bits[2];
guchar in[64];
--- /dev/null 2005-03-19 18:29:52.956227376 -0400
+++ docs/reference/libedataserver/tmpl/e-trie.sgml 2005-03-23 12:11:40.539340696 -0400
@@ -0,0 +1,64 @@
+<!-- ##### SECTION Title ##### -->
+ETrie
+
+<!-- ##### SECTION Short_Description ##### -->
+A trie data structure.
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT ETrie ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION e_trie_new ##### -->
+<para>
+
+</para>
+
+ icase:
+ Returns:
+
+
+<!-- ##### FUNCTION e_trie_free ##### -->
+<para>
+
+</para>
+
+ trie:
+
+
+<!-- ##### FUNCTION e_trie_add ##### -->
+<para>
+
+</para>
+
+ trie:
+ pattern:
+ pattern_id:
+
+
+<!-- ##### FUNCTION e_trie_search ##### -->
+<para>
+
+</para>
+
+ trie:
+ buffer:
+ buflen:
+ matched_id:
+ Returns:
+
+
--- /dev/null 2005-03-19 18:29:52.956227376 -0400
+++ docs/reference/libedataserver/tmpl/e-uid.sgml 2005-03-23 12:12:23.218852424 -0400
@@ -0,0 +1,27 @@
+<!-- ##### SECTION Title ##### -->
+User ID Generation
+
+<!-- ##### SECTION Short_Description ##### -->
+Generate unique UIDs.
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### FUNCTION e_uid_new ##### -->
+<para>
+
+</para>
+
+ Returns:
+
+
--- /dev/null 2005-03-19 18:29:52.956227376 -0400
+++ docs/reference/libedataserver/tmpl/e-url.sgml 2005-03-23 12:12:46.679285896 -0400
@@ -0,0 +1,100 @@
+<!-- ##### SECTION Title ##### -->
+EUrl
+
+<!-- ##### SECTION Short_Description ##### -->
+A URI data structure and associated functions.
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT EUri ##### -->
+<para>
+
+</para>
+
+ protocol:
+ user:
+ authmech:
+ passwd:
+ host:
+ port:
+ path:
+ params:
+ query:
+ fragment:
+
+<!-- ##### FUNCTION e_url_shroud ##### -->
+<para>
+
+</para>
+
+ url:
+ Returns:
+
+
+<!-- ##### FUNCTION e_url_equal ##### -->
+<para>
+
+</para>
+
+ url1:
+ url2:
+ Returns:
+
+
+<!-- ##### FUNCTION e_uri_new ##### -->
+<para>
+
+</para>
+
+ uri_string:
+ Returns:
+
+
+<!-- ##### FUNCTION e_uri_free ##### -->
+<para>
+
+</para>
+
+ uri:
+
+
+<!-- ##### FUNCTION e_uri_get_param ##### -->
+<para>
+
+</para>
+
+ uri:
+ name:
+ Returns:
+
+
+<!-- ##### FUNCTION e_uri_copy ##### -->
+<para>
+
+</para>
+
+ uri:
+ Returns:
+
+
+<!-- ##### FUNCTION e_uri_to_string ##### -->
+<para>
+
+</para>
+
+ uri:
+ show_password:
+ Returns:
+
+
--- /dev/null 2005-03-19 18:29:52.956227376 -0400
+++ docs/reference/libedataserver/tmpl/e-util.sgml 2005-03-23 12:09:20.429640608 -0400
@@ -0,0 +1,96 @@
+<!-- ##### SECTION Title ##### -->
+Utility Functions
+
+<!-- ##### SECTION Short_Description ##### -->
+Miscellaneous utility functions for evolution-data-server.
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### FUNCTION e_util_mkdir_hier ##### -->
+<para>
+
+</para>
+
+ path:
+ mode:
+ Returns:
+
+
+<!-- ##### FUNCTION e_util_strstrcase ##### -->
+<para>
+
+</para>
+
+ haystack:
+ needle:
+ Returns:
+
+
+<!-- ##### FUNCTION e_util_unicode_get_utf8 ##### -->
+<para>
+
+</para>
+
+ text:
+ out:
+ Returns:
+
+
+<!-- ##### FUNCTION e_util_utf8_strstrcase ##### -->
+<para>
+
+</para>
+
+ haystack:
+ needle:
+ Returns:
+<!-- # Unused Parameters # -->
+ s1:
+ s2:
+
+
+<!-- ##### FUNCTION e_util_utf8_strstrcasedecomp ##### -->
+<para>
+
+</para>
+
+ haystack:
+ needle:
+ Returns:
+
+
+<!-- ##### FUNCTION e_strftime ##### -->
+<para>
+
+</para>
+
+ s:
+ max:
+ fmt:
+ tm:
+ Returns:
+
+
+<!-- ##### FUNCTION e_utf8_strftime ##### -->
+<para>
+
+</para>
+
+ s:
+ max:
+ fmt:
+ tm:
+ Returns:
+
+
--- /dev/null 2005-03-19 18:29:52.956227376 -0400
+++ docs/reference/libedataserver/tmpl/md5-utils.sgml 2005-03-23 12:07:36.736404376 -0400
@@ -0,0 +1,71 @@
+<!-- ##### SECTION Title ##### -->
+MD5 Utility Functions
+
+<!-- ##### SECTION Short_Description ##### -->
+Functions for manipulating MD5 checksums.
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### STRUCT MD5Context ##### -->
+<para>
+
+</para>
+
+
+<!-- ##### FUNCTION md5_get_digest ##### -->
+<para>
+
+</para>
+
+ buffer:
+ buffer_size:
+ digest:
+
+
+<!-- ##### FUNCTION md5_get_digest_from_file ##### -->
+<para>
+
+</para>
+
+ filename:
+ digest:
+
+
+<!-- ##### FUNCTION md5_init ##### -->
+<para>
+
+</para>
+
+ ctx:
+
+
+<!-- ##### FUNCTION md5_update ##### -->
+<para>
+
+</para>
+
+ ctx:
+ buf:
+ len:
+
+
+<!-- ##### FUNCTION md5_final ##### -->
+<para>
+
+</para>
+
+ ctx:
+ digest:
+
+
Index: ChangeLog
===================================================================
RCS file: /cvs/gnome/evolution-data-server/ChangeLog,v
retrieving revision 1.234
diff -u -r1.234 ChangeLog
--- ChangeLog 15 Mar 2005 01:48:03 -0000 1.234
+++ ChangeLog 23 Mar 2005 16:39:37 -0000
@@ -1,3 +1,30 @@
+2005-03-23 James Bowes <bowes cs dal ca>
+
+ * configure.in: Add docs/reference/libedataserver/Makefile
+ as output.
+ * docs/reference/Makefile.am: Add libedataserver as subdir.
+ * docs/reference/libedataserver/Makefile.am: Remove ignored files
+ section.
+ * docs/reference/libedataserver/libedataserver-docs.sgml: Add
+ sections for new API docs.
+ * docs/reference/libedataserver/libedataserver-sections.txt: Make
+ nice formatting for the new documentation.
+ * libedataserver/e-trie.c:
+ * libedataserver/e-uid.c:
+ * libedataserver/e-url.c:
+ * libedataserver/e-url.h:
+ * libedataserver/e-util.c:
+ * libedataserver/e-util.h:
+ * libedataserver/md5-utils.c:
+ * libedataserver/md5-utils.h: Document public functions and data
+ structures.
+ * docs/reference/libedataserver/tmpl/e-trie.sgml:
+ * docs/reference/libedataserver/tmpl/e-uid.sgml:
+ * docs/reference/libedataserver/tmpl/e-url.sgml:
+ * docs/reference/libedataserver/tmpl/e-util.sgml:
+ * docs/reference/libedataserver/tmpl/md5-utils.sgml: New template
+ files for API documentation.
+
2005-03-06 JP Rosevear <jpr novell com>
* configure.in: bump version, libtool numbers
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
