conversation.h
Go to the documentation of this file.
00001 
00007 /* purple
00008  *
00009  * Purple is the legal property of its developers, whose names are too numerous
00010  * to list here.  Please refer to the COPYRIGHT file distributed with this
00011  * source distribution.
00012  *
00013  * This program is free software; you can redistribute it and/or modify
00014  * it under the terms of the GNU General Public License as published by
00015  * the Free Software Foundation; either version 2 of the License, or
00016  * (at your option) any later version.
00017  *
00018  * This program is distributed in the hope that it will be useful,
00019  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00020  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00021  * GNU General Public License for more details.
00022  *
00023  * You should have received a copy of the GNU General Public License
00024  * along with this program; if not, write to the Free Software
00025  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
00026  */
00027 #ifndef _PURPLE_CONVERSATION_H_
00028 #define _PURPLE_CONVERSATION_H_
00029 
00030 /**************************************************************************/
00032 /**************************************************************************/
00033 
00034 
00036 typedef struct _PurpleConversationUiOps PurpleConversationUiOps;
00038 typedef struct _PurpleConversation      PurpleConversation;
00040 typedef struct _PurpleConvIm            PurpleConvIm;
00042 typedef struct _PurpleConvChat          PurpleConvChat;
00044 typedef struct _PurpleConvChatBuddy     PurpleConvChatBuddy;
00046 typedef struct _PurpleConvMessage       PurpleConvMessage;
00047 
00051 typedef enum
00052 {
00053     PURPLE_CONV_TYPE_UNKNOWN = 0, 
00054     PURPLE_CONV_TYPE_IM,          
00055     PURPLE_CONV_TYPE_CHAT,        
00056     PURPLE_CONV_TYPE_MISC,        
00057     PURPLE_CONV_TYPE_ANY          
00059 } PurpleConversationType;
00060 
00064 typedef enum
00065 {
00066     PURPLE_CONV_UPDATE_ADD = 0, 
00068     PURPLE_CONV_UPDATE_REMOVE,  
00070     PURPLE_CONV_UPDATE_ACCOUNT, 
00071     PURPLE_CONV_UPDATE_TYPING,  
00072     PURPLE_CONV_UPDATE_UNSEEN,  
00073     PURPLE_CONV_UPDATE_LOGGING, 
00075     PURPLE_CONV_UPDATE_TOPIC,   
00076     /*
00077      * XXX These need to go when we implement a more generic core/UI event
00078      * system.
00079      */
00080     PURPLE_CONV_ACCOUNT_ONLINE,  
00081     PURPLE_CONV_ACCOUNT_OFFLINE, 
00082     PURPLE_CONV_UPDATE_AWAY,     
00083     PURPLE_CONV_UPDATE_ICON,     
00084     PURPLE_CONV_UPDATE_TITLE,
00085     PURPLE_CONV_UPDATE_CHATLEFT,
00086 
00087     PURPLE_CONV_UPDATE_FEATURES  
00089 } PurpleConvUpdateType;
00090 
00094 typedef enum
00095 {
00096     PURPLE_NOT_TYPING = 0,  
00097     PURPLE_TYPING,          
00098     PURPLE_TYPED            
00100 } PurpleTypingState;
00101 
00105 typedef enum
00106 {
00107     PURPLE_MESSAGE_SEND        = 0x0001, 
00108     PURPLE_MESSAGE_RECV        = 0x0002, 
00109     PURPLE_MESSAGE_SYSTEM      = 0x0004, 
00110     PURPLE_MESSAGE_AUTO_RESP   = 0x0008, 
00111     PURPLE_MESSAGE_ACTIVE_ONLY = 0x0010,  
00118     PURPLE_MESSAGE_NICK        = 0x0020, 
00119     PURPLE_MESSAGE_NO_LOG      = 0x0040, 
00120     PURPLE_MESSAGE_WHISPER     = 0x0080, 
00121     PURPLE_MESSAGE_ERROR       = 0x0200, 
00122     PURPLE_MESSAGE_DELAYED     = 0x0400, 
00123     PURPLE_MESSAGE_RAW         = 0x0800, 
00125     PURPLE_MESSAGE_IMAGES      = 0x1000, 
00126     PURPLE_MESSAGE_NOTIFY      = 0x2000, 
00127     PURPLE_MESSAGE_NO_LINKIFY  = 0x4000, 
00129     PURPLE_MESSAGE_INVISIBLE   = 0x8000  
00130 } PurpleMessageFlags;
00131 
00135 typedef enum
00136 {
00137     PURPLE_CBFLAGS_NONE          = 0x0000, 
00138     PURPLE_CBFLAGS_VOICE         = 0x0001, 
00139     PURPLE_CBFLAGS_HALFOP        = 0x0002, 
00140     PURPLE_CBFLAGS_OP            = 0x0004, 
00141     PURPLE_CBFLAGS_FOUNDER       = 0x0008, 
00142     PURPLE_CBFLAGS_TYPING        = 0x0010, 
00143     PURPLE_CBFLAGS_AWAY          = 0x0020  
00145 } PurpleConvChatBuddyFlags;
00146 
00147 #include "account.h"
00148 #include "buddyicon.h"
00149 #include "log.h"
00150 #include "server.h"
00151 
00158 struct _PurpleConversationUiOps
00159 {
00163     void (*create_conversation)(PurpleConversation *conv);
00164 
00166     void (*destroy_conversation)(PurpleConversation *conv);
00171     void (*write_chat)(PurpleConversation *conv, const char *who,
00172                        const char *message, PurpleMessageFlags flags,
00173                        time_t mtime);
00178     void (*write_im)(PurpleConversation *conv, const char *who,
00179                      const char *message, PurpleMessageFlags flags,
00180                      time_t mtime);
00189     void (*write_conv)(PurpleConversation *conv,
00190                        const char *name,
00191                        const char *alias,
00192                        const char *message,
00193                        PurpleMessageFlags flags,
00194                        time_t mtime);
00195 
00202     void (*chat_add_users)(PurpleConversation *conv,
00203                            GList *cbuddies,
00204                            gboolean new_arrivals);
00210     void (*chat_rename_user)(PurpleConversation *conv, const char *old_name,
00211                              const char *new_name, const char *new_alias);
00216     void (*chat_remove_users)(PurpleConversation *conv, GList *users);
00220     void (*chat_update_user)(PurpleConversation *conv, const char *user);
00221 
00225     void (*present)(PurpleConversation *conv);
00226 
00231     gboolean (*has_focus)(PurpleConversation *conv);
00232 
00233     /* Custom Smileys */
00234     gboolean (*custom_smiley_add)(PurpleConversation *conv, const char *smile, gboolean remote);
00235     void (*custom_smiley_write)(PurpleConversation *conv, const char *smile,
00236                                 const guchar *data, gsize size);
00237     void (*custom_smiley_close)(PurpleConversation *conv, const char *smile);
00238 
00244     void (*send_confirm)(PurpleConversation *conv, const char *message);
00245 
00246     void (*_purple_reserved1)(void);
00247     void (*_purple_reserved2)(void);
00248     void (*_purple_reserved3)(void);
00249     void (*_purple_reserved4)(void);
00250 };
00251 
00255 struct _PurpleConvIm
00256 {
00257     PurpleConversation *conv;            
00259     PurpleTypingState typing_state;      
00260     guint  typing_timeout;             
00261     time_t type_again;                 
00262     guint  send_typed_timeout;         
00264     PurpleBuddyIcon *icon;               
00265 };
00266 
00270 struct _PurpleConvChat
00271 {
00272     PurpleConversation *conv;          
00274     GList *in_room;                  
00275     GList *ignored;                  
00276     char  *who;                      
00277     char  *topic;                    
00278     int    id;                       
00279     char *nick;                      
00281     gboolean left;                   
00282 };
00283 
00287 struct _PurpleConvChatBuddy
00288 {
00289     char *name;                      
00290     char *alias;                     
00293     char *alias_key;                 
00298     gboolean buddy;                  
00301     PurpleConvChatBuddyFlags flags;  
00304     GHashTable *attributes;          
00307 };
00308 
00314 struct _PurpleConvMessage
00315 {
00316     char *who;
00317     char *what;
00318     PurpleMessageFlags flags;
00319     time_t when;
00320     PurpleConversation *conv;  
00321     char *alias;               
00322 };
00323 
00329 struct _PurpleConversation
00330 {
00331     PurpleConversationType type;  
00333     PurpleAccount *account;       
00336     char *name;                 
00337     char *title;                
00339     gboolean logging;           
00341     GList *logs;                
00343     union
00344     {
00345         PurpleConvIm   *im;       
00346         PurpleConvChat *chat;     
00347         void *misc;             
00349     } u;
00350 
00351     PurpleConversationUiOps *ui_ops;           
00352     void *ui_data;                           
00354     GHashTable *data;                        
00356     PurpleConnectionFlags features; 
00357     GList *message_history;         
00358 };
00359 
00360 #ifdef __cplusplus
00361 extern "C" {
00362 #endif
00363 
00364 /**************************************************************************/
00366 /**************************************************************************/
00380 PurpleConversation *purple_conversation_new(PurpleConversationType type,
00381                                         PurpleAccount *account,
00382                                         const char *name);
00383 
00393 void purple_conversation_destroy(PurpleConversation *conv);
00394 
00395 
00401 void purple_conversation_present(PurpleConversation *conv);
00402 
00403 
00411 PurpleConversationType purple_conversation_get_type(const PurpleConversation *conv);
00412 
00419 void purple_conversation_set_ui_ops(PurpleConversation *conv,
00420                                   PurpleConversationUiOps *ops);
00421 
00427 void purple_conversations_set_ui_ops(PurpleConversationUiOps *ops);
00428 
00436 PurpleConversationUiOps *purple_conversation_get_ui_ops(
00437         const PurpleConversation *conv);
00438 
00448 void purple_conversation_set_account(PurpleConversation *conv,
00449                                    PurpleAccount *account);
00450 
00461 PurpleAccount *purple_conversation_get_account(const PurpleConversation *conv);
00462 
00472 PurpleConnection *purple_conversation_get_gc(const PurpleConversation *conv);
00473 
00480 void purple_conversation_set_title(PurpleConversation *conv, const char *title);
00481 
00489 const char *purple_conversation_get_title(const PurpleConversation *conv);
00490 
00499 void purple_conversation_autoset_title(PurpleConversation *conv);
00500 
00507 void purple_conversation_set_name(PurpleConversation *conv, const char *name);
00508 
00517 const char *purple_conversation_get_name(const PurpleConversation *conv);
00518 
00527 const char *purple_conv_chat_cb_get_attribute(PurpleConvChatBuddy *cb, const char *key);
00528 
00536 GList *purple_conv_chat_cb_get_attribute_keys(PurpleConvChatBuddy *cb);
00537     
00546 void purple_conv_chat_cb_set_attribute(PurpleConvChat *chat, PurpleConvChatBuddy *cb, const char *key, const char *value);
00547 
00556 void
00557 purple_conv_chat_cb_set_attributes(PurpleConvChat *chat, PurpleConvChatBuddy *cb, GList *keys, GList *values);
00558 
00565 void purple_conversation_set_logging(PurpleConversation *conv, gboolean log);
00566 
00574 gboolean purple_conversation_is_logging(const PurpleConversation *conv);
00575 
00585 void purple_conversation_close_logs(PurpleConversation *conv);
00586 
00596 PurpleConvIm *purple_conversation_get_im_data(const PurpleConversation *conv);
00597 
00598 #define PURPLE_CONV_IM(c) (purple_conversation_get_im_data(c))
00599 
00609 PurpleConvChat *purple_conversation_get_chat_data(const PurpleConversation *conv);
00610 
00611 #define PURPLE_CONV_CHAT(c) (purple_conversation_get_chat_data(c))
00612 
00620 void purple_conversation_set_data(PurpleConversation *conv, const char *key,
00621                                 gpointer data);
00622 
00631 gpointer purple_conversation_get_data(PurpleConversation *conv, const char *key);
00632 
00640 GList *purple_get_conversations(void);
00641 
00647 GList *purple_get_ims(void);
00648 
00654 GList *purple_get_chats(void);
00655 
00665 PurpleConversation *purple_find_conversation_with_account(
00666         PurpleConversationType type, const char *name,
00667         const PurpleAccount *account);
00668 
00689 void purple_conversation_write(PurpleConversation *conv, const char *who,
00690         const char *message, PurpleMessageFlags flags,
00691         time_t mtime);
00692 
00698 void purple_conversation_set_features(PurpleConversation *conv,
00699         PurpleConnectionFlags features);
00700 
00701 
00706 PurpleConnectionFlags purple_conversation_get_features(PurpleConversation *conv);
00707 
00716 gboolean purple_conversation_has_focus(PurpleConversation *conv);
00717 
00724 void purple_conversation_update(PurpleConversation *conv, PurpleConvUpdateType type);
00725 
00731 void purple_conversation_foreach(void (*func)(PurpleConversation *conv));
00732 
00744 GList *purple_conversation_get_message_history(PurpleConversation *conv);
00745 
00753 void purple_conversation_clear_message_history(PurpleConversation *conv);
00754 
00764 const char *purple_conversation_message_get_sender(PurpleConvMessage *msg);
00765 
00775 const char *purple_conversation_message_get_message(PurpleConvMessage *msg);
00776 
00786 PurpleMessageFlags purple_conversation_message_get_flags(PurpleConvMessage *msg);
00787 
00797 time_t purple_conversation_message_get_timestamp(PurpleConvMessage *msg);
00798 
00802 /**************************************************************************/
00804 /**************************************************************************/
00814 PurpleConversation *purple_conv_im_get_conversation(const PurpleConvIm *im);
00815 
00827 void purple_conv_im_set_icon(PurpleConvIm *im, PurpleBuddyIcon *icon);
00828 
00836 PurpleBuddyIcon *purple_conv_im_get_icon(const PurpleConvIm *im);
00837 
00844 void purple_conv_im_set_typing_state(PurpleConvIm *im, PurpleTypingState state);
00845 
00853 PurpleTypingState purple_conv_im_get_typing_state(const PurpleConvIm *im);
00854 
00861 void purple_conv_im_start_typing_timeout(PurpleConvIm *im, int timeout);
00862 
00868 void purple_conv_im_stop_typing_timeout(PurpleConvIm *im);
00869 
00877 guint purple_conv_im_get_typing_timeout(const PurpleConvIm *im);
00878 
00890 void purple_conv_im_set_type_again(PurpleConvIm *im, unsigned int val);
00891 
00900 time_t purple_conv_im_get_type_again(const PurpleConvIm *im);
00901 
00907 void purple_conv_im_start_send_typed_timeout(PurpleConvIm *im);
00908 
00914 void purple_conv_im_stop_send_typed_timeout(PurpleConvIm *im);
00915 
00923 guint purple_conv_im_get_send_typed_timeout(const PurpleConvIm *im);
00924 
00930 void purple_conv_im_update_typing(PurpleConvIm *im);
00931 
00941 void purple_conv_im_write(PurpleConvIm *im, const char *who,
00942                         const char *message, PurpleMessageFlags flags,
00943                         time_t mtime);
00944 
00958 gboolean purple_conv_present_error(const char *who, PurpleAccount *account, const char *what);
00959 
00966 void purple_conv_im_send(PurpleConvIm *im, const char *message);
00967 
00980 void purple_conv_send_confirm(PurpleConversation *conv, const char *message);
00981 
00989 void purple_conv_im_send_with_flags(PurpleConvIm *im, const char *message, PurpleMessageFlags flags);
00990 
01010 gboolean purple_conv_custom_smiley_add(PurpleConversation *conv, const char *smile,
01011                                       const char *cksum_type, const char *chksum,
01012                                       gboolean remote);
01013 
01014 
01024 void purple_conv_custom_smiley_write(PurpleConversation *conv,
01025                                    const char *smile,
01026                                    const guchar *data,
01027                                    gsize size);
01028 
01038 void purple_conv_custom_smiley_close(PurpleConversation *conv, const char *smile);
01039 
01043 /**************************************************************************/
01045 /**************************************************************************/
01055 PurpleConversation *purple_conv_chat_get_conversation(const PurpleConvChat *chat);
01056 
01069 GList *purple_conv_chat_set_users(PurpleConvChat *chat, GList *users);
01070 
01079 GList *purple_conv_chat_get_users(const PurpleConvChat *chat);
01080 
01087 void purple_conv_chat_ignore(PurpleConvChat *chat, const char *name);
01088 
01095 void purple_conv_chat_unignore(PurpleConvChat *chat, const char *name);
01096 
01105 GList *purple_conv_chat_set_ignored(PurpleConvChat *chat, GList *ignored);
01106 
01114 GList *purple_conv_chat_get_ignored(const PurpleConvChat *chat);
01115 
01130 const char *purple_conv_chat_get_ignored_user(const PurpleConvChat *chat,
01131                                             const char *user);
01132 
01141 gboolean purple_conv_chat_is_user_ignored(const PurpleConvChat *chat,
01142                                         const char *user);
01143 
01151 void purple_conv_chat_set_topic(PurpleConvChat *chat, const char *who,
01152                               const char *topic);
01153 
01161 const char *purple_conv_chat_get_topic(const PurpleConvChat *chat);
01162 
01169 void purple_conv_chat_set_id(PurpleConvChat *chat, int id);
01170 
01178 int purple_conv_chat_get_id(const PurpleConvChat *chat);
01179 
01189 void purple_conv_chat_write(PurpleConvChat *chat, const char *who,
01190                           const char *message, PurpleMessageFlags flags,
01191                           time_t mtime);
01192 
01199 void purple_conv_chat_send(PurpleConvChat *chat, const char *message);
01200 
01208 void purple_conv_chat_send_with_flags(PurpleConvChat *chat, const char *message, PurpleMessageFlags flags);
01209 
01219 void purple_conv_chat_add_user(PurpleConvChat *chat, const char *user,
01220                              const char *extra_msg, PurpleConvChatBuddyFlags flags,
01221                              gboolean new_arrival);
01222 
01240 void purple_conv_chat_add_users(PurpleConvChat *chat, GList *users, GList *extra_msgs,
01241                               GList *flags, gboolean new_arrivals);
01242 
01250 void purple_conv_chat_rename_user(PurpleConvChat *chat, const char *old_user,
01251                                 const char *new_user);
01252 
01262 void purple_conv_chat_remove_user(PurpleConvChat *chat, const char *user,
01263                                 const char *reason);
01264 
01272 void purple_conv_chat_remove_users(PurpleConvChat *chat, GList *users,
01273                                  const char *reason);
01274 
01283 gboolean purple_conv_chat_find_user(PurpleConvChat *chat, const char *user);
01284 
01292 void purple_conv_chat_user_set_flags(PurpleConvChat *chat, const char *user,
01293                                    PurpleConvChatBuddyFlags flags);
01294 
01303 PurpleConvChatBuddyFlags purple_conv_chat_user_get_flags(PurpleConvChat *chat,
01304                                                      const char *user);
01305 
01311 void purple_conv_chat_clear_users(PurpleConvChat *chat);
01312 
01319 void purple_conv_chat_set_nick(PurpleConvChat *chat, const char *nick);
01320 
01327 const char *purple_conv_chat_get_nick(PurpleConvChat *chat);
01328 
01337 PurpleConversation *purple_find_chat(const PurpleConnection *gc, int id);
01338 
01345 void purple_conv_chat_left(PurpleConvChat *chat);
01346 
01360 void purple_conv_chat_invite_user(PurpleConvChat *chat, const char *user,
01361         const char *message, gboolean confirm);
01362 
01372 gboolean purple_conv_chat_has_left(PurpleConvChat *chat);
01373 
01383 PurpleConvChatBuddy *purple_conv_chat_cb_new(const char *name, const char *alias,
01384                                         PurpleConvChatBuddyFlags flags);
01385 
01392 PurpleConvChatBuddy *purple_conv_chat_cb_find(PurpleConvChat *chat, const char *name);
01393 
01401 const char *purple_conv_chat_cb_get_name(PurpleConvChatBuddy *cb);
01402 
01408 void purple_conv_chat_cb_destroy(PurpleConvChatBuddy *cb);
01409 
01421 GList * purple_conversation_get_extended_menu(PurpleConversation *conv);
01422 
01436 gboolean purple_conversation_do_command(PurpleConversation *conv, const gchar *cmdline, const gchar *markup, gchar **error);
01437 
01440 /**************************************************************************/
01442 /**************************************************************************/
01450 void *purple_conversations_get_handle(void);
01451 
01455 void purple_conversations_init(void);
01456 
01460 void purple_conversations_uninit(void);
01461 
01464 #ifdef __cplusplus
01465 }
01466 #endif
01467 
01468 #endif /* _PURPLE_CONVERSATION_H_ */