HACKING

   1 CenterIM 5 Hacking Documentation
   2
   3 Contents
   4 --------
   5
   6 1. Code Style
   7 2. General Debugging
   8 3. Valgrind Notes
   9
  10
  11 1. Code Style
  12 -------------
  13
  14 - No tabs, two spaces indenting.
  15 - Line length limited to 78 characters.
  16 - Comments:
  17     // one line comment
  18     /* Multiline
  19      * comment. */
  20 - Names of classes and methods use CamelNotation, variables use
  21   common_c_naming. THIS_IS_A_CONST. There is an exception, libpurple/glib
  22   callbacks use common C naming too.
  23 - Example of class declaration:
  24 class MyClass
  25 : public OtherClass
  26 {
  27 public:
  28   // enums and typedefs first,
  29   // then variables,
  30   // methods last
  31
  32   /**
  33    * Doxygen comment.
  34    */
  35   virtual size_t GetLinesCount() const { return lines_count; }
  36
  37 protected:
  38   size_t lines_count;
  39
  40 private:
  41 };
  42 - Order methods in an implementation file according to a header file.
  43 - Methods that can be bound to a key are prefixed with 'Action', for example,
  44   ActionActivate().
  45 - Methods connected to signals should use 'On' prefix, for example,
  46   OnSelectionChanged().
  47 - Singletons have got all variables private, other classes should have all
  48   variables protected.
  49
  50
  51 2. General Debugging
  52 --------------------
  53
  54 Use the '--enable-debug' configure option to disable optimizations and to
  55 enable producing of binary with debugging information.
  56
  57 Use the '--enable-strict' configure option to enable extra compiler warnings.
  58
  59
  60 3. Valgrind Notes
  61 -----------------
  62
  63 % export GLIBCXX_FORCE_NEW=1
  64 % export G_DEBUG=gc-friendly
  65 % export G_SLICE=always-malloc
  66 % valgrind --leak-check=full --child-silent-after-fork=yes \
  67     --log-file=cim5.log --track-fds=yes centerim5
  68
  69 Make sure you don't run this command on libtool's binary wrapper.
  70
  71 GLIBCXX_FORCE_NEW forces libstdc++ allocator to use new() and delete() calls
  72 instead of using memory pools
  73 (http://gcc.gnu.org/onlinedocs/libstdc++/manual/ext_allocators.html).
  74
  75 G_SLICE and G_DEBUG env vars make sure to turn off glib's memory
  76 optimizations, so that they do not confuse Valgrind
  77 (https://live.gnome.org/Valgrind).
  78
  79 There is currently no suppresion list, though you can use at least the list
  80 from the Pidgin project.
  81