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
|
/**
* @defgroup core libpurple
*/
/* purple
*
* Purple is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* This program 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 2 of the License, or
* (at your option) any later version.
*
* This program 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 this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*
* @see @ref core-signals
*/
#ifndef _PURPLE_CORE_H_
#define _PURPLE_CORE_H_
typedef struct PurpleCore PurpleCore;
typedef struct
{
void (*ui_prefs_init)(void);
void (*debug_ui_init)(void); /* Unfortunate necessity. */
void (*ui_init)(void);
void (*quit)(void);
GHashTable* (*get_ui_info)(void);
void (*_purple_reserved1)(void);
void (*_purple_reserved2)(void);
void (*_purple_reserved3)(void);
} PurpleCoreUiOps;
#ifdef __cplusplus
extern "C" {
#endif
/**
* Initializes the core of purple.
*
* This will setup preferences for all the core subsystems.
*
* @param ui The ID of the UI using the core. This should be a
* unique ID, registered with the purple team.
*
* @return @c TRUE if successful, or @c FALSE otherwise.
*/
gboolean purple_core_init(const char *ui);
/**
* Quits the core of purple, which, depending on the UI, may quit the
* application using the purple core.
*/
void purple_core_quit(void);
/**
* Calls purple_core_quit(). This can be used as the function
* passed to purple_timeout_add() when you want to shutdown Purple
* in a specified amount of time. When shutting down Purple
* from a plugin, you must use this with a timeout value of 0:
* purple_timeout_add(0, purple_core_quitcb, NULL);
* This is ensures that code from your plugin is not being
* executed when purple_core_quit() is called. Otherwise you
* would get a core dump after purple_core_quit() executes and
* control returns to your plugin because purple_core_quit() frees
* all plugins.
*/
gboolean purple_core_quit_cb(gpointer unused);
/**
* Returns the version of the core library.
*
* @return The version of the core library.
*/
const char *purple_core_get_version(void);
/**
* Returns the ID of the UI that is using the core.
*
* @return The ID of the UI that is currently using the core.
*/
const char *purple_core_get_ui(void);
/**
* Returns a handle to the purple core.
*
* This is used for such things as signals.
*/
PurpleCore *purple_get_core(void);
/**
* Sets the UI ops for the core.
*
* @param ops A UI ops structure for the core.
*/
void purple_core_set_ui_ops(PurpleCoreUiOps *ops);
/**
* Returns the UI ops for the core.
*
* @return The core's UI ops structure.
*/
PurpleCoreUiOps *purple_core_get_ui_ops(void);
/**
* Migrates from .gaim to .purple.
*
* UIs MUST NOT call this if they have been told to use a custom
* user directory.
*
* @return A boolean indicating success or migration failure. On failure,
* the application must display an error to the user and then exit.
*/
gboolean purple_core_migrate(void);
/**
* Ensures that only one instance is running.
*
* @return A boolean such that @c TRUE indicates that this is the first instance,
* whereas @c FALSE indicates that there is another instance running.
*
* @since 2.1.0
*/
gboolean purple_core_ensure_single_instance(void);
/**
* Returns a hashtable containing various information about the UI
*
* @return A GHashTable with strings for keys and values. This
* hash table must not be freed.
*
* @since 2.1.0
*
*/
GHashTable* purple_core_get_ui_info(void);
#ifdef __cplusplus
}
#endif
#endif /* _PURPLE_CORE_H_ */
/*
/===-
`//"\\ """"`---.___.-""
______-==| | | \\ _-"`
__--""" ,-/-==\\ | | `\ ,'
_-" /' | \\ ___ / / \ /
.' / | \\ /" "\ /' / \ /'
/ ____ / | \`\.__/-"" D O \_/' / \/'
/-'" """""---__ | "-/" O G R /' _--"`
\_| / R __--_ t ), __--""
'""--_/ T _-"_>--<_\ h '-" \
{\__--_/} / \\__>--<__\ e B \
/' (_/ _-" | |__>--<__| U |
| _/) )-" | |__>--<__| R |
/ /" ,_/ / /__>---<__/ N |
o-o _// /-"_>---<__-" I /
(^(" /"_>---<__- N _-"
,/| /__>--<__/ A _-"
,//('( |__>--<__| T / .----_
( ( ')) |__>--<__| | /' _---_"\
`-)) )) ( |__>--<__| O | /' / "\`\
,/,'//( ( \__>--<__\ R \ /' // ||
,( ( ((, )) "-__>--<_"-_ "--____---"' _/'/ /'
`"/ )` ) ,/| "-_">--<_/-__ __-" _/
._-"//( )/ )) ` ""-'_/_/ /"""""""__--"
;'( ')/ ,)( """"""""""
' ') '( (/
' ' `
*/
|
