view PROGRAMMING_NOTES @ 4242:cf19d8102b34

[gaim-migrate @ 4492] John B. Silvestri (silvestrij) writes: "This adds a --longhelp (-H) option to gaim-remote, which details its usage (aim?goim,gochat, and addbuddy)." he further writes: "Now follows Sean's request of being `gaim-remote -h uri` or `gaim-remote --help uri` This is version 3.11.\n"), name); luke writes that this patch is needed because _i_ can't remember how to use the gaim-remote stuff, much less help others to do so, and what use is a gaim-remote that only 2 people know how to use? 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)