annotate PROGRAMMING_NOTES @ 5129:c19cc54f4df6

[gaim-migrate @ 5492] Stuff I did (in order from most important to least): -Made set away message and set profile count the number of bytes rather than the number of characters. This fixes the lack of a warning dialog when setting info that needs an encoding other than ascii or iso8859-1. (Because "hi" in UCS-2BE is 4 bytes but "hi" in utf8 is only 2.) -Created an oscar_encoding_to_utf8 function to convert from a given encoding to utf8. This is AIM/ICQ specific. -Added a "Profile:" and "Away Message:" line to the get info response window. Is it better this way or without it? I thought it would be good if there was a way for users to tell which text was the away message and which was the info, but I also think this solution could be nicer looking. -Added a little check for some server icon stuff because someone reported an obscure crash. -Shuffled some stuff around in oscar.c -Bouldered on the little wall outside of the gym today. It's much more difficult than climbing inside. I think my forearms are just a bit too weak. The holds are tiny, though. 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)