Mercurial > pidgin
view src/stringref.h @ 12116:e75ef7aa913e
[gaim-migrate @ 14416]
" This patch implements a replacement for the queuing
system from 1.x. It also obsoletes a previous patch
[#1338873] I submitted to prioritize the unseen states
in gtk conversations.
The attached envelope.png is ripped from the
msgunread.png already included in gaim. It should be
dropped in the pixmaps directory (Makefile.am is
updated accordingly in this patch).
The two separate queuing preferences from 1.x, queuing
messages while away and queuing all new messages (from
docklet), are replaced with a single 3-way preference
for conversations. The new preference is "Hide new IM
conversations". This preference can be set to never,
away and always.
When a gtk conversation is created, it may be placed in
a hidden conversation window instead of being placed
normally. This decision is based upon the preference
and possibly the away state of the account the
conversation is being created for. This *will* effect
conversations the user explicitly requests to be
created, so in these cases the caller must be sure to
present the conversation to the user, using
gaim_gtkconv_present_conversation(). This is done
already in gtkdialogs.c which handles creating
conversations requested by the user from gaim proper
(menus, double-clicking on budy in blist, etc.).
The main advantage to not queuing messages is that the
conversations exist, the message is written to the
conversation (and logged if appropriate) and the unseen
state is set on the conversation. This means no
additional features are needed to track whether there
are queued messages or not, just use the unseen state
on conversations.
Since conversations may not be visible (messages
"queued"), gaim proper needs some notification that
there are messages waiting. I opted for a menutray icon
that shows up when an im conversation has an unseen
message. Clicking this icon will focus (and show if
hidden) the first conversation with an unseen message.
This is essentially the same behavior of the docklet in
cvs right now, except that the icon is only visible
when there is a conversation with an unread message.
The api that is added is flexible enough to allow
either the docklet or the new blist menutray icon to be
visible for conversations of any/all types and for
unseen messages >= any state. Currently they are set to
only IM conversations and only unseen states >= TEXT
(system messages and no log messages will not trigger
blinking the docklet or showing the blist tray icon),
but these could be made preferences relatively easily
in the future. Other plugins could probably benefit as
well: gaim_gtk_conversations_get_first_unseen().
There is probably some limit to comment size, so I'll
stop rambling now. If anyone has more
questions/comments, catch me in #gaim, here or on
gaim-devel."
committer: Tailor Script <tailor@pidgin.im>
author | Luke Schierer <lschiere@pidgin.im> |
---|---|
date | Wed, 16 Nov 2005 18:17:01 +0000 |
parents | db62420a53a2 |
children |
line wrap: on
line source
/** * @file stringref.h Reference-counted immutable strings * @ingroup core * * gaim * * Gaim 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA * */ #ifndef _GAIM_STRINGREF_H_ #define _GAIM_STRINGREF_H_ /** * The internal representation of a stringref. * * @note For this structure to be useful, the string contained within * it must be immutable -- for this reason, do _not_ access it * directly! */ typedef struct _GaimStringref { guint32 ref; /**< The reference count of this string. * Note that reference counts are only * 31 bits, and the high-order bit * indicates whether this string is up * for GC at the next idle handler... * But you aren't going to touch this * anyway, right? */ char value[1]; /**< The string contained in this ref. * Notice that it is simply "hanging * off the end" of the ref ... this * is to save an allocation. */ } GaimStringref; /** * Creates an immutable reference-counted string object. The newly * created object will have a reference count of 1. * * @param value This will be the value of the string; it will be * duplicated. * * @return A newly allocated string reference object with a refcount * of 1. */ GaimStringref *gaim_stringref_new(const char *value); /** * Creates an immutable reference-counted string object. The newly * created object will have a reference count of zero, and if it is * not referenced before the next iteration of the mainloop it will * be freed at that time. * * @param value This will be the value of the string; it will be * duplicated. * * @return A newly allocated string reference object with a refcount * of zero. */ GaimStringref *gaim_stringref_new_noref(const char *value); /** * Creates an immutable reference-counted string object from a printf * format specification and arguments. The created object will have a * reference count of 1. * * @param format A printf-style format specification. * * @return A newly allocated string reference object with a refcount * of 1. */ GaimStringref *gaim_stringref_printf(const char *format, ...); /** * Increase the reference count of the given stringref. * * @param stringref String to be referenced. * * @return A pointer to the referenced string. */ GaimStringref *gaim_stringref_ref(GaimStringref *stringref); /** * Decrease the reference count of the given stringref. If this * reference count reaches zero, the stringref will be freed; thus * you MUST NOT use this string after dereferencing it. * * @param stringref String to be dereferenced. */ void gaim_stringref_unref(GaimStringref *stringref); /** * Retrieve the value of a stringref. * * @note This value should not be cached or stored in a local variable. * While there is nothing inherently incorrect about doing so, it * is easy to forget that the cached value is in fact a * reference-counted object and accidentally use it after * dereferencing. This is more problematic for a reference- * counted object than a heap-allocated object, as it may seem to * be valid or invalid nondeterministically based on how many * other references to it exist. * * @param stringref String reference from which to retrieve the value. * * @return The contents of the string reference. */ const char *gaim_stringref_value(const GaimStringref *stringref); /** * Compare two stringrefs for string equality. This returns the same * value as strcmp would, where <0 indicates that s1 is "less than" s2 * in the ASCII lexicography, 0 indicates equality, etc. * * @param s1 The reference string. * * @param s2 The string to compare against the reference. * * @return An ordering indication on s1 and s2. */ int gaim_stringref_cmp(const GaimStringref *s1, const GaimStringref *s2); /** * Find the length of the string inside a stringref. * * @param stringref The string in whose length we are interested. * * @return The length of the string in stringref */ size_t gaim_stringref_len(const GaimStringref *stringref); #endif /* _GAIM_STRINGREF_H_ */