view PROGRAMMING_NOTES @ 10372:618a330c0260

[gaim-migrate @ 11595] (17:31:55) SimGuy: LSchiere2: because the person that redid it didn't think to move the CPWs since they only have one field (17:32:05) SimGuy: the others are all multiple pieces of data (17:32:07) LSchiere2: its confusing and inconsistent now (17:48:00) SimGuy: LSchiere2: http://kevin.simguy.net:8888/patches/gaim-cpw-structify.diff (17:48:03) SimGuy: that should apply to both (17:48:16) SimGuy: the patch to util.c just fixes a spelling error in a comment I fixed like 6 weeks ago (17:48:59) SimGuy: er, both being HEAD and oldstatus 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)