annotate PROGRAMMING_NOTES @ 16490:15f79c0cd0b9

Finally fix SILC fully, now that i have HAVE_SILCMIME_H defined.
author Daniel Atallah <daniel.atallah@gmail.com>
date Fri, 27 Apr 2007 04:04:04 +0000
parents e8f8d19bf3ee
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
16188
e8f8d19bf3ee Replace an instance of GAIM with "Pidgin, Finch, and libpurple"
Richard Laager <rlaager@wiktel.com>
parents: 16176
diff changeset
1 Notes on keeping Pidgin, Finch, and libpurple OS independant
e8f8d19bf3ee Replace an instance of GAIM with "Pidgin, Finch, and libpurple"
Richard Laager <rlaager@wiktel.com>
parents: 16176
diff changeset
2 ------------------------------------------------------------
3630
9682c0e022c6 [gaim-migrate @ 3753]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
3
9682c0e022c6 [gaim-migrate @ 3753]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
4 General
9682c0e022c6 [gaim-migrate @ 3753]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
5 -------
9682c0e022c6 [gaim-migrate @ 3753]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
6 - Use G_DIR_SEPARATOR_S and G_DIR_SEPARATOR for paths
9682c0e022c6 [gaim-migrate @ 3753]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
7
9682c0e022c6 [gaim-migrate @ 3753]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
8 - Use g_getenv, g_snprintf, g_vsnprintf
9682c0e022c6 [gaim-migrate @ 3753]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
9
16188
e8f8d19bf3ee Replace an instance of GAIM with "Pidgin, Finch, and libpurple"
Richard Laager <rlaager@wiktel.com>
parents: 16176
diff changeset
10 - Use purple_home_dir instead of g_get_home_dir or g_getenv("HOME")
3630
9682c0e022c6 [gaim-migrate @ 3753]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
11
3713
e3a8baffcc24 [gaim-migrate @ 3846]
Herman Bloggs <hermanator12002@yahoo.com>
parents: 3630
diff changeset
12 - Make sure when including win32dep.h that it is the last header to
e3a8baffcc24 [gaim-migrate @ 3846]
Herman Bloggs <hermanator12002@yahoo.com>
parents: 3630
diff changeset
13 be included.
3630
9682c0e022c6 [gaim-migrate @ 3753]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
14
4482
59ff9d0b7b85 [gaim-migrate @ 4757]
Herman Bloggs <hermanator12002@yahoo.com>
parents: 4062
diff changeset
15 - Open binary files when reading or writing with 'b' mode.
59ff9d0b7b85 [gaim-migrate @ 4757]
Herman Bloggs <hermanator12002@yahoo.com>
parents: 4062
diff changeset
16
59ff9d0b7b85 [gaim-migrate @ 4757]
Herman Bloggs <hermanator12002@yahoo.com>
parents: 4062
diff changeset
17 e.g: fopen("somefile", "wb");
59ff9d0b7b85 [gaim-migrate @ 4757]
Herman Bloggs <hermanator12002@yahoo.com>
parents: 4062
diff changeset
18
16176
83ec0b408926 Beat some older documentation into submission.
Richard Laager <rlaager@wiktel.com>
parents: 9619
diff changeset
19 Not doing so will open files in windows using default translation mode.
4482
59ff9d0b7b85 [gaim-migrate @ 4757]
Herman Bloggs <hermanator12002@yahoo.com>
parents: 4062
diff changeset
20 i.e. newline -> <CR><LF>
59ff9d0b7b85 [gaim-migrate @ 4757]
Herman Bloggs <hermanator12002@yahoo.com>
parents: 4062
diff changeset
21
4062
e074172f4a41 [gaim-migrate @ 4272]
Herman Bloggs <hermanator12002@yahoo.com>
parents: 3713
diff changeset
22 Paths
e074172f4a41 [gaim-migrate @ 4272]
Herman Bloggs <hermanator12002@yahoo.com>
parents: 3713
diff changeset
23 -----
e074172f4a41 [gaim-migrate @ 4272]
Herman Bloggs <hermanator12002@yahoo.com>
parents: 3713
diff changeset
24
16188
e8f8d19bf3ee Replace an instance of GAIM with "Pidgin, Finch, and libpurple"
Richard Laager <rlaager@wiktel.com>
parents: 16176
diff changeset
25 - DATADIR, LOCALEDIR & LIBDIR are defined as functions in the win32 build
4062
e074172f4a41 [gaim-migrate @ 4272]
Herman Bloggs <hermanator12002@yahoo.com>
parents: 3713
diff changeset
26 Doing the following will therefore break the windows build:
e074172f4a41 [gaim-migrate @ 4272]
Herman Bloggs <hermanator12002@yahoo.com>
parents: 3713
diff changeset
27
e074172f4a41 [gaim-migrate @ 4272]
Herman Bloggs <hermanator12002@yahoo.com>
parents: 3713
diff changeset
28 printf("File in DATADIR is: %s\n", DATADIR G_DIR_SEPARATOR_S "pic.png");
e074172f4a41 [gaim-migrate @ 4272]
Herman Bloggs <hermanator12002@yahoo.com>
parents: 3713
diff changeset
29
e074172f4a41 [gaim-migrate @ 4272]
Herman Bloggs <hermanator12002@yahoo.com>
parents: 3713
diff changeset
30 it should be:
e074172f4a41 [gaim-migrate @ 4272]
Herman Bloggs <hermanator12002@yahoo.com>
parents: 3713
diff changeset
31
e074172f4a41 [gaim-migrate @ 4272]
Herman Bloggs <hermanator12002@yahoo.com>
parents: 3713
diff changeset
32 printf("File in DATADIR is: %s%s%s\n", DATADIR, G_DIR_SEPARATOR_S, "pic.png");
e074172f4a41 [gaim-migrate @ 4272]
Herman Bloggs <hermanator12002@yahoo.com>
parents: 3713
diff changeset
33
3630
9682c0e022c6 [gaim-migrate @ 3753]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
34 PLUGINS & PROTOS
9682c0e022c6 [gaim-migrate @ 3753]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
35 ----------------
9682c0e022c6 [gaim-migrate @ 3753]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
36
9682c0e022c6 [gaim-migrate @ 3753]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
37 - G_MODULE_EXPORT all functions which are to be accessed from outside the
16188
e8f8d19bf3ee Replace an instance of GAIM with "Pidgin, Finch, and libpurple"
Richard Laager <rlaager@wiktel.com>
parents: 16176
diff changeset
38 scope of its "dll" or "so". (E.G. purple_plugin_init)
3630
9682c0e022c6 [gaim-migrate @ 3753]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
39
9682c0e022c6 [gaim-migrate @ 3753]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
40 - G_MODULE_IMPORT all global variables which are located outside your
9682c0e022c6 [gaim-migrate @ 3753]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
41 dynamic library. (E.G. connections)
9682c0e022c6 [gaim-migrate @ 3753]
Rob Flynn <gaim@robflynn.com>
parents:
diff changeset
42
16188
e8f8d19bf3ee Replace an instance of GAIM with "Pidgin, Finch, and libpurple"
Richard Laager <rlaager@wiktel.com>
parents: 16176
diff changeset
43 (Not doing this will cause "Memory Access Violations" in win32)