annotate PROGRAMMING_NOTES @ 15279:fbfdbde296b0

[gaim-migrate @ 18069] Patch from Graham Booker which prevents the following crash: Thread 0 Crashed: 0 Libgaim 0x0fbbbe3a flap_connection_send + 17 (flap_connection.c:977) 1 Libgaim 0x0fbb2c04 aim_srv_setidle + 61 (family_oservice.c:588) 2 Libgaim 0x0fb1470e set_account_unidle + 122 (idle.c:93) 3 Libgaim 0x0fafd75c gaim_signal_emit_vargs + 234 (signals.c:485) 4 Libgaim 0x0fafd7c4 gaim_signal_emit + 90 (signals.c:435) 5 Libgaim 0x0fb1da57 gaim_connection_destroy + 186 (connection.c:180) 6 Libgaim 0x0fb2cb46 gaim_account_disconnect + 119 (account.c:1017) 7 Libgaim 0x0fb1d3ee gaim_connection_disconnect_cb + 37 (connection.c:425) 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)