view PROGRAMMING_NOTES @ 4160:fcc6db86f5c7

[gaim-migrate @ 4389] Nicola's Lichtmaier (niqueco) writes: "Several things: I've added some "const"s here and there. I've declared some functions as "pure" or "const" (helps gcc to optimize the code). I've declared debug_printf so that gcc can check the printf format string (this makes visible several formatting bugs!) I've changed minor things in util.c (why having an useless extra call to g_strncasecmp?). And I've added some _() as usual. I hope some of this gets checked in, if not all." 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)