Changes between Version 6 and Version 7 of Writing Rules/General

Timestamp:

Nov 29, 2012, 5:30:13 PM (11 years ago)

Author:

meunier

Comment:

Added a "Source Code Style" section (not finished)

Writing Rules/General

@@ -43 +43 @@
  * LSBs of the VCI ADDRESS are ignored, and the VCI ADDRESS is only used to select a VCI cell (a word in memory).
  * Bytes are selected by the VCI BE field, and the BE![0] bit is always associated to the Byte 0 of the VCI WDATA field (ie WDATA![7:0]).
+
+
+= Source Code Style and Indentation (to be completed) =
+
+In so far as possible, people writing code are encouraged to follow some rules regarding indentation and coding style. These rules are described below:
+
+ * The coding style used is a variant of the BSD KNF style.
+   * There must be one instruction per line : a line can be terminated by:
+     * a semi-colon {{{;}}}
+     * an opening bracket {{{ { }}}
+     * a closing bracket {{{ } }}}
+     * a colon after a {{{case}}} statement
+   * A line following an opening bracket must be right-shifted
+   * The opening bracket must always be the last character of its line
+   * A left shift is done on a line containing a closing bracket
+   * The opening bracket can be either on the same line as the instruction before or be the single instruction of its line
+   * A line following a {{{case}}} statement must be right-shifted if no new block is created
+   * A space is inserted at the following places:
+     * after the statements {{{if}}}, {{{while}}}, {{{for}}} and {{{switch}}}
+     * before and after a {{{=}}}
+     * before and after all binary operators: {{{==}}}, {{{!=}}}, {{{&&}}}, {{{||}}}, {{{&}}} (bitwise and), {{{|}}}, {{{<<}}}, {{{>>}}}, {{{%}}}, {{{/}}}, {{{*}}} (multiplication), {{{+}}}, {{{-}}}, {{{<}}}, {{{>}}}
+     * before and after a {{{*}}} in a pointer declaration
+     * after a comma {{{,}}}
+     * before the question mark {{{?}}} and the semi-colon {{{:}}} in a unary if construct {{{(x ? y : z)}}}
+     * after the closing parenthesis in a cast statement
+     * after the {{{//}}} sequence (commentary)
+   * A space is '''not''' inserted at the following places :
+     * before a semi-colon {{{;}}}
+     * before and after the operators {{{->}}} and {{{.}}} (field selection)
+     * before the opening bracket of a function declaration
+     * before the opening bracket of a function call
+     * before a comma {{{,}}}
+     * before the operators {{{++}}} and {{{--}}}
+     * after a {{{*}}} in a pointer dereferencement
+     * before a colon {{{:}}} of a case statement
+     * before an indexation operator {{{[]}}}
+   * It is tolerated to add spaces to align some elements such as: affectations, indexation, conditions on several lines, parameters in function calls, variables declarations.
+ * C-99 types must be used when possible: {{{int8_t, uint8_t, int16_t, uint16_t, int32_t, uint32_t, int64_t, uint64_t}}}
+ * The indentation must use spaces and not tabs. The number of spaces used is 4.
+ * Blocks (i.e. brackets) must be used even for a single instruction.
+ * The keywords {{{public}}} and {{{private}}} can be either indented regularly or the same way as their parents (the class in which they are).
+
+Here is a code exemple :
+{{{
+#!cpp
+
+template <int32_t size> class MyClass : public Parent {
+
+public:
+    sc_signal<uint32_t> my_signal;
+};
+
+typedef struct _mystruct {
+    uint32_t val;
+} mystruct;
+
+
+int32_t f(int32_t x, mystruct * y, uint32_t c) {
+    int16_t a, b = 0;
+    int32_t * ptr;
+    mystruct st;
+
+    MyClass<1>  t1;
+    MyClass<10> t10;
+
+    while (st.val == b && *ptr != 0) {
+        if ((a & 0x10) != 0 || y->val) {
+            *y--;
+#ifdef SOME_FLAG
+            my_counter++;
+#endif
+            return 1;
+        }
+
+        switch (c) {
+            case 0:
+                printf("c is %d\n", c);
+                break;
+            case 1:
+            {
+                int local = 2;
+                c = local + 1;
+            }
+            default:
+                break;
+        }
+    }
+    // f is a recursive function
+    f(x, y, c + 1);
+    int32_t exp = (a + (b * st.val) % d) >> 2;
+    uint32_t b = (a * (b + c) == 1) ? c : c + 1;
+    uint32_t var = *(uint32_t *) 0x10000000;
+
+    return exp;
+}
+}}}
+
+ * Every file must contain at its end an epilogue specifying some indentation parameters for vim and emacs. This epilogue must be:
+{{{
+# Local Variables:
+# tab-width: 4;
+# c-basic-offset: 4;
+# c-file-offsets:((innamespace . 0)(inline-open . 0));
+# indent-tabs-mode: nil;
+# End:
+#
+# vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=4:softtabstop=4
+}}}
+
+''Please note: some files do not respect yet all these conventions.''