view PROGRAMMING_NOTES @ 6686:0b286eace44c

[gaim-migrate @ 7212] Tim Ringenbach (marv_sf) writes: " Changed an isprint to a g_ascii_isprint in disabled debug code, this used to cause a crash back when it was enabled (invalid utf8). Made it only show buddies away when they really are (instead of thinking they're away just because they have a status message). Made it notice when people log on using the java chat client. Made it show how long idle buddies have been idle, and also notice that idle buddies with status messages are in fact idle. Eliminated duplicate code in yahoo_process_contact (which fixes some bugs, such as not showing the buddies status message when you just added them), and also made it show a message when a buddy denied your add (basicly deleting themselves from your server-side buddy list). We still don't do anything about this, however (should probably delete the buddy, or show him as offline or unathorized or something)." sean rocks. just in case you weren't sure, now you know. 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");

- When writing out paths to .gaimrc, use wgaim_escape_dirsep. This is necessary
  because the Windows dir separator '\' is being used to escape characters, when
  paths are read in from the .gaimrc file.

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)