view PROGRAMMING_NOTES @ 9419:72013e9ba6d1

[gaim-migrate @ 10234] (22:48:24) LSchiere: marv: *sigh* (22:48:55) marv: Hellmark: now quit upsetting luke (22:49:06) LSchiere: who is upsetting me? (22:49:32) marv: LSchiere: Hellmark? or else why are you sighing? (22:49:42) LSchiere: marv: you're comment from several hours ago (22:49:49) LSchiere: where you mentioned other flaws in that patch (22:50:03) KingAnt: It's no Hope Diamond, that's for sure (22:51:07) marv: LSchiere: huh? what patch and other problems? (22:52:45) LSchiere: (20:07:55) marv: LSchiere: not only does that patch have // comments, it has references to "GAIM" in it (22:52:54) marv: oh *that* patch 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)