view PROGRAMMING_NOTES @ 14764:f0292b71104b

[gaim-migrate @ 17521] Fix a couple of issues I ran into while running make distcheck. It still isn't successfully completing but it is getting farther. Right now I'm getting: /usr/bin/xgettext: error while opening "../../po/../gtk/plugins/crazychat/cc_gaim_plugin.c" for reading: No such file or directory ERROR: xgettext failed to generate PO template file. Please consult error message above if there is any. while in the /home/deryni/gaim/clean/gaim-2.0.0beta4/_build/po directory. I think we either need to remove crazy chat from the po files or add it to DIST_SUBDIRS, but I don't have time to test that right now. 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)