view PROGRAMMING_NOTES @ 9923:248c3f88ce99

[gaim-migrate @ 10815] (14:24:22) datallah: LSchiere2: http://www.butfer.com/gaim-patches/log_filename_escaping.patch deals with creating logs for screennames that have characters that are not valid for filenames (14:25:34) datallah: i may write a conversion script for existing log files (particularly because it will cause all irc and yahoo chats not to be found) (14:25:49) datallah: oh.. not irc chats... only yahoo chats (14:26:10) LSchiere2: can yahoo chats be found now? (14:26:35) datallah: yeah... they all have a ':' in them which is not a valid filename character in win32 (14:26:51) LSchiere2: i see. so they can be found on unix but not on win32 (14:27:51) datallah: LSchiere2: yeah, as far as i know 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)