annotate PROGRAMMING_NOTES @ 8436:4bb3d8dc717e

[gaim-migrate @ 9166] " If getaddrinfo() is used, the addrlen and addr returned through that function are written through the pipe to the child Gaim processes. getaddrinfo() sets the addrlen and addr fields through the following structure, defined in <netdb.h>: struct addrinfo { int ai_flags; int ai_family; int ai_socktype; int ai_protocol; size_t ai_addrlen; char *ai_canonname; struct sockaddr *ai_addr; struct addrinfo *ai_next; }; This is from FreeBSD/amd64 5.2.1-RELEASE. This structure is defined differently on different systems. Take, for example, this OpenBSD/i386 3.5-beta system: struct addrinfo { int ai_flags; int ai_family; int ai_socktype; int ai_protocol; socklen_t ai_addrlen; struct sockaddr *ai_addr; char *ai_canonname; struct addrinfo *ai_next; }; After being read, the addrlen and addr of each host is written through the descriptor: src/proxy.c: 466 rc = getaddrinfo(dns_params.hostname, servname, &hints, &res); ... 478 while(res) { 479 write(child_out[1], &(res->ai_addrlen), sizeof(res->ai_addrlen)); 480 write(child_out[1], res->ai_addr, res->ai_addrlen); 481 res = res->ai_next; 482 } And later subsequently read: 286 rc=read(req->fd_out, &addrlen, sizeof(addrlen)); 287 if(rc>0 && addrlen > 0) { 288 addr=g_malloc(addrlen); 289 rc=read(req->fd_out, addr, addrlen); So hence, the type of addrlen that is used in host_resolved() must match that of the addrlen used in the addrinfo structure, or they must at least be guarenteed to be the same size." --jarady 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)