view PROGRAMMING_NOTES @ 11211:03a244acce57

[gaim-migrate @ 13342] (14:28:27) Christopher O'Brien (siege): ArdentlyGnarly, gaim_proxy_connect's docs lie (14:28:36) Christopher O'Brien (siege): it doesn't return a fd (14:28:52) Christopher O'Brien (siege): it returns a status code ... (14:37:58) rlaager: siege, ArdentlyGnarly: We should correct the docs for gaim_proxy_connect... how does this sound? "@return zero for success, any other value for failure" ... (14:39:22) Jonathan Clark (ArdentlyGnarly): we really don't know whether or not the call was successful at the time it returns (14:39:55) Jonathan Clark (ArdentlyGnarly): we get that information when things get back around to the callback passed to gaim_proxy_connect (14:42:08) Jonathan Clark (ArdentlyGnarly): perhaps: @return zero indicates connection is pending, any other value for failure 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)