Changes between Version 25 and Version 26 of Hacking

Timestamp:

01/03/16 13:58:07 (9 years ago)

Author:

andrew_b

Comment:

--

Hacking

@@ -2 +2 @@
 = HACKING =
 
-== Code Style ==
+== Coding Style ==
 
 Please use the same indentation as other developers.
  * Maximum line width is 100 characters. The reason is not about people with low-res screens but rather sticking to 100 columns prevents you from easily nesting more than one level of if statements or other code blocks.
- * Use 4 space tabs with whitespace fillers to Indent. Never use tabs.
- * No trailing whitespace 
- * Follow the GNU-Style guidelines. 
+ * No tabs. Use 4 space tabs with whitespace fillers to indent.
+ * No trailing whitespace.
+ * Follow the GNU-Style guidelines.
 
 To format the code, use the '''indent''' utility with following options:
@@ -23 +23 @@
 
 or in short notation:
-
 {{{
 indent -gnu -fc1 -i4 -bli0 -nut -bap -l100
@@ -34 +33 @@
 Comments should always use the standard C syntax. C++ style comments are not currently allowed.
 
-The lines before a comment should be empty. If the comment directly belongs to the following code, there should be no empty line after the comment, except if the comment contains a summary of multiple following code blocks.
+Lines before a comment should be empty. If the comment directly belongs to the following code, there should be no empty line after the comment, except if the comment contains a summary of multiple following code blocks.
 
 '''This is right:'''
@@ -74 +73 @@
 }}}
 
-=== Conditions in Code blocks (if, for, case...) ===
-
-Always follow an 'if' keyword with a space but don't include additional
-spaces following or preceding the parentheses in the conditional.
+=== Conditions in code blocks (if, for, case...) ===
+
+Always follow an 'if' keyword with a space but don't include additional spaces following or preceding the parentheses in the conditional.
 
 '''This is right:'''
@@ -142 +140 @@
     path = strip_home_and_password (current_panel->cwd); }
 
-    for (k = 0; k < 10; k++)
-        for (j = 0; j < 10; j++)
-            for (i = 0; str_options[i].opt_name != NULL; i++)
-                g_free (*str_options[i].opt_addr);
+for (k = 0; k < 10; k++)
+     for (j = 0; j < 10; j++)
+        for (i = 0; str_options[i].opt_name != NULL; i++)
+            g_free (*str_options[i].opt_addr);
 }}}
 
@@ -160 +158 @@
         dest = input_expand_dialog (_("Link"), src, MC_HISTORY_FM_LINK, "");
 
-        if (!dest || !*dest)
+        if (dest == NULL || *dest == '\0')
             goto cleanup;
         ...
@@ -176 +174 @@
 === Readable Code ===
 
-Use your best judgement and choose the more readable option.
-Remember that many other persons will review it:
+Use your best judgement and choose the more readable option. Remember that many other persons will review it:
 
 '''This is right:'''
 {{{
 bytes = read (fd, &routine.pointer, sizeof (routine));
-if (bytes == -1 || (size_t) bytes < (sizeof (routine)))
-}}}
-
-'''This is wrong:'''
-{{{
-if (bytes = read (fd, &routine.pointer, sizeof (routine)) == -1 || (size_t) bytes < (sizeof (routine)))
-
-if (read (from_parent_fd, &i, sizeof (int)) != sizeof (int))
-    return NULL;
+if (bytes == -1 || (size_t) bytes < sizeof (routine))
+    ...
+}}}
+
+'''This is wrong:'''
+{{{
+if ((bytes = read (fd, &routine.pointer, sizeof (routine))) == -1 || (size_t) bytes < sizeof (routine))
+    ...
+}}}
+
+Don not place more than one statement in one line.
+
+'''This is right:'''
+{{{
+a = 0;
+b = 2;
+
+a = f();
+if (a == 2)
+    b = 5;
+
+}}}
+
+'''This is wrong:'''
+{{{
+a = 0; b = 2;
+
+if ((a = f()) == 2)
+    b = 5;
+
+if (a == 2) b = 5;
 }}}
 
@@ -227 +246 @@
 }}}
 
+Do not check boolean values for equality:
+
+'''This is right:'''
+{{{
+gboolean b1, b2;
+
+if (b1)
+if (!b2)
+}}}
+
+'''This is wrong:'''
+{{{
+gboolean b1, b2;
+
+if (b1 == TRUE)
+if (b2 == FALSE)
+}}}
+
+
 === Variables ===
 
-Declare variable only in the beginning of block. Split variable declaration and code using one empty line. Try to avoid using functions to initialize variables. Split variable declaration and value assignment.
+Reduce variable scope as much as possible: declare local variable in that block where it is used.
+
+Don't mix variable declaration and code, declare variable only in the beginning of block.
+
+Split variable declaration and code using one empty line. Avoid using function to initialize variable. Split variable declaration and value assignment.
 
 '''This is right:'''
@@ -239 +281 @@
 
 '''This is wrong:'''
-
 {{{
 vfs_path_t *vpath = vfs_path_from_str (filename);
 }}}
 
-=== Make use of helper variables ===
-
-Please try to avoid passing function calls as function parameters in new code. This makes the code much easier to read and it's also easier to use the "step" command within gdb.
+=== Helper variables ===
+
+Try to avoid passing function calls as function parameters in new code. This makes the code much easier to read and it's also easier to use the "step" command within gdb.
 
 '''This is right:'''
@@ -326 +367 @@
 
 Do not mix global and local variables and functions.
-Do not mix static and non-static statments.
+Do not mix static and non-static statements.
 
 Follow typical structure of *.c file: