view PROGRAMMING_NOTES @ 12620:13599d978a31

[gaim-migrate @ 14956] SF Patch #1387727 from Dennis Lambe Jr. (malsyned) "When gaim_markup_strip_html removes HTML tags from log messages before writing them out, the contents of the href attribute of <a> tags gets lost, even though that information is much more valuable than HTML formatting information and would be very useful to have in logs. This patch causes gaim_markup_strip_html, when confronted with a chunk of text that looks like this: Check out <a href="http://gaim.sf.net/">this great program</a> I just found! to emit something like this: Check out this great program<http://gaim.sf.net/> I just found!" 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)