about summary refs log tree commit diff stats
path: root/src/ui/ui.h
blob: d9534ed5e5c5c7c69d27a6ad8bd352024072ed10 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
/*
 * ui.h
 * vim: expandtab:ts=4:sts=4:sw=4
 *
 * Copyright (C) 2012 - 2019 James Booth <boothj5@gmail.com>
 * Copyright (C) 2019 - 2023 Michael Vetter <jubalh@iodoru.org>
 *
 * This file is part of Profanity.
 *
 * Profanity is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Profanity is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Profanity.  If not, see <https://www.gnu.org/licenses/>.
 *
 * In addition, as a special exception, the copyright holders give permission to
 * link the code of portions of this program with the OpenSSL library under
 * certain conditions as described in each individual source file, and
 * distribute linked combinations including the two.
 *
 * You must obey the GNU General Public License in all respects for all of the
 * code used other than OpenSSL. If you modify file(s) with this exception, you
 * may extend this exception to your version of the file(s), but you are not
 * obligated to do so. If you do not wish to do so, delete this exception
 * statement from your version. If you delete this exception statement from all
 * source files in the program, then also delete it here.
 *
 */

#ifndef UI_UI_H
#define UI_UI_H

#include "config.h"

#include "config/tlscerts.h"
#include "config/account.h"
#include "command/cmd_funcs.h"
#include "ui/win_types.h"
#include "xmpp/message.h"
#include "xmpp/muc.h"

#ifdef HAVE_LIBOTR
#include "otr/otr.h"
#endif

#define NO_ME          1
#define NO_DATE        2
#define NO_EOL         4
#define NO_COLOUR_FROM 8
#define NO_COLOUR_DATE 16
#define UNTRUSTED      32

// core UI
void ui_init(void);
void ui_load_colours(void);
void ui_update(void);
void ui_close(void);
void ui_redraw(void);
void ui_resize(void);
void ui_focus_win(ProfWin* window);
void ui_sigwinch_handler(int sig);
void ui_handle_otr_error(const char* const barejid, const char* const message);
unsigned long ui_get_idle_time(void);
void ui_reset_idle_time(void);
void ui_print_system_msg_from_recipient(const char* const barejid, const char* message);
void ui_close_connected_win(int index);
int ui_close_all_wins(void);
int ui_close_read_wins(void);
void ui_close_win(int index);
int ui_win_unread(int index);
gboolean ui_win_has_attention(int index);
gboolean win_has_attention(ProfWin* window);
gboolean win_toggle_attention(ProfWin* window);
char* ui_ask_password(gboolean confirm);
char* ui_get_line(void);
char* ui_ask_pgp_passphrase(const char* hint, int prev_fail);
void ui_contact_online(char* barejid, Resource* resource, GDateTime* last_activity);
void ui_contact_typing(const char* const barejid, const char* const resource);
void ui_disconnected(void);
void ui_room_join(const char* const roomjid, gboolean focus);
void ui_switch_to_room(const char* const roomjid);
void ui_room_destroy(const char* const roomjid);
void ui_room_destroyed(const char* const roomjid, const char* const reason, const char* const new_jid,
                       const char* const password);
void ui_room_kicked(const char* const roomjid, const char* const actor, const char* const reason);
void ui_room_banned(const char* const roomjid, const char* const actor, const char* const reason);
void ui_leave_room(const char* const roomjid);
void ui_show_roster(void);
void ui_hide_roster(void);
void ui_roster_add(const char* const barejid, const char* const name);
void ui_roster_remove(const char* const barejid);
void ui_contact_already_in_group(const char* const contact, const char* const group);
void ui_contact_not_in_group(const char* const contact, const char* const group);
void ui_group_added(const char* const contact, const char* const group);
void ui_group_removed(const char* const contact, const char* const group);
void ui_contact_offline(char* barejid, char* resource, char* status);
void ui_handle_recipient_error(const char* const recipient, const char* const err_msg);
void ui_handle_error(const char* const err_msg);
void ui_clear_win_title(void);
void ui_goodbye_title(void);
void ui_handle_room_configuration_form_error(const char* const roomjid, const char* const message);
void ui_handle_room_config_submit_result(const char* const roomjid);
void ui_handle_room_config_submit_result_error(const char* const roomjid, const char* const message);
void ui_show_lines(ProfWin* window, gchar** lines);
void ui_redraw_all_room_rosters(void);
void ui_show_all_room_rosters(void);
void ui_hide_all_room_rosters(void);
void ui_handle_software_version_error(const char* const roomjid, const char* const message);
void ui_show_software_version(const char* const jid, const char* const presence, const char* const name,
                              const char* const version, const char* const os);
