blob: 00c717473e6a344cca401bd43496c84a0df6168c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
|
# Open Screen Library Style Guide
The Open Screen Library follows the
[Chromium C++ coding style](https://chromium.googlesource.com/chromium/src/+/master/styleguide/c++/c++.md).
We also follow the
[Chromium C++ Do's and Don'ts](https://sites.google.com/a/chromium.org/dev/developers/coding-style/cpp-dos-and-donts).
C++14 language and library features are allowed in the Open Screen Library
according to the
[C++14 use in Chromium](https://chromium-cpp.appspot.com#core-whitelist) guidelines.
## Open Screen Library Features
- For public API functions that return values or errors, please return
[`ErrorOr<T>`](https://chromium.googlesource.com/openscreen/+/master/base/error.h).
## Style Addenda
- Prefer to omit braces for single-line if statements.
## Copy and Move Operators
Use the following guidelines when deciding on copy and move semantics for
objects.
- Objects with data members greater than 32 bytes should be move-able.
- Known large objects (I/O buffers, etc.) should be be move-only.
- Application or client provided objects of variable length should be move-able
(since they may be arbitrarily large in size) and, if possible, move-only.
- Inherently non-copyable objects (like sockets) should be move-only.
We [prefer the use of `default` and `delete`](https://sites.google.com/a/chromium.org/dev/developers/coding-style/cpp-dos-and-donts#TOC-Prefer-to-use-default)
to declare the copy and move semantics of objects. See
[Stoustrop's C++ FAQ](http://www.stroustrup.com/C++11FAQ.html#default)
for details on how to do that.
## Noexcept
We prefer to use `noexcept` on move constructors. Although exceptions are not
allowed, this declaration [enables STL optimizations](https://en.cppreference.com/w/cpp/language/noexcept_spec).
## Disallowed Styles and Features
Blink style is *not allowed* anywhere in the Open Screen Library.
C++17-only features are currently *not allowed* in the Open Screen Library.
|
