modules/FvwmWinList/List.c

   1 /* -*-c-*- */
   2 /* FvwmWinList Module for Fvwm.
   3  *
   4  *  Copyright 1994,  Mike Finger (mfinger@mermaid.micro.umn.edu or
   5  *                               Mike_Finger@atk.com)
   6  *
   7  * The functions in this source file are the original work of Mike Finger.
   8  *
   9  * No guarantees or warantees or anything are provided or implied in any way
  10  * whatsoever. Use this program at your own risk. Permission to use this
  11  * program for any purpose is given, as long as the copyright is kept intact.
  12  *
  13  *  Things to do:  Convert to C++  (In Progress)
  14  */
  15
  16 /* This program is free software; you can redistribute it and/or modify
  17  * it under the terms of the GNU General Public License as published by
  18  * the Free Software Foundation; either version 2 of the License, or
  19  * (at your option) any later version.
  20  *
  21  * This program is distributed in the hope that it will be useful,
  22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24  * GNU General Public License for more details.
  25  *
  26  * You should have received a copy of the GNU General Public License
  27  * along with this program; if not, write to the Free Software
  28  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  29  */
  30
  31 #include "config.h"
  32 #include <stdio.h>
  33
  34 #include "FvwmWinList.h"
  35 #include "List.h"
  36 #include "Mallocs.h"
  37 #include "libs/Module.h"
  38 #include "fvwm/fvwm.h"
  39
  40 extern long CurrentDesk;
  41 extern int ShowCurrentDesk;
  42 extern int UseSkipList;
  43
  44 /*
  45   InitList - Initialize the list
  46 */
  47 void InitList(List *list)
  48 {
  49   list->head=list->tail=NULL;
  50   list->count=0;
  51 }
  52
  53 /*
  54   AddItem - Allocates spaces for and appends an item to the list
  55 */
  56 /*void AddItem(List *list, long id,long flags, long desk)*/
  57 void AddItem(List *list, ConfigWinPacket *cfgpacket)
  58 {
  59 Item *new;
  60   new=(Item *)safemalloc(sizeof(Item));
  61   new->id=cfgpacket->w;
  62   new->name=NULL;
  63   new->flags=cfgpacket->flags;
  64   new->desk=cfgpacket->desk;
  65   new->next=NULL;
  66
  67   if (list->tail==NULL) list->head=list->tail=new;
  68   else {
  69    list->tail->next=new;
  70    list->tail=new;
  71   }
  72   list->count++;
  73 }
  74
  75 /*
  76   ReorderList - Make the list order matcht the internal fvwm winlist
  77   FlipFocus is False when the Focus command has been used, True for all other
  78   cases of Focus change.
  79   If true the item is plucked from the list and placed at the start
  80   If false the list is closed into a loop, rotated around to bring id to
  81   the top and then opened up into a terminated line again.
  82 */
  83 void ReorderList(List *list, long id, long FlipFocus)
  84 {
  85   Item *temp = list->head, *prev = NULL;
  86   int i = 0;
  87
  88   if (!id) return; /* this is a NOP if id == 0 */
  89
  90   /* find the item */
  91   while (temp && i != id) {
  92     prev = temp;
  93     temp = temp->next;
  94     i++;
  95   }
  96
  97   if (!temp) return; /* we fell off the list */
  98
  99   /* prev is guaranteed to be !NULL */
 100   if (FlipFocus) {
 101     /* take care of the tail of the list */
 102     if (list->tail == temp) list->tail = prev;
 103     /* pluck it */
 104     prev->next = temp->next;
 105     /* shove it */
 106     temp->next = list->head;
 107     list->head = temp;
 108   } else {
 109     /* close the end */
 110     list->tail->next = list->head;
 111     /* rotate around by changing the list pointers */
 112     list->head = temp;
 113     list->tail = prev;
 114     /* unclose the end */
 115     prev->next = NULL;
 116   }
 117 }
 118
 119 /*
 120   FindItem - Find the item in the list matching the id
 121 */
 122 int FindItem(List *list, long id)
 123 {
 124   Item *temp;
 125   int i;
 126
 127   for(i=0,temp=list->head;temp!=NULL && temp->id!=id;i++,temp=temp->next);
 128   if (temp==NULL) return -1;
 129   return i;
 130 }
 131
 132 /*
 133   FindItemVisible - Find the item which should be in winlist in the list
 134   matching the id
 135 */
 136 int FindItemVisible(List *list, long id)
 137 {
 138   Item *temp;
 139   int i=0;
 140
 141   for(temp=list->head;temp!=NULL && temp->id!=id;temp=temp->next)
 142   {
 143     if (IsItemVisible(temp)) i++;
 144   }
 145   if (temp==NULL) return -1;
 146   return i;
 147 }
 148
 149
 150 /*
 151   UpdateItem - Update the item in the list, setting name & flags as necessary.
 152 */
 153 int UpdateItemName(List *list, long id, char *string)
 154 {
 155   Item *temp;
 156   int i;
 157
 158   for(i=0,temp=list->head;temp!=NULL && id!=temp->id;i++,temp=temp->next);
 159   if (temp==NULL) return -1;
 160   UpdateString(&temp->name, string);
 161   return i;
 162 }
 163
 164 /*
 165   UpdateItemDesk - Update the item in the list, setting desk as necessary.
 166   returns 1 if desk was updated,
 167   returns 0, if not changed
 168   returns -1 if not found
 169 */
 170 int UpdateItemDesk(List *list, ConfigWinPacket *cfgpacket)
 171 {
 172   Item *temp;
 173
 174   for(temp=list->head;temp != NULL && cfgpacket->w!=temp->id;temp=temp->next);
 175   if (temp ==NULL ) return -1;
 176   if(temp->desk != cfgpacket->desk)
 177   {
 178     temp->desk = cfgpacket->desk;
 179     return 1;
 180   }
 181
 182   return 0;
 183 }
 184
 185 /*
 186   UpdateItemGSFRFlags - Update the GSFR flags
 187   returns -1 if not found
 188 */
 189 int UpdateItemGSFRFlags(List *list, ConfigWinPacket *cfgpacket)
 190 {
 191   Item *temp;
 192   for(temp=list->head;temp!=NULL && cfgpacket->w!=temp->id;temp=temp->next);
 193   if (temp==NULL) return -1;
 194   temp->flags = cfgpacket->flags;
 195   return 0;
 196 }
 197
 198 /*
 199   FreeItem - Frees allocated space for an Item
 200 */
 201 void FreeItem(Item *ptr)
 202 {
 203   if (ptr != NULL) {
 204     if (ptr->name!=NULL) free(ptr->name);
 205     free(ptr);
 206   }
 207 }
 208
 209 /*
 210   DeleteItem - Deletes an item from the list
 211 */
 212 int DeleteItem(List *list,long id)
 213 {
 214   Item *temp,*temp2;
 215   int i;
 216
 217   if (list->head==NULL) return -1;
 218   if (list->head->id==id)
 219   {
 220     temp2=list->head;
 221     temp=list->head=list->head->next;
 222     i=-1;
 223   }
 224   else
 225   {
 226     for(i=0,temp=list->head;temp->next!=NULL && temp->next->id!=id;
 227       i++,temp=temp->next);
 228     if (temp->next==NULL) return -1;
 229     temp2=temp->next;
 230     temp->next=temp2->next;
 231   }
 232
 233   if (temp2==list->tail) list->tail=temp;
 234
 235   FreeItem(temp2);
 236   list->count--;
 237   return i+1;
 238 }
 239
 240 /*
 241   FreeList - Free the entire list of Items
 242 */
 243 void FreeList(List *list)
 244 {
 245   Item *temp,*temp2;
 246
 247   for(temp=list->head;temp!=NULL;)
 248   {
 249     temp2=temp;
 250     temp=temp->next;
 251     FreeItem(temp2);
 252   }
 253   list->count=0;
 254 }
 255
 256 /*
 257   PrintList - Print the list of item on the console. (Debugging)
 258 */
 259 void PrintList(List *list)
 260 {
 261     Item *temp;
 262     ConsoleMessage("List of Items:\n");
 263     ConsoleMessage("   %10s %-15s %-15s %-15s %-15s Flgs\n",
 264                    "ID","Name","I-Name", "R-Name","R-Class");
 265     ConsoleMessage("   ---------- --------------- --------------- --------------- --------------- ----\n");
 266     for(temp=list->head;temp!=NULL;temp=temp->next) {
 267         int i;
 268         unsigned char* p = (unsigned char*)&temp->flags;
 269         ConsoleMessage("   %10ld %-15.15s ",
 270                        temp->id,
 271                        (temp->name==NULL) ? "<null>" : temp->name);
 272         for( i = 0; i < sizeof(temp->flags); ++i ) {
 273             ConsoleMessage( "%x2", *p++ );
 274         }
 275         ConsoleMessage( "\n" );
 276     }
 277 }
 278
 279 /*
 280   ItemName - Return the name of an Item
 281 */
 282 char *ItemName(List *list, int n)
 283 {
 284   Item *temp;
 285   int i;
 286
 287   for(i=0,temp=list->head;temp!=NULL && i<n;i++,temp=temp->next);
 288   if (temp==NULL) return NULL;
 289   return temp->name;
 290 }
 291
 292 /*
 293   ItemFlags - Return the flags for an item
 294   RBW - this is no longer appropriate since the Great Style Flag Rewrite, so
 295   this function will just return the Item pointer. The GSFR macros know how
 296   deal with that.
 297   Function returns NULL if the item is not found.
 298 */
 299 Item *ItemFlags(List *list, long id)
 300 {
 301   Item *temp;
 302
 303   for(temp=list->head; temp != NULL && id!=temp->id; temp=temp->next);
 304
 305   return temp;
 306 }
 307
 308
 309 /*
 310   ItemDesk - Return the desk for an item
 311 */
 312 long ItemDesk(List *list, long id)
 313 {
 314   Item *temp;
 315
 316   for(temp=list->head;temp!=NULL && id!=temp->id;temp=temp->next);
 317
 318   if (temp==NULL) return -1;
 319   else return temp->desk;
 320 }
 321
 322
 323
 324 /*
 325   ItemCount - Return the number of items in the list
 326 */
 327 int ItemCount(List *list)
 328 {
 329   return list->count;
 330 }
 331
 332 /*
 333   ItemCountDesk - Return the number of items in the list which should be in
 334   in winlist
 335 */
 336
 337 int ItemCountVisible(List *list)
 338 {
 339   Item *temp;
 340   int count=0;
 341
 342   for(temp=list->head;temp != NULL;temp = temp->next)
 343   {
 344      if (IsItemVisible(temp))
 345       count++;
 346   }
 347
 348   return count;
 349 }
 350
 351 /*
 352   ItemID - Return the ID of the item in the list.
 353 */
 354 long ItemID(List *list, int n)
 355 {
 356   Item *temp;
 357   int i;
 358
 359   for(i=0,temp=list->head;temp!=NULL && i<n;i++,temp=temp->next);
 360   if (temp==NULL) return -1;
 361   return temp->id;
 362 }
 363
 364 /*
 365   CopyItem - Copy an item from one list to another
 366 */
 367 void CopyItem(List *dest, List *source, int n)
 368 {
 369   Item *temp;
 370   int i;
 371   ConfigWinPacket cfgpkt;
 372
 373   for(i=0,temp=source->head;temp!=NULL && i<n;i++,temp=temp->next);
 374   if (temp==NULL) return;
 375   memset(&cfgpkt, '\0', sizeof(cfgpkt));
 376   AddItem(dest, &cfgpkt);
 377   UpdateItemName(dest,temp->id,temp->name);
 378   DeleteItem(source,temp->id);
 379 }
 380
 381 /*
 382   IsItemVisible - Says if the item should be in winlist
 383 */
 384 int IsItemVisible(Item *temp)
 385 {
 386   if ((!ShowCurrentDesk || temp->desk == CurrentDesk ||
 387        IS_STICKY_ACROSS_DESKS(temp)) &&
 388       (!DO_SKIP_WINDOW_LIST(temp) || !UseSkipList))
 389     return 1;
 390   else
 391     return 0;
 392 }
 393
 394 /*
 395   IsItemIndexVisible - Says if the item of index i in the list should be in
 396   winlist
 397 */
 398 int IsItemIndexVisible(List *list,int n)
 399 {
 400   Item *temp;
 401   int i;
 402
 403   for(i=0,temp=list->head;temp!=NULL && i<n;i++,temp=temp->next);
 404   if (temp == NULL) return 0;
 405   if (IsItemVisible(temp))
 406     return 1;
 407   else
 408     return 0;
 409 }