void ui_prune_wins(void);
void ui_auto_away(char* message, gint time, resource_presence_t res_presence);
void ui_handle_login_account_success(ProfAccount* account, gboolean secured);
void ui_update_presence(const resource_presence_t resource_presence, const char* const message, const char* const show);
void ui_invalid_command_usage(const char* const cmd, void (*setting_func)(void));
gboolean ui_win_has_unsaved_form(int num);

// Chat window
ProfChatWin* chatwin_new(const char* const barejid);
void chatwin_incoming_msg(ProfChatWin* chatwin, ProfMessage* message, gboolean win_created);
void chatwin_receipt_received(ProfChatWin* chatwin, const char* const id);
void chatwin_recipient_gone(ProfChatWin* chatwin);
void chatwin_outgoing_msg(ProfChatWin* chatwin, const char* const message, char* id, prof_enc_t enc_mode, gboolean request_receipt, const char* const replace_id);
void chatwin_outgoing_carbon(ProfChatWin* chatwin, ProfMessage* message);
void chatwin_contact_online(ProfChatWin* chatwin, Resource* resource, GDateTime* last_activity);
void chatwin_contact_offline(ProfChatWin* chatwin, char* resource, char* status);
char* chatwin_get_string(ProfChatWin* chatwin);
#ifdef HAVE_LIBOTR
void chatwin_otr_secured(ProfChatWin* chatwin, gboolean trusted);
void chatwin_otr_unsecured(ProfChatWin* chatwin);
void chatwin_otr_trust(ProfChatWin* chatwin);
void chatwin_otr_untrust(ProfChatWin* chatwin);
void chatwin_otr_smp_event(ProfChatWin* chatwin, prof_otr_smp_event_t event, void* data);
#endif
void chatwin_set_enctext(ProfChatWin* chatwin, const char* const enctext);
void chatwin_unset_enctext(ProfChatWin* chatwin);
void chatwin_set_incoming_char(ProfChatWin* chatwin, const char* const ch);
void chatwin_unset_incoming_char(ProfChatWin* chatwin);
void chatwin_set_outgoing_char(ProfChatWin* chatwin, const char* const ch);
void chatwin_unset_outgoing_char(ProfChatWin* chatwin);
gboolean chatwin_db_history(ProfChatWin* chatwin, char* start_time, char* end_time, gboolean flip);

// MUC window
ProfMucWin* mucwin_new(const char* const barejid);
void mucwin_role_change(ProfMucWin* mucwin, const char* const role, const char* const actor, const char* const reason);
void mucwin_affiliation_change(ProfMucWin* mucwin, const char* const affiliation, const char* const actor,
                               const char* const reason);
void mucwin_role_and_affiliation_change(ProfMucWin* mucwin, const char* const role,
                                        const char* const affiliation, const char* const actor, const char* const reason);
void mucwin_occupant_role_change(ProfMucWin* mucwin, const char* const nick, const char* const role,
                                 const char* const actor, const char* const reason);
void mucwin_occupant_affiliation_change(ProfMucWin* mucwin, const char* const nick,
                                        const char* const affiliation, const char* const actor, const char* const reason);
void mucwin_occupant_role_and_affiliation_change(ProfMucWin* mucwin, const char* const nick,
                                                 const char* const role, const char* const affiliation, const char* const actor, const char* const reason);
void mucwin_roster(ProfMucWin* mucwin, GList* occupants, const char* const presence);
void mucwin_history(ProfMucWin* mucwin, const ProfMessage* const message);
void mucwin_outgoing_msg(ProfMucWin* mucwin, const char* const message, const char* const id, prof_enc_t enc_mode, const char* const replace_id);
void mucwin_incoming_msg(ProfMucWin* mucwin, const ProfMessage* const message, GSList* mentions, GList* triggers, gboolean filter_reflection);
void mucwin_subject(ProfMucWin* mucwin, const char* const nick, const char* const subject);
void mucwin_requires_config(ProfMucWin* mucwin);
void mucwin_info(ProfMucWin* mucwin);
void mucwin_show_role_list(ProfMucWin* mucwin, muc_role_t role);
void mucwin_show_affiliation_list(ProfMucWin* mucwin, muc_affiliation_t affiliation);
void mucwin_room_info_error(ProfMucWin* mucwin, const char* const error);
void mucwin_room_disco_info(ProfMucWin* mucwin, GSList* identities, GSList* features);
void mucwin_occupant_kicked(ProfMucWin* mucwin, const char* const nick, const char* const actor,
                            const char* const reason);
