Mercurial > pidgin.yaz
annotate PROGRAMMING_NOTES @ 6317:285444815c6a
[gaim-migrate @ 6816]
Updated the Doxygen configuration template.
committer: Tailor Script <tailor@pidgin.im>
author | Christian Hammond <chipx86@chipx86.com> |
---|---|
date | Sun, 27 Jul 2003 22:13:36 +0000 |
parents | 10b5ac17fdd6 |
children | da88e2cd5c53 |
rev | line source |
---|---|
3630 | 1 Notes on keeping GAIM OS independant |
2 ------------------------------------ | |
3 | |
4 General | |
5 ------- | |
6 - Use G_DIR_SEPARATOR_S and G_DIR_SEPARATOR for paths | |
7 | |
8 - Use g_getenv, g_snprintf, g_vsnprintf | |
9 | |
10 - Use gaim_home_dir instead of g_get_home_dir or g_getenv("HOME") | |
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 | 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 |
59ff9d0b7b85
[gaim-migrate @ 4757]
Herman Bloggs <hermanator12002@yahoo.com>
parents:
4062
diff
changeset
|
19 Not doing so will open files in windows using defaut translation mode. |
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 |
e074172f4a41
[gaim-migrate @ 4272]
Herman Bloggs <hermanator12002@yahoo.com>
parents:
3713
diff
changeset
|
25 - DATADIR, LOCALEDIR & LIBDIR are defined in wingaim as functions. |
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 |
5338
10b5ac17fdd6
[gaim-migrate @ 5714]
Herman Bloggs <hermanator12002@yahoo.com>
parents:
4482
diff
changeset
|
34 - When writing out paths to .gaimrc, use wgaim_escape_dirsep. This is necessary |
10b5ac17fdd6
[gaim-migrate @ 5714]
Herman Bloggs <hermanator12002@yahoo.com>
parents:
4482
diff
changeset
|
35 because the Windows dir separator '\' is being used to escape characters, when |
10b5ac17fdd6
[gaim-migrate @ 5714]
Herman Bloggs <hermanator12002@yahoo.com>
parents:
4482
diff
changeset
|
36 paths are read in from the .gaimrc file. |
10b5ac17fdd6
[gaim-migrate @ 5714]
Herman Bloggs <hermanator12002@yahoo.com>
parents:
4482
diff
changeset
|
37 |
3630 | 38 PLUGINS & PROTOS |
39 ---------------- | |
40 | |
41 - G_MODULE_EXPORT all functions which are to be accessed from outside the | |
42 scope of its "dll" or "so". (E.G. gaim_plugin_init) | |
43 | |
44 - G_MODULE_IMPORT all global variables which are located outside your | |
45 dynamic library. (E.G. connections) | |
46 | |
47 (Not doing this will cause "Memory Access Violations" in Win32) |