Changeset d5ccd83

Timestamp:

2006-08-13T19:15:23Z (18 years ago)

Author:

Wilmer van der Gaast <wilmer@…>

Branches:

master

Children:

08cdb93

Parents:

846cec61

Message:

Extra comments in set.h and now properly using set_getbool() instead of
set_getint().

Files:

• irc.c (modified) (2 diffs)
• protocols/nogaim.c (modified) (16 diffs)
• protocols/oscar/oscar.c (modified) (1 diff)
• protocols/oscar/rxhandlers.c (modified) (1 diff)
• root_commands.c (modified) (1 diff)
• set.h (modified) (2 diffs)
• user.c (modified) (1 diff)

irc.c

@@ -213 +213 @@
         log_message( LOGLVL_INFO, "Destroying connection with fd %d", irc->fd );
         
-        if( irc->status & USTATUS_IDENTIFIED && set_getint( &irc->set, "save_on_quit" ) ) 
+        if( irc->status & USTATUS_IDENTIFIED && set_getbool( &irc->set, "save_on_quit" ) ) 
                 if( storage_save( irc, TRUE ) != STORAGE_OK )
                         irc_usermsg( irc, "Error while saving settings!" );
@@ -1058 +1058 @@
         if( !u || !u->gc ) return;
         
-        if( set_getint( &irc->set, "buddy_sendbuffer" ) && set_getint( &irc->set, "buddy_sendbuffer_delay" ) > 0 )
+        if( set_getbool( &irc->set, "buddy_sendbuffer" ) && set_getint( &irc->set, "buddy_sendbuffer_delay" ) > 0 )
         {
                 int delay;

protocols/nogaim.c

@@ -208 +208 @@
 
         if( ( g_strcasecmp( set_getstr( &gc->irc->set, "strip_html" ), "always" ) == 0 ) ||
-            ( ( gc->flags & OPT_CONN_HTML ) && set_getint( &gc->irc->set, "strip_html" ) ) )
+            ( ( gc->flags & OPT_CONN_HTML ) && set_getbool( &gc->irc->set, "strip_html" ) ) )
                 strip_html( text );
         
@@ -353 +353 @@
         irc_t *irc = gc->irc;
         
-        if( set_getint( &irc->set, "debug" ) && 0 ) /* This message is too useless */
+        if( set_getbool( &irc->set, "debug" ) && 0 ) /* This message is too useless */
                 serv_got_crap( gc, "Receiving user add from handle: %s", handle );
         
         if( user_findhandle( gc, handle ) )
         {
-                if( set_getint( &irc->set, "debug" ) )
+                if( set_getbool( &irc->set, "debug" ) )
                         serv_got_crap( gc, "User already exists, ignoring add request: %s", handle );
                 
@@ -446 +446 @@
                 u->realname = g_strdup( realname );
                 
-                if( ( gc->flags & OPT_LOGGED_IN ) && set_getint( &gc->irc->set, "display_namechanges" ) )
+                if( ( gc->flags & OPT_LOGGED_IN ) && set_getbool( &gc->irc->set, "display_namechanges" ) )
                         serv_got_crap( gc, "User `%s' changed name to `%s'", u->nick, u->realname );
         }