void mucwin_occupant_banned(ProfMucWin* mucwin, const char* const nick, const char* const actor,
                            const char* const reason);
void mucwin_broadcast(ProfMucWin* mucwin, const char* const message);
void mucwin_occupant_offline(ProfMucWin* mucwin, const char* const nick);
void mucwin_occupant_online(ProfMucWin* mucwin, const char* const nick, const char* const roles,
                            const char* const affiliation, const char* const show, const char* const status);
void mucwin_occupant_nick_change(ProfMucWin* mucwin, const char* const old_nick, const char* const nick);
void mucwin_nick_change(ProfMucWin* mucwin, const char* const nick);
void mucwin_occupant_presence(ProfMucWin* mucwin, const char* const nick, const char* const show,
                              const char* const status);
void mucwin_update_occupants(ProfMucWin* mucwin);
void mucwin_show_occupants(ProfMucWin* mucwin);
void mucwin_hide_occupants(ProfMucWin* mucwin);
void mucwin_affiliation_list_error(ProfMucWin* mucwin, const char* const affiliation, const char* const error);
void mucwin_handle_affiliation_list(ProfMucWin* mucwin, const char* const affiliation, GSList* jids);
void mucwin_affiliation_set_error(ProfMucWin* mucwin, const char* const jid, const char* const affiliation,
                                  const char* const error);
void mucwin_role_set_error(ProfMucWin* mucwin, const char* const nick, const char* const role, const char* const error);
void mucwin_role_list_error(ProfMucWin* mucwin, const char* const role, const char* const error);
void mucwin_handle_role_list(ProfMucWin* mucwin, const char* const role, GSList* nicks);
void mucwin_kick_error(ProfMucWin* mucwin, const char* const nick, const char* const error);
char* mucwin_get_string(ProfMucWin* mucwin);
void mucwin_set_enctext(ProfMucWin* mucwin, const char* const enctext);
void mucwin_unset_enctext(ProfMucWin* mucwin);
void mucwin_set_message_char(ProfMucWin* mucwin, const char* const ch);
void mucwin_unset_message_char(ProfMucWin* mucwin);

// MUC private chat window
void privwin_incoming_msg(ProfPrivateWin* privatewin, ProfMessage* message);
void privwin_outgoing_msg(ProfPrivateWin* privwin, const char* const message);
void privwin_message_occupant_offline(ProfPrivateWin* privwin);

void privwin_message_left_room(ProfPrivateWin* privwin);

char* privwin_get_string(ProfPrivateWin* privwin);
void privwin_occupant_offline(ProfPrivateWin* privwin);
void privwin_occupant_kicked(ProfPrivateWin* privwin, const char* const actor, const char* const reason);
void privwin_occupant_banned(ProfPrivateWin* privwin, const char* const actor, const char* const reason);
void privwin_occupant_online(ProfPrivateWin* privwin);

void privwin_room_destroyed(ProfPrivateWin* privwin);
void privwin_room_left(ProfPrivateWin* privwin);
void privwin_room_kicked(ProfPrivateWin* privwin, const char* const actor, const char* const reason);
void privwin_room_banned(ProfPrivateWin* privwin, const char* const actor, const char* const reason);
void privwin_room_joined(ProfPrivateWin* privwin);

// config window
void confwin_handle_configuration(ProfConfWin* confwin, DataForm* form);
void confwin_show_form(ProfConfWin* confwin);
void confwin_show_form_field(ProfConfWin* confwin, DataForm* form, char* tag);
void confwin_form_help(ProfConfWin* confwin);
void confwin_field_help(ProfConfWin* confwin, char* tag);
char* confwin_get_string(ProfConfWin* confwin);

// xml console
void xmlwin_show(ProfXMLWin* xmlwin, const char* const msg);
char* xmlwin_get_string(ProfXMLWin* xmlwin);

