annotate plugins/crazychat/crazychat.h @ 13545:cfc2f7fcb3dd

[gaim-migrate @ 15922] Way more changes that I initially thought I was going to make. I apologize for the commit message spam. These changes bring a lot of consistency to our capitalization and punctuation, especially of words like "e-mail". For reference, I've used these rules (after discussing in #gaim): e-mail, a case of two words joined: "e-mail" - in the middle of a sentence caps context "E-mail" - start of text in a sentence caps context "E-Mail" - in a header (title) caps context re-enable, a single word, would be: "re-enable", "Re-enable", and "Re-enable" (respectively) The reason this changeset exploded is that, as I went through and verified these changes, I realized we were using improper capitalization (e.g. header instead of sentence) in a number of dialogs. I fixed a number of these cases before, and this corrects another pile. This looks like I've made a LOT of work for the translators, but the impact is significantly mitigated by three factors: 1) Many of these changes use strings that already exist, or change one string in many places. 2) I've used sed to correct the .po files where possible. 3) The actual changes are extremely trivial. committer: Tailor Script <[e-mail]>

#ifndef __CRAZYCHAT_H__
#define __CRAZYCHAT_H__

#include <glib.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <gtk/gtk.h>
#include "filter.h"
#include "gaim.h"

#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

struct crazychat;

/* --- type definitions --- */

typedef enum { INVITE = 0, ACCEPT, ACCEPTED, CONNECTED } CC_STATE;

/**
 * Finds the CrazyChat session with the handle.
 * @param cc		global crazychat data structure
 * @param handle	the peer name
 * @return		the cc_session if found, or NULL
 */
struct cc_session *cc_find_session(struct crazychat *cc, char *handle);

/**
 * Adds a new session with a peer, unless a peer session already exists.
 * Makes a deep copy of the handle.
 * @param cc		global crazychat data structure
 * @param handle	the peer name
 * @return		the new/old cc_session
 */
struct cc_session *cc_add_session(struct crazychat *cc, char *handle);

/**
 * Removes a crazychat session with a peer.
 * @param cc		global crazychat data structure
 * @param session	the cc_session to remove
 */
void cc_remove_session(struct crazychat *cc, struct cc_session *session);

#endif				/* __CRAZYCHAT_H__ */