conversation.h

Go to the documentation of this file.

/* purple
 *
 * Purple is the legal property of its developers, whose names are too numerous
 * to list here.  Please refer to the COPYRIGHT file distributed with this
 * source distribution.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
 */
#ifndef _PURPLE_CONVERSATION_H_
#define _PURPLE_CONVERSATION_H_

/**************************************************************************/
/**************************************************************************/


typedef struct _PurpleConversationUiOps PurpleConversationUiOps;
typedef struct _PurpleConversation      PurpleConversation;
typedef struct _PurpleConvIm            PurpleConvIm;
typedef struct _PurpleConvChat          PurpleConvChat;
typedef struct _PurpleConvChatBuddy     PurpleConvChatBuddy;
typedef struct _PurpleConvMessage       PurpleConvMessage;

typedef enum
{
    PURPLE_CONV_TYPE_UNKNOWN = 0, 
    PURPLE_CONV_TYPE_IM,          
    PURPLE_CONV_TYPE_CHAT,        
    PURPLE_CONV_TYPE_MISC,        
    PURPLE_CONV_TYPE_ANY          
} PurpleConversationType;

typedef enum
{
    PURPLE_CONV_UPDATE_ADD = 0, 
    PURPLE_CONV_UPDATE_REMOVE,  
    PURPLE_CONV_UPDATE_ACCOUNT, 
    PURPLE_CONV_UPDATE_TYPING,  
    PURPLE_CONV_UPDATE_UNSEEN,  
    PURPLE_CONV_UPDATE_LOGGING, 
    PURPLE_CONV_UPDATE_TOPIC,   
    /*
     * XXX These need to go when we implement a more generic core/UI event
     * system.
     */
    PURPLE_CONV_ACCOUNT_ONLINE,  
    PURPLE_CONV_ACCOUNT_OFFLINE, 
    PURPLE_CONV_UPDATE_AWAY,     
    PURPLE_CONV_UPDATE_ICON,     
    PURPLE_CONV_UPDATE_TITLE,
    PURPLE_CONV_UPDATE_CHATLEFT,

    PURPLE_CONV_UPDATE_FEATURES  
} PurpleConvUpdateType;

typedef enum
{
    PURPLE_NOT_TYPING = 0,  
    PURPLE_TYPING,          
    PURPLE_TYPED            
} PurpleTypingState;

typedef enum
{
    PURPLE_MESSAGE_SEND        = 0x0001, 
    PURPLE_MESSAGE_RECV        = 0x0002, 
    PURPLE_MESSAGE_SYSTEM      = 0x0004, 
    PURPLE_MESSAGE_AUTO_RESP   = 0x0008, 
    PURPLE_MESSAGE_ACTIVE_ONLY = 0x0010,  
    PURPLE_MESSAGE_NICK        = 0x0020, 
    PURPLE_MESSAGE_NO_LOG      = 0x0040, 
    PURPLE_MESSAGE_WHISPER     = 0x0080, 
    PURPLE_MESSAGE_ERROR       = 0x0200, 
    PURPLE_MESSAGE_DELAYED     = 0x0400, 
    PURPLE_MESSAGE_RAW         = 0x0800, 
    PURPLE_MESSAGE_IMAGES      = 0x1000, 
    PURPLE_MESSAGE_NOTIFY      = 0x2000, 
    PURPLE_MESSAGE_NO_LINKIFY  = 0x4000, 
    PURPLE_MESSAGE_INVISIBLE   = 0x8000  
} PurpleMessageFlags;

typedef enum
{
    PURPLE_CBFLAGS_NONE          = 0x0000, 
    PURPLE_CBFLAGS_VOICE         = 0x0001, 
    PURPLE_CBFLAGS_HALFOP        = 0x0002, 
    PURPLE_CBFLAGS_OP            = 0x0004, 
    PURPLE_CBFLAGS_FOUNDER       = 0x0008, 
    PURPLE_CBFLAGS_TYPING        = 0x0010, 
    PURPLE_CBFLAGS_AWAY          = 0x0020  
} PurpleConvChatBuddyFlags;

#include "account.h"
#include "buddyicon.h"
#include "log.h"
#include "server.h"

struct _PurpleConversationUiOps
{
    void (*create_conversation)(PurpleConversation *conv);

