view PROGRAMMING_NOTES @ 5418:697cd2f19d0c

[gaim-migrate @ 5795] "Why?" I asked. "Because," he claimed, "I needed the money." "And that gives you an excuse to butcher my hamburger and turn it into a bowl of filth?" I exclaimed. "Step 1. Butcher Chippy's hamburger. Step 2. ??? Step 3. Profit!" shouted Mr. McDonald. 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)