view PROGRAMMING_NOTES @ 14875:7357d46ba817

[gaim-migrate @ 17644] SF Patch #1586467 from Benjamin Moody - floppusmaximus "Currently if a plugin creates a multi-line, non-HTML string preference, i.e. a GaimPluginPref with type GAIM_PLUGIN_PREF_STRING_FORMAT and format-type GAIM_STRING_FORMAT_TYPE_MULTILINE, the resulting widget is extremely narrow and impossible to use. This is because the widget is packed into an hbox without allowing expansion (expand = fill = FALSE.) If HTML is enabled, the presence of the format bar forces the widget to be wide enough to be usable. Disabling HTML causes the format bar to be removed, so the widget is set to the minimum allowed size." 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)