annotate PROGRAMMING_NOTES @ 4597:1969709eee1e

[gaim-migrate @ 4882] You know how when you get info with TOC it only works 25% of the time? This fixes that! I wrote the patch, but George Vulov was the one who realized what was going on. Here's his post from the forums: I was looking at the gaim TOC source and I noticed that when gaim receives a GOTO_URL command, it appends the given url to "http://toc.oscar.aol.com";. However, toc.oscar.aol.com resolves to different servers at different times, so when one is logged on using TOC for over 10 mins and requests someone's info, "<H1>The requested URL 901450_722937 was not found on this server</H1>" comes up. gaim should request the info from the specific toc server it is connected to, instead of using toc.oscar.aol.com So basically... we lookup the IP address of our connection socket and keep that in TOC's protocol data. Then, when we get someone's info, open http://64.12.163.214:port/bleh instead of http://toc.oscar.aol.com:port/bleh Thanks George, you da man. 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)