view PROGRAMMING_NOTES @ 5180:ea261ce36f0b

[gaim-migrate @ 5544] This is the wave of the future! Or something like that. Imma go eat cake later! Yay happy Easter!! Oh crap, I'm probably going to get in a lot of trouble now. Holiday references, y'know. They're illegal'n stuff. Or something like that. Personally, I like Christmas, but it's just too near my birthday, you know? The presents should be spread out. Birthdays are cool, sometimes. Halloween can be fun. Free candy! Society says I can't trick-or-treat anymore though, so I take my little sister around and get candy. Mmm.. Like stealing candy from a baby, except we share it. So it's not stealing, really. Voluntary. On her part, not mine, because it'd be stealing if it was my volunteering to take her candy. 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)