PROGRAMMING_NOTES

Fri, 05 May 2006 19:35:15 +0000

author
Will Thompson <resiak@pidgin.im>
date
Fri, 05 May 2006 19:35:15 +0000
changeset 13727
914824d0d64d
parent 9619
2d8adb92f665
child 16237
606a402fea87
permissions
-rw-r--r--

[gaim-migrate @ 16136]
SF Patch #1482398 from resiak

"This patch makes the manpage at least agree with `gaim
-h` and reality when it comes to command-line
arguments. It still differs from reality in just about
every other way."

Does the -l option still work? I never use it. If it does,
the information here and that from `gaim -h` is surely wrong.

committer: Richard Laager <rlaager@pidgin.im>

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)

mercurial