PROGRAMMING_NOTES

   1 Notes on keeping GAIM OS independant
   2 ------------------------------------
   3
   4 General
   5 -------
   6 - Use G_DIR_SEPARATOR_S and G_DIR_SEPARATOR for paths
   7
   8 - Use g_getenv, g_snprintf, g_vsnprintf
   9
  10 - Use gaim_home_dir instead of g_get_home_dir or g_getenv("HOME")
  11
  12 - Make sure when including win32dep.h that it is the last header to
  13   be included.
  14
  15 - Open binary files when reading or writing with 'b' mode.
  16
  17   e.g: fopen("somefile", "wb");
  18
  19   Not doing so will open files in windows using defaut translation mode.
  20   i.e. newline -> <CR><LF>
  21
  22 Paths
  23 -----
  24
  25 - DATADIR, LOCALEDIR & LIBDIR are defined in wingaim as functions.
  26   Doing the following will therefore break the windows build:
  27
  28   printf("File in DATADIR is: %s\n", DATADIR G_DIR_SEPARATOR_S "pic.png");
  29
  30   it should be:
  31
  32   printf("File in DATADIR is: %s%s%s\n", DATADIR, G_DIR_SEPARATOR_S, "pic.png");
  33
  34 PLUGINS & PROTOS
  35 ----------------
  36
  37 - G_MODULE_EXPORT all functions which are to be accessed from outside the
  38   scope of its "dll" or "so". (E.G. gaim_plugin_init)
  39
  40 - G_MODULE_IMPORT all global variables which are located outside your
  41   dynamic library. (E.G. connections)
  42
  43   (Not doing this will cause "Memory Access Violations" in Win32)