view PROGRAMMING_NOTES @ 7819:2226c01893d6

[gaim-migrate @ 8471] Take this, Luke! Also, shx, Felipe, guy, if you're listening: The top half of gaim_mime_decode_field() in util.c does things it shouldn't. You should not cast a const char * to a char *. Somewhere in that block the value of new changes, which is bad. It causes the following backtrace: #3 0x003fc9af in free_check () from /lib/tls/libc.so.6 #4 0x003f9fa5 in free () from /lib/tls/libc.so.6 #5 0x006aba64 in g_free () from /usr/lib/libglib-2.0.so.0 #6 0x0021da94 in email_msg (servconn=0x94df488, msg=0x95a1910) at notification.c:2083 #7 0x0021ebfd in process_message (servconn=0x94df488, msg=0x95a1910) at servconn.c:49 #8 0x0021ef6e in process_multi_line (servconn=0x94df488, buffer=0x95a4fd0 "MIME-Version: 1.0\r\nContent-Type: text/x-msmsgsemailnotification; charset=UTF-8\r\n\r\nFrom: Mark Doliner\r\nMessage-URL: /cgi-bin/getmsg?msg=MSG1070938998.38&start=7318&len=972&curmbox=ACTIVE\r\nPost-URL: htt"...) at servconn.c:165 #9 0x002201c5 in msn_servconn_parse_data (data=0x94df488, source=5, cond=GAIM_INPUT_READ) at servconn.c:602 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)