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(coding): add guides about string usage

Browse Source 
Add guides about using QStringLiteral, QLatin1String, QLatin1Char and QStringBuilder for more efficient strings.

Qt uses uses these techniques internally and can be considered as good coding practice when working with Qt libraries.
This commit is contained in:
Vincas Dargis 2017-06-17 19:12:28 +03:00
parent b39a15873d
commit bf8ecb4419
1 changed files with 68 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
doc/coding_standards.md
View File

@ -467,8 +467,76 @@ someWidget->setTooltip(QStringLiteral("<html><!-- some HTML text -->") + tr("Tra
+ QStringLiteral("</html>")); + QStringLiteral("</html>"));
``` ```
## Strings
* Use `QStringLiteral` macro when creating new string.
In this example, string is not intended to be modified or copied (like
appending) into other string:
```
QApplication a(argc, argv);
a.setApplicationName(QStringLiteral("qTox"));
```
* Use `QLatin1String` when specialized overload exists.
Overload such as `QString::operator==(QLatin1String)` helps to avoid creating
temporary QString and thus avoids malloc:
```
if (eventType == QLatin1String("uri"))
handleToxURI(firstParam.toUtf8());
else if (eventType == QLatin1String("save"))
handleToxSave(firstParam.toUtf8());
```
* Use `QLatin1String` when appending to string, joining two strings.
QLatin1String is literal type and knows string length at compile time
(compared to `QString(const char*)` run-time cost with plain C++
string literal). Also, copying 8-bit latin string requires less memory
bandwith compared to 16-bit `QStringLiteral` mentioned earlier, and
copying here is unavoidable (and thus `QStringLiteral` loses it's purpose):
```
if (!dir.rename(logFileDir + QLatin1String("qtox.log"),
logFileDir + QLatin1String("qtox.log.1")))
qCritical() << "Unable to move logs";
```
* Use `QStringBuilder` when joining more than two strings (and chars) together.
Include `<QStringBuilder>` and use `%` operator for optimized single-pass
concatination with help of expression template's lazy evaluation:
```
QCommandLineParser parser;
parser.setApplicationDescription(QLatin1String("qTox, version: ")
% QLatin1String(GIT_VERSION) % QLatin1String("\nBuilt: ")
% QLatin1String(__TIME__) % QLatin1Char(' ') % QLatin1String(__DATE__));
```
* Use `QLatin1Char` to avoid UTF-16-char handling (same as in previous example):
```
QString path = QString(__FILE__);
path = path.left(path.lastIndexOf(QLatin1Char('/')) + 1);
```
* Use `QLatin1String` and `QLatin1Char` _only_ for Latin-1 strings and chars.
[Latin-1][Latin-1] is ASCII-based standard character encoding, use
`QStringLiteral` for Unicode instead.
For more info, see:
* [Using QString Effectively]
* [QStringLiteral explained]
* [String concatenation with QStringBuilder]
<!-- Markdown links --> <!-- Markdown links -->
[ISO/IEC/C++11]: http://www.iso.org/iso/catalogue_detail.htm?csnumber=50372 [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 [Exceptions]: https://en.wikipedia.org/wiki/C%2B%2B#Exception_handling
[RTTI]: https://en.wikipedia.org/wiki/Run-time_type_information [RTTI]: https://en.wikipedia.org/wiki/Run-time_type_information
[`tools/format-code.sh`]: /tools/format-code.sh [`tools/format-code.sh`]: /tools/format-code.sh
[Using QString Effectively]: https://wiki.qt.io/Using_QString_Effectively
[QStringLiteral explained]: https://woboq.com/blog/qstringliteral.html
[String concatenation with QStringBuilder]: https://blog.qt.io/blog/2011/06/13/string-concatenation-with-qstringbuilder/
[Latin-1]: https://en.wikipedia.org/wiki/ISO/IEC_8859-1