annotate PROGRAMMING_NOTES @ 4082:4b04ecb3eb97

[gaim-migrate @ 4297] (22:54:38) Robot101: * Make sure prefs are saved before plugins are removed, and not afterwards. (22:54:59) Robot101: * Move do_quit() into aim.c and make sure everything appropriate uses it. (22:55:12) Robot101: * Remove duplicated cancel_login for closing the main window, use do_quit instead. (22:55:49) Robot101: * Remove uncalled code pertaining to closing the about window from when it was called via gaim -v. (22:56:06) LSchiere: what's this in sounds? (22:56:29) Robot101: * Add correct ifdefs to prefs so only compiled-in sound methods are shown. (22:56:34) LSchiere: if you broke my sounds... (22:57:07) Robot101: * Remove unused sound order data, and clarify comments and debug output. (22:57:56) Robot101: * Remove duplicated check which is performed at the start of play_file anyway. (22:58:03) Robot101: that's the lot 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)