git.notmuchmail.org Git - notmuch/blob - devel/STYLE

   1 C/C++ coding style
   2 ==================
   3
   4 Tools
   5 -----
   6
   7 There is a file uncrustify.cfg in this directory that can be used to
   8 approximate the prevailing code style. You can run it with e.g.
   9
  10    uncrustify --replace -c devel/uncrustify.cfg foo.c
  11
  12 You still have to use your judgement about accepting or rejecting the
  13 changes uncrustify makes. With a nice git frontend, you can add the
  14 lines you agree with and reject the rest.
  15
  16 For Emacs users, the file .dir-locals.el in the top level source
  17 directory will configure c-mode to automatically meet most of the
  18 basic layout rules.  I
  19
  20 Indentation, Whitespace, and Layout
  21 -----------------------------------
  22
  23 The following nonsense code demonstrates many aspects of the style:
  24
  25 static some_type
  26 function (param_type param, param_type param)
  27 {
  28    int i;
  29
  30    for (i = 0; i < 10; i++) {
  31        int j;
  32
  33        j = i + 10;
  34
  35        some_other_func (j, i);
  36    }
  37 }
  38
  39 * Indent is 4 spaces with mixed tab/spaces and a tab width of 8.
  40   (Specifically, a line should begin with zero or more tabs followed
  41   by fewer than eight spaces.)
  42
  43 * Use copious whitespace.  In particular
  44    - there is a space between the function name and the open paren in a call.
  45    - likewise, there is a space following keywords such as if and while
  46    - every binary operator should have space on either side.
  47
  48 * No trailing whitespace. Please enable the standard pre-commit hook in git
  49   (or an equivalent hook). The standard pre-commit hook is enabled by simply
  50   renaming file '.git/hooks/pre-commit.sample' to '.git/hooks/pre-commit' .
  51
  52 * The name in a function prototype should start at the beginning of a line.
  53
  54 * Opening braces "cuddle" (they are on the same line as the
  55   if/for/while test) and are preceded by a space. The opening brace of
  56   functions is the exception, and starts on a new line.
  57
  58 * Comments are always C-style /* */ block comments.  They should start
  59   with a capital letter and generally be written in complete
  60   sentences.  Public library functions are documented immediately
  61   before their prototype in lib/notmuch.h.  Internal functions are
  62   typically documented immediately before their definition.
  63
  64 * Code lines should be less than 80 columns and comments should be
  65   wrapped at 70 columns.
  66
  67 Naming
  68 ------
  69
  70 * Use lowercase_with_underscores for function, variable, and type
  71   names.
  72
  73 * All structs should be typedef'd to a name ending with _t.  If the
  74   struct has a tag, it should be the same as the typedef name, minus
  75   the trailing _t.
  76
  77 CLI conventions
  78 ---------------
  79
  80 * Any changes to the JSON output format of search or show need an
  81   accompanying change to devel/schemata.
  82
  83 libnotmuch conventions
  84 ----------------------------------
  85
  86 * Functions starting with notmuch_ in lib/notmuch.h are public and are
  87   automatically exported from the shared library.  Private library
  88   functions should generally either be static or, if they are shared
  89   between compilation units, start with _notmuch.
  90
  91 * Functions in libnotmuch must not access user configuration files
  92   (i.e. .notmuch-config)
  93
  94 * Code which needs to be accessed from both the CLI and from
  95   libnotmuch should be factored out into libutil (under util/).
  96
  97 * Deprecated functions should be marked with the NOTMUCH_DEPRECATED
  98   macro which generates run time warnings with gcc and clang. In order
  99   not to confuse doxygen this should go at the beginning of the
 100   declaration like:
 101
 102   NOTMUCH_DEPRECATED(major,minor) notmuch_status_t notmuch_dwim(void *arg);
 103
 104   The @deprecated doxygen command can be used to generate markup in
 105   the API docs.