// vCard window
void vcardwin_show_vcard_config(ProfVcardWin* vcardwin);
char* vcardwin_get_string(ProfVcardWin* vcardwin);
void vcardwin_update(void);

// Input window
char* inp_readline(void);
void inp_nonblocking(gboolean reset);

// Console window
void cons_show(const char* const msg, ...);
void cons_show_padded(int pad, const char* const msg, ...);
void cons_about(void);
void cons_help(void);
void cons_show_help(const char* const cmd, CommandHelp* help);
void cons_bad_cmd_usage(const char* const cmd);
void cons_navigation_help(void);
void cons_prefs(void);
void cons_show_ui_prefs(void);
void cons_show_desktop_prefs(void);
void cons_show_chat_prefs(void);
void cons_show_log_prefs(void);
void cons_show_presence_prefs(void);
void cons_show_connection_prefs(void);
void cons_show_otr_prefs(void);
void cons_show_pgp_prefs(void);
void cons_show_omemo_prefs(void);
void cons_show_ox_prefs(void);
void cons_show_account(ProfAccount* account);
void cons_debug(const char* const msg, ...);
void cons_show_error(const char* const cmd, ...);
void cons_show_contacts(GSList* list);
void cons_show_roster(GSList* list);
void cons_show_roster_group(const char* const group, GSList* list);
void cons_show_wins(gboolean unread);
void cons_show_wins_attention();
char* cons_get_string(ProfConsoleWin* conswin);
void cons_show_status(const char* const barejid);
void cons_show_info(PContact pcontact);
void cons_show_caps(const char* const fulljid, resource_presence_t presence);
void cons_show_themes(GSList* themes);
void cons_show_scripts(GSList* scripts);
void cons_show_script(const char* const script, GSList* commands);
void cons_show_aliases(GList* aliases);
void cons_show_login_success(ProfAccount* account, gboolean secured);
void cons_show_account_list(gchar** accounts);
void cons_show_room_list(GSList* room, const char* const conference_node);
void cons_show_bookmark(Bookmark* item);
void cons_show_bookmarks(const GList* list);
void cons_show_bookmarks_ignore(gchar** list, gsize len);
void cons_show_disco_items(GSList* items, const char* const jid);
void cons_show_disco_info(const char* from, GSList* identities, GSList* features);

void cons_show_disco_contact_information(GHashTable* addresses);

void cons_show_qrcode();

void cons_show_room_invite(const char* const invitor, const char* const room, const char* const reason);
void cons_check_version(gboolean not_available_msg);
void cons_show_typing(const char* const barejid);
void cons_show_incoming_room_message(const char* const nick, const char* const room, const int win_index,
                                     gboolean mention, GList* triggers, int unread, ProfWin* const window);
void cons_show_incoming_message(const char* const short_from, const int win_index, int unread, ProfWin* const window);
void cons_show_incoming_private_message(const char* const nick, const char* const room, const int win_index, int unread, ProfWin* const window);
void cons_show_room_invites(GList* invites);
void cons_show_received_subs(void);
void cons_show_sent_subs(void);
void cons_theme_setting(void);
void cons_resource_setting(void);
void cons_privileges_setting(void);
void cons_beep_setting(void);
void cons_console_setting(void);
void cons_flash_setting(void);
void cons_tray_setting(void);
void cons_splash_setting(void);
void cons_titlebar_setting(void);
void cons_vercheck_setting(void);
void cons_occupants_setting(void);
void cons_roster_setting(void);
void cons_presence_setting(void);
void cons_wrap_setting(void);
void cons_time_setting(void);
void cons_wintitle_setting(void);
void cons_notify_setting(void);
void cons_show_desktop_prefs(void);
void cons_states_setting(void);
void cons_outtype_setting(void);
void cons_intype_setting(void);
void cons_gone_setting(void);
void cons_history_setting(void);
void cons_carbons_setting(void);
void cons_receipts_setting(void);
void cons_log_setting(void);
void cons_logging_setting(void);
void cons_autoaway_setting(void);
void cons_reconnect_setting(void);
void cons_autoping_setting(void);
void cons_autoconnect_setting(void);
void cons_room_cache_setting(void);
void cons_inpblock_setting(void);
void cons_statusbar_setting(void);
void cons_winpos_setting(void);
void cons_color_setting(void);
void cons_os_setting(void);
void cons_correction_setting(void);
void cons_executable_setting(void);
void cons_slashguard_setting(void);
void cons_mam_setting(void);
void cons_silence_setting(void);
void cons_mood_setting(void);
void cons_strophe_setting(void);
void cons_show_contact_online(PContact contact, Resource* resource, GDateTime* last_activity);
void cons_show_contact_offline(PContact contact, char* resource, char* status);
void cons_theme_properties(void);
void cons_theme_colours(void);
void cons_show_tlscert(const TLSCertificate* cert);
void cons_show_tlscert_summary(const TLSCertificate* cert);

