annotate PROGRAMMING_NOTES @ 9190:9e3289499977

[gaim-migrate @ 9985] Patch by Evan Schoenberg. The disconnected UI op was called twice on connection errors. Now it is only called once. He describes it as follows: "Currently, the UI's disconnected callback is called twice when there is a connection error. First, it is called by gaim_connection_error(). Then, gaim_connection_disconnect_cb is called, leading to a call to gaim_connection_set_state() at which point the gc's state is set to GAIM_DISCONNECTED. Finally, the UI's disconnected callback is called once the state is set to GAIM_DISCONNECTED. The call in gaim_connection_error() is incorrect; there is no need to manually call the UI's disconnected callback. It causes really nasty problems for smart reconnection handling and is wasteful. :)" 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)