[libEtPan-commits] CVS: xetpan/src message.h,1.4,1.5

[Melvin H. <mha...@us...>]

Update of /cvsroot/libetpan/xetpan/src
In directory sc8-pr-cvs1:/tmp/cvs-serv3045/src

Modified Files:
	message.h 
Log Message:
* src/message.h:
	- Documented XePMessage
	- Added XePMessage::muid a unique XePMessage identifier
	- Replaced XePMessage::flags with XePMessage::flags_set
	and XePMessage::flags_unset
	- a_Message_new() must be called from the main thread due
	to the static nature of XePMessage::muid
	- a_Message_free(): check for NULL
	- a_Message_get_message(): removed
	- a_Message_get_flags(): removed
	- a_Message_get_bodystructure(): use a_Folder_noop()
	instead of a_Folder_connect(), and resolve single fields.
	- a_Message_fetch_fields(): removed
	- a_Message_flags_set(): removed
	- a_Message_flags_unset(): removed
	- a_Message_flags_change(): new function to set/unset
	flags.



Index: message.h
===================================================================
RCS file: /cvsroot/libetpan/xetpan/src/message.h,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- message.h	28 May 2003 20:57:04 -0000	1.4
+++ message.h	30 May 2003 19:03:27 -0000	1.5
@@ -27,23 +27,35 @@
 
 typedef struct XePMessage_s XePMessage;
 
+/**! A structure containing all the data needed to display/edit a 
+ *   message. Each XePMessage will contain a unique identifier (across
+ *   a XetPan session).
+ */
 struct XePMessage_s
 {
-  char *data;
-  size_t len;
-  XePFolder *folder;
-  uint32_t msg_index;
-  mailmessage *msg;
-  struct mailmime *mime;
-  struct mailimf_fields *fields;
-  struct mailimf_single_fields *single_fields;
-  struct mailmime *selected_mime;
-  uint32_t flags;
-  char *source_charset;
-  const char *dest_charset;
+  char *data;             /**< Current in memory data */
+  size_t len;             /**< Its size */
+  XePFolder *folder;      /**< The related folder */
+  uint32_t muid;          /**< A unique identifier for the structure,
+			   *   * incremented for each call to
+			   *   XePMessage_new(). Must be set and read
+			   *   only from the main thread. */
+  mailmessage *msg;       /**< The message structure. */
+  struct mailmime *mime;  /**< The root MIME of the message */
+  struct mailimf_fields *fields;  /**< The fields of the root MIME */
+  struct mailimf_single_fields *single_fields;  
+  struct mailmime *selected_mime; /**< The selected MIME */
+  uint32_t flags_set;     /**< Flags to set, used by
+			   * a_Message_flags_change() */
+  uint32_t flags_unset;   /**< Flags to unset, used by
+			   * a_Message_flags_change() */
+  char *source_charset;   /**< The source charset of the data */
+  const char *dest_charset; /**< The destination charset */
 };
 
 
+/**! Create a new XePMessage structure. This must be called from the
+ *   main thread */
 XePMessage *
 a_Message_new(void);
 
@@ -165,19 +177,9 @@
 			    char **other);
 
 int
-a_Message_get_message(XePMessage *message);
-
-
-int
-a_Message_get_flags(XePMessage *message);
-
-int
 a_Message_get_bodystructure(XePMessage *message);
 
 int
-a_Message_fetch_fields(XePMessage *message);
-
-int
 a_Message_mime_find_default(XePMessage *message);
 
 int
@@ -187,10 +189,7 @@
 a_Message_fetch(XePMessage *message);
 
 int
-a_Message_flags_set(XePMessage *message);
-
-int
-a_Message_flags_unset(XePMessage *message);
+a_Message_flags_change(XePMessage *message);
 
 mailmessage *
 a_Message_message_new_from_data(char *data, size_t len);