annotate PROGRAMMING_NOTES @ 4609:71b27122c8a6

[gaim-migrate @ 4897] [21:48:32] <shadows> uhhh.... gaim is still crashing when clicking okay button twice in New IM screenname prompe [21:48:41] <shadows> s/prompe/prompt/ [21:49:03] <shadows> what the hell guys? it's one line of code to comment out to make the quick fix [21:51:38] <LSchiere0> that's a fun backtrace shadows [21:51:58] <LSchiere0> shadows: what would that line be? [21:52:41] <shadows> src/dialogs.c [21:52:42] <shadows> lemme check [21:53:32] <-- LSchiere has quit ("Download Gaim [http://gaim.sourceforge.net/]") [21:54:11] <shadows> line 570 [21:54:25] <shadows> it needs to be commented out with a note asking for a proper solution [21:54:32] <shadows> otherwise, as-is, it results in a double-free 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");

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)