@@ -509 +509 @@
                 else
                 {
-                        if( set_getint( &gc->irc->set, "debug" ) || g_strcasecmp( set_getstr( &gc->irc->set, "handle_unknown" ), "ignore" ) != 0 )
+                        if( set_getbool( &gc->irc->set, "debug" ) || g_strcasecmp( set_getstr( &gc->irc->set, "handle_unknown" ), "ignore" ) != 0 )
                         {
                                 serv_got_crap( gc, "serv_got_update() for handle %s:", handle );
@@ -568 +568 @@
         
         /* LISPy... */
-        if( ( set_getint( &gc->irc->set, "away_devoice" ) ) &&          /* Don't do a thing when user doesn't want it */
+        if( ( set_getbool( &gc->irc->set, "away_devoice" ) ) &&         /* Don't do a thing when user doesn't want it */
             ( u->online ) &&                                            /* Don't touch offline people */
             ( ( ( u->online != oo ) && !u->away ) ||                    /* Voice joining people */
@@ -591 +591 @@
                 if( g_strcasecmp( h, "ignore" ) == 0 )
                 {
-                        if( set_getint( &irc->set, "debug" ) )
+                        if( set_getbool( &irc->set, "debug" ) )
                                 serv_got_crap( gc, "Ignoring message from unknown handle %s", handle );
                         
@@ -598 +598 @@
                 else if( g_strncasecmp( h, "add", 3 ) == 0 )
                 {
-                        int private = set_getint( &irc->set, "private" );
+                        int private = set_getbool( &irc->set, "private" );
                         
                         if( h[3] )
@@ -620 +620 @@
         
         if( ( g_strcasecmp( set_getstr( &gc->irc->set, "strip_html" ), "always" ) == 0 ) ||
-            ( ( gc->flags & OPT_CONN_HTML ) && set_getint( &gc->irc->set, "strip_html" ) ) )
+            ( ( gc->flags & OPT_CONN_HTML ) && set_getbool( &gc->irc->set, "strip_html" ) ) )
                 strip_html( msg );
 
@@ -660 +660 @@
         user_t *u;
         
-        if( !set_getint( &gc->irc->set, "typing_notice" ) )
+        if( !set_getbool( &gc->irc->set, "typing_notice" ) )
                 return;
         
@@ -682 +682 @@
         GList *ir;
         
-        if( set_getint( &gc->irc->set, "debug" ) )
+        if( set_getbool( &gc->irc->set, "debug" ) )
                 serv_got_crap( gc, "You were removed from conversation %d", (int) id );
         
@@ -728 +728 @@
         
         if( ( g_strcasecmp( set_getstr( &gc->irc->set, "strip_html" ), "always" ) == 0 ) ||
-            ( ( gc->flags & OPT_CONN_HTML ) && set_getint( &gc->irc->set, "strip_html" ) ) )
+            ( ( gc->flags & OPT_CONN_HTML ) && set_getbool( &gc->irc->set, "strip_html" ) ) )
                 strip_html( msg );
         
@@ -761 +761 @@
         g_free( s );
         
-        if( set_getint( &gc->irc->set, "debug" ) )
+        if( set_getbool( &gc->irc->set, "debug" ) )
                 serv_got_crap( gc, "Creating new conversation: (id=%d,handle=%s)", id, handle );
         
@@ -775 +775 @@
         int me = 0;
         
-        if( set_getint( &b->gc->irc->set, "debug" ) )
+        if( set_getbool( &b->gc->irc->set, "debug" ) )
                 serv_got_crap( b->gc, "User %s added to conversation %d", handle, b->id );
         
@@ -809 +809 @@
         int me = 0;
         
-        if( set_getint( &b->gc->irc->set, "debug" ) )
+        if( set_getbool( &b->gc->irc->set, "debug" ) )
                 serv_got_crap( b->gc, "User %s removed from conversation %d (%s)", handle, b->id, reason ? reason : "" );
         
@@ -887 +887 @@
         /* Horror.... */
         
-        if( st != set_getint( &irc->set, "away_devoice" ) )
+        if( st != set_getbool( &irc->set, "away_devoice" ) )
         {
                 char list[80] = "";
@@ -1007 +1007 @@
                 {
                         gc->acc->prpl->set_away( gc, s, away );
-                        if( set_getint( &gc->irc->set, "debug" ) )
+                        if( set_getbool( &gc->irc->set, "debug" ) )
                                 serv_got_crap( gc, "Setting away state to %s", s );
                 }

protocols/oscar/oscar.c

@@ -1251 +1251 @@
         channel = va_arg(ap, int);
         userinfo = va_arg(ap, aim_userinfo_t *);
-
-    if (set_getint(sess->aux_data, "debug")) {
-        serv_got_crap(sess->aux_data, "channel %i called", channel);
-    }
 
         switch (channel) {

protocols/oscar/rxhandlers.c

@@ -112 +112 @@
                 /* Following SNAC will be related */
         }
-
-    if (set_getint(sess->aux_data, "debug")) {
-        serv_got_crap(sess->aux_data, "snac %x/%x received", snac.family, snac.subtype);
-    }
 
         for (cur = (aim_module_t *)sess->modlistv; cur; cur = cur->next) {

root_commands.c

@@ -144 +144 @@
                 irc_usermsg( irc, "Password accepted, settings and accounts loaded" );
                 irc_umode_set( irc, "+R", 1 );
-                if( set_getint( &irc->set, "auto_connect" ) )
+                if( set_getbool( &irc->set, "auto_connect" ) )
                         cmd_account( irc, account_on );
                 break;

set.h

@@ -24 +24 @@
 */
 
+/* This used to be specific to irc_t structures, but it's more generic now
+   (so it can also be used for account_t structs). It's pretty simple, but
+   so far pretty useful.
+   
+   In short, it just keeps a linked list of settings/variables and it also
+   remembers a default value for every setting. And to prevent the user
+   from setting invalid values, you can write an evaluator function for
+   every setting, which can check a new value and block it by returning
+   NULL, or replace it by returning a new value. See struct set.eval. */
+
 typedef struct set
 {
-        void *data;
+        void *data;     /* Here you can save a pointer to the
+                           object this settings belongs to. */
         
         char *key;
         char *value;
-        char *def;      /* Default */
+        char *def;      /* Default value. If the set_setstr() function
+                           notices a new value is exactly the same as
+                           the default, value gets set to NULL. So when
+                           you read a setting, don't forget about this! */
         
-        int flags;
+        int flags;      /* See account.h, for example. set.c doesn't use
+                           this (yet?). */
         
         /* Eval: Returns NULL if the value is incorrect or exactly the
@@ -41 +56 @@
 } set_t;
 
+/* Should be pretty clear. */
 set_t *set_add( set_t **head, char *key, char *def, void *eval, void *data );
+
+/* Returns the raw set_t. Might be useful sometimes. */
 set_t *set_find( set_t **head, char *key );
+
+/* Returns a pointer to the string value of this setting. Don't modify the
+   returned string, and don't free() it! */
 G_MODULE_EXPORT char *set_getstr( set_t **head, char *key );
+
+/* Get an integer. Right now this also converts true/false/on/off/etc to
+   numbers, but this is for historical reasons, please use set_getbool()
+   for booleans instead. */
 G_MODULE_EXPORT int set_getint( set_t **head, char *key );
 G_MODULE_EXPORT int set_getbool( set_t **head, char *key );
+
+/* set_setstr() strdup()s the given value, so after using this function
+   you can free() it, if you want. */
 int set_setstr( set_t **head, char *key, char *value );
 int set_setint( set_t **head, char *key, int value );
 void set_del( set_t **head, char *key );
 
+/* Two very useful generic evaluators. */
 char *set_eval_int( set_t *set, char *value );
 char *set_eval_bool( set_t *set, char *value );
 
+/* Some not very generic evaluators that really shouldn't be here... */
 char *set_eval_to_char( set_t *set, char *value );
 char *set_eval_ops( set_t *set, char *value );

user.c

@@ -67 +67 @@
         
         u->user = u->realname = u->host = u->nick = g_strdup( nick );
-        u->is_private = set_getint( &irc->set, "private" );
+        u->is_private = set_getbool( &irc->set, "private" );
         
         key = g_strdup( nick );