Mercurial > ~mikael > mcabber > hg

annotate mcabber/modules/beep/beep.c @ 1826:1aa89ccfb626

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Reorder module info fields in the beep module
author Mikael Berthe <mikael@lilotux.net>
date Sat, 27 Mar 2010 11:08:19 +0100
parents 1c3efa9bc422
children c059c5c98de6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1671
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
1
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
2 /* Copyright 2009 Myhailo Danylenko
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
3
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
4 This file is part of mcabber module writing howto examples.
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
5
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
6 Examples are free software: you can redistribute it and/or modify
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
7 it under the terms of the GNU General Public License as published by
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
8 the Free Software Foundation, either version 2 of the License, or
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
9 (at your option) any later version.
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
10
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
11 This program is distributed in the hope that it will be useful,
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
14 GNU General Public License for more details.
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
15
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
18
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
19 #include <string.h>
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 <mcabber/logprint.h>
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
22 #include <mcabber/commands.h>
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
23 #include <mcabber/compl.h>
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
24 #include <mcabber/hooks.h>
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
25 #include <mcabber/screen.h>
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
26 #include <mcabber/settings.h>
1735
5093b5ca1572 New modules loading scheme
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1671
diff changeset
27 #include <mcabber/modules.h>
1750
14b4866cc9f2 Update modules to use new api
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1735
diff changeset
28 #include <mcabber/config.h>
1735
5093b5ca1572 New modules loading scheme
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1671
diff changeset
29
5093b5ca1572 New modules loading scheme
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1671
diff changeset
30 static void beep_init (void);
5093b5ca1572 New modules loading scheme
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1671
diff changeset
31 static void beep_uninit (void);
5093b5ca1572 New modules loading scheme
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1671
diff changeset
32
5093b5ca1572 New modules loading scheme
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1671
diff changeset
33 /* Module description */
5093b5ca1572 New modules loading scheme
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1671
diff changeset
34 module_info_t info_beep = {
1750
14b4866cc9f2 Update modules to use new api
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1735
diff changeset
35 .branch = MCABBER_BRANCH,
1826
1aa89ccfb626 Reorder module info fields in the beep module
Mikael Berthe <mikael@lilotux.net>
parents: 1813
diff changeset
36 .api = MCABBER_API_VERSION,
1aa89ccfb626 Reorder module info fields in the beep module
Mikael Berthe <mikael@lilotux.net>
parents: 1813
diff changeset
37 .version = MCABBER_VERSION,
1aa89ccfb626 Reorder module info fields in the beep module
Mikael Berthe <mikael@lilotux.net>
parents: 1813
diff changeset
38 .description = "Simple beeper module\n"
1aa89ccfb626 Reorder module info fields in the beep module
Mikael Berthe <mikael@lilotux.net>
parents: 1813
diff changeset
39 " Recognizes option beep_enable\n"
1aa89ccfb626 Reorder module info fields in the beep module
Mikael Berthe <mikael@lilotux.net>
parents: 1813
diff changeset
40 " Provides command /beep",
1735
5093b5ca1572 New modules loading scheme
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1671
diff changeset
41 .requires = NULL,
5093b5ca1572 New modules loading scheme
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1671
diff changeset
42 .init = beep_init,
5093b5ca1572 New modules loading scheme
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1671
diff changeset
43 .uninit = beep_uninit,
1750
14b4866cc9f2 Update modules to use new api
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1735
diff changeset
44 .next = NULL,
1735
5093b5ca1572 New modules loading scheme
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1671
diff changeset
45 };
1671
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
46
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
47 static guint beep_cid = 0;
1795
47699a09ceb3 Rework the hook system
Mikael Berthe <mikael@lilotux.net>
parents: 1780
diff changeset
48 static guint beep_hid;
1671
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
49
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
50 /* Event handler */
1795
47699a09ceb3 Rework the hook system
Mikael Berthe <mikael@lilotux.net>
parents: 1780
diff changeset
51 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
52 {
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
53 /* Check if beeping is enabled */
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
54 if (settings_opt_get_int ("beep_enable"))
1795
47699a09ceb3 Rework the hook system
Mikael Berthe <mikael@lilotux.net>
parents: 1780
diff changeset
55 scr_beep (); /* *BEEP*! */
1813
1c3efa9bc422 s/HOOK_HANDLER_RESULT_ALLOW_MORE_HOOKS/HOOK_HANDLER_RESULT_ALLOW_MORE_HANDLERS
Mikael Berthe <mikael@lilotux.net>
parents: 1796
diff changeset
56 return HOOK_HANDLER_RESULT_ALLOW_MORE_HANDLERS;
1671
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
57 }
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
58
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
59 /* beep command handler */
1735
5093b5ca1572 New modules loading scheme
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1671
diff changeset
60 static void do_beep (char *args)
1671
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
61 {
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
62 /* Check arguments, and if recognized,
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
63 * set mcabber option accordingly */
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
64 if (!strcmp (args, "enable") ||
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
65 !strcmp (args, "on") ||
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
66 !strcmp (args, "yes") ||
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
67 !strcmp (args, "1"))
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
68 settings_set (SETTINGS_TYPE_OPTION,
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
69 "beep_enable", "1");
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
70 else if (!strcmp (args, "disable") ||
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
71 !strcmp (args, "off") ||
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
72 !strcmp (args, "no") ||
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
73 !strcmp (args, "0"))
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
74 settings_set (SETTINGS_TYPE_OPTION,
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
75 "beep_enable", "0");
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
76
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
77 /* Output current state, either if state is
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
78 * changed and if argument is not recognized */
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
79 if (settings_opt_get_int ("beep_enable"))
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
80 scr_LogPrint (LPRINT_NORMAL,
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
81 "Beep on messages is enabled");
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
82 else
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
83 scr_LogPrint (LPRINT_NORMAL,
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
84 "Beep on messages is disabled");
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
85 }
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 /* Initialization */
1735
5093b5ca1572 New modules loading scheme
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1671
diff changeset
88 static void beep_init (void)
1671
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
89 {
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
90 /* Create completions */
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
91 beep_cid = compl_new_category ();
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
92 if (beep_cid) {
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
93 compl_add_category_word (beep_cid, "enable");
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
94 compl_add_category_word (beep_cid, "disable");
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
95 }
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
96 /* Add command */
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
97 cmd_add ("beep", "", beep_cid, 0, do_beep, NULL);
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
98 /* Add handler
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
99 * We are only interested in incoming message events
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
100 */
1796
5e2db25fdb17 Rename "hook-message-in" to "hook-post-message-in"
Mikael Berthe <mikael@lilotux.net>
parents: 1795
diff changeset
101 beep_hid = hk_add_handler (beep_hh, HOOK_POST_MESSAGE_IN,
1795
47699a09ceb3 Rework the hook system
Mikael Berthe <mikael@lilotux.net>
parents: 1780
diff changeset
102 G_PRIORITY_DEFAULT_IDLE, NULL);
1671
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
103 }
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 /* Deinitialization */
1735
5093b5ca1572 New modules loading scheme
Myhailo Danylenko <isbear@ukrpost.net>
parents: 1671
diff changeset
106 static void beep_uninit (void)
1671
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
107 {
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
108 /* Unregister event handler */
1796
5e2db25fdb17 Rename "hook-message-in" to "hook-post-message-in"
Mikael Berthe <mikael@lilotux.net>
parents: 1795
diff changeset
109 hk_del_handler (HOOK_POST_MESSAGE_IN, beep_hid);
1671
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
110 /* Unregister command */
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
111 cmd_del ("beep");
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
112 /* Give back completion handle */
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
113 if (beep_cid)
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
114 compl_del_category (beep_cid);
411269409f34 Add in-tree beep example module
Myhailo Danylenko <isbear@ukrpost.net>
parents:
diff changeset
115 }
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 /* The End */