annotate PROGRAMMING_NOTES @ 8310:cc3a65c19ecf

[gaim-migrate @ 9034] <nosnilmot> I think someone should remove buddy_chat.c from POTFILES.in === can you commit this fix? i cant do it from work... ----- Original Message ----- From: <[e-mail]> To: <[e-mail]> Sent: Thursday, February 19, 2004 10:25 AM Subject: 'nl.po' typo > Dear Rob, > > Yesterday i sent an e-mail to your sourceforge account. I bet you > never read it, so here it is again (in short ;)). First of all, love > Gaim, hate MSN Messenger 6.1, so I use it ;). When I got rather bored > I started reading the dutch translation (nl.po), to look for any > mistakes, and hey, I found one! Where it says > #~ msgid "State:" > #~ msgstr "Privincie:" > it should say: > #~ msgid "State:" > #~ msgstr "Provincie:" > Well, that was about all > > Roy Spliet. 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)