view PROGRAMMING_NOTES @ 11701:5d7da4056644

[gaim-migrate @ 13992] SF Patch #1332870, from corfe83 "In gtkimhtml.c, in function gtk_smiley_tree_destroy, in the while loop, we go through the tree and add all the nodes to be deleted to a GSList. However, we add them by appending them to the list, but the order of the list doesn't matter. Because GSList's don't keep track of the last item in the list, this means each step of the loop (when we append) we are incrementing through the whole list. In my tests, on closing the preference box, this loop was gone through more than 1,000 times, and at many stages this list it is appending to is well over 50 elements long. I've changed it to prepend items to the list, which works just the same (although destroying items in the tree in a different order), and is much faster (prepend works in O(1) time, as opposed to O(N) time)." I think the moral of the story is, when order doesn't matter, use g_[s]list_prepend instead of g_[s]list_append. 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)