view PROGRAMMING_NOTES @ 12685:e9f279f0ef02

[gaim-migrate @ 15028] Changes from and inspired by SF Patch #1394379 from Martijn Dekker "The attached patch to configure.ac fixes two issues: (1) To compile Gaim 2.0.0cvs on Mac OS X, the linker flag "-lresolv" is needed to correctly link to the libresolv library, or the linker will complain about an illegal indirect reference to "res_9_dn_expand" in src/dnssrv.c. (2) On Mac OS X with Fink, the /sw/include and /sw/lib paths need to be included in CPPFLAGS and LDFLAGS respectively for configure to detect certain libraries such as libao and GNUTLS." I took a different (and untested) approach to solving the first one. As for the second, we were already doing CFLAGS, so I only accepted the LDFLAGS part. 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)