view PROGRAMMING_NOTES @ 13654:b6f7686c6082

[gaim-migrate @ 16056] Fix Coverity CID 28: Fix some checks so that a function isn't ugly. Fix Coverity CID 76, 77 and 112: Get rid of an unnecessary NULL-pointer check after we'd already dereferenced a pointer. Fix Coverity CID 124: Possible use of a NULL pointer in gaim_icon_parseicon. It only had the potential to crash when compiled with g_assertions turned off. Fix Coverity CID 125: Possible use of a NULL pointer in gaim_parse_oncoming. It only had the potential to crash when compiled with g_assertions turned off. Fix Coverity CID 123 and 136: Possible dereference of a NULL pointer in gaim_auth_request(). It was only possible when you turned off g_assertions, and even then I'm not so sure. In any case, the code is certainly cleaner 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)