view PROGRAMMING_NOTES @ 4070:6efe00ee7de8

[gaim-migrate @ 4282] Just shuffling around some version stuff. I'm planning on changing things to be aim 5.1ish, but I want to do it in a separate patch, so it will be easy to unpatch if there are problems. Also, I figured out what those PleaseUpgrade000 buddies are. Like, if you add "[e-mail]" to your buddy list, then sign on with an aim client that advertises an old version of the ssi protocol (eg. gaim), then the server replaces "[e-mail]" with "PleaseUpgrade000" on the fly. It might replace other screen names, as well, I'm not exactly sure. Uh, so that problem should hopefully go away when I change the ssi family to 4, along with change other versions to be 5.1ish. Ribbit. 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)