From 5e6c38a5247d7da266d4ca3f0c5f9c7bd37bc966 Mon Sep 17 00:00:00 2001 From: sledgehammer999 Date: Sun, 10 Jan 2016 14:48:48 +0200 Subject: [PATCH] Add info and files for coding style. Issue #2192. --- CODING_GUIDELINES.md | 4 +++- codingStyleQtCreator.xml | 39 ++++++++++++++++++++++++++++++++ uncrustify.cfg | 49 ++++++++++++++++++++++++++++++++++++++++ 3 files changed, 91 insertions(+), 1 deletion(-) create mode 100644 codingStyleQtCreator.xml create mode 100644 uncrustify.cfg diff --git a/CODING_GUIDELINES.md b/CODING_GUIDELINES.md index f4b71be9a..c74cbccd2 100644 --- a/CODING_GUIDELINES.md +++ b/CODING_GUIDELINES.md @@ -1,6 +1,8 @@ All new code must follow the following coding guidelines. If you make changes in a file that still uses another coding style, make sure that you follow these guidelines for your changes instead. -**Note:** I will now take your head if you forget and use another style. However, most probably the request will be delayed until you fix your coding style. +**Note 1:** I will not take your head if you forget and use another style. However, most probably the request will be delayed until you fix your coding style. +**Note 2:** You can use the `uncrustify` program/tool to clean up any source file. Use it with the `uncrustify.cfg` configuration file found in the root folder. +**Note 3:** There is also a style for QtCreator but it doesn't cover all cases. In QtCreator `Tools->Options...->C++->Code Style->Import...` and choose the `codingStyleQtCreator.xml` file found in the root folder. ### 1. Curly braces ### #### a. Function blocks, class/struct definitions, namespaces #### diff --git a/codingStyleQtCreator.xml b/codingStyleQtCreator.xml new file mode 100644 index 000000000..0f8ccaae6 --- /dev/null +++ b/codingStyleQtCreator.xml @@ -0,0 +1,39 @@ + + + + + + CodeStyleData + + true + false + false + true + false + true + false + false + true + false + false + false + true + true + false + true + false + true + false + 4 + true + false + 1 + true + 4 + + + + DisplayName + qBittorrent + + diff --git a/uncrustify.cfg b/uncrustify.cfg new file mode 100644 index 000000000..46f444573 --- /dev/null +++ b/uncrustify.cfg @@ -0,0 +1,49 @@ +set FOR foreach + +newlines = LF + +indent_with_tabs = 0 +indent_columns = 4 +indent_switch_case = 0 +indent_namespace = true +indent_class = true +indent_col1_comment = true +indent_access_spec = -4 + +nl_enum_brace = add +nl_union_brace = add +nl_struct_brace = add +nl_class_brace = add +nl_do_brace = remove +nl_if_brace = remove +nl_for_brace = remove +nl_else_brace = remove +nl_while_brace = remove +nl_switch_brace = remove +nl_brace_while = remove +nl_brace_else = remove +nl_try_brace = remove +nl_fcall_brace = remove +nl_fdef_brace = add +nl_after_return = false +nl_brace_else = add +nl_class_leave_one_liners = true + +mod_full_brace_if = remove +mod_full_brace_do = remove +mod_full_brace_while = remove +mod_full_brace_for = remove +mod_full_brace_if_chain = true +mod_full_brace_nl = 3 +mod_full_paren_if_bool = true + +sp_else_brace = add +sp_try_brace = add +sp_arith = add +sp_assign = add +sp_defined_paren = ignore +sp_pp_concat = ignore +sp_pp_stringify = ignore +sp_bool = add +sp_after_class_colon = add +sp_before_class_colon = remove