annotate PROGRAMMING_NOTES @ 8705:543b19a96ac5

[gaim-migrate @ 9458] " All preferences in gaim, except for "No sounds when you log in", are "positive" preferences. For consistency and to make it a bit easier to understand the preference I think they should all be "positive" preferences (there's probably something about this in some HIG somewhere too) This patch: 1. changes "No sounds when you log in" to "Sounds when you log in" 2. adds a helper function for renaming old boolean prefs and inverting their meaning (gaim_prefs_rename_boolean_toggle) 3. Moves existing renames from prefs.c to gtkprefs.c because they all reference gtk preferences. Default behaviour for new users remains the same (no sounds during log in), and existing user's preferences are migrated correctly." --Stu Tomlinson at one point possitive preferences were policy, i think we should maintain that policy. 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)