annotate PROGRAMMING_NOTES @ 4194:9325df841a40

[gaim-migrate @ 4425] This is what happens when our cable goes down for a few hours. Dear Time Warner, Speaking as a customer, you suck. -Your friendly neighborhood ant So like, I went through and fixed pretty much every call to debug_printf, so that it uses the correct %whatever's. I also changed a lot of va_arg stuff to make it more uniform. The va_arg man page says that the return value does not need to be cast, but if this is not true on all operating systems, somebody lemme know and I'll fix it. Oh, the few compile warnings that aren't fixed interfere with my SSI stuff. I'll commit fixes for that along with the ICQ SSI stuff. I'm trying to get it done before school starts on Thursday. Keyword: Trying. 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.

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)