view PROGRAMMING_NOTES @ 9896:a806e5150eca

[gaim-migrate @ 10785] " summary: This patch adds support for a zephyr proxy tzc. User visible changes will be an options check box to enable tzc, and a text box with the command to run tzc. %s in the command would be replaced by the user's exposure (visibility) level. e.g ssh username@host tzc -e %s Details: What is tzc: tzc aka "trivial zephyr client", is a zephyr helper program, designed originally for use with emacs-zephyr (it takes as input and outputs lisp expressions), and also used as the backend for kzephyr. Why? It is often invoked by a zephyr using on a remote host, by doing ssh username@host tzc -e EXPOSURE so that one can use any of the zephyr clients that use it as a backend, behind NAT "routers" and firewalls, which will generally block zephyr. Also, people will not have to recompile gaim, or have a working zephyr setup as is currently needed - they can merely set the tzc command to a run tzc from a remote host which has zephyr and tzc installed -- most zephyr users are at universities where they have access to such a machine. Where can one get tzc? I tested this against the version (2.6.15-zml) available here: http://www.club.cc.cmu.edu/debian/dists/stable/contrib/source/tzc-cclub_001-3.tar.gz Some older versions won't support buddylists. A lot of the parsing code was borrowed (and converted from C++ to C) from kzephyr (http://www-2.cs.cmu.edu/~colohan/kzephyr/), a GPL'd zephyr client. And tzc is also GPL'd, FWIW." --Arun A Tharuvai 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)