Mercurial > ~mikael > mcabber > hg

annotate mcabber/modules/beep/beep.c @ 2042:0cb8ea02e472

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Make completion sorting order configurable * Use allocated plain array for categories * Use callbacks for dynamic completions (private for now) * Add compl_set_flags() to allow user to set completion order * Bump api to 24-24
author Myhailo Danylenko <isbear@ukrpost.net>
date Sat, 20 Oct 2012 18:29:49 +0300
parents ad77110343d6
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1829
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
1 /*
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
2 * Module "beep" -- Beep on all incoming messages
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
3 *
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
4 * Copyright 2009 Myhailo Danylenko
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
5 * This file is part of mcabber module writing howto examples.
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
6 *
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
7 * This module is free software; you can redistribute it and/or modify
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
8 * it under the terms of the GNU General Public License as published by
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
9 * the Free Software Foundation; either version 2 of the License, or (at
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
10 * your option) any later version.
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
11 *
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
12 * This program is distributed in the hope that it will be useful, but
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
15 * General Public License for more details.
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
16 *
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
17 * You should have received a copy of the GNU General Public License
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
19 */
1671
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
20
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
21 #include <string.h>
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
22
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
23 #include <mcabber/logprint.h>
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
24 #include <mcabber/commands.h>
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
25 #include <mcabber/compl.h>
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
26 #include <mcabber/hooks.h>
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
27 #include <mcabber/screen.h>
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
28 #include <mcabber/settings.h>
1735
5093b5ca1572 New modules loading scheme
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1671
diff changeset
29 #include <mcabber/modules.h>
1750
14b4866cc9f2 Update modules to use new api
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1735
diff changeset
30 #include <mcabber/config.h>
1735
5093b5ca1572 New modules loading scheme
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1671
diff changeset
31
5093b5ca1572 New modules loading scheme
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1671
diff changeset
32 static void beep_init (void);
5093b5ca1572 New modules loading scheme
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1671
diff changeset
33 static void beep_uninit (void);
5093b5ca1572 New modules loading scheme
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1671
diff changeset
34
5093b5ca1572 New modules loading scheme
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1671
diff changeset
35 /* Module description */
5093b5ca1572 New modules loading scheme
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1671
diff changeset
36 module_info_t info_beep = {
1829
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
37 .branch = MCABBER_BRANCH,
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
38 .api = MCABBER_API_VERSION,
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
39 .version = MCABBER_VERSION,
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
40 .description = "Simple beeper module\n"
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
41 " Recognizes option beep_enable\n"
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
42 " Provides command /beep",
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
43 .requires = NULL,
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
44 .init = beep_init,
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
45 .uninit = beep_uninit,
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
46 .next = NULL,
1735
5093b5ca1572 New modules loading scheme
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1671
diff changeset
47 };
1671
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
48
1986
ad77110343d6 Use a command ID with cmd_add/cmd_del (Myhailo Danylenko)
Mikael Berthe <mikael@lilotux.net>
parents: 1829
diff changeset
49 static guint beep_cid = 0; /* Command completion category id */
ad77110343d6 Use a command ID with cmd_add/cmd_del (Myhailo Danylenko)
Mikael Berthe <mikael@lilotux.net>
parents: 1829
diff changeset
50 static gpointer beep_cmid = 0; /* Command id */
ad77110343d6 Use a command ID with cmd_add/cmd_del (Myhailo Danylenko)
Mikael Berthe <mikael@lilotux.net>
parents: 1829
diff changeset
51 static guint beep_hid = 0; /* Hook handler id */
1671
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
52
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
53 /* Event handler */
1829
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
54 static guint beep_hh(const gchar *hookname, hk_arg_t *args, gpointer userdata)
1671
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
55 {
1829
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
56 /* Check if beeping is enabled */
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
57 if (settings_opt_get_int("beep_enable"))
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
58 scr_beep(); /* *BEEP*! */
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
59
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
60 /* We're done, let the other handlers do their job! */
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
61 return HOOK_HANDLER_RESULT_ALLOW_MORE_HANDLERS;
1671
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
62 }
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
63
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
64 /* beep command handler */
1829
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
65 static void do_beep(char *args)
1671
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
66 {
1829
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
67 /* Check arguments, and if recognized,
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
68 * set mcabber option accordingly */
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
69 if (!strcmp(args, "enable") ||
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
70 !strcmp(args, "on") ||
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
71 !strcmp(args, "yes") ||
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
72 !strcmp(args, "1"))
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
73 settings_set(SETTINGS_TYPE_OPTION, "beep_enable", "1");
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
74 else if (!strcmp(args, "disable") ||
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
75 !strcmp(args, "off") ||
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
76 !strcmp(args, "no") ||
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
77 !strcmp(args, "0"))
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
78 settings_set(SETTINGS_TYPE_OPTION, "beep_enable", "0");
1671
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
79
1829
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
80 /* Output current state, either if state is
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
81 * changed or if argument is not recognized */
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
82 if (settings_opt_get_int("beep_enable"))
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
83 scr_log_print(LPRINT_NORMAL, "Beep on messages is enabled");
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
84 else
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
85 scr_log_print(LPRINT_NORMAL, "Beep on messages is disabled");
1671
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
86 }
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
87
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
88 /* Initialization */
1829
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
89 static void beep_init(void)
1671
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
90 {
1829
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
91 /* Create completions */
2042
0cb8ea02e472 Make completion sorting order configurable
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1986
diff changeset
92 beep_cid = compl_new_category(COMPL_FLAGS_SORT);
1829
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
93 if (beep_cid) {
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
94 compl_add_category_word(beep_cid, "enable");
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
95 compl_add_category_word(beep_cid, "disable");
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
96 }
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
97 /* Add command */
1986
ad77110343d6 Use a command ID with cmd_add/cmd_del (Myhailo Danylenko)
Mikael Berthe <mikael@lilotux.net>
parents: 1829
diff changeset
98 beep_cmid = cmd_add("beep", "", beep_cid, 0, do_beep, NULL);
1829
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
99 /* Add handler
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
100 * We are only interested in incoming message events
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
101 */
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
102 beep_hid = hk_add_handler(beep_hh, HOOK_POST_MESSAGE_IN,
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
103 G_PRIORITY_DEFAULT_IDLE, NULL);
1671
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
104 }
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
105
1829
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
106 /* Uninitialization */
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
107 static void beep_uninit(void)
1671
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
108 {
1829
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
109 /* Unregister event handler */
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
110 hk_del_handler(HOOK_POST_MESSAGE_IN, beep_hid);
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
111 /* Unregister command */
1986
ad77110343d6 Use a command ID with cmd_add/cmd_del (Myhailo Danylenko)
Mikael Berthe <mikael@lilotux.net>
parents: 1829
diff changeset
112 cmd_del(beep_cmid);
1829
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
113 /* Give back completion handle */
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
114 if (beep_cid)
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
115 compl_del_category(beep_cid);
1671
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
116 }
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
117
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
118 /* The End */
1829
c059c5c98de6 Update beep module coding style
Mikael Berthe <mikael@lilotux.net>
parents: 1826
diff changeset
119 /* vim: set et cindent cinoptions=>2\:2(0 ts=2 sw=2: For Vim users... */