Mercurial > pidgin
annotate plugins/ChangeLog @ 745:d693b83e4933
[gaim-migrate @ 755]
apply aliases of self
committer: Tailor Script <tailor@pidgin.im>
author | Eric Warmenhoven <eric@warmenhoven.org> |
---|---|
date | Wed, 23 Aug 2000 02:43:34 +0000 |
parents | a26eb4c472d8 |
children | 9614e69f68ca |
rev | line source |
---|---|
591
a26eb4c472d8
[gaim-migrate @ 601]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
445
diff
changeset
|
1 version 0.10.0: |
a26eb4c472d8
[gaim-migrate @ 601]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
445
diff
changeset
|
2 Rather than have a separate CFLAGS and LDFLAGS for the plugins than |
a26eb4c472d8
[gaim-migrate @ 601]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
445
diff
changeset
|
3 for gaim, and doing all kinds of crazy things to work around the |
a26eb4c472d8
[gaim-migrate @ 601]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
445
diff
changeset
|
4 problems that creates, the plugins now have the same CFLAGS and LIBS. |
a26eb4c472d8
[gaim-migrate @ 601]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
445
diff
changeset
|
5 The plugins also have PLUGIN_LIBS which can be passed at make time. |
a26eb4c472d8
[gaim-migrate @ 601]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
445
diff
changeset
|
6 This makes things like #ifdef USE_APPLET and #ifdef USE_PERL much more |
a26eb4c472d8
[gaim-migrate @ 601]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
445
diff
changeset
|
7 reliable. |
a26eb4c472d8
[gaim-migrate @ 601]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
445
diff
changeset
|
8 |
391 | 9 version 0.9.20: |
10 It's 3 am the night before finals, it's obviously a good time to hack | |
11 gaim. | |
12 | |
425
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
13 This became quite long, and if you don't want to read it all, here's |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
14 the important stuff summed up: |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
15 - 9 new events (see SIGNALS file for more details) |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
16 - int gaim_plugin_init(void *) (no longer returns void, see error.c) |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
17 - void gaim_plugin_unload(void *) (to allow plugin to remove itself) |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
18 - can only load 1 instance of the same plugin |
445
e4c34ca88d9b
[gaim-migrate @ 455]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
425
diff
changeset
|
19 - PLUGIN_LIBS for extra libraries for plugin |
425
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
20 |
391 | 21 The first thing to note is that there are about 9 new events plugins |
22 can attach to, most of them dealing with chat, since I know that was a | |
23 big thing that was missing. Please note that I was nice and decided to | |
24 tack these extra events onto the end of the enum, which means that | |
25 plugins do not have to be recompiled in order for them to still work. | |
26 | |
425
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
27 The big change is that gaim_plugin_init no longer returns void, but |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
28 int. If it returns 0+, gaim interprets this as there being no error, |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
29 and continues with loading as normal. (This should be backwards- |
398
59d97cd251ff
[gaim-migrate @ 408]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
394
diff
changeset
|
30 compatible: returning 0/1 is the equivalent of returning void.) If it |
59d97cd251ff
[gaim-migrate @ 408]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
394
diff
changeset
|
31 returns a number less than 0, there was an error loading detected by |
394
f73dc7d32ede
[gaim-migrate @ 404]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
392
diff
changeset
|
32 the plugin. At that point, gaim will try to clean things up by removing |
f73dc7d32ede
[gaim-migrate @ 404]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
392
diff
changeset
|
33 any callbacks that have been added by the plugin. It will then try to |
f73dc7d32ede
[gaim-migrate @ 404]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
392
diff
changeset
|
34 call the plugin's gaim_plugin_error function, if there is one. The |
f73dc7d32ede
[gaim-migrate @ 404]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
392
diff
changeset
|
35 function should take an int (the int returned by gaim_plugin_init) and |
f73dc7d32ede
[gaim-migrate @ 404]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
392
diff
changeset
|
36 return a char*. If the char* is not NULL, it is displayed by gaim as an |
f73dc7d32ede
[gaim-migrate @ 404]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
392
diff
changeset
|
37 error message. The plugin is then unloaded and closed and life goes |
f73dc7d32ede
[gaim-migrate @ 404]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
392
diff
changeset
|
38 back to normal. If any of that was confusing, it was confusing to me, |
f73dc7d32ede
[gaim-migrate @ 404]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
392
diff
changeset
|
39 too. I added a plugin, error.c, which should help clear things up. |
392
df5127560034
[gaim-migrate @ 402]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
391
diff
changeset
|
40 |
425
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
41 Another big thing to note is that plugins can unload themselves. A good |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
42 example of why this is useful is a ticker plugin. If the user closes |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
43 the ticker window, they obviously want the plugin to be unloaded. Gaim |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
44 has no way of knowing that; therefore, the plugin must tell gaim that |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
45 it is to be unloaded. To have a plugin unload itself, simply call |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
46 gaim_plugin_unload(void *) (the void* is the handle passed to |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
47 gaim_plugin_init). Because you are explicitly asking to be removed, |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
48 gaim assumes that you have done any cleanup already, and so does not |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
49 call gaim_plugin_remove. Rather, it simply removes your callbacks and |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
50 unloads the plugin. (There is some trickery to this. Think about it: |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
51 your plugin calls the function, your plugin is unloaded, and execution |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
52 returns to your plugin, which no longer exists. This would cause a |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
53 segfault if it behaved exactly as described. Instead, the plugin is |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
54 removed from the list of plugins, and removed 5 seconds later. By then |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
55 the plugin should be effectively gone, though still in memory.) |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
56 |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
57 In previous versions of gaim, you could load multiple copies of the |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
58 same plugin. This is no longer the case. The reason for this was that |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
59 there were not two instances of the plugin in memory; rather, one copy |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
60 and two structures representing the same plugin. Then, the callbacks |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
61 would be called twice (since the plugin would most likely act the same |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
62 across multiple instances), and when one was unloaded, all callbacks |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
63 for both instances would be removed. Rather than deal with two copies |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
64 of the same plugin, it is easier and cleaner to only handle one. |
ae7c762775cd
[gaim-migrate @ 435]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
404
diff
changeset
|
65 |
445
e4c34ca88d9b
[gaim-migrate @ 455]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
425
diff
changeset
|
66 Sometimes it's necessary to link a plugin with libraries other than the |
e4c34ca88d9b
[gaim-migrate @ 455]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
425
diff
changeset
|
67 ones needed for GTK. Before, it was necessary to modify the Makefile to |
e4c34ca88d9b
[gaim-migrate @ 455]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
425
diff
changeset
|
68 do so (which was usually messy since it's generated by GNU automake). |
e4c34ca88d9b
[gaim-migrate @ 455]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
425
diff
changeset
|
69 Now, you can simply set the environment variable PLUGIN_LIBS to be the |
e4c34ca88d9b
[gaim-migrate @ 455]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
425
diff
changeset
|
70 extra libraries you want to link in. For example, to link plugin.c with |
e4c34ca88d9b
[gaim-migrate @ 455]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
425
diff
changeset
|
71 the math library, you can run the command |
e4c34ca88d9b
[gaim-migrate @ 455]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
425
diff
changeset
|
72 PLUGIN_LIBS=-lm make plugin.so |
e4c34ca88d9b
[gaim-migrate @ 455]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
425
diff
changeset
|
73 To link with multiple plugins, make sure to indicate spaces, e.g. |
e4c34ca88d9b
[gaim-migrate @ 455]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
425
diff
changeset
|
74 PLUGIN_LIBS='-lm -lcrypt' make encrypt.so |
e4c34ca88d9b
[gaim-migrate @ 455]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
425
diff
changeset
|
75 |
392
df5127560034
[gaim-migrate @ 402]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
391
diff
changeset
|
76 There is a new event, event_quit, which signifies that gaim has exited |
df5127560034
[gaim-migrate @ 402]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
391
diff
changeset
|
77 correctly (i.e. didn't segfault). Also, after this event is called, all |
404
3d94cc1dc424
[gaim-migrate @ 414]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
398
diff
changeset
|
78 plugins are removed, and their gaim_plugin_remove function is called. |
392
df5127560034
[gaim-migrate @ 402]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
391
diff
changeset
|
79 This behavior is different from previous versions; however, it is the |
df5127560034
[gaim-migrate @ 402]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
391
diff
changeset
|
80 proper way of doing things, and should have no effect on current |
df5127560034
[gaim-migrate @ 402]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
391
diff
changeset
|
81 plugins. The reason event_quit exists despite plugins being removed at |
df5127560034
[gaim-migrate @ 402]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
391
diff
changeset
|
82 quit is because a plugin can be removed without gaim quitting. They are |
df5127560034
[gaim-migrate @ 402]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
391
diff
changeset
|
83 distinctly separate events. |
df5127560034
[gaim-migrate @ 402]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
391
diff
changeset
|
84 |
df5127560034
[gaim-migrate @ 402]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
391
diff
changeset
|
85 The new events mean that some versions of gaim have certain events, |
df5127560034
[gaim-migrate @ 402]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
391
diff
changeset
|
86 others don't. The thing I find fascinating though is that even if a |
df5127560034
[gaim-migrate @ 402]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
391
diff
changeset
|
87 plugin is compiled for a later version, it will still be backwards- |
df5127560034
[gaim-migrate @ 402]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
391
diff
changeset
|
88 compatible, even if it makes use of the newer events. The reason why |
df5127560034
[gaim-migrate @ 402]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
391
diff
changeset
|
89 is the names of the events are stored as integers, and those integers |
df5127560034
[gaim-migrate @ 402]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
391
diff
changeset
|
90 will never match an event in a prior version. This means you don't |
df5127560034
[gaim-migrate @ 402]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
391
diff
changeset
|
91 have to worry about which version the person is using, only which |
df5127560034
[gaim-migrate @ 402]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
391
diff
changeset
|
92 version the person is compiling against. For simplicity's sake, please |
df5127560034
[gaim-migrate @ 402]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
391
diff
changeset
|
93 assume people are compiling against the latest version. For |
df5127560034
[gaim-migrate @ 402]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
391
diff
changeset
|
94 practicality's sake, VERSION is #define'd to be the version you're |
df5127560034
[gaim-migrate @ 402]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
391
diff
changeset
|
95 compiling against, starting with 0.9.20. Prior versions do not have |
df5127560034
[gaim-migrate @ 402]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
391
diff
changeset
|
96 this defined in the standard plugin Makefile. |