StarMirror/qTox
1
0
Fork 0
mirror of https://github.com/qTox/qTox.git synced 2024-03-22 14:00:36 +08:00
Code Issues Projects Releases Wiki Activity

docs(clangformat): add documentation on coding style with respect to clang-format

Browse Source
This commit is contained in:
initramfs 2016-10-27 10:37:23 -04:00 committed by Zetok Zalbavar
parent c32a44b7ef
commit e4d40f11ed
No known key found for this signature in database
GPG Key ID: C953D3880212068A
2 changed files with 481 additions and 140 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

142
CONTRIBUTING.md
View File

@ -349,146 +349,7 @@ git config --global commit.gpgsign true
# Coding Guidelines # Coding Guidelines
Use `C++11`. See [coding_standards.md][Coding Standards].
## Includes
On the project level, include files starting with the root directory of the
repository, e.g. `src/core/core.h` from `src/widget/widget.cpp`:
```C++
#include "src/core/core.h"
```
Do **not** use `<>` tags to include files on the project level, e.g.
`src/core/core.h` from `src/widget/widget.cpp`:
```C++
#include <core.h> // WRONG
```
If including files from the operating system, external libraries, frameworks
or Qt classes use `<>` tags, e.g. `cstdio` and `QString` from `src/main.cpp`:
```C++
#include <cstdio>
#include <QString>
```
## Coding style
There's a [coding style file](/tools/configs/qTox-Coding-Style.xml) for Qt
Creator that handles some of the rules below.
```C++
function()
{
1st_line;
2nd_line;
}
// if / while / for / switch
// always use curly brackets
if () // ← note the space between `if` and parenthesis
{
1_line_curly;
}
else if ()
{
just_one_line;
}
else
{
each_condition_in_curly;
}
QObject* asterisksGoWithTheType;
uint8_t* array = new uint8_t[count];
// camelCase for variables, CamelCase for classes
QObject notToMentionThatWeUseCamelCase;
```
## Dynamic casts / RTTI
qTox is compiled without support for RTTI, as such PRs making use of
`dynamic_cast()` will fail to compile and may be rejected on this basis. For
manipulating Qt-based objects, use `qobject_cast()` instead.
Compiling qTox without RTTI support gives up to 5-6% size reductions on
compiled binary files. The usage of `dynamic_cast()` can also be completely
mitigated when dealing with Qt objects through use of `qobject_cast()` which
behaves very much like C++'s `dynamic_cast()` but without the RTTI overhead.
Enforced with `-fno-rtti`.
## Documentation
If you added a new function, also add a doxygen comment before the
implementation. If you changed an old function, make sure the doxygen comment
is still correct. If it doesn't exist add it.
Don't put docs in .h files, if there is a corresponding .cpp file.
### Documentation style
```C++
/*...license info...*/
#include "blabla.h"
/**
* @brief I can be briefly described as well!
*
* And here goes my longer descrption!
*
* @param x Description for the first parameter
* @param y Description for the second paramater
* @return An amazing result
*/
static int example(int x, int y)
{
// Function implementation...
}
/**
* @class OurClass
* @brief Exists for some reason...!?
*
* Longer description
*/
/**
* @enum OurClass::OurEnum
* @brief The brief description line.
*
* @var EnumValue1
* means something
*
* @var EnumValue2
* means something else
*
* Optional long description
*/
/**
* @fn OurClass::somethingHappened(const QString &happened)
* @param[in] happened tells what has happened...
* @brief This signal is emitted when something has happened in the class.
*
* Here's an optional longer description of what the signal additionally does.
*/
```
## No translatable HTML tags
Do not put HTML in UI files, or inside `tr()`. Instead, you can put put it in
C++ code in the following way, to make only user-facing text translatable:
```C++
someWidget->setTooltip(
QStringLiteral("<html><!-- some HTML text -->") + tr("Translatable text…") +
QStringLiteral("</html>");
```
## Limitations ## Limitations
@ -505,3 +366,4 @@ Symbols that should be forbidden for filenames under Windows:
[pull request]: https://github.com/qTox/qTox/pulls [pull request]: https://github.com/qTox/qTox/pulls
[`test-pr.sh`]: /test-pr.sh [`test-pr.sh`]: /test-pr.sh
[Coding Standards]: https://github.com/qTox/qTox/blob/master/doc/coding_standards.md

