view PROGRAMMING_NOTES @ 10844:d1f7821c09f4

[gaim-migrate @ 12516] sf patch #1185455, from Richard Laager "I realize gtk_key_pressed_cb is a work-around hack, but given the stance of supporting GTK+ 2.0, we're going to be stuck with it for a while. There's no need to connect this signal for new versions of GTK+. Also, the logic in the hack is quite weird and there's some dead code. Without looking at CVS logs, I can only assume this is because it went through lots of changes. This patch makes it more clear what's going on and will make it easier to remove this code when GTK+ 2.2 support is eventually deprecated at some point in the distant future." 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)