libpurple/purplewhiteboardops.h

Thu, 07 Aug 2025 21:32:18 -0500

author
Gary Kramlich <grim@reaperworld.com>
date
Thu, 07 Aug 2025 21:32:18 -0500
changeset 43300
0604c6839974
parent 42594
eddde70cedd8
permissions
-rw-r--r--

Clean up and modernize PurpleImage

Testing Done:
Ran the tests under valgrind and called in the turtles.

Reviewed at https://reviews.imfreedom.org/r/4074/

40595
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
1 /*
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
2 * Purple - Internet Messaging Library
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
3 * Copyright (C) Pidgin Developers <devel@pidgin.im>
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
4 *
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
5 * Purple is the legal property of its developers, whose names are too numerous
42594
eddde70cedd8 Create a test for verifying license headers and correct the ones that were wrong
Gary Kramlich <grim@reaperworld.com>
parents: 41276
diff changeset
6 * to list here. Please refer to the COPYRIGHT file distributed with this
40595
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
7 * source distribution.
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
8 *
42594
eddde70cedd8 Create a test for verifying license headers and correct the ones that were wrong
Gary Kramlich <grim@reaperworld.com>
parents: 41276
diff changeset
9 * This library is free software; you can redistribute it and/or modify it
eddde70cedd8 Create a test for verifying license headers and correct the ones that were wrong
Gary Kramlich <grim@reaperworld.com>
parents: 41276
diff changeset
10 * under the terms of the GNU General Public License as published by the Free
eddde70cedd8 Create a test for verifying license headers and correct the ones that were wrong
Gary Kramlich <grim@reaperworld.com>
parents: 41276
diff changeset
11 * Software Foundation; either version 2 of the License, or (at your option)
eddde70cedd8 Create a test for verifying license headers and correct the ones that were wrong
Gary Kramlich <grim@reaperworld.com>
parents: 41276
diff changeset
12 * any later version.
40595
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
13 *
42594
eddde70cedd8 Create a test for verifying license headers and correct the ones that were wrong
Gary Kramlich <grim@reaperworld.com>
parents: 41276
diff changeset
14 * This library is distributed in the hope that it will be useful, but WITHOUT
eddde70cedd8 Create a test for verifying license headers and correct the ones that were wrong
Gary Kramlich <grim@reaperworld.com>
parents: 41276
diff changeset
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
eddde70cedd8 Create a test for verifying license headers and correct the ones that were wrong
Gary Kramlich <grim@reaperworld.com>
parents: 41276
diff changeset
16 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
eddde70cedd8 Create a test for verifying license headers and correct the ones that were wrong
Gary Kramlich <grim@reaperworld.com>
parents: 41276
diff changeset
17 * more details.
40595
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
18 *
42594
eddde70cedd8 Create a test for verifying license headers and correct the ones that were wrong
Gary Kramlich <grim@reaperworld.com>
parents: 41276
diff changeset
19 * You should have received a copy of the GNU General Public License along with
eddde70cedd8 Create a test for verifying license headers and correct the ones that were wrong
Gary Kramlich <grim@reaperworld.com>
parents: 41276
diff changeset
20 * this library; if not, see <https://www.gnu.org/licenses/>.
40595
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
21 */
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
22
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
23 #if !defined(PURPLE_GLOBAL_HEADER_INSIDE) && !defined(PURPLE_COMPILATION)
41276
03f98ece6b26 Fix a ton of missing and incorrect global header guards
Gary Kramlich <grim@reaperworld.com>
parents: 41205
diff changeset
24 # error "only <purple.h> may be included directly"
40595
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
25 #endif
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
26
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
27 #ifndef PURPLE_WHITEBOARD_OPS_H
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
28 #define PURPLE_WHITEBOARD_OPS_H
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
29
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
30 #include <glib.h>
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
31
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
32 typedef struct _PurpleWhiteboardOps PurpleWhiteboardOps;
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
33
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
34 #include "purplewhiteboard.h"
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
35
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
36 G_BEGIN_DECLS
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
37
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
38 /**
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
39 * PurpleWhiteboardOps:
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
40 * @start: start function
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
41 * @end: end function
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
42 * @get_dimensions: get whiteboard dimensions
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
43 * @set_dimensions: set whiteboard dimensions
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
44 * @get_brush: get the brush size and color
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
45 * @set_brush: set the brush size and color
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
46 * @send_draw_list: send_draw_list function
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
47 * @clear: clear whiteboard
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
48 *
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
49 * Whiteboard protocol operations
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
50 */
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
51 struct _PurpleWhiteboardOps
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
52 {
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
53 void (*start)(PurpleWhiteboard *wb);
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
54 void (*end)(PurpleWhiteboard *wb);
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
55 void (*get_dimensions)(const PurpleWhiteboard *wb, int *width, int *height);
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
56 void (*set_dimensions)(PurpleWhiteboard *wb, int width, int height);
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
57 void (*get_brush) (const PurpleWhiteboard *wb, int *size, int *color);
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
58 void (*set_brush) (PurpleWhiteboard *wb, int size, int color);
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
59 void (*send_draw_list)(PurpleWhiteboard *wb, GList *draw_list);
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
60 void (*clear)(PurpleWhiteboard *wb);
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
61
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
62 /*< private >*/
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
63 gpointer reserved[4];
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
64 };
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
65
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
66 G_END_DECLS
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
67
d7e28f8a0994 split up whiteboard.[ch] to separate files
Gary Kramlich <grim@reaperworld.com>
parents:
diff changeset
68 #endif /* PURPLE_WHITEBOARD_OPS_H */

mercurial