view PROGRAMMING_NOTES @ 8672:142108e89399

[gaim-migrate @ 9424] "This patch contains two fixes. The first is rather trivial, just removes the declaration of extra pointer used for deleting a message and deletes the message directly. The second is the real bug that needed fixing. Short Explanation: The old code only fixed the message that was being displayed, and still sent the original unchecked message to the receiving party. All I did was add a handler to the load_plugin function to make it fix the message being sent as well. Longer Explanation: In my cursory look through the gaim code (warning, <15 minutes) it appears the message pointer send to all the various *-im-msg and *-chat-msg handlers is a copy of the original string each time. This means if you fix the string at one stage (displaying), you have to fix it again at the next (sending). This seems rather inefficient, but hey, it's your client, maybe it was a design feature. Anyway, the spellchk plugin was only fixing the displayed message, and not the message being sent. So I thought my messages were being fixed while those receiving them new I was screwing up. I added substitute_somethingorother handler for the sending-im-msg callback in the load_plugin function. Other comments: I didn't look to deeply into it since it's so late, but the "displaying-chat-msg" and "sending-chat-msg" callbacks appear to be broken. The spellchk.c currently has a handler registered for the first callback, but the message displayed on my screen still contains the original typos. If I try to register a handler for the second callback listed, Gaim crashes when sending the message to a chat window. As I said, I didn't look into why it was crashing, I just removed my attempt to handle it and built this patch." --Matt Brenneke 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");

- When writing out paths to .gaimrc, use wgaim_escape_dirsep. This is necessary
  because the Windows dir separator '\' is being used to escape characters, when
  paths are read in from the .gaimrc file.

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)