view PROGRAMMING_NOTES @ 5431:49f857d4b754

[gaim-migrate @ 5811] Tim Mooney (enchanter) writes: "In src/protocols/jabber/jabber.c, in the function `jabber_xfer_read', sscanf is called like such: sscanf(lenstr, "Content-Length: %d", &size); The problem is that `size' is of type `size_t', which is always the largest integral type size supported on your platform. That means on 32 bit platforms, it's either a long or an int (they're the same, 32 bits wide), and using %d as the format is ok. On 64 bit platforms, size_t will be a long, so using %d isn't sufficient. Since size_t is always as big as a `long' on every platform, even 32 bit platforms, there should be no problem switching the format to %ld. That will fix the problem for 64 bit platforms, and shouldn't cause any change on 32 bit platforms. Patch is attached. The problem was detected and warned about by the vendor compiler on the 64 bit platform I'm using, Tru64 UNIX." since it still compiles here, i'm putting this in 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");

- When writing out paths to .gaimrc, use wgaim_escape_dirsep. This is necessary
  because the Windows dir separator '\' is being used to escape characters, when
  paths are read in from the .gaimrc file.

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)