view PROGRAMMING_NOTES @ 9927:fb08a0973b3e

[gaim-migrate @ 10819] " Currently, the "loggedin" parameter of serv_got_update() is of type int and used as a boolean. I updated it and all references to be gboolean. I also noticed that "presence" in gaim_blist_update_buddy_presence() is also a really boolean. of whether or not the buddy is currently online. There seemed to be some confusion, particularly in the silc plugin which tried to use a GaimBuddyPresenceState (coincidentally (or perhaps not) GAIM_BUDDY_OFFLINE and GAIM_BUDDY_ONLINE work as FALSE and TRUE respectively). The value passed to gaim_blist_update_buddy_presence() doesn't directly become the buddy presence state and this patch helps avoid confusion in this respect." --Daniel Atallah 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)