apps/irssi/src/fe-common/core/fe-windows.c

   1 /*
   2  windows.c : irssi
   3
   4     Copyright (C) 1999-2000 Timo Sirainen
   5
   6     This program is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     This program is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with this program; if not, write to the Free Software
  18     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19 */
  20
  21 #include "module.h"
  22 #include "module-formats.h"
  23 #include "modules.h"
  24 #include "signals.h"
  25 #include "commands.h"
  26 #include "servers.h"
  27 #include "misc.h"
  28 #include "settings.h"
  29
  30 #include "levels.h"
  31
  32 #include "printtext.h"
  33 #include "fe-windows.h"
  34 #include "window-items.h"
  35
  36 GSList *windows; /* first in the list is the active window,
  37                     next is the last active, etc. */
  38 WINDOW_REC *active_win;
  39
  40 static int daytag;
  41 static int daycheck; /* 0 = don't check, 1 = time is 00:00, check,
  42                         2 = time is 00:00, already checked */
  43
  44 static int window_get_new_refnum(void)
  45 {
  46         WINDOW_REC *win;
  47         GSList *tmp;
  48         int refnum;
  49
  50         refnum = 1;
  51         tmp = windows;
  52         while (tmp != NULL) {
  53                 win = tmp->data;
  54
  55                 if (refnum != win->refnum) {
  56                         tmp = tmp->next;
  57                         continue;
  58                 }
  59
  60                 refnum++;
  61                 tmp = windows;
  62         }
  63
  64         return refnum;
  65 }
  66
  67 WINDOW_REC *window_create(WI_ITEM_REC *item, int automatic)
  68 {
  69         WINDOW_REC *rec;
  70
  71         rec = g_new0(WINDOW_REC, 1);
  72         rec->refnum = window_get_new_refnum();
  73         rec->level = level2bits(settings_get_str("window_default_level"));
  74
  75         windows = g_slist_prepend(windows, rec);
  76         signal_emit("window created", 2, rec, GINT_TO_POINTER(automatic));
  77
  78         if (item != NULL) window_item_add(rec, item, automatic);
  79         if (windows->next == NULL || !automatic || settings_get_bool("window_auto_change")) {
  80                 if (automatic && windows->next != NULL)
  81                         signal_emit("window changed automatic", 1, rec);
  82                 window_set_active(rec);
  83         }
  84         return rec;
  85 }
  86
  87 /* removed_refnum was removed from the windows list, pack the windows so
  88    there won't be any holes. If there is any holes after removed_refnum,
  89    leave the windows behind it alone. */
  90 static void windows_pack(int removed_refnum)
  91 {
  92         WINDOW_REC *window;
  93         int refnum;
  94
  95         for (refnum = removed_refnum+1;; refnum++) {
  96                 window = window_find_refnum(refnum);
  97                 if (window == NULL || window->sticky_refnum)
  98                         break;
  99
 100                 window_set_refnum(window, refnum-1);
 101         }
 102 }
 103
 104 void window_destroy(WINDOW_REC *window)
 105 {
 106         g_return_if_fail(window != NULL);
 107
 108         if (window->destroying) return;
 109         window->destroying = TRUE;
 110         windows = g_slist_remove(windows, window);
 111
 112         if (active_win == window) {
 113                 active_win = NULL; /* it's corrupted */
 114                 if (windows != NULL)
 115                         window_set_active(windows->data);
 116         }
 117
 118         while (window->items != NULL)
 119                 window_item_destroy(window->items->data);
 120
 121         if (settings_get_bool("windows_auto_renumber"))
 122                 windows_pack(window->refnum);
 123
 124         signal_emit("window destroyed", 1, window);
 125
 126         while (window->bound_items != NULL)
 127                 window_bind_destroy(window, window->bound_items->data);
 128
 129         g_free_not_null(window->hilight_color);
 130         g_free_not_null(window->servertag);
 131         g_free_not_null(window->theme_name);
 132         g_free_not_null(window->name);
 133         g_free(window);
 134 }
 135
 136 void window_auto_destroy(WINDOW_REC *window)
 137 {
 138         if (settings_get_bool("autoclose_windows") && windows->next != NULL &&
 139             window->items == NULL && window->bound_items == NULL &&
 140             window->level == 0 && !window->immortal)
 141                 window_destroy(window);
 142 }
 143
 144 void window_set_active(WINDOW_REC *window)
 145 {
 146         WINDOW_REC *old_window;
 147
 148         if (window == active_win)
 149                 return;
 150
 151         old_window = active_win;
 152         active_win = window;
 153         if (active_win != NULL) {
 154                 windows = g_slist_remove(windows, active_win);
 155                 windows = g_slist_prepend(windows, active_win);
 156         }
 157
 158         if (active_win != NULL)
 159                 signal_emit("window changed", 2, active_win, old_window);
 160 }
 161
 162 void window_change_server(WINDOW_REC *window, void *server)
 163 {
 164         SERVER_REC *active, *connect;
 165
 166         if (server != NULL && SERVER(server)->disconnected)
 167                 return;
 168
 169         if (server == NULL) {
 170                 active = connect = NULL;
 171         } else if (g_slist_find(servers, server) != NULL) {
 172                 active = server;
 173                 connect = NULL;
 174         } else {
 175                 active = NULL;
 176                 connect = server;
 177         }
 178
 179         if (window->connect_server != connect) {
 180                 window->connect_server = connect;
 181                 signal_emit("window connect changed", 2, window, connect);
 182         }
 183
 184         if (window->active_server != active) {
 185                 window->active_server = active;
 186                 signal_emit("window server changed", 2, window, active);
 187         }
 188 }
 189
 190 void window_set_refnum(WINDOW_REC *window, int refnum)
 191 {
 192         GSList *tmp;
 193         int old_refnum;
 194
 195         g_return_if_fail(window != NULL);
 196         g_return_if_fail(refnum >= 1);
 197         if (window->refnum == refnum) return;
 198
 199         for (tmp = windows; tmp != NULL; tmp = tmp->next) {
 200                 WINDOW_REC *rec = tmp->data;
 201
 202                 if (rec->refnum == refnum) {
 203                         rec->refnum = window->refnum;
 204                         signal_emit("window refnum changed", 2, rec, GINT_TO_POINTER(refnum));
 205                         break;
 206                 }
 207         }
 208
 209         old_refnum = window->refnum;
 210         window->refnum = refnum;
 211         signal_emit("window refnum changed", 2, window, GINT_TO_POINTER(old_refnum));
 212 }
 213
 214 void window_set_name(WINDOW_REC *window, const char *name)
 215 {
 216         g_free_not_null(window->name);
 217         window->name = name == NULL || *name == '\0' ? NULL : g_strdup(name);
 218
 219         signal_emit("window name changed", 1, window);
 220 }
 221
 222 void window_set_history(WINDOW_REC *window, const char *name)
 223 {
 224         char *oldname;
 225         oldname = window->history_name;
 226
 227         if (name == NULL || *name == '\0')
 228                 window->history_name = NULL;
 229         else
 230                 window->history_name = g_strdup(name);
 231
 232         signal_emit("window history changed", 1, window, oldname);
 233
 234         g_free_not_null(oldname);
 235 }
 236
 237 void window_set_level(WINDOW_REC *window, int level)
 238 {
 239         g_return_if_fail(window != NULL);
 240
 241         window->level = level;
 242         signal_emit("window level changed", 1, window);
 243 }
 244
 245 void window_set_immortal(WINDOW_REC *window, int immortal)
 246 {
 247         g_return_if_fail(window != NULL);
 248
 249         window->immortal = immortal;
 250         signal_emit("window immortal changed", 1, window);
 251 }
 252
 253 /* return active item's name, or if none is active, window's name */
 254 const char *window_get_active_name(WINDOW_REC *window)
 255 {
 256         g_return_val_if_fail(window != NULL, NULL);
 257
 258         if (window->active != NULL)
 259                 return window->active->visible_name;
 260
 261         return window->name;
 262 }
 263
 264 #define WINDOW_LEVEL_MATCH(window, server, level) \
 265         (((window)->level & level) && \
 266          (server == NULL || (window)->active_server == server))
 267
 268 WINDOW_REC *window_find_level(void *server, int level)
 269 {
 270         GSList *tmp;
 271
 272         /* prefer active window if possible */
 273         if (active_win != NULL &&
 274             WINDOW_LEVEL_MATCH(active_win, server, level))
 275                 return active_win;
 276
 277         for (tmp = windows; tmp != NULL; tmp = tmp->next) {
 278                 WINDOW_REC *rec = tmp->data;
 279
 280                 if (WINDOW_LEVEL_MATCH(rec, server, level))
 281                         return rec;
 282         }
 283
 284         return NULL;
 285 }
 286
 287 WINDOW_REC *window_find_closest(void *server, const char *name, int level)
 288 {
 289         WINDOW_REC *window,*namewindow=NULL;
 290         WI_ITEM_REC *item;
 291
 292         /* match by name */
 293         item = name == NULL ? NULL :
 294                 window_item_find(server, name);
 295         if (item != NULL) {
 296                 namewindow = window_item_window(item);
 297                 if (namewindow != NULL && ((namewindow->level & level) != 0 ||
 298                     !settings_get_bool("window_check_level_first")))
 299                   return namewindow;
 300         }
 301
 302         /* match by level */
 303         if (level != MSGLEVEL_HILIGHT)
 304                 level &= ~(MSGLEVEL_HILIGHT | MSGLEVEL_NOHILIGHT);
 305         window = window_find_level(server, level);
 306         if (window != NULL) return window;
 307
 308         /* match by level - ignore server */
 309         window = window_find_level(NULL, level);
 310         if (window != NULL) return window;
 311
 312         /* still return item's window if we didnt find anything */
 313         if (namewindow != NULL) return namewindow;
 314
 315         /* fallback to active */
 316         return active_win;
 317 }
 318
 319 WINDOW_REC *window_find_refnum(int refnum)
 320 {
 321         GSList *tmp;
 322
 323         for (tmp = windows; tmp != NULL; tmp = tmp->next) {
 324                 WINDOW_REC *rec = tmp->data;
 325
 326                 if (rec->refnum == refnum)
 327                         return rec;
 328         }
 329
 330         return NULL;
 331 }
 332
 333 WINDOW_REC *window_find_name(const char *name)
 334 {
 335         GSList *tmp;
 336
 337         g_return_val_if_fail(name != NULL, NULL);
 338
 339         for (tmp = windows; tmp != NULL; tmp = tmp->next) {
 340                 WINDOW_REC *rec = tmp->data;
 341
 342                 if (rec->name != NULL && g_strcasecmp(rec->name, name) == 0)
 343                         return rec;
 344         }
 345
 346         return NULL;
 347 }
 348
 349 WINDOW_REC *window_find_item(SERVER_REC *server, const char *name)
 350 {
 351         WINDOW_REC *rec;
 352         WI_ITEM_REC *item;
 353
 354         g_return_val_if_fail(name != NULL, NULL);
 355
 356         rec = window_find_name(name);
 357         if (rec != NULL) return rec;
 358
 359         item = server == NULL ? NULL :
 360                 window_item_find(server, name);
 361         if (item == NULL) {
 362                 /* not found from the active server - any server? */
 363                 item = window_item_find(NULL, name);
 364         }
 365
 366         if (item == NULL)
 367                 return 0;
 368
 369         return window_item_window(item);
 370 }
 371
 372 int window_refnum_prev(int refnum, int wrap)
 373 {
 374         GSList *tmp;
 375         int prev, max;
 376
 377         max = prev = -1;
 378         for (tmp = windows; tmp != NULL; tmp = tmp->next) {
 379                 WINDOW_REC *rec = tmp->data;
 380
 381                 if (rec->refnum < refnum && (prev == -1 || rec->refnum > prev))
 382                         prev = rec->refnum;
 383                 if (wrap && (max == -1 || rec->refnum > max))
 384                         max = rec->refnum;
 385         }
 386
 387         return prev != -1 ? prev : max;
 388 }
 389
 390 int window_refnum_next(int refnum, int wrap)
 391 {
 392         GSList *tmp;
 393         int min, next;
 394
 395         min = next = -1;
 396         for (tmp = windows; tmp != NULL; tmp = tmp->next) {
 397                 WINDOW_REC *rec = tmp->data;
 398
 399                 if (rec->refnum > refnum && (next == -1 || rec->refnum < next))
 400                         next = rec->refnum;
 401                 if (wrap && (min == -1 || rec->refnum < min))
 402                         min = rec->refnum;
 403         }
 404
 405         return next != -1 ? next : min;
 406 }
 407
 408 int windows_refnum_last(void)
 409 {
 410         GSList *tmp;
 411         int max;
 412
 413         max = -1;
 414         for (tmp = windows; tmp != NULL; tmp = tmp->next) {
 415                 WINDOW_REC *rec = tmp->data;
 416
 417                 if (rec->refnum > max)
 418                         max = rec->refnum;
 419         }
 420
 421         return max;
 422 }
 423
 424 int window_refnum_cmp(WINDOW_REC *w1, WINDOW_REC *w2)
 425 {
 426         return w1->refnum < w2->refnum ? -1 : 1;
 427 }
 428
 429 GSList *windows_get_sorted(void)
 430 {
 431         GSList *tmp, *sorted;
 432
 433         sorted = NULL;
 434         for (tmp = windows; tmp != NULL; tmp = tmp->next) {
 435                 WINDOW_REC *rec = tmp->data;
 436
 437                 sorted = g_slist_insert_sorted(sorted, rec, (GCompareFunc)
 438                                                window_refnum_cmp);
 439         }
 440
 441         return sorted;
 442 }
 443
 444 /* Add a new bind to window - if duplicate is found it's returned */
 445 WINDOW_BIND_REC *window_bind_add(WINDOW_REC *window, const char *servertag,
 446                                  const char *name)
 447 {
 448         WINDOW_BIND_REC *rec;
 449
 450         g_return_val_if_fail(window != NULL, NULL);
 451         g_return_val_if_fail(servertag != NULL, NULL);
 452         g_return_val_if_fail(name != NULL, NULL);
 453
 454         rec = window_bind_find(window, servertag, name);
 455         if (rec != NULL)
 456                 return rec;
 457
 458         rec = g_new0(WINDOW_BIND_REC, 1);
 459         rec->name = g_strdup(name);
 460         rec->servertag = g_strdup(servertag);
 461
 462         window->bound_items = g_slist_append(window->bound_items, rec);
 463         return rec;
 464 }
 465
 466 void window_bind_destroy(WINDOW_REC *window, WINDOW_BIND_REC *rec)
 467 {
 468         g_return_if_fail(window != NULL);
 469         g_return_if_fail(rec != NULL);
 470
 471         window->bound_items = g_slist_remove(window->bound_items, rec);
 472
 473         g_free(rec->servertag);
 474         g_free(rec->name);
 475         g_free(rec);
 476 }
 477
 478 WINDOW_BIND_REC *window_bind_find(WINDOW_REC *window, const char *servertag,
 479                                   const char *name)
 480 {
 481         GSList *tmp;
 482
 483         g_return_val_if_fail(window != NULL, NULL);
 484         g_return_val_if_fail(servertag != NULL, NULL);
 485         g_return_val_if_fail(name != NULL, NULL);
 486
 487         for (tmp = window->bound_items; tmp != NULL; tmp = tmp->next) {
 488                 WINDOW_BIND_REC *rec = tmp->data;
 489
 490                 if (g_strcasecmp(rec->name, name) == 0 &&
 491                     g_strcasecmp(rec->servertag, servertag) == 0)
 492                         return rec;
 493         }
 494
 495         return NULL;
 496 }
 497
 498 void window_bind_remove_unsticky(WINDOW_REC *window)
 499 {
 500         GSList *tmp, *next;
 501
 502         for (tmp = window->bound_items; tmp != NULL; tmp = next) {
 503                 WINDOW_BIND_REC *rec = tmp->data;
 504
 505                 next = tmp->next;
 506                 if (!rec->sticky)
 507                         window_bind_destroy(window, rec);
 508         }
 509 }
 510
 511 static void sig_server_connected(SERVER_REC *server)
 512 {
 513         GSList *tmp;
 514
 515         g_return_if_fail(server != NULL);
 516
 517         /* Try to keep some server assigned to windows..
 518            Also change active window's server if the window is empty */
 519         for (tmp = windows; tmp != NULL; tmp = tmp->next) {
 520                 WINDOW_REC *rec = tmp->data;
 521
 522                 if ((rec->servertag == NULL ||
 523                      g_strcasecmp(rec->servertag, server->tag) == 0) &&
 524                     (rec->active_server == NULL ||
 525                      (rec == active_win && rec->items == NULL)))
 526                         window_change_server(rec, server);
 527         }
 528 }
 529
 530 static void sig_server_disconnected(SERVER_REC *server)
 531 {
 532         GSList *tmp;
 533         SERVER_REC *new_server;
 534
 535         g_return_if_fail(server != NULL);
 536
 537         new_server = servers == NULL ? NULL : servers->data;
 538         for (tmp = windows; tmp != NULL; tmp = tmp->next) {
 539                 WINDOW_REC *rec = tmp->data;
 540
 541                 if (rec->active_server == server ||
 542                     rec->connect_server == server) {
 543                         window_change_server(rec, rec->servertag != NULL ?
 544                                              NULL : new_server);
 545                 }
 546         }
 547 }
 548
 549 static void window_print_daychange(WINDOW_REC *window, struct tm *tm)
 550 {
 551         THEME_REC *theme;
 552         TEXT_DEST_REC dest;
 553         char *format, str[256];
 554
 555         theme = active_win->theme != NULL ? active_win->theme : current_theme;
 556         format_create_dest(&dest, NULL, NULL, MSGLEVEL_NEVER, window);
 557         format = format_get_text_theme(theme, MODULE_NAME, &dest,
 558                                        TXT_DAYCHANGE);
 559         if (strftime(str, sizeof(str), format, tm) <= 0)
 560                 str[0] = '\0';
 561         g_free(format);
 562
 563         printtext_string_window(window, MSGLEVEL_NEVER, str);
 564 }
 565
 566 static void sig_print_text(void)
 567 {
 568         GSList *tmp;
 569         time_t t;
 570         struct tm *tm;
 571
 572         t = time(NULL);
 573         tm = localtime(&t);
 574         if (tm->tm_hour != 0 || tm->tm_min != 0)
 575                 return;
 576
 577         daycheck = 2;
 578         signal_remove("print text", (SIGNAL_FUNC) sig_print_text);
 579
 580         /* day changed, print notice about it to every window */
 581         for (tmp = windows; tmp != NULL; tmp = tmp->next)
 582                 window_print_daychange(tmp->data, tm);
 583 }
 584
 585 static int sig_check_daychange(void)
 586 {
 587         time_t t;
 588         struct tm *tm;
 589
 590         t = time(NULL);
 591         tm = localtime(&t);
 592
 593         if (daycheck == 1 && tm->tm_hour == 0 && tm->tm_min == 0) {
 594                 sig_print_text();
 595                 return TRUE;
 596         }
 597
 598         if (tm->tm_hour != 23 || tm->tm_min != 59) {
 599                 daycheck = 0;
 600                 return TRUE;
 601         }
 602
 603         /* time is 23:59 */
 604         if (daycheck == 0) {
 605                 daycheck = 1;
 606                 signal_add("print text", (SIGNAL_FUNC) sig_print_text);
 607         }
 608         return TRUE;
 609 }
 610
 611 static void read_settings(void)
 612 {
 613         if (daytag != -1) {
 614                 g_source_remove(daytag);
 615                 daytag = -1;
 616         }
 617
 618         if (settings_get_bool("timestamps"))
 619                 daytag = g_timeout_add(30000, (GSourceFunc) sig_check_daychange, NULL);
 620 }
 621
 622 void windows_init(void)
 623 {
 624         active_win = NULL;
 625         daycheck = 0; daytag = -1;
 626         settings_add_bool("lookandfeel", "window_auto_change", FALSE);
 627         settings_add_bool("lookandfeel", "windows_auto_renumber", TRUE);
 628         settings_add_bool("lookandfeel", "window_check_level_first", FALSE);
 629         settings_add_str("lookandfeel", "window_default_level", "NONE");
 630
 631         read_settings();
 632         signal_add("server looking", (SIGNAL_FUNC) sig_server_connected);
 633         signal_add("server connected", (SIGNAL_FUNC) sig_server_connected);
 634         signal_add("server disconnected", (SIGNAL_FUNC) sig_server_disconnected);
 635         signal_add("server connect failed", (SIGNAL_FUNC) sig_server_disconnected);
 636         signal_add("setup changed", (SIGNAL_FUNC) read_settings);
 637 }
 638
 639 void windows_deinit(void)
 640 {
 641         if (daytag != -1) g_source_remove(daytag);
 642         if (daycheck == 1) signal_remove("print text", (SIGNAL_FUNC) sig_print_text);
 643
 644         signal_remove("server looking", (SIGNAL_FUNC) sig_server_connected);
 645         signal_remove("server connected", (SIGNAL_FUNC) sig_server_connected);
 646         signal_remove("server disconnected", (SIGNAL_FUNC) sig_server_disconnected);
 647         signal_remove("server connect failed", (SIGNAL_FUNC) sig_server_disconnected);
 648         signal_remove("setup changed", (SIGNAL_FUNC) read_settings);
 649 }