view PROGRAMMING_NOTES @ 16034:baf76a49d199

(16:27:44) Mirv: LSchiere2: actually, %s/Gaim/Pidgin/ , there's 5 instances (16:28:05) LSchiere2: you are the translator? (16:28:15) Mirv: LSchiere2: yep. (16:28:25) LSchiere2: there were 63 instances (16:28:28) Mirv: (as you can see in whois) (16:28:41) Mirv: LSchiere2: what.. did you use upper-case G? (16:28:42) LSchiere2: ah, cool (16:28:49) LSchiere2: yes (16:29:00) Mirv: ah, yes and some are in commented out translation in the end

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)