view PROGRAMMING_NOTES @ 4594:a2c95c0d7333

[gaim-migrate @ 4879] I need the ack thing so Gaim will be able to exchange files with MacAIM clizients. I think. The other changes makes gaim call gaim_xfer_end after reading in the # of bytes in the file. Previously it only called gaim_xfer_end when the other end closed the socket. I could write an oscar_xfer_read function that does this, but I would basically be duplicating all of gaim_xfer_read, and I thought this was a little clean. Chipster can lay the smack down on me if this is too ugly. I figured some of this will have to change if multiple files per transfer is ever supported. Gaim doesn't provide support for that [insert "support" related joke here]. 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)