view PROGRAMMING_NOTES @ 9387:bcdf6a530d41

[gaim-migrate @ 10195] (20:11:29) nosnilmot: s/To/Too/ in Chip's news entry :) (20:11:44) LSchiere: no, i'm not changing that one. he can fix his own grammer and spelling ;-) (20:11:53) LSchiere: then someone besides me can have spelling mistakes on file (20:11:55) nosnilmot: but he had to go... :) (20:11:58) SimGuy: LSchiere: I think you had a spelling error (20:12:04) LSchiere: see? someone has to keep me company (20:12:05) SimGuy: unless someone told you already (20:12:09) LSchiere: nope (20:12:32) SimGuy: s/writters/writers/ (20:12:38) LSchiere: *sigh* (20:12:56) nosnilmot: SimGuy: I don't know about you, but I'd be happy as a writter (20:13:16) aatharuv: LSchiere: oh, also s/Zepher/Zephyr/ :-) (20:13:23) nosnilmot: oh yeah, that too :) (20:13:24) LSchiere: where is that? (20:13:26) SimGuy: yeah, but I didn't contribute anything meaningful, so I don't get to be a writter, therefore I must take the honor from you (20:13:29) nosnilmot: ChangeLog (20:13:32) LSchiere: oh 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)