void cons_alert(ProfWin* alert_origin_window);
void cons_remove_alert(ProfWin* window);
void cons_clear_alerts(void);
gboolean cons_has_alerts(void);

// title bar
void title_bar_set_presence(contact_presence_t presence);

// status bar
void status_bar_inactive(const int win);
void status_bar_active(const int win, win_type_t wintype, char* identifier);
void status_bar_new(const int win, win_type_t wintype, char* identifier);
void status_bar_set_all_inactive(void);

// roster window
void rosterwin_roster(void);

// occupants window
void occupantswin_occupants(const char* const room);
void occupantswin_occupants_all(void);

// window interface
ProfWin* win_create_console(void);
ProfWin* win_create_xmlconsole(void);
ProfWin* win_create_chat(const char* const barejid);
ProfWin* win_create_muc(const char* const roomjid);
ProfWin* win_create_config(const char* const title, DataForm* form, ProfConfWinCallback submit, ProfConfWinCallback cancel, const void* userdata);
ProfWin* win_create_private(const char* const fulljid);
ProfWin* win_create_plugin(const char* const plugin_name, const char* const tag);
ProfWin* win_create_vcard(vCard* vcard);
void win_update_virtual(ProfWin* window);
void win_free(ProfWin* window);
gboolean win_notify_remind(ProfWin* window);
int win_unread(ProfWin* window);
void win_resize(ProfWin* window);
void win_hide_subwin(ProfWin* window);
void win_show_subwin(ProfWin* window);
void win_refresh_without_subwin(ProfWin* window);
void win_refresh_with_subwin(ProfWin* window);

void win_print(ProfWin* window, theme_item_t theme_item, const char* show_char, const char* const message, ...);
void win_println(ProfWin* window, theme_item_t theme_item, const char* show_char, const char* const message, ...);
void win_println_indent(ProfWin* window, int pad, const char* const message, ...);

void win_append(ProfWin* window, theme_item_t theme_item, const char* const message, ...);
void win_appendln(ProfWin* window, theme_item_t theme_item, const char* const message, ...);

void win_append_highlight(ProfWin* window, theme_item_t theme_item, const char* const message, ...);
void win_appendln_highlight(ProfWin* window, theme_item_t theme_item, const char* const message, ...);

char* win_get_title(ProfWin* window);
void win_show_occupant(ProfWin* window, Occupant* occupant);
void win_show_occupant_info(ProfWin* window, const char* const room, Occupant* occupant);
void win_show_contact(ProfWin* window, PContact contact);
void win_show_info(ProfWin* window, PContact contact);
void win_show_vcard(ProfWin* window, vCard* vcard);

void win_clear(ProfWin* window);
char* win_get_tab_identifier(ProfWin* window);
char* win_to_string(ProfWin* window);
void win_command_list_error(ProfWin* window, const char* const error);
void win_command_exec_error(ProfWin* window, const char* const command, const char* const error, ...);
void win_handle_command_list(ProfWin* window, GSList* cmds);
void win_handle_command_exec_status(ProfWin* window, const char* const type, const char* const value);
void win_handle_command_exec_result_note(ProfWin* window, const char* const type, const char* const value);
char* win_get_last_sent_message(ProfWin* window);

// desktop notifications
void notifier_initialise(void);
void notifier_uninit(void);
void notify_typing(const char* const name);
void notify_message(const char* const name, int win, const char* const text);
void notify_room_message(const char* const nick, const char* const room, int win, const char* const text);
void notify_remind(void);
void notify_invite(const char* const from, const char* const room, const char* const reason);
void notify(const char* const message, int timeout, const char* const category);
void notify_subscription(const char* const from);

#endif