view PROGRAMMING_NOTES @ 10039:cf02e7104706

[gaim-migrate @ 10998] A patch from rian hunter (chrono86): In src/protocols/oscar/oscar.c, in the function gaim_plugin_oscar_convert_to_best_encoding. g_convert is called multiple times. As its 5th argument g_convert takes a gsize* (8 byte), yet the argument to gaim_plugin_oscar_convert_to_best_encoding is a int* (4 byte). On LP64 machines this can allow the int* to be overwritten. This is especially bad on big endian 64-bit machines, causing the high 32-bits to be written into the low 32-bits of the int. This is a quick fix patch that lets g_convert deal with a gsize* pointer instead, then casting the value at gsize* to the value at the int*. A real fix would be to fix the aim_sendimext_args structure to have a gsize instead of an int (and all functions that use the aim_sendimext_args struct), and changing gaim_plugin_oscar_convert_to_best_encoding to accept a gsize*. of course, this woudl promote glib2 dependence, so that's probably not the best thing to do. 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)