annotate PROGRAMMING_NOTES @ 5226:a2199ef77cbc

[gaim-migrate @ 5596] Javier Fern?ndez-Sanguino Pe?a writes: "Please find adjointed a revised spanish translation for the gaim version available at CVS. I have made a lot of effort in order to make it homogeneus in the translation (the same term was translated in different ways) and added missing translations (or updated fuzzy ones). Please add this to CVS. Thanks Javi PS: I'm cc:ing the last translator too since gaim's po files are not in the GNU's translation project. PPS: I'm sending a diff instead of the file since it's quite big, but feel free to ask for the whole file if needed." 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.

- Open binary files when reading or writing with 'b' mode.

  e.g: fopen("somefile", "wb");

  Not doing so will open files in windows using defaut translation mode. 
  i.e. newline -> <CR><LF>

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)