annotate PROGRAMMING_NOTES @ 8146:596c64a2a2d0

[gaim-migrate @ 8854] " (16:36:05) Me: Hi Sean (16:36:21) Me: Mind if I e-mail you a little COPYRIGHT related diff? (16:37:17) Sean: Yes, I do! (16:37:22) Sean: How dare you consider e-mailing me patches? (16:37:26) Sean: seriously, now. (16:37:32) Me: (16:38:42) Me: Look at my webcam: [URL to patch, now attached to this message] (16:43:03) Sean: Have Luke commit it for me (16:43:17) Sean: I won't be around until late tomorrow night. (16:46:53) Me: ahh, k It's a pretty straightforward deal - I think I mentioned this the other day: .[c|h] files in src/ should have the generic copyright. Also, giving Marc Mulcahy credit for the accessibility stuff. Cheers, John [Silvestri]" except that i'd already given Marc credit 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)