annotate PROGRAMMING_NOTES @ 15784:eed84b59c252

There were a few problems here 1. Raw gnutls error codes were being printed in debug messages. This isn't necessarily bad, but it's much less useful than the text returned from gnutls_strerror(). Never underestimate the value of good error handling. 2. ssl_gnutls_read() and ssl_gnutls_write() were returning 0 when there was an error reading from or writing to the ssl connection. They should return -1 to indicate failure (0 normally indicates that the server closed the connection) 3. ssl_gnutls_read() and ssl_gnutls_write() weren't setting errno when they failed. errno would be set to something random, which seemed to frequently be EAGAIN for me when reading, which causes Gaim to keep trying to read from the connection even though it's closed. Ideally ssl-gnutls.c would have a function equivalent to set_errno() in ssl-nss.c, but the gnutls documentation does a poor job of telling you what possible error codes could be returned from gnutls_record_recv() and gnutls_record_send() Even better would be if we allowed the ssl plugins to keep track of the error message themselves, then added a new ssl ops function to fetch the message from the plugin.

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)