view PROGRAMMING_NOTES @ 4834:0ed37c803503

[gaim-migrate @ 5159] Bjoern Voigt writes: "I resolved the conflicts and added a new patch in the attachment. Besides this updates | I have updated the German translation and fixed some i18n bugs. Most | interesting is, that the new Gaim main menu now can be translated. As | a quick fix I added a new item_factory_translate_func function to | buddy.c. Now there are 2 static item_factory_translate_func functions | in buddy.c and gtkconv.c. If you are interested, I can clean this next | time (only one global function in gaim.h and utils.c). | The other i18n fixed mark some strings as translatable, for instance | in the "Get Buddy Info" message boxes. I included an i18n fix for src/util.c:for sec_to_text (seconds to text)." 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)