From 933343b16de25f9f7eb6e0bcf9157b31f2557092 Mon Sep 17 00:00:00 2001 From: Alexey Edelev Date: Tue, 9 Mar 2021 17:51:31 +0100 Subject: Move qtpaths from qttools repository to qtbase qtpath should replicate the functionality of 'qmake -query'. Also we want this tool to be available in builds without qttools. Task-number: QTBUG-75870 Change-Id: I6578fc4fc45dd940fd353a5cfe6db0a12744230a Reviewed-by: Alexandru Croitor --- src/tools/CMakeLists.txt | 3 + src/tools/qtpaths/CMakeLists.txt | 24 +++ src/tools/qtpaths/qtpaths.cpp | 325 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 352 insertions(+) create mode 100644 src/tools/qtpaths/CMakeLists.txt create mode 100644 src/tools/qtpaths/qtpaths.cpp diff --git a/src/tools/CMakeLists.txt b/src/tools/CMakeLists.txt index 463f8bcc5b..b73c050e5b 100644 --- a/src/tools/CMakeLists.txt +++ b/src/tools/CMakeLists.txt @@ -5,6 +5,9 @@ if (QT_FEATURE_dbus) endif() add_subdirectory(qlalr) add_subdirectory(qvkgen) +if (QT_FEATURE_commandlineparser) + add_subdirectory(qtpaths) +endif() # Only include the following tools when performing a host build if(NOT CMAKE_CROSSCOMPILING) diff --git a/src/tools/qtpaths/CMakeLists.txt b/src/tools/qtpaths/CMakeLists.txt new file mode 100644 index 0000000000..a866000eaa --- /dev/null +++ b/src/tools/qtpaths/CMakeLists.txt @@ -0,0 +1,24 @@ +# Generated from qtpaths.pro. + +##################################################################### +## qtpaths App: +##################################################################### + +qt_get_tool_target_name(target_name qtpaths) +qt_internal_add_tool(${target_name} + TARGET_DESCRIPTION "Qt tool that provides the standard paths of the Qt framework" + TOOLS_TARGET Core + SOURCES + qtpaths.cpp + DEFINES + QT_NO_FOREACH +) + +## Scopes: +##################################################################### + +if(WIN32) + set_target_properties(qtpaths PROPERTIES + WIN32_EXECUTABLE FALSE + ) +endif() diff --git a/src/tools/qtpaths/qtpaths.cpp b/src/tools/qtpaths/qtpaths.cpp new file mode 100644 index 0000000000..93e2e42a5f --- /dev/null +++ b/src/tools/qtpaths/qtpaths.cpp @@ -0,0 +1,325 @@ +/**************************************************************************** + * * + ** Copyright (C) 2016 Sune Vuorela + ** Contact: http://www.qt-project.org/ + ** + ** This file is part of the tools applications of the Qt Toolkit. + ** + ** $QT_BEGIN_LICENSE:BSD$ + ** Commercial License Usage + ** Licensees holding valid commercial Qt licenses may use this file in + ** accordance with the commercial license agreement provided with the + ** Software or, alternatively, in accordance with the terms contained in + ** a written agreement between you and The Qt Company. For licensing terms + ** and conditions see https://www.qt.io/terms-conditions. For further + ** information use the contact form at https://www.qt.io/contact-us. + ** + ** BSD License Usage + ** Alternatively, you may use this file under the terms of the BSD license + ** as follows: + ** + ** "Redistribution and use in source and binary forms, with or without + ** modification, are permitted provided that the following conditions are + ** met: + ** * Redistributions of source code must retain the above copyright + ** notice, this list of conditions and the following disclaimer. + ** * Redistributions in binary form must reproduce the above copyright + ** notice, this list of conditions and the following disclaimer in + ** the documentation and/or other materials provided with the + ** distribution. + ** * Neither the name of The Qt Company Ltd nor the names of its + ** contributors may be used to endorse or promote products derived + ** from this software without specific prior written permission. + ** + ** + ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + ** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + ** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." + ** + ** $QT_END_LICENSE$ + ** + ****************************************************************************/ + +#include +#include +#include +#include +#include + +#include + +#include + +QT_USE_NAMESPACE + +/** + * Prints the string on stdout and appends a newline + * \param string printable string + */ +static void message(const QString &string) +{ + fprintf(stdout, "%s\n", qPrintable(string)); +} + +/** + * Writes error message and exits 1 + * \param message to write + */ +Q_NORETURN static void error(const QString &message) +{ + fprintf(stderr, "%s\n", qPrintable(message)); + ::exit(EXIT_FAILURE); +} + +class StringEnum { +public: + const char *stringvalue; + QStandardPaths::StandardLocation enumvalue; + bool hasappname; + + /** + * Replace application name by generic name if requested + */ + QString mapName(const QString &s) const + { + return hasappname ? QString(s).replace("qtpaths", "") : s; + } +}; + +static const StringEnum lookupTableData[] = { + { "AppConfigLocation", QStandardPaths::AppConfigLocation, true }, + { "AppDataLocation", QStandardPaths::AppDataLocation, true }, + { "AppLocalDataLocation", QStandardPaths::AppLocalDataLocation, true }, + { "ApplicationsLocation", QStandardPaths::ApplicationsLocation, false }, + { "CacheLocation", QStandardPaths::CacheLocation, true }, + { "ConfigLocation", QStandardPaths::ConfigLocation, false }, +#if QT_VERSION < QT_VERSION_CHECK(6,0,0) + { "DataLocation", QStandardPaths::DataLocation, true }, +#endif + { "DesktopLocation", QStandardPaths::DesktopLocation, false }, + { "DocumentsLocation", QStandardPaths::DocumentsLocation, false }, + { "DownloadLocation", QStandardPaths::DownloadLocation, false }, + { "FontsLocation", QStandardPaths::FontsLocation, false }, + { "GenericCacheLocation", QStandardPaths::GenericCacheLocation, false }, + { "GenericConfigLocation", QStandardPaths::GenericConfigLocation, false }, + { "GenericDataLocation", QStandardPaths::GenericDataLocation, false }, + { "HomeLocation", QStandardPaths::HomeLocation, false }, + { "MoviesLocation", QStandardPaths::MoviesLocation, false }, + { "MusicLocation", QStandardPaths::MusicLocation, false }, + { "PicturesLocation", QStandardPaths::PicturesLocation, false }, + { "RuntimeLocation", QStandardPaths::RuntimeLocation, false }, + { "TempLocation", QStandardPaths::TempLocation, false } +}; + +/** + * \return available types as a QStringList. + */ +static QStringList types() +{ + QStringList typelist; + for (const StringEnum &se : lookupTableData) + typelist << QString::fromLatin1(se.stringvalue); + std::sort(typelist.begin(), typelist.end()); + return typelist; +} + +/** + * Tries to parse the location string into a reference to a StringEnum entry or alternatively + * calls \ref error with a error message + */ +static const StringEnum &parseLocationOrError(const QString &locationString) +{ + for (const StringEnum &se : lookupTableData) + if (locationString == QLatin1String(se.stringvalue)) + return se; + + QString message = QCoreApplication::translate("qtpaths", "Unknown location: %1"); + error(message.arg(locationString)); +} + +/** + * searches for exactly one remaining argument and returns it. + * If not found, \ref error is called with a error message. + * \param parser to ask for remaining arguments + * \return one extra argument + */ +static QString searchStringOrError(QCommandLineParser *parser) +{ + int positionalArgumentCount = parser->positionalArguments().size(); + if (positionalArgumentCount != 1) + error(QCoreApplication::translate("qtpaths", "Exactly one argument needed as searchitem")); + return parser->positionalArguments().constFirst(); +} + +int main(int argc, char **argv) +{ + QCoreApplication app(argc, argv); + app.setApplicationVersion("1.0"); + +#ifdef Q_OS_WIN + const QLatin1Char pathsep(';'); +#else + const QLatin1Char pathsep(':'); +#endif + + QCommandLineParser parser; + parser.setApplicationDescription(QCoreApplication::translate("qtpaths", "Command line client to QStandardPaths")); + parser.addPositionalArgument(QCoreApplication::translate("qtpaths", "[name]"), QCoreApplication::tr("Name of file or directory")); + parser.addHelpOption(); + parser.addVersionOption(); + + //setting up options + QCommandLineOption types(QStringLiteral("types"), QCoreApplication::translate("qtpaths", "Available location types.")); + parser.addOption(types); + + QCommandLineOption paths(QStringLiteral("paths"), QCoreApplication::translate("qtpaths", "Find paths for ."), QStringLiteral("type")); + parser.addOption(paths); + + QCommandLineOption writablePath(QStringLiteral("writable-path"), + QCoreApplication::translate("qtpaths", "Find writable path for ."), QStringLiteral("type")); + parser.addOption(writablePath); + + QCommandLineOption locateDir(QStringList() << QStringLiteral("locate-dir") << QStringLiteral("locate-directory"), + QCoreApplication::translate("qtpaths", "Locate directory [name] in ."), QStringLiteral("type")); + parser.addOption(locateDir); + + QCommandLineOption locateDirs(QStringList() << QStringLiteral("locate-dirs") << QStringLiteral("locate-directories"), + QCoreApplication::translate("qtpaths", "Locate directories [name] in all paths for ."), QStringLiteral("type")); + parser.addOption(locateDirs); + + QCommandLineOption locateFile(QStringLiteral("locate-file"), + QCoreApplication::translate("qtpaths", "Locate file [name] for ."), QStringLiteral("type")); + parser.addOption(locateFile); + + QCommandLineOption locateFiles(QStringLiteral("locate-files"), + QCoreApplication::translate("qtpaths", "Locate files [name] in all paths for ."), QStringLiteral("type")); + parser.addOption(locateFiles); + + QCommandLineOption findExe(QStringList() << QStringLiteral("find-exe") << QStringLiteral("find-executable"), + QCoreApplication::translate("qtpaths", "Find executable with [name].")); + parser.addOption(findExe); + + QCommandLineOption display(QStringList() << QStringLiteral("display"), + QCoreApplication::translate("qtpaths", "Prints user readable name for ."), QStringLiteral("type")); + parser.addOption(display); + + QCommandLineOption testmode(QStringList() << QStringLiteral("testmode") << QStringLiteral("test-mode"), + QCoreApplication::translate("qtpaths", "Use paths specific for unit testing.")); + parser.addOption(testmode); + + QCommandLineOption qtversion(QStringLiteral("qt-version"), QCoreApplication::translate("qtpaths", "Qt version.")); + parser.addOption(qtversion); + + QCommandLineOption installprefix(QStringLiteral("install-prefix"), QCoreApplication::translate("qtpaths", "Installation prefix for Qt.")); + parser.addOption(installprefix); + + QCommandLineOption bindir(QStringList() << QStringLiteral("binaries-dir") << QStringLiteral("binaries-directory"), + QCoreApplication::translate("qtpaths", "Location of Qt executables.")); + parser.addOption(bindir); + + QCommandLineOption plugindir(QStringList() << QStringLiteral("plugin-dir") << QStringLiteral("plugin-directory"), + QCoreApplication::translate("qtpaths", "Location of Qt plugins.")); + parser.addOption(plugindir); + + parser.process(app); + + QStandardPaths::setTestModeEnabled(parser.isSet(testmode)); + + QStringList results; + if (parser.isSet(qtversion)) { + QString qtversionstring = QString::fromLatin1(qVersion()); + results << qtversionstring; + } + + if (parser.isSet(installprefix)) { + QString path = QLibraryInfo::path(QLibraryInfo::PrefixPath); + results << path; + } + + if (parser.isSet(bindir)) { + QString path = QLibraryInfo::path(QLibraryInfo::BinariesPath); + results << path; + } + + if (parser.isSet(plugindir)) { + QString path = QLibraryInfo::path(QLibraryInfo::PluginsPath); + results << path; + } + + if (parser.isSet(types)) { + QStringList typesList = ::types(); + results << typesList.join('\n'); + } + + if (parser.isSet(display)) { + const StringEnum &location = parseLocationOrError(parser.value(display)); + QString text = QStandardPaths::displayName(location.enumvalue); + results << location.mapName(text); + } + + if (parser.isSet(paths)) { + const StringEnum &location = parseLocationOrError(parser.value(paths)); + QStringList paths = QStandardPaths::standardLocations(location.enumvalue); + results << location.mapName(paths.join(pathsep)); + } + + if (parser.isSet(writablePath)) { + const StringEnum &location = parseLocationOrError(parser.value(writablePath)); + QString path = QStandardPaths::writableLocation(location.enumvalue); + results << location.mapName(path); + } + + if (parser.isSet(findExe)) { + QString searchitem = searchStringOrError(&parser); + QString path = QStandardPaths::findExecutable(searchitem); + results << path; + } + + if (parser.isSet(locateDir)) { + const StringEnum &location = parseLocationOrError(parser.value(locateDir)); + QString searchitem = searchStringOrError(&parser); + QString path = QStandardPaths::locate(location.enumvalue, searchitem, QStandardPaths::LocateDirectory); + results << location.mapName(path); + } + + if (parser.isSet(locateFile)) { + const StringEnum &location = parseLocationOrError(parser.value(locateFile)); + QString searchitem = searchStringOrError(&parser); + QString path = QStandardPaths::locate(location.enumvalue, searchitem, QStandardPaths::LocateFile); + results << location.mapName(path); + } + + if (parser.isSet(locateDirs)) { + const StringEnum &location = parseLocationOrError(parser.value(locateDirs)); + QString searchitem = searchStringOrError(&parser); + QStringList paths = QStandardPaths::locateAll(location.enumvalue, searchitem, QStandardPaths::LocateDirectory); + results << location.mapName(paths.join(pathsep)); + } + + if (parser.isSet(locateFiles)) { + const StringEnum &location = parseLocationOrError(parser.value(locateFiles)); + QString searchitem = searchStringOrError(&parser); + QStringList paths = QStandardPaths::locateAll(location.enumvalue, searchitem, QStandardPaths::LocateFile); + results << location.mapName(paths.join(pathsep)); + } + if (results.isEmpty()) { + parser.showHelp(); + } else if (results.size() == 1) { + const QString &item = results.first(); + message(item); + if (item.isEmpty()) + return EXIT_FAILURE; + } else { + QString errorMessage = QCoreApplication::translate("qtpaths", "Several options given, only one is supported at a time."); + error(errorMessage); + } + return EXIT_SUCCESS; +} -- cgit v1.2.3