479
doc/coding_standards.md Normal file
View File

@ -0,0 +1,479 @@
# Coding Standards & Guidelines
This document defines the qTox coding standards and style, all code
contributions are expected to adhere to the rules described below.
Most stylistic features described below are described as clang-format rules
present in the root of the repository, as such most code formatting rules can
be applied by simply running clang-format over the source code in question.
## Coding Standard
qTox is written under **[ISO/IEC 14882:2011 (C++11)][ISO/IEC/C++11]** without
GNU/GCC specific extensions (i.e. qTox should compile with `CXXFLAGS` set to
`-std=c++11`, regardless of if `-std=gnu+11` is being used during compile
time). Source code must be able to be compiled under multiple different
compilers and operating systems including but not limited to GCC and Clang on
Microsoft Windows, Apple OS X and GNU/Linux-based derivatives.
In addition to the base language, the following additional restrictions are
imposed:
### Compatibility
qTox is linked against Qt 5, allowing the use of Qt constructs and library
features. The current minimum supported Qt version is Qt 5.3, meaning that all
code must compile in a Qt 5.3 environment. Any usage post-Qt 5.3 features must
be optional and be disabled when compiling/running in a Qt 5.3 environment.
### No Exceptions
qTox is compiled without support for [C++11 exceptions][Exceptions], meaning
that any code contribution or dependency cannot throw a C++ exception at
runtime or else the application will crash. For code present in the qTox
repository, this is enforced by the use of the `exceptions_off` qmake
configuration.
Note: This restriction prohibits the use of external libraries that may throw
unhandled exceptions to qTox code. External libraries using exceptions, but
never require qTox code to handle them directly, will work fine.
### No RTTI
qTox is compiled without support for [RTTI], as such code contributions using
`dynamic_cast()` or `std::dynamic_pointer_cast()` may fail to compile and may
be rejected on this basis. The implications of this are that the signature of
all polymorphic types must be known at compile time or stored in an
implementation-specific way. In essence, if a substitution from
`dynamic_cast()` to `static_cast()` can be performed without affecting program
correctness, the construct in question is valid.
**Note: no usage of `dynamic_cast()` or `std::dynamic_pointer_cast()` is
permitted, even if the code compiles**. An optimizing compiler may be silently
replacing your dynamic casts with static casts if it can ensure the replacement
is to the same effect.
For manipulation of Qt-based objects, use `qobject_cast()` instead.
## Coding Style
### Indentation
All code is to be formatted with an indentation size of 4 characters, using
spaces. **Tabs are not permitted.** Scope specifiers and namespaces are not to
be indented.
The following example demonstrates well formatted code under the indentation
rules:
```c++
namespace Foo
{
class Bar
{
public:
Bar()
{
// Some code here
switch (...)
{
case 0:
{
// Some code here
}
}
// More code
if (...)
{
// Conditional code
}
}
};
}
```
### Spacing
Spaces are to be added before the opening parenthesis of all control
statements. No spaces should be present preceeding or trailing in argument
lists, template specification, array indexing or between any set of brackets.
Spaces should additionally be present in between all binary, ternary and
assignment operators, but should **not** be present in unary operators between
the operator and the operand.
Inline comments have to be one space away from the end of the statement unless
being aligned in a group.
The following example demonstrates well formatted code under the spacing rules:
```c++
void foo(int a, int b)
{
int x = 0;
int y = 0; // Inline comments have to be at least one space away
++x; // Example unary operator
int z = x + y; // Example binary operator
int x = z > 2 ? 1 : 3; // Example ternary operator
if (z >= 1)
{
// Some code here
}
else
{
// More code here
}
for (std::size_t i = 0; i < 56; ++i)
{
// For loop body
}
while (true)
{
// While loop body
}
}
template <typename T>
void bar(T a)
{
std::vector<T> foo{a};
std::cout << foo[0] << std::endl;
}
```
### Alignment
If an argument list is to be split into multiple lines, the subsequent
arguments must be aligned with the opening brace of the argument list.
Alignment should also be performed on multiline binary or ternary operations.
If multiple trailing inline comments are used, they should all be aligned
together.
The following example demonstrates well formatted code under the alignment
rules:
```c++
void foo()
{
int a = 2; // Inline comments
int b = 3; // must be aligned
int c = a + // Multiline binary operator has to be aligned.
b;
}
void bar(int a, int b, int c, int d, int e, int f)
{
// Function body here
}
```
### Braces and Line Breaks
The line length limit is set to around 100 characters. This means that most
expressions approaching 100 characters should be broken into multiline
statements. Clang-format will attempt to target this limit, going over the
limit slightly if there are tokens that should not be split. Comments should
wrap around unless they include elements that cannot be split (e.g. URLs).
Line breaks should be added before all opening braces and after all template
specializations except for the `extern "C"` specifier. Lambdas have special
rules that need to be handled seperately, see section below.
Braces should be added for all control structures, even those whose bodies only
contain a single line.
**Note: Clang-format does not have the ability to enforce brace presence, one
must manually ensure all braces are present before formatting via
clang-format.**
The following example demonstrates well formatted code under the braces and
line break rules:
```c++
extern "C" {
#include <foo.h>
}
namespace Foo
{
struct Bar
{
void foobar();
};
template <class T>
void example(T veryLongArgumentName, T anotherVeryLongArgumentName, T aThirdVeryLongArgumentName,
T aForthVeryLongArgumentName, T aFifthVeryLongArgumentName)
{
// This is a very long comment that has been broken into two lines due to it exceeding the 100
// characters per line rules.
if (...)
{
// Single line control statements are still required to use braces.
}
else
{
// Multiline block
// Multiline block
}
}
}
```
### Lambdas
Lambdas are to follow special break rules defined by clang-format. In
particular, if the lambda body contains a single statement and line length
permits, the lambda is to be treated as a single expression, represented in an
inlined format (i.e. no newlines). Or else, a newline is to be inserted
**after** the opening bracket.
The following example demonstrates well formatted code under the lambda rules:
```c++
// Empty lambda, all on same line.
auto a = []() {};
// Lambda with single statement, all on same line.
auto b = []() { return 0; };
// Lambda with multiple statements, line break after the opening bracket.
auto swap = [](int& a, int& b) {
a = a ^ b;
b = a ^ b;
a = a ^ b;
};
// Long lambda with single statement, line break after the opening bracket.
auto compareAndUpdate = [](const int expect, int& actual, int& newVal) -> int {
actual = (actual == expect) ? newVal : actual;
};
```
### Pointers
Pointers, references and rvalue references should be be aligned left, combining
with the type **when it is possible to do so**. What this means that in a
regular pointer declaration of variable `x` pointing to a type `T` should be
declared as `T* x;` where the \* glyph is placed next to the type `T` without any
spaces separating them. A space should be present between pointer type and the
variable name except in the special cases described below.
Special cases exist when the pointer glyph and the variable needs to put in
parentheses such as when declaring pointers to C-style arrays and pointers to
functions. In these cases, the pointer **should be combined with the variable**
and placed one space away from the pointer type, see examples below.
As a reminder, usage of C-style arrays should be minimized and generally
restricted to interactions with C-based APIs present in external libraries.
Consider using the keyword `auto` to allow automatic type deduction by the
compiler to avoid long and messy type ids.
This rule should apply everywhere: function parameters, declarations,
constructor initializer lists, etc, applying even if the variable name is not
specified.
A few examples of pointer specifications is given below:
```c++
int* bar(int* foo)
{
// Return type pointer binds to type and does not float in the middle.
}
int a = 0;
int* x; // Pointer is put next to the type
int& y = a; // Reference is put next to the type.
int (*z)[1]; // Special case: pointer binded to 'z' due to requirement of being in paratheses.
int* (*a)(int*) = &bar; // Pointer binded to 'a' due to require of being in paratheses, rest of the
// type maintains pointer being next to the type.
void foo(int* x, int&&); // Forward function declaration pointers and rvalue references bind to type
// even if there is no name.
```
### Unary Increment/Decrement
When the use of the prefix and postfix notation for increment and decrement
operators yield the same effect (typical when the return value is ignored), the
prefix notation is preferred to ensure a consistent style. This applies to all
uses of the increment/decrement operators, including those embedded in
for-loops.
A few examples of the usage of increment/decrement operators:
```c++
int a = 0;
++a; // Preferred over "a++".
for (std::size_t i = 0; i < 5; ++i) // Usage of ++i rather than i++.
{
// for-loop code
}
if (a++ == 0) // Allowed since ++a is not equivalent.
{
// if statement body
}
```
**Note: Clang-format does not have the ability to enforce consistent
prefix/postfix choice, one must manually ensure the correct style is used.**
### Includes
Minimize the amount of include directives used in header files if they can be
placed in the source file (i.e. don't include something used in the source but
not in the header declaration). This helps improve compile times and keeps the
header lean.
Include directives should include header files in the following order:
| Order | Header Type | Description |
| :---: | :--------------: | :--------------------------------------------------------------------------------------------------------------------------- |
| 1 | Main | The main header corresponding to a source (e.g. a source file `foo.cpp` includes `foo.h` as it's main header). |
| 2 | Local/Module | Headers in the same folder as the current file. These headers should be included directly, without specifying the full path. |
| 3 | Project | Headers belonging to the qTox project. These should be specified using full header paths starting within "src/". |
| 4\* | Qt | Headers for Qt objects and functions. |
| 5\* | Other | Headers for any other dependencies (external libraries, tox, C/C++ STL, system headers, etc. |
\* These headers should be included with angle bracket (e.g.
`#include <cstdint>`).
For better header sorting, consider additionally sorting headers in the "other"
category (category 5) in the following order: Tox, external libraries, C/C++
STL and system headers for a smaller include profile (this is not mandatory).
Newlines can be present between includes to indicate logical grouping, however
be wary that clang-format does not sort includes properly this way, electing to
sort each group individually according to the criteria defined above.
The following example demonstrates the above include rules:
```c++
#include "core.h"
#include "cdata.h"
#include "coreav.h"
#include "corefile.h"
#include "cstring.h"
#include "net/avatarbroadcaster.h"
#include "nexus.h"
#include "persistence/profile.h"
#include "persistence/profilelocker.h"
#include "persistence/settings.h"
#include "widget/gui.h"
#include <QCoreApplication>
#include <QThread>
#include <QTimer>
#include <tox/tox.h>
#include <tox/toxav.h>
extern "C" {
#include <libavcodec/avcodec.h>
}
#include <ctime>
#include <functional>
#include <limits>
```
## Documentation
When adding new code to qTox also add doxygen style comments before the
implementation. If an old function is changed, make sure the existing
documentation is updated to reflect the changes or if none exists, add it.
Always attempt to put the documentation at the point of implementation (i.e.
put as much in the source `.cpp` files as possible and minimize clutter in `.h`
files.)
The documentation style mandates the use of `/**` to start a doxygen style
comment, and having ` *` (space asterisk) on all lines following the starting
line. Doxygen keywords like `@brief`, `@param` and `@return` should be used
such that doxygen can intelligently generate the appropriate documentation.
On all updates to master, doxygen comments are automatically generated for the
source code, available at [https://qtox.github.io/doxygen][Doxygen].
```C++
/*...license info...*/
#include "blabla.h"
/**
* @brief I can be briefly described as well!
*
* And here goes my longer descrption!
*
* @param x Description for the first parameter
* @param y Description for the second paramater
* @return An amazing result
*/
static int example(int x, int y)
{
// Function implementation...
}
/**
* @class OurClass
* @brief Exists for some reason...!?
*
* Longer description
*/
/**
* @enum OurClass::OurEnum
* @brief The brief description line.
*
* @var EnumValue1
* means something
*
* @var EnumValue2
* means something else
*
* Optional long description
*/
/**
* @fn OurClass::somethingHappened(const QString &happened)
* @param[in] happened tells what has happened...
* @brief This signal is emitted when something has happened in the class.
*
* Here's an optional longer description of what the signal additionally does.
*/
```
## No translatable HTML tags
Do not put HTML in UI files, or inside Qt's `tr()`. Instead, you can embed HTML
directly into C++ in the following way, to make only the user-facing text
translatable:
```C++
someWidget->setTooltip(QStringLiteral("<html><!-- some HTML text -->") + tr("Translatable text…")
+ QStringLiteral("</html>"));
```
<!-- Markdown links -->
[ISO/IEC/C++11]: http://www.iso.org/iso/catalogue_detail.htm?csnumber=50372
[Exceptions]: https://en.wikipedia.org/wiki/C%2B%2B#Exception_handling
[RTTI]: https://en.wikipedia.org/wiki/Run-time_type_information
[Doxygen]: https://qtox.github.io/doxygen/