view PROGRAMMING_NOTES @ 8445:46f3c447da4d

[gaim-migrate @ 9175] Mar 13 20:58:37 <nosnilmot> LSchiere2: ping Mar 13 21:04:28 <LSchiere2> semi-pong Mar 13 21:05:11 <nosnilmot> LSchiere2: simple one, do you want a patch that splits changelog into ChangeLog & po/ChangeLog ? Mar 13 21:05:24 <LSchiere2> sure. go ahead Mar 13 21:06:13 <nosnilmot> http://www.nosnilmot.com/patches/gaim-0.76cvs-i18n-changelog.patch ... Mar 13 21:58:31 <nosnilmot> LSchiere2: did you get that changelog patch? Mar 13 22:01:44 <LSchiere2> i grabbed it, nothing more .... Mar 14 00:53:07 <LSchiere> nosnilmot: i left that patch at work accidentally All times in GST (Gaim Standard Time). 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)