annotate PROGRAMMING_NOTES @ 6096:94e4cf59bacb

[gaim-migrate @ 6555] (21:55:33) Robot101: LSchiere2: while you're round, fancy renaming a file? StdAfx.h in src/win32/ to stdafx.h. (21:55:50) LSchiere2: Robot101: is there a reason? (21:55:57) Robot101: LSchiere2: yeah, try and put a vitriolic comment about windows and/or herman and his build system into the CVS message. (21:56:14) ***LSchiere2 listens for the why (21:56:33) Robot101: because it gets included as "stdafx.h" (21:56:38) LSchiere2: that's a good reason (21:56:53) SimGuy: windows filesystems and their not-caring-ness (21:57:03) Robot101: so gcc on Linux doesn't find it. just because you're building on a retarded platform doesn't mean you have to be all retarded about it. (21:57:14) Robot101: (yeah, use that as the commit message) (21:57:31) LSchiere2: how many places is it included? ie would it be easier to just change the include? (21:58:00) Robot101: we want to discourage this camelcaps as much as possible, so let's just embrace the fact he included it as lowercase. (21:58:13) ***LSchiere2 detects evasion (21:58:26) LSchiere2: you do realize do you not that cvs does NOT handle renaming a file well at all (21:58:37) Robot101: detect someone who is on a windows laptop ssh'd to a machine which doesn't have a gaim tree on (21:58:50) Robot101: the file isn't ours (21:58:55) Robot101: it's just ripped from some other project (21:58:58) zx64: mv File file; cvs remove File; cvs add file; cvs ci; done (21:59:00) Robot101: we havn't changed it much.any (21:59:04) RUBotzman left the room ("Bye all"). (21:59:11) LSchiere2: yes i'm aware of the steps involved zx64 (21:59:12) Robot101: *much/any 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)