view PROGRAMMING_NOTES @ 14141:5f656a0a82b7

[gaim-migrate @ 16783] Whitespace and warning fixes: gtkaccount.c: In function ?icon_select_cb?: gtkaccount.c:289: warning: passing argument 1 of ?gaim_gtk_buddy_icon_chooser_new? from incompatible pointer type gtkaccount.c:289: warning: passing argument 2 of ?gaim_gtk_buddy_icon_chooser_new? from incompatible pointer type gtkstatusbox.c: In function ?icon_box_press_cb?: gtkstatusbox.c:951: warning: passing argument 2 of ?gaim_gtk_buddy_icon_chooser_new? from incompatible pointer type gtkstatusbox.c:951: warning: ISO C90 forbids mixed declarations and code gtkstatusbox.c: In function ?icon_box_enter_cb?: gtkstatusbox.c:960: warning: passing argument 1 of ?gtk_image_set_from_pixbuf? from incompatible pointer type gtkstatusbox.c: In function ?icon_box_leave_cb?: gtkstatusbox.c:968: warning: passing argument 1 of ?gtk_image_set_from_pixbuf? from incompatible pointer type gtkstatusbox.c: In function ?gtk_gaim_status_box_size_allocate?: gtkstatusbox.c:1183: warning: passing argument 1 of ?gtk_image_set_from_pixbuf? from incompatible pointer type gtkstatusbox.c: In function ?gtk_gaim_status_box_set_buddy_icon?: gtkstatusbox.c:1338: warning: passing argument 1 of ?gtk_image_set_from_pixbuf? from incompatible pointer type gtkutils.c: In function ?gaim_gtk_convert_buddy_icon?: gtkutils.c:2463: warning: ISO C90 forbids mixed declarations and code 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)