summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorPaul Wicking <paul.wicking@qt.io>2020-03-14 09:21:30 +0100
committerPaul Wicking <paul.wicking@qt.io>2020-03-19 06:00:33 +0100
commit6f50422bab3c3683ba3d18f37d7096d0999f4ae4 (patch)
treee2b3249a6b5ce8eb1d973eba75a52ef76f85d0cb /src
parent50ef2ac2f135fda07570aba4f40796df801935bf (diff)
QDoc: Code cleanup in Config
* Prefer list initialization * Unify member variable naming (prefix with 'm_' rather than postfix with '_') Change-Id: I603d184cb455e0523f7a2ab53abea6a0c8872403 Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'src')
-rw-r--r--src/qdoc/config.cpp98
-rw-r--r--src/qdoc/config.h58
2 files changed, 78 insertions, 78 deletions
diff --git a/src/qdoc/config.cpp b/src/qdoc/config.cpp
index dee983004..0f5acb406 100644
--- a/src/qdoc/config.cpp
+++ b/src/qdoc/config.cpp
@@ -240,14 +240,14 @@ QStringList MetaStack::getExpanded(const Location &location)
}
const QString Config::dot = QLatin1String(".");
-bool Config::debug_ = false;
+bool Config::m_debug = false;
bool Config::generateExamples = true;
QString Config::overrideOutputDir;
QString Config::installDir;
QSet<QString> Config::overrideOutputFormats;
-QMap<QString, QString> Config::extractedDirs;
-QStack<QString> Config::workingDirs_;
-QMap<QString, QStringList> Config::includeFilesMap_;
+QMap<QString, QString> Config::m_extractedDirs;
+QStack<QString> Config::m_workingDirs;
+QMap<QString, QStringList> Config::m_includeFilesMap;
/*!
\class Config
@@ -264,7 +264,7 @@ QMap<QString, QStringList> Config::includeFilesMap_;
*/
void Config::init(const QString &programName, const QStringList &args)
{
- prog = programName;
+ m_prog = programName;
processCommandLineOptions(args);
reset();
}
@@ -279,9 +279,9 @@ Config::~Config()
*/
void Config::clear()
{
- loc = lastLocation_ = Location();
- configVars_.clear();
- includeFilesMap_.clear();
+ m_location = m_lastLocation = Location();
+ m_configVars.clear();
+ m_includeFilesMap.clear();
}
/*!
@@ -329,15 +329,15 @@ void Config::reset()
void Config::load(const QString &fileName)
{
// Reset if a previous project was loaded
- if (configVars_.contains(CONFIG_PROJECT))
+ if (m_configVars.contains(CONFIG_PROJECT))
reset();
load(Location(), fileName);
- if (loc.isEmpty())
- loc = Location(fileName);
+ if (m_location.isEmpty())
+ m_location = Location(fileName);
else
- loc.setEtc(true);
- lastLocation_ = Location();
+ m_location.setEtc(true);
+ m_lastLocation = Location();
// Add defines and includepaths from command line to their
// respective configuration variables. Values set here are
@@ -351,7 +351,7 @@ void Config::load(const QString &fileName)
*/
void Config::setStringList(const QString &var, const QStringList &values)
{
- configVars_.replace(var, ConfigVar(var, values, QDir::currentPath()));
+ m_configVars.replace(var, ConfigVar(var, values, QDir::currentPath()));
}
/*!
@@ -360,7 +360,7 @@ void Config::setStringList(const QString &var, const QStringList &values)
*/
void Config::insertStringList(const QString &var, const QStringList &values)
{
- configVars_.insert(var, ConfigVar(var, values, QDir::currentPath()));
+ m_configVars.insert(var, ConfigVar(var, values, QDir::currentPath()));
}
/*!
@@ -385,7 +385,7 @@ void Config::processCommandLineOptions(const QStringList &args)
for (const auto &format : outputFormats)
overrideOutputFormats.insert(format);
- debug_ = m_parser.isSet(m_parser.debugOption);
+ m_debug = m_parser.isSet(m_parser.debugOption);
if (m_parser.isSet(m_parser.prepareOption))
m_qdocPass = Prepare;
@@ -518,21 +518,21 @@ QSet<QString> Config::getOutputFormats() const
*/
QString Config::getString(const QString &var, const QString &defaultString) const
{
- QList<ConfigVar> configVars = configVars_.values(var);
+ QList<ConfigVar> configVars = m_configVars.values(var);
if (!configVars.empty()) {
QString value("");
int i = configVars.size() - 1;
while (i >= 0) {
const ConfigVar &cv = configVars[i];
- if (!cv.location_.isEmpty())
- const_cast<Config *>(this)->lastLocation_ = cv.location_;
- if (!cv.values_.isEmpty()) {
- if (!cv.plus_)
+ if (!cv.m_location.isEmpty())
+ const_cast<Config *>(this)->m_lastLocation = cv.m_location;
+ if (!cv.m_values.isEmpty()) {
+ if (!cv.m_plus)
value.clear();
- for (int j = 0; j < cv.values_.size(); ++j) {
+ for (int j = 0; j < cv.m_values.size(); ++j) {
if (!value.isEmpty() && !value.endsWith(QChar('\n')))
value.append(QChar(' '));
- value.append(cv.values_[j]);
+ value.append(cv.m_values[j]);
}
}
--i;
@@ -568,17 +568,17 @@ QSet<QString> Config::getStringSet(const QString &var) const
*/
QStringList Config::getStringList(const QString &var) const
{
- QList<ConfigVar> configVars = configVars_.values(var);
+ QList<ConfigVar> configVars = m_configVars.values(var);
QStringList values;
if (!configVars.empty()) {
int i = configVars.size() - 1;
while (i >= 0) {
- if (!configVars[i].location_.isEmpty())
- const_cast<Config *>(this)->lastLocation_ = configVars[i].location_;
- if (configVars[i].plus_)
- values.append(configVars[i].values_);
+ if (!configVars[i].m_location.isEmpty())
+ const_cast<Config *>(this)->m_lastLocation = configVars[i].m_location;
+ if (configVars[i].m_plus)
+ values.append(configVars[i].m_values);
else
- values = configVars[i].values_;
+ values = configVars[i].m_values;
--i;
}
}
@@ -603,17 +603,17 @@ QStringList Config::getStringList(const QString &var) const
QStringList Config::getCanonicalPathList(const QString &var, bool validate) const
{
QStringList t;
- QList<ConfigVar> configVars = configVars_.values(var);
+ QList<ConfigVar> configVars = m_configVars.values(var);
if (!configVars.empty()) {
int i = configVars.size() - 1;
while (i >= 0) {
const ConfigVar &cv = configVars[i];
- if (!cv.location_.isEmpty())
- const_cast<Config *>(this)->lastLocation_ = cv.location_;
- if (!cv.plus_)
+ if (!cv.m_location.isEmpty())
+ const_cast<Config *>(this)->m_lastLocation = cv.m_location;
+ if (!cv.m_plus)
t.clear();
- const QString d = cv.currentPath_;
- const QStringList &sl = cv.values_;
+ const QString d = cv.m_currentPath;
+ const QStringList &sl = cv.m_values;
if (!sl.isEmpty()) {
t.reserve(t.size() + sl.size());
for (int i = 0; i < sl.size(); ++i) {
@@ -622,7 +622,7 @@ QStringList Config::getCanonicalPathList(const QString &var, bool validate) cons
if (dir.isRelative())
dir.setPath(d + QLatin1Char('/') + path);
if (validate && !QFileInfo::exists(dir.path()))
- lastLocation_.warning(tr("Cannot find file or directory: %1").arg(path));
+ m_lastLocation.warning(tr("Cannot find file or directory: %1").arg(path));
else {
QString canonicalPath = dir.canonicalPath();
if (!canonicalPath.isEmpty())
@@ -687,7 +687,7 @@ QSet<QString> Config::subVars(const QString &var) const
{
QSet<QString> result;
QString varDot = var + QLatin1Char('.');
- for (auto it = configVars_.constBegin(); it != configVars_.constEnd(); ++it) {
+ for (auto it = m_configVars.constBegin(); it != m_configVars.constEnd(); ++it) {
if (it.key().startsWith(varDot)) {
QString subVar = it.key().mid(varDot.length());
int dot = subVar.indexOf(QLatin1Char('.'));
@@ -708,7 +708,7 @@ QSet<QString> Config::subVars(const QString &var) const
void Config::subVarsAndValues(const QString &var, ConfigVarMultimap &t) const
{
QString varDot = var + QLatin1Char('.');
- for (auto it = configVars_.constBegin(); it != configVars_.constEnd(); ++it) {
+ for (auto it = m_configVars.constBegin(); it != m_configVars.constEnd(); ++it) {
if (it.key().startsWith(varDot)) {
QString subVar = it.key().mid(varDot.length());
int dot = subVar.indexOf(QLatin1Char('.'));
@@ -727,7 +727,7 @@ QString Config::getIncludeFilePath(const QString &fileName) const
QString ext = fileName.mid(fileName.lastIndexOf('.'));
ext.prepend('*');
- if (!includeFilesMap_.contains(ext)) {
+ if (!m_includeFilesMap.contains(ext)) {
QSet<QString> t;
QStringList result;
const auto sourceDirs = getCanonicalPathList(CONFIG_SOURCEDIRS);
@@ -737,9 +737,9 @@ QString Config::getIncludeFilePath(const QString &fileName) const
const auto exampleDirs = getCanonicalPathList(CONFIG_EXAMPLEDIRS);
for (const auto &dir : exampleDirs)
result += getFilesHere(dir, ext, location(), t, t);
- includeFilesMap_.insert(ext, result);
+ m_includeFilesMap.insert(ext, result);
}
- const QStringList &paths = (*includeFilesMap_.find(ext));
+ const QStringList &paths = (*m_includeFilesMap.find(ext));
for (const auto &path : paths) {
if (path.endsWith(fileName))
return path;
@@ -845,7 +845,7 @@ QString Config::findFile(const Location &location, const QStringList &files,
userFriendlyFilePath->append(*c);
if (isArchive) {
- QString extracted = extractedDirs[fileInfo.filePath()];
+ QString extracted = m_extractedDirs[fileInfo.filePath()];
++c;
fileInfo.setFile(QDir(extracted), *c);
} else {
@@ -1220,9 +1220,9 @@ void Config::load(Location location, const QString &fileName)
keyLoc.fatal(tr("Invalid key '%1'").arg(key));
ConfigVarMultimap::Iterator i;
- i = configVars_.insert(key,
+ i = m_configVars.insert(key,
ConfigVar(key, rhsValues, QDir::currentPath(), keyLoc));
- i.value().plus_ = plus;
+ i.value().m_plus = plus;
}
}
} else {
@@ -1230,8 +1230,8 @@ void Config::load(Location location, const QString &fileName)
}
}
popWorkingDir();
- if (!workingDirs_.isEmpty())
- QDir::setCurrent(workingDirs_.top());
+ if (!m_workingDirs.isEmpty())
+ QDir::setCurrent(m_workingDirs.top());
}
bool Config::isFileExcluded(const QString &fileName, const QSet<QString> &excludedFiles)
@@ -1285,7 +1285,7 @@ QStringList Config::getFilesHere(const QString &uncleanDir, const QString &nameF
*/
void Config::pushWorkingDir(const QString &dir)
{
- workingDirs_.push(dir);
+ m_workingDirs.push(dir);
}
/*!
@@ -1294,8 +1294,8 @@ void Config::pushWorkingDir(const QString &dir)
*/
QString Config::popWorkingDir()
{
- if (!workingDirs_.isEmpty())
- return workingDirs_.pop();
+ if (!m_workingDirs.isEmpty())
+ return m_workingDirs.pop();
qDebug() << "RETURNED EMPTY WORKING DIR";
return QString();
diff --git a/src/qdoc/config.h b/src/qdoc/config.h
index 30b2637f6..29ad59afb 100644
--- a/src/qdoc/config.h
+++ b/src/qdoc/config.h
@@ -66,22 +66,22 @@ protected:
*/
struct ConfigVar
{
- bool plus_;
- QString name_;
- QStringList values_;
- QString currentPath_;
- Location location_;
+ bool m_plus {};
+ QString m_name {};
+ QStringList m_values {};
+ QString m_currentPath {};
+ Location m_location {};
- ConfigVar() : plus_(false) {}
+ ConfigVar() : m_plus(false) {}
ConfigVar(const QString &name, const QStringList &values, const QString &dir)
- : plus_(true), name_(name), values_(values), currentPath_(dir)
+ : m_plus(true), m_name(name), m_values(values), m_currentPath(dir)
{
}
ConfigVar(const QString &name, const QStringList &values, const QString &dir,
const Location &loc)
- : plus_(false), name_(name), values_(values), currentPath_(dir), location_(loc)
+ : m_plus(false), m_name(name), m_values(values), m_currentPath(dir), m_location(loc)
{
}
};
@@ -101,7 +101,7 @@ public:
enum QDocPass { Neither, Prepare, Generate };
void init(const QString &programName, const QStringList &args);
- bool getDebug() const { return debug_; }
+ bool getDebug() const { return m_debug; }
void clear();
void reset();
@@ -111,9 +111,9 @@ public:
void showHelp(int exitCode = 0) { m_parser.showHelp(exitCode); }
QStringList qdocFiles() const { return m_parser.positionalArguments(); }
- const QString &programName() const { return prog; }
- const Location &location() const { return loc; }
- const Location &lastLocation() const { return lastLocation_; }
+ const QString &programName() const { return m_prog; }
+ const Location &location() const { return m_location; }
+ const Location &lastLocation() const { return m_lastLocation; }
bool getBool(const QString &var) const;
int getInt(const QString &var) const;
@@ -185,29 +185,29 @@ private:
void setIncludePaths();
void setIndexDirs();
- QStringList m_dependModules;
- QStringList m_defines;
- QStringList m_includePaths;
- QStringList m_indexDirs;
- QString m_currentDir;
- QString m_previousCurrentDir;
+ QStringList m_dependModules {};
+ QStringList m_defines {};
+ QStringList m_includePaths {};
+ QStringList m_indexDirs {};
+ QString m_currentDir {};
+ QString m_previousCurrentDir {};
- static bool debug_;
+ static bool m_debug;
static bool isMetaKeyChar(QChar ch);
void load(Location location, const QString &fileName);
- QString prog;
- Location loc;
- Location lastLocation_;
- ConfigVarMultimap configVars_;
+ QString m_prog {};
+ Location m_location {};
+ Location m_lastLocation {};
+ ConfigVarMultimap m_configVars {};
- static QMap<QString, QString> uncompressedFiles;
- static QMap<QString, QString> extractedDirs;
- static QStack<QString> workingDirs_;
- static QMap<QString, QStringList> includeFilesMap_;
- QDocCommandLineParser m_parser;
+ static QMap<QString, QString> m_uncompressedFiles;
+ static QMap<QString, QString> m_extractedDirs;
+ static QStack<QString> m_workingDirs;
+ static QMap<QString, QStringList> m_includeFilesMap;
+ QDocCommandLineParser m_parser {};
- QDocPass m_qdocPass = Neither;
+ QDocPass m_qdocPass { Neither };
};
struct ConfigStrings