annotate PROGRAMMING_NOTES @ 5145:fc09679bffbe

[gaim-migrate @ 5509] (21:17:26) KingAnt: The thing Luke committed a few hours ago. I think it makes it so Buddies->Get User Info gets the info of whoever is highlighted in the buddy list instead of always opening the "enter screenname" box (21:18:25) LSchiere: KingAnt: correct, as the commit message states, that's exactly what it does (21:18:29) Robot101: KingAnt: the menus don't act on buddies in the list (21:18:34) Robot101: the buttons do, but the menus don't (21:18:40) Robot101: so now it's inconsistent. (21:18:47) KingAnt: That's what I was thinking (21:18:51) Robot101: revert. (21:18:53) LSchiere: kay (21:19:09) KingAnt: Well, I was thinking more... if I want to get info of someone who's not on my buddy list, I shouldn't have to unclick on people in the buddy list (21:19:25) Robot101: that too! (21:19:37) LSchiere: i always forget the menu, so that didn't occur to me: i'm used to unclicking committer: Tailor Script <[e-mail]>

Notes on keeping GAIM OS independant
------------------------------------

General
-------
- Use G_DIR_SEPARATOR_S and G_DIR_SEPARATOR for paths

- Use g_getenv, g_snprintf, g_vsnprintf

- Use gaim_home_dir instead of g_get_home_dir or g_getenv("HOME")

- Make sure when including win32dep.h that it is the last header to
  be included.

- Open binary files when reading or writing with 'b' mode.

  e.g: fopen("somefile", "wb");

  Not doing so will open files in windows using defaut translation mode. 
  i.e. newline -> <CR><LF>

Paths
-----

- DATADIR, LOCALEDIR & LIBDIR are defined in wingaim as functions.
  Doing the following will therefore break the windows build:

  printf("File in DATADIR is: %s\n", DATADIR G_DIR_SEPARATOR_S "pic.png");

  it should be:

  printf("File in DATADIR is: %s%s%s\n", DATADIR, G_DIR_SEPARATOR_S, "pic.png");

PLUGINS & PROTOS
----------------

- G_MODULE_EXPORT all functions which are to be accessed from outside the
  scope of its "dll" or "so". (E.G. gaim_plugin_init)

- G_MODULE_IMPORT all global variables which are located outside your
  dynamic library. (E.G. connections)

  (Not doing this will cause "Memory Access Violations" in Win32)