view PROGRAMMING_NOTES @ 10137:94167af56ace

[gaim-migrate @ 11206] Herman and I sat down and had a little chit chat. Well, I was sitting, he could have been standing, or lying, or hanging upside-down. Who knows. Anyway, the moral of the story is that plugins and smiley themes and really anything that isn't officially distributed by Gaim should not be in C:\Program Files\Gaim Putting stuff in the user's ~/.gaim directory is the way to go. For side-wide stuff, Herman suggested maybe using the .gaim directory for All Users, but that isn't implemented yet. So if someone wants that they'll have to write a patch. So 3rd party plugins should install to ~/.gaim and NOT program files. Also, I cvs admined this file, which seemed to do weird things. I'm not sure if you have to do anything to make sure you're actually using what's in CVS. 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)