view PROGRAMMING_NOTES @ 8466:5562e8a74c94

[gaim-migrate @ 9196] " if the user has the pref set to false, we're still handling the key.. This is bad if for instance.. the user wants to do something like ctrl-shift-b-3 to display a superscripted 3. This patch makes the callback function return FALSE so that it will propergate down to the GtkTextView and give the user the desired behavior. i realized this will conflict when i finish 9, 10, and 11 on simguys list, and since i already had 11 done.. I'll just throw it in with this.. so here's the updated update patch ;) simguy's imhtml bug 11 is that the italic and underline buttons don't get toggled when you press ctrl-i ctrl-u this fixes that as well as my initial comment ;)" --Gary Kramlich 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)