mcabber/modules/xttitle/xttitle.c
author Mikael Berthe <mikael@lilotux.net>
Sun, 28 Mar 2010 10:56:42 +0200
changeset 1841 8ad982f83fd6
parent 1832 48b265f8c5cb
child 2038 5d5af91a0a69
permissions -rw-r--r--
[xttitle] Add option xttitle_short_format As suggested by Pavel Ulpi in issue #51: - A title is set as soon as the module is loaded, - The option xttitle_short_format can be set to 1 to have a very short title Notes: - The terminal title will only display the number of unread nuffers after the unread list has changed (not right after the module loading), - The title is reset to "MCabber" when the module is unloaded.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1827
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     1
/*
1832
48b265f8c5cb [xttitle] Fix typos
Mikael Berthe <mikael@lilotux.net>
parents: 1827
diff changeset
     2
 *  Module "xttitle"    -- Update X terminal title
1827
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     3
 *
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     4
 * Copyright (C) 2010 Mikael Berthe <mikael@lilotux.net>
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     5
 *
1841
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
     6
 * The option 'xttitle_short_format' can be set to 1 to use a very
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
     7
 * short terminal title.
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
     8
 *
1827
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     9
 * This module is free software; you can redistribute it and/or modify
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    10
 * it under the terms of the GNU General Public License as published by
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    11
 * the Free Software Foundation; either version 2 of the License, or (at
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    12
 * your option) any later version.
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    13
 *
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    14
 * This program is distributed in the hope that it will be useful, but
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    15
 * WITHOUT ANY WARRANTY; without even the implied warranty of
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    16
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    17
 * General Public License for more details.
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    18
 *
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    19
 * You should have received a copy of the GNU General Public License
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    20
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    21
 */
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    22
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    23
#include <stdlib.h>
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    24
#include <mcabber/modules.h>
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    25
#include <mcabber/settings.h>
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    26
#include <mcabber/hooks.h>
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    27
#include <mcabber/logprint.h>
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    28
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    29
static void xttitle_init(void);
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    30
static void xttitle_uninit(void);
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    31
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    32
/* Module description */
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    33
module_info_t info_xttitle = {
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    34
        .branch         = MCABBER_BRANCH,
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    35
        .api            = MCABBER_API_VERSION,
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    36
        .version        = MCABBER_VERSION,
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    37
        .description    = "Show unread message count in X terminal title",
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    38
        .requires       = NULL,
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    39
        .init           = xttitle_init,
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    40
        .uninit         = xttitle_uninit,
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    41
        .next           = NULL,
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    42
};
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    43
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    44
// Hook handler id
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    45
static guint unread_list_hid;
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    46
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    47
// Event handler for HOOK_UNREAD_LIST_CHANGE events
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    48
static guint unread_list_hh(const gchar *hookname, hk_arg_t *args,
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    49
                            gpointer userdata)
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    50
{
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    51
  guint all_unread = 0;
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    52
  guint muc_unread = 0;
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    53
  guint muc_attention = 0;
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    54
  guint unread; // private message count
1841
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
    55
  static gchar buf[128];
1827
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    56
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    57
  // Note: We can add "attention" string later, but it isn't used
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    58
  // yet in mcabber...
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    59
  for ( ; args->name; args++) {
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    60
    if (!g_strcmp0(args->name, "unread")) {
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    61
      all_unread = atoi(args->value);
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    62
    } else if (!g_strcmp0(args->name, "muc_unread")) {
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    63
      muc_unread = atoi(args->value);
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    64
    } else if (!g_strcmp0(args->name, "muc_attention")) {
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    65
      muc_attention = atoi(args->value);
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    66
    }
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    67
  }
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    68
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    69
  // Let's not count the MUC unread buffers that don't have the attention
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    70
  // flag (that is, MUC buffer that have no highlighted messages).
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    71
  unread = all_unread - (muc_unread - muc_attention);
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    72
1841
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
    73
  // TODO: let the user use a format string, instead of hard-coded defaults...
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
    74
  if (settings_opt_get_int("xttitle_short_format") == 1) {
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
    75
    // Short title message
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
    76
    if (!all_unread)
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
    77
      snprintf(buf, sizeof(buf), "MCabber");
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
    78
    else if (unread == all_unread)
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
    79
      snprintf(buf, sizeof(buf), "MCabber (%u)", unread);
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
    80
    else
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
    81
      snprintf(buf, sizeof(buf), "MCabber (%u/%u)", unread, all_unread);
1827
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    82
  } else {
1841
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
    83
    // Long title message
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
    84
    if (muc_unread) {
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
    85
      snprintf(buf, sizeof(buf), "MCabber -- %u message%c (total:%u / MUC:%u)",
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
    86
               unread, (unread > 1 ? 's' : ' '), all_unread, muc_unread);
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
    87
    } else {
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
    88
      if (unread)
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
    89
        snprintf(buf, sizeof(buf), "MCabber -- %u message%c", unread,
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
    90
                 (unread > 1 ? 's' : ' '));
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
    91
      else
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
    92
        snprintf(buf, sizeof(buf), "MCabber -- No message");
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
    93
    }
1827
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    94
  }
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    95
1841
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
    96
  // Update the terminal title
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
    97
  printf("\033]0;%s\007", buf);
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
    98
1827
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    99
  return HOOK_HANDLER_RESULT_ALLOW_MORE_HANDLERS;
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   100
}
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   101
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   102
// Initialization
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   103
static void xttitle_init(void)
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   104
{
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   105
  // Add hook handler for unread message data
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   106
  unread_list_hid = hk_add_handler(unread_list_hh, HOOK_UNREAD_LIST_CHANGE,
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   107
                                   G_PRIORITY_DEFAULT_IDLE, NULL);
1841
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
   108
  // Default title
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
   109
  printf("\033]0;MCabber\007");
1827
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   110
}
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   111
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   112
// Uninitialization
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   113
static void xttitle_uninit(void)
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   114
{
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   115
  // Unregister handler
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   116
  hk_del_handler(HOOK_UNREAD_LIST_CHANGE, unread_list_hid);
1841
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
   117
  // Reset title
8ad982f83fd6 [xttitle] Add option xttitle_short_format
Mikael Berthe <mikael@lilotux.net>
parents: 1832
diff changeset
   118
  printf("\033]0;MCabber\007");
1827
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   119
}
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   120
a2642e56e0de Add xttitle module
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   121
/* vim: set et cindent cinoptions=>2\:2(0 ts=2 sw=2:  For Vim users... */