    void (*destroy_conversation)(PurpleConversation *conv);
    void (*write_chat)(PurpleConversation *conv, const char *who,
                       const char *message, PurpleMessageFlags flags,
                       time_t mtime);
    void (*write_im)(PurpleConversation *conv, const char *who,
                     const char *message, PurpleMessageFlags flags,
                     time_t mtime);
    void (*write_conv)(PurpleConversation *conv,
                       const char *name,
                       const char *alias,
                       const char *message,
                       PurpleMessageFlags flags,
                       time_t mtime);

    void (*chat_add_users)(PurpleConversation *conv,
                           GList *cbuddies,
                           gboolean new_arrivals);
    void (*chat_rename_user)(PurpleConversation *conv, const char *old_name,
                             const char *new_name, const char *new_alias);
    void (*chat_remove_users)(PurpleConversation *conv, GList *users);
    void (*chat_update_user)(PurpleConversation *conv, const char *user);

    void (*present)(PurpleConversation *conv);

    gboolean (*has_focus)(PurpleConversation *conv);

    /* Custom Smileys */
    gboolean (*custom_smiley_add)(PurpleConversation *conv, const char *smile, gboolean remote);
    void (*custom_smiley_write)(PurpleConversation *conv, const char *smile,
                                const guchar *data, gsize size);
    void (*custom_smiley_close)(PurpleConversation *conv, const char *smile);

    void (*send_confirm)(PurpleConversation *conv, const char *message);

    void (*_purple_reserved1)(void);
    void (*_purple_reserved2)(void);
    void (*_purple_reserved3)(void);
    void (*_purple_reserved4)(void);
};

struct _PurpleConvIm
{
    PurpleConversation *conv;            
    PurpleTypingState typing_state;      
    guint  typing_timeout;             
    time_t type_again;                 
    guint  send_typed_timeout;         
    PurpleBuddyIcon *icon;               
};

struct _PurpleConvChat
{
    PurpleConversation *conv;          
    GList *in_room;                  
    GList *ignored;                  
    char  *who;                      
    char  *topic;                    
    int    id;                       
    char *nick;                      
    gboolean left;                   
    GHashTable *users;               
};

struct _PurpleConvChatBuddy
{
    char *name;                      
    char *alias;                     
    char *alias_key;                 
    gboolean buddy;                  
    PurpleConvChatBuddyFlags flags;  
    GHashTable *attributes;          
    gpointer ui_data;                
};

struct _PurpleConvMessage
{
    char *who;
    char *what;
    PurpleMessageFlags flags;
    time_t when;
    PurpleConversation *conv;  
    char *alias;               
};

struct _PurpleConversation
{
    PurpleConversationType type;  
    PurpleAccount *account;       
    char *name;                 
    char *title;                
    gboolean logging;           
    GList *logs;                
    union
    {
        PurpleConvIm   *im;       
        PurpleConvChat *chat;     
        void *misc;             
    } u;

    PurpleConversationUiOps *ui_ops;           
    void *ui_data;                           
    GHashTable *data;                        
    PurpleConnectionFlags features; 
    GList *message_history;         
};

