view PROGRAMMING_NOTES @ 13419:3e9c865abd3f

[gaim-migrate @ 15794] Resolve CID 22: Event assign_zero: Variable "prpl_info" assigned value 0. 3764 GaimPluginProtocolInfo *prpl_info = NULL; 3795 if (gc != NULL) 3796 prpl_info = GAIM_PLUGIN_PROTOCOL_INFO(gc->prpl); Event var_deref_op: Variable "prpl_info" tracked as NULL was dereferenced. 3798 if (prpl_info->options & OPT_PROTO_CHAT_TOPIC) Basically, if gc == NULL, then prpl_info == NULL, so this crashes. Let's be safe and use a g_return_if_fail(). I also added one to the write_conv stuff I changed in my last commit. We seem to do that in a lot of places, so I guess I'll p lay it safe. 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)