annotate PROGRAMMING_NOTES @ 5939:3014de25a8a4

[gaim-migrate @ 6379] Tim Ringenbach writes: "Here's a one liner to make gaim process YAHOO_SERVICE_CHATMSG packets, which are the same as normal YAHOO_SERVICE_MESSAGE packets, although they seem less featureful. The java client at chat.yahoo.com sends these. It receives the normal ones that gaim sends back fine however. Without this patch, IMs from the java yahoo chat client (possibly others?) just get ignored, which is probably a BadThing(TM)." I tend to agree that missing messages is a Bad Thing, and i know sean won't look at this patch. He'll probly just reverse it because he probly won't like it, but hopefully this way he might at least give some feedback, and maybe it will even stay in and do gaim some good. 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)