view PROGRAMMING_NOTES @ 5231:b5f912af996e

[gaim-migrate @ 5601] i missed that rant when i looked at this the first 2 times. it was MY fault that the original es.po patch, submitted to debian, was not committed. i was not yet on the debian Gaim PTS, and had committed a translation update that broke the one submitted to debian just before i was notified that the debian submitted patch existed. any rant about that patch not being accepted should be directed to/at me not robot101. i addressed this once in a reply to the aforementioned patch, but apparently the submitter is too dense to figure it out. hopefully this is the last time i will have to address the fact that because i get translation patches from a number of different sources, i sometimes break one patch by applying a different one. 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)