#ifdef __cplusplus
extern "C" {
#endif

/**************************************************************************/
/**************************************************************************/
PurpleConversation *purple_conversation_new(PurpleConversationType type,
                                        PurpleAccount *account,
                                        const char *name);

void purple_conversation_destroy(PurpleConversation *conv);


void purple_conversation_present(PurpleConversation *conv);


PurpleConversationType purple_conversation_get_type(const PurpleConversation *conv);

void purple_conversation_set_ui_ops(PurpleConversation *conv,
                                  PurpleConversationUiOps *ops);

void purple_conversations_set_ui_ops(PurpleConversationUiOps *ops);

PurpleConversationUiOps *purple_conversation_get_ui_ops(
        const PurpleConversation *conv);

void purple_conversation_set_account(PurpleConversation *conv,
                                   PurpleAccount *account);

PurpleAccount *purple_conversation_get_account(const PurpleConversation *conv);

PurpleConnection *purple_conversation_get_gc(const PurpleConversation *conv);

void purple_conversation_set_title(PurpleConversation *conv, const char *title);

const char *purple_conversation_get_title(const PurpleConversation *conv);

void purple_conversation_autoset_title(PurpleConversation *conv);

void purple_conversation_set_name(PurpleConversation *conv, const char *name);

const char *purple_conversation_get_name(const PurpleConversation *conv);

const char *purple_conv_chat_cb_get_attribute(PurpleConvChatBuddy *cb, const char *key);

GList *purple_conv_chat_cb_get_attribute_keys(PurpleConvChatBuddy *cb);
    
void purple_conv_chat_cb_set_attribute(PurpleConvChat *chat, PurpleConvChatBuddy *cb, const char *key, const char *value);

void
purple_conv_chat_cb_set_attributes(PurpleConvChat *chat, PurpleConvChatBuddy *cb, GList *keys, GList *values);

void purple_conversation_set_logging(PurpleConversation *conv, gboolean log);

gboolean purple_conversation_is_logging(const PurpleConversation *conv);

void purple_conversation_close_logs(PurpleConversation *conv);

PurpleConvIm *purple_conversation_get_im_data(const PurpleConversation *conv);

#define PURPLE_CONV_IM(c) (purple_conversation_get_im_data(c))

PurpleConvChat *purple_conversation_get_chat_data(const PurpleConversation *conv);

#define PURPLE_CONV_CHAT(c) (purple_conversation_get_chat_data(c))

void purple_conversation_set_data(PurpleConversation *conv, const char *key,
                                gpointer data);

gpointer purple_conversation_get_data(PurpleConversation *conv, const char *key);

GList *purple_get_conversations(void);

GList *purple_get_ims(void);

GList *purple_get_chats(void);

PurpleConversation *purple_find_conversation_with_account(
        PurpleConversationType type, const char *name,
        const PurpleAccount *account);

void purple_conversation_write(PurpleConversation *conv, const char *who,
        const char *message, PurpleMessageFlags flags,
        time_t mtime);

void purple_conversation_set_features(PurpleConversation *conv,
        PurpleConnectionFlags features);


PurpleConnectionFlags purple_conversation_get_features(PurpleConversation *conv);

gboolean purple_conversation_has_focus(PurpleConversation *conv);

void purple_conversation_update(PurpleConversation *conv, PurpleConvUpdateType type);

void purple_conversation_foreach(void (*func)(PurpleConversation *conv));

GList *purple_conversation_get_message_history(PurpleConversation *conv);

void purple_conversation_clear_message_history(PurpleConversation *conv);

const char *purple_conversation_message_get_sender(PurpleConvMessage *msg);

const char *purple_conversation_message_get_message(PurpleConvMessage *msg);

PurpleMessageFlags purple_conversation_message_get_flags(PurpleConvMessage *msg);

time_t purple_conversation_message_get_timestamp(PurpleConvMessage *msg);

/**************************************************************************/
/**************************************************************************/
PurpleConversation *purple_conv_im_get_conversation(const PurpleConvIm *im);

void purple_conv_im_set_icon(PurpleConvIm *im, PurpleBuddyIcon *icon);

PurpleBuddyIcon *purple_conv_im_get_icon(const PurpleConvIm *im);

void purple_conv_im_set_typing_state(PurpleConvIm *im, PurpleTypingState state);

PurpleTypingState purple_conv_im_get_typing_state(const PurpleConvIm *im);

void purple_conv_im_start_typing_timeout(PurpleConvIm *im, int timeout);

void purple_conv_im_stop_typing_timeout(PurpleConvIm *im);

guint purple_conv_im_get_typing_timeout(const PurpleConvIm *im);

void purple_conv_im_set_type_again(PurpleConvIm *im, unsigned int val);

time_t purple_conv_im_get_type_again(const PurpleConvIm *im);

void purple_conv_im_start_send_typed_timeout(PurpleConvIm *im);

void purple_conv_im_stop_send_typed_timeout(PurpleConvIm *im);

guint purple_conv_im_get_send_typed_timeout(const PurpleConvIm *im);

void purple_conv_im_update_typing(PurpleConvIm *im);

void purple_conv_im_write(PurpleConvIm *im, const char *who,
                        const char *message, PurpleMessageFlags flags,
                        time_t mtime);

gboolean purple_conv_present_error(const char *who, PurpleAccount *account, const char *what);

void purple_conv_im_send(PurpleConvIm *im, const char *message);

void purple_conv_send_confirm(PurpleConversation *conv, const char *message);

void purple_conv_im_send_with_flags(PurpleConvIm *im, const char *message, PurpleMessageFlags flags);

gboolean purple_conv_custom_smiley_add(PurpleConversation *conv, const char *smile,
                                      const char *cksum_type, const char *chksum,
                                      gboolean remote);


void purple_conv_custom_smiley_write(PurpleConversation *conv,
                                   const char *smile,
                                   const guchar *data,
                                   gsize size);

void purple_conv_custom_smiley_close(PurpleConversation *conv, const char *smile);

/**************************************************************************/
/**************************************************************************/
PurpleConversation *purple_conv_chat_get_conversation(const PurpleConvChat *chat);

GList *purple_conv_chat_set_users(PurpleConvChat *chat, GList *users);

GList *purple_conv_chat_get_users(const PurpleConvChat *chat);

void purple_conv_chat_ignore(PurpleConvChat *chat, const char *name);

void purple_conv_chat_unignore(PurpleConvChat *chat, const char *name);

GList *purple_conv_chat_set_ignored(PurpleConvChat *chat, GList *ignored);

GList *purple_conv_chat_get_ignored(const PurpleConvChat *chat);

const char *purple_conv_chat_get_ignored_user(const PurpleConvChat *chat,
                                            const char *user);

gboolean purple_conv_chat_is_user_ignored(const PurpleConvChat *chat,
                                        const char *user);

void purple_conv_chat_set_topic(PurpleConvChat *chat, const char *who,
                              const char *topic);

const char *purple_conv_chat_get_topic(const PurpleConvChat *chat);

void purple_conv_chat_set_id(PurpleConvChat *chat, int id);

int purple_conv_chat_get_id(const PurpleConvChat *chat);

void purple_conv_chat_write(PurpleConvChat *chat, const char *who,
                          const char *message, PurpleMessageFlags flags,
                          time_t mtime);

void purple_conv_chat_send(PurpleConvChat *chat, const char *message);

void purple_conv_chat_send_with_flags(PurpleConvChat *chat, const char *message, PurpleMessageFlags flags);

void purple_conv_chat_add_user(PurpleConvChat *chat, const char *user,
                             const char *extra_msg, PurpleConvChatBuddyFlags flags,
                             gboolean new_arrival);

void purple_conv_chat_add_users(PurpleConvChat *chat, GList *users, GList *extra_msgs,
                              GList *flags, gboolean new_arrivals);

void purple_conv_chat_rename_user(PurpleConvChat *chat, const char *old_user,
                                const char *new_user);

void purple_conv_chat_remove_user(PurpleConvChat *chat, const char *user,
                                const char *reason);

void purple_conv_chat_remove_users(PurpleConvChat *chat, GList *users,
                                 const char *reason);

gboolean purple_conv_chat_find_user(PurpleConvChat *chat, const char *user);

void purple_conv_chat_user_set_flags(PurpleConvChat *chat, const char *user,
                                   PurpleConvChatBuddyFlags flags);

PurpleConvChatBuddyFlags purple_conv_chat_user_get_flags(PurpleConvChat *chat,
                                                     const char *user);

void purple_conv_chat_clear_users(PurpleConvChat *chat);

void purple_conv_chat_set_nick(PurpleConvChat *chat, const char *nick);

const char *purple_conv_chat_get_nick(PurpleConvChat *chat);

PurpleConversation *purple_find_chat(const PurpleConnection *gc, int id);

void purple_conv_chat_left(PurpleConvChat *chat);

void purple_conv_chat_invite_user(PurpleConvChat *chat, const char *user,
        const char *message, gboolean confirm);

gboolean purple_conv_chat_has_left(PurpleConvChat *chat);

PurpleConvChatBuddy *purple_conv_chat_cb_new(const char *name, const char *alias,
                                        PurpleConvChatBuddyFlags flags);

PurpleConvChatBuddy *purple_conv_chat_cb_find(PurpleConvChat *chat, const char *name);

const char *purple_conv_chat_cb_get_name(PurpleConvChatBuddy *cb);

void purple_conv_chat_cb_destroy(PurpleConvChatBuddy *cb);

GList * purple_conversation_get_extended_menu(PurpleConversation *conv);

gboolean purple_conversation_do_command(PurpleConversation *conv, const gchar *cmdline, const gchar *markup, gchar **error);

/**************************************************************************/
/**************************************************************************/
void *purple_conversations_get_handle(void);

void purple_conversations_init(void);

void purple_conversations_uninit(void);

#ifdef __cplusplus
}
#endif

#endif /* _PURPLE_CONVERSATION_H_ */