annotate PROGRAMMING_NOTES @ 11015:45ceaa1ccc6e

[gaim-migrate @ 12884] (10:37:16) rizzo: wtf that silc ft patch still not in (10:38:45) LSchiere2: rizzo: what are you talking about (10:39:03) rizzo: gaim silc won't build against silc 1.0 (10:39:16) rizzo: has been an issue since gaim 1.3.0 (10:39:29) LSchiere2: I don't recall the patch (10:39:32) rizzo: http://www.gentoo.org/cgi-bin/viewcvs.cgi/*checkout*/net-im/gaim/files/gaim-1.3.0-silc-ft.patch (10:39:41) rizzo: I thought I got it from you guys (10:39:46) LSchiere2: is it in our tracker? (10:39:51) rizzo: I don't see it (10:40:05) ***rizzo digs up his bug (10:40:57) rizzo: LSchiere2: I think pekka emailed it to -packagers list (10:41:01) rizzo: http://bugs.gentoo.org/show_bug.cgi?id=92251 (10:41:33) rizzo: from his email: (10:41:33) rizzo: Enclosed a small patch that makes the Gaim compile with SILC Toolkit 1.0. (10:41:33) rizzo: We had unfortunate timing when I released 1.0 at the same time you (10:41:33) rizzo: released Gaim 1.3 so I didn't have time to make the patch for 1.3. (10:41:33) rizzo: Anyway, the patch removes code that really isn't supposed to even be (10:41:33) rizzo: there... 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)