qloggingregistry.cpp

Absolute File Name:

/home/qt/qt5_coco/qt5/qtbase/src/corelib/io/qloggingregistry.cpp

Source code

Switch to Preprocessed file

Line Source Count

1 /**************************************************************************** -

2 ** -

4 ** Contact: https://www.qt.io/licensing/ -

5 ** -

6 ** This file is part of the QtCore module of the Qt Toolkit. -

7 ** -

8 ** $QT_BEGIN_LICENSE:LGPL$ -

9 ** Commercial License Usage -

10 ** Licensees holding valid commercial Qt licenses may use this file in -

11 ** accordance with the commercial license agreement provided with the -

12 ** Software or, alternatively, in accordance with the terms contained in -

13 ** a written agreement between you and The Qt Company. For licensing terms -

14 ** and conditions see https://www.qt.io/terms-conditions. For further -

15 ** information use the contact form at https://www.qt.io/contact-us. -

16 ** -

17 ** GNU Lesser General Public License Usage -

18 ** Alternatively, this file may be used under the terms of the GNU Lesser -

19 ** General Public License version 3 as published by the Free Software -

20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the -

21 ** packaging of this file. Please review the following information to -

22 ** ensure the GNU Lesser General Public License version 3 requirements -

23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. -

24 ** -

25 ** GNU General Public License Usage -

26 ** Alternatively, this file may be used under the terms of the GNU -

27 ** General Public License version 2.0 or (at your option) the GNU General -

28 ** Public license version 3 or any later version approved by the KDE Free -

29 ** Qt Foundation. The licenses are as published by the Free Software -

30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 -

31 ** included in the packaging of this file. Please review the following -

32 ** information to ensure the GNU General Public License requirements will -

33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and -

34 ** https://www.gnu.org/licenses/gpl-3.0.html. -

35 ** -

36 ** $QT_END_LICENSE$ -

37 ** -

38 ****************************************************************************/ -

39 -

40 #include "qloggingregistry_p.h" -

41 -

42 #include <QtCore/qfile.h> -

43 #include <QtCore/qlibraryinfo.h> -

44 #include <QtCore/qstandardpaths.h> -

45 #include <QtCore/qtextstream.h> -

46 #include <QtCore/qdir.h> -

47 -

48 // We can't use the default macros because this would lead to recursion. -

49 // Instead let's define our own one that unconditionally logs... -

50 #define debugMsg QMessageLogger(__FILE__, __LINE__, __FUNCTION__, "qt.core.logging").debug -

51 #define warnMsg QMessageLogger(__FILE__, __LINE__, __FUNCTION__, "qt.core.logging").warning -

52 -

53 -

54 QT_BEGIN_NAMESPACE -

55 -

56 Q_GLOBAL_STATIC(QLoggingRegistry, qtLoggingRegistry) -

57 -

58 /*! -

59 \internal -

60 Constructs a logging rule with default values. -

61 */ -

62 QLoggingRule::QLoggingRule() : -

63 enabled(false) -

64 { -

65 } -

66 -

67 /*! -

68 \internal -

69 Constructs a logging rule. -

70 */ -

71 QLoggingRule::QLoggingRule(const QStringRef &pattern, bool enabled) : -

72 messageType(-1), -

73 enabled(enabled) -

74 { -

75 parse(pattern); -

76 } -

77 -

78 /*! -

79 \internal -

80 Return value 1 means filter passed, 0 means filter doesn't influence this -

81 category, -1 means category doesn't pass this filter. -

82 */ -

83 int QLoggingRule::pass(const QString &cat, QtMsgType msgType) const -

84 { -

85 // check message type -

86 if (messageType > -1 && messageType != msgType) -

87 return 0; -

88 -

89 if (flags == FullText) { -

90 // full match -

91 if (category == cat) -

92 return (enabled ? 1 : -1); -

93 else -

94 return 0; -

95 } -

96 -

97 const int idx = cat.indexOf(category); -

98 if (idx >= 0) { -

99 if (flags == MidFilter) { -

100 // matches somewhere -

101 if (idx >= 0) -

102 return (enabled ? 1 : -1); -

103 } else if (flags == LeftFilter) { -

104 // matches left -

105 if (idx == 0) -

106 return (enabled ? 1 : -1); -

107 } else if (flags == RightFilter) { -

108 // matches right -

109 if (idx == (cat.count() - category.count())) -

110 return (enabled ? 1 : -1); -

111 } -

112 } -

113 return 0; -

114 } -

115 -

116 /*! -

117 \internal -

118 Parses \a pattern. -

119 Allowed is f.ex.: -

120 qt.core.io.debug FullText, QtDebugMsg -

121 qt.core.* LeftFilter, all types -

122 *.io.warning RightFilter, QtWarningMsg -

123 *.core.* MidFilter -

124 */ -

125 void QLoggingRule::parse(const QStringRef &pattern) -

126 { -

127 QStringRef p; -

128 -

129 // strip trailing ".messagetype" -

130 if (pattern.endsWith(QLatin1String(".debug"))) { -

131 p = QStringRef(pattern.string(), pattern.position(), -

132 pattern.length() - 6); // strlen(".debug") -

133 messageType = QtDebugMsg; -

134 } else if (pattern.endsWith(QLatin1String(".info"))) { -

135 p = QStringRef(pattern.string(), pattern.position(), -

136 pattern.length() - 5); // strlen(".info") -

137 messageType = QtInfoMsg; -

138 } else if (pattern.endsWith(QLatin1String(".warning"))) { -

139 p = QStringRef(pattern.string(), pattern.position(), -

140 pattern.length() - 8); // strlen(".warning") -

141 messageType = QtWarningMsg; -

142 } else if (pattern.endsWith(QLatin1String(".critical"))) { -

143 p = QStringRef(pattern.string(), pattern.position(), -

144 pattern.length() - 9); // strlen(".critical") -

145 messageType = QtCriticalMsg; -

146 } else { -

147 p = pattern; -

148 } -

149 -

150 if (!p.contains(QLatin1Char('*'))) { -

151 flags = FullText; -

152 } else { -

153 if (p.endsWith(QLatin1Char('*'))) { -

154 flags |= LeftFilter; -

155 p = QStringRef(p.string(), p.position(), p.length() - 1); -

156 } -

157 if (p.startsWith(QLatin1Char('*'))) { -

158 flags |= RightFilter; -

159 p = QStringRef(p.string(), p.position() + 1, p.length() - 1); -

160 } -

161 if (p.contains(QLatin1Char('*'))) // '*' only supported at start/end -

162 flags = 0; -

163 } -

164 -

165 category = p.toString(); -

166 } -

167 -

168 /*! -

169 \class QLoggingSettingsParser -

170 \since 5.3 -

171 \internal -

172 -

173 Parses a .ini file with the following format: -

174 -

175 [rules] -

176 rule1=[true|false] -

177 rule2=[true|false] -

178 ... -

179 -

180 [rules] is the default section, and therefore optional. -

181 */ -

182 -

183 /*! -

184 \internal -

185 Parses configuration from \a content. -

186 */ -

187 void QLoggingSettingsParser::setContent(const QString &content) -

188 { -

189 QString content_ = content; -

190 QTextStream stream(&content_, QIODevice::ReadOnly); -

191 setContent(stream); -

192 } -

193 -

194 /*! -

195 \internal -

196 Parses configuration from \a stream. -

197 */ -

198 void QLoggingSettingsParser::setContent(QTextStream &stream) -

199 { -

200 _rules.clear(); -

201 while (!stream.atEnd()) { -

202 QString line = stream.readLine(); -

203 -

204 // Remove all whitespace from line -

205 line = line.simplified(); -

206 line.remove(QLatin1Char(' ')); -

207 -

208 // comment -

209 if (line.startsWith(QLatin1Char(';'))) -

210 continue; -

211 -

212 if (line.startsWith(QLatin1Char('[')) && line.endsWith(QLatin1Char(']'))) { -

213 // new section -

214 _section = line.mid(1, line.size() - 2); -

215 continue; -

216 } -

217 -

218 if (_section.toLower() == QLatin1String("rules")) { -

219 int equalPos = line.indexOf(QLatin1Char('=')); -

220 if (equalPos != -1) { -

221 if (line.lastIndexOf(QLatin1Char('=')) == equalPos) { -

222 const QStringRef pattern = line.leftRef(equalPos); -

223 const QStringRef valueStr = line.midRef(equalPos + 1); -

224 int value = -1; -

225 if (valueStr == QLatin1String("true")) -

226 value = 1; -

227 else if (valueStr == QLatin1String("false")) -

228 value = 0; -

229 QLoggingRule rule(pattern, (value == 1)); -

230 if (rule.flags != 0 && (value != -1)) -

231 _rules.append(rule); -

232 else -

233 warnMsg("Ignoring malformed logging rule: '%s'", line.toUtf8().constData()); -

234 } else { -

235 warnMsg("Ignoring malformed logging rule: '%s'", line.toUtf8().constData()); -

236 } -

237 } -

238 } -

239 } -

240 } -

241 -

242 /*! -

243 \internal -

244 QLoggingRegistry constructor -

245 */ -

246 QLoggingRegistry::QLoggingRegistry() -

247 : categoryFilter(defaultCategoryFilter) -

248 { -

249 } -

250 -

251 static bool qtLoggingDebug() -

252 { -

253 static const bool debugEnv = qEnvironmentVariableIsSet("QT_LOGGING_DEBUG"); -

254 return debugEnv; -

255 } -

256 -

257 static QVector<QLoggingRule> loadRulesFromFile(const QString &filePath) -

258 { -

259 QFile file(filePath); -

260 if (file.open(QIODevice::ReadOnly | QIODevice::Text)) { -

261 if (qtLoggingDebug()) -

262 debugMsg("Loading \"%s\" ...", -

263 QDir::toNativeSeparators(file.fileName()).toUtf8().constData()); -

264 QTextStream stream(&file); -

265 QLoggingSettingsParser parser; -

266 parser.setContent(stream); -

267 return parser.rules(); -

268 } -

269 return QVector<QLoggingRule>(); -

270 } -

271 -

272 /*! -

273 \internal -

274 Initializes the rules database by loading -

275 $QT_LOGGING_CONF, $QT_LOGGING_RULES, and .config/QtProject/qtlogging.ini. -

276 */ -

277 void QLoggingRegistry::init() -

278 { -

279 QVector<QLoggingRule> er, qr, cr;// get rules from environment -

280 const QByteArray rulesFilePath = qgetenv("QT_LOGGING_CONF"); -

281

if (!rulesFilePath.isEmpty())

!rulesFilePath.isEmpty()

Description

TRUE

evaluated 3 times by 1 test

Evaluated by:

tst_QLoggingRegistry

FALSE

evaluated 1078 times by 23 tests

Evaluated by:

tst_QApplication
tst_QCommandLineParser
tst_QCoreApplication
tst_QDBusConnectionNoBus
tst_QDBusConnectionNoLibDBus1
tst_QDBusConnection_Delayed
tst_QDnsLookup_Appless
tst_QGlobal
tst_QGuiApplication
tst_QNetworkConfigurationManager
tst_QSql
tst_qapplication - unknown status
tst_qdbusabstractadaptor - unknown status
tst_qdbusabstractinterface - unknown status
tst_qdbusinterface - unknown status
tst_qdbusmarshall - unknown status
tst_qdbusxml2cpp - unknown status
tst_qlogging - unknown status
tst_qobject - unknown status
tst_qprocess - unknown status
tst_qsharedmemory - unknown status
tst_qsystemsemaphore - unknown status
tst_selftests - unknown status

3-1078

282

erenvRules = loadRulesFromFile(QFile::decodeName(rulesFilePath));

executed 3 times by 1 test: envRules = loadRulesFromFile(QFile::decodeName(rulesFilePath));

Executed by:

tst_QLoggingRegistry

283 -

284 const QByteArray rulesSrc = qgetenv("QT_LOGGING_RULES").replace(';', '\n'); -

285

if (!rulesSrc.isEmpty()) {

!rulesSrc.isEmpty()

Description

TRUE

evaluated 2 times by 1 test

Evaluated by:

tst_QLoggingRegistry

FALSE

evaluated 1079 times by 24 tests

Evaluated by:

tst_QApplication
tst_QCommandLineParser
tst_QCoreApplication
tst_QDBusConnectionNoBus
tst_QDBusConnectionNoLibDBus1
tst_QDBusConnection_Delayed
tst_QDnsLookup_Appless
tst_QGlobal
tst_QGuiApplication
tst_QLoggingRegistry
tst_QNetworkConfigurationManager
tst_QSql
tst_qapplication - unknown status
tst_qdbusabstractadaptor - unknown status
tst_qdbusabstractinterface - unknown status
tst_qdbusinterface - unknown status
tst_qdbusmarshall - unknown status
tst_qdbusxml2cpp - unknown status
tst_qlogging - unknown status
tst_qobject - unknown status
tst_qprocess - unknown status
tst_qsharedmemory - unknown status
tst_qsystemsemaphore - unknown status
tst_selftests - unknown status

2-1079

286 QTextStream stream(rulesSrc); -

287 QLoggingSettingsParser parser; -

288 parser.setSection(QStringLiteral("Rules")); -

289 parser.setContent(stream); -

290 erenvRules += parser.rules(); -

291

}

executed 2 times by 1 test: end of block

Executed by:

tst_QLoggingRegistry

292 -

293

const QString configFileName = QStringLiteral("qtlogging.ini");

executed 1081 times by 24 tests: return qstring_literal_temp;

Executed by:

tst_QApplication
tst_QCommandLineParser
tst_QCoreApplication
tst_QDBusConnectionNoBus
tst_QDBusConnectionNoLibDBus1
tst_QDBusConnection_Delayed
tst_QDnsLookup_Appless
tst_QGlobal
tst_QGuiApplication
tst_QLoggingRegistry
tst_QNetworkConfigurationManager
tst_QSql
tst_qapplication - unknown status
tst_qdbusabstractadaptor - unknown status
tst_qdbusabstractinterface - unknown status
tst_qdbusinterface - unknown status
tst_qdbusmarshall - unknown status
tst_qdbusxml2cpp - unknown status
tst_qlogging - unknown status
tst_qobject - unknown status
tst_qprocess - unknown status
tst_qsharedmemory - unknown status
tst_qsystemsemaphore - unknown status
tst_selftests - unknown status

1081

294 -

295 #if !defined(QT_BOOTSTRAPPED) -

296 // get rules from Qt data configuration path -

297 const QString qtConfigPath -

298 = QDir(QLibraryInfo::location(QLibraryInfo::DataPath)).absoluteFilePath(configFileName); -

299 qrqtConfigRules = loadRulesFromFile(qtConfigPath); -

300 #endif -

301 -

302 // get rules from user's/system configuration -

303 const QString envPath = QStandardPaths::locate(QStandardPaths::GenericConfigLocation, -

304 QString::fromLatin1("QtProject/") + configFileName); -

305

if (!envPath.isEmpty())

!envPath.isEmpty()

Description

TRUE

evaluated 1 time by 1 test

Evaluated by:

tst_QLoggingRegistry

FALSE

evaluated 1079 times by 24 tests

Evaluated by:

tst_QApplication
tst_QCommandLineParser
tst_QCoreApplication
tst_QDBusConnectionNoBus
tst_QDBusConnectionNoLibDBus1
tst_QDBusConnection_Delayed
tst_QDnsLookup_Appless
tst_QGlobal
tst_QGuiApplication
tst_QLoggingRegistry
tst_QNetworkConfigurationManager
tst_QSql
tst_qapplication - unknown status
tst_qdbusabstractadaptor - unknown status
tst_qdbusabstractinterface - unknown status
tst_qdbusinterface - unknown status
tst_qdbusmarshall - unknown status
tst_qdbusxml2cpp - unknown status
tst_qlogging - unknown status
tst_qobject - unknown status
tst_qprocess - unknown status
tst_qsharedmemory - unknown status
tst_qsystemsemaphore - unknown status
tst_selftests - unknown status

1-1079

306

crconfigRules = loadRulesFromFile(envPath);