comparison src/log.h @ 11177:3924db2b1ca8

[gaim-migrate @ 13285] Performance optimizing the log set and screenname autocompletion code. committer: Tailor Script <[e-mail]>

11176:6932df31225f

	GAIM_LOG_READ_NO_NEWLINE = 1
} GaimLogReadFlags;

#include "account.h"
#include "conversation.h"

/**
 * A log logger.
 *
 * This struct gets filled out and is included in the GaimLog.  It contains everything

	int (*total_size)(GaimLogType type, const char *name, GaimAccount *account);

	/** This function returns a sorted GList of available system GaimLogs */
	GList *(*list_syslog)(GaimAccount *account);

	/** Returns a list of GaimLogSets. By passing the data in the GaimLogSets
	 *  to list, the caller can get every available GaimLog from the logger.
	 *  Loggers using gaim_log_common_writer() (or otherwise storing their
	 *  logs in the same directory structure as the stock loggers) do not
	 *  need to implement this function. */
	GList *(*get_log_sets)(void);
};

/**
 * A log.  Not the wooden type.
 */

	                                           logger's implementation of
	                                           list, it may not be possible
	                                           to load such logs.) */
	gboolean buddy;                       /**< Is this (account, name) a buddy
	                                           on the buddy list? */
};

#ifdef __cplusplus
extern "C" {
#endif

 * @return                    A sorted list of GaimLogs
 */
GList *gaim_log_get_logs(GaimLogType type, const char *name, GaimAccount *account);

/**
 * Returns a list of GaimLogSets.
 *
 * A "log set" here means the information necessary to gather the
 * GaimLogs for a given buddy/chat. This information would be passed
 * to gaim_log_list to get a list of GaimLogs.
 *
 * The primary use of this function is to get a list of everyone the
 * user has ever talked to (assuming he or she uses logging).
 *
 * @return A sorted list of all available unique GaimLogSets
 */
GList *gaim_log_get_log_sets(void);

/**
 * Returns a list of all available system logs
 *
 * @param account The account
 * @return		A sorted list of GaimLogs
 */
GList *gaim_log_get_system_logs(GaimAccount *account);

/**
 * Returns the size of a log

char *gaim_log_get_log_dir(GaimLogType type, const char *name, GaimAccount *account);

/**
 * Implements GCompareFunc for GaimLogs
 *
 * @param y				   A GaimLog
 * @param z				   Another GaimLog
 * @return					A value as specified by GCompareFunc
 */
gint gaim_log_compare(gconstpointer y, gconstpointer z);

/**
 * Implements GCompareFunc for GaimLogSets

 * @param y                   A GaimLogSet
 * @param z                   Another GaimLogSet
 * @return                    A value as specified by GCompareFunc
 */
gint gaim_log_set_compare(gconstpointer y, gconstpointer z);

/*@}*/

/******************************************/
/** @name Common Logger Functions         */

				GList*(*list)(GaimLogType type, const char*, GaimAccount*),
				char*(*read)(GaimLog*, GaimLogReadFlags*),
				int(*size)(GaimLog*),
				int(*total_size)(GaimLogType type, const char *name, GaimAccount *account),
				GList*(*list_syslog)(GaimAccount *account),
				GList*(*get_log_sets)(void));

/**
 * Frees a logger
 *
 * @param logger       The logger to free

11177:3924db2b1ca8

	GAIM_LOG_READ_NO_NEWLINE = 1
} GaimLogReadFlags;

#include "account.h"
#include "conversation.h"

typedef void (*GaimLogSetCallback) (GHashTable *sets, GaimLogSet *set);

/**
 * A log logger.
 *
 * This struct gets filled out and is included in the GaimLog.  It contains everything

	int (*total_size)(GaimLogType type, const char *name, GaimAccount *account);

	/** This function returns a sorted GList of available system GaimLogs */
	GList *(*list_syslog)(GaimAccount *account);

	/** Adds GaimLogSets to a GHashTable. By passing the data in the GaimLogSets
	 *  to list, the caller can get every available GaimLog from the logger.
	 *  Loggers using gaim_log_common_writer() (or otherwise storing their
	 *  logs in the same directory structure as the stock loggers) do not
	 *  need to implement this function.
	 *
	 *  Loggers which implement this function must create a GaimLogSet,
	 *  then call @a cb with @a sets and the newly created GaimLogSet. */
	void (*get_log_sets)(GaimLogSetCallback cb, GHashTable *sets);
};

/**
 * A log.  Not the wooden type.
 */

	                                           logger's implementation of
	                                           list, it may not be possible
	                                           to load such logs.) */
	gboolean buddy;                       /**< Is this (account, name) a buddy
	                                           on the buddy list? */
	char *normalized_name;                /**< The normalized version of
	                                           @a name. It must be set, and
	                                           may be set to the same pointer
	                                           value as @a name. */
};

#ifdef __cplusplus
extern "C" {
#endif

 * @return                    A sorted list of GaimLogs
 */
GList *gaim_log_get_logs(GaimLogType type, const char *name, GaimAccount *account);

/**
 * Returns a GHashTable of GaimLogSets.
 *
 * A "log set" here means the information necessary to gather the
 * GaimLogs for a given buddy/chat. This information would be passed
 * to gaim_log_list to get a list of GaimLogs.
 *
 * The primary use of this function is to get a list of everyone the
 * user has ever talked to (assuming he or she uses logging).
 *
 * The GHashTable that's returned will free all log sets in it when
 * destroyed. If a GaimLogSet is removed from the GHashTable, it
 * must be freed with gaim_log_set_free().
 *
 * @return A GHashTable of all available unique GaimLogSets
 */
GHashTable *gaim_log_get_log_sets(void);

/**
 * Returns a list of all available system logs
 *
 * @param account The account
 * @return        A sorted list of GaimLogs
 */
GList *gaim_log_get_system_logs(GaimAccount *account);

/**
 * Returns the size of a log

char *gaim_log_get_log_dir(GaimLogType type, const char *name, GaimAccount *account);

/**
 * Implements GCompareFunc for GaimLogs
 *
 * @param y                   A GaimLog
 * @param z                   Another GaimLog
 * @return                    A value as specified by GCompareFunc
 */
gint gaim_log_compare(gconstpointer y, gconstpointer z);

/**
 * Implements GCompareFunc for GaimLogSets

 * @param y                   A GaimLogSet
 * @param z                   Another GaimLogSet
 * @return                    A value as specified by GCompareFunc
 */
gint gaim_log_set_compare(gconstpointer y, gconstpointer z);

/**
 * Frees a log set
 *
 * @param set         The log set to destroy
 */
void gaim_log_set_free(GaimLogSet *set);

/*@}*/

/******************************************/
/** @name Common Logger Functions         */

				GList*(*list)(GaimLogType type, const char*, GaimAccount*),
				char*(*read)(GaimLog*, GaimLogReadFlags*),
				int(*size)(GaimLog*),
				int(*total_size)(GaimLogType type, const char *name, GaimAccount *account),
				GList*(*list_syslog)(GaimAccount *account),
				void(*get_log_sets)(GaimLogSetCallback cb, GHashTable *sets));

/**
 * Frees a logger
 *
 * @param logger       The logger to free