view PROGRAMMING_NOTES @ 10297:ec140184437b

[gaim-migrate @ 11480] "After applying this patch, which modifies the make files and makes the @file/@ingroup markers at the top of several gtk files more uniform, the following files should be renamed: dnd-hints.h -> gtkdnd-hints.h dnd-hints.c -> gtkdnd-hints.c gaim-disclosure.h -> gtkgaim-disclosure.h gaim-disclosure.c -> gtkgaim-disclosure.c stock.h -> gtkstock.h stock.c -> gtkstock.c I believe that completes the renaming of files which are explicitly for gtkgaim; all files in /gaim/src which depend upon gtk should now have gtk in their name. There are two candidates which might be considered part of gtkgaim rather than part of the core, but I didn't modify them: session.c and log.c. Both are quite gaim-UI specific, it seems, particularly session, but perhaps other UIs could also make use of their functionality. -Evan " 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)