diff options
Diffstat (limited to 'examples/qtconcurrent/wordcount')
| -rw-r--r-- | examples/qtconcurrent/wordcount/CMakeLists.txt | 48 | ||||
| -rw-r--r-- | examples/qtconcurrent/wordcount/doc/src/qtconcurrent-wordcount.qdoc | 70 | ||||
| -rw-r--r-- | examples/qtconcurrent/wordcount/main.cpp | 195 |
3 files changed, 149 insertions, 164 deletions
diff --git a/examples/qtconcurrent/wordcount/CMakeLists.txt b/examples/qtconcurrent/wordcount/CMakeLists.txt index e2566b0a8f..0be10c3f35 100644 --- a/examples/qtconcurrent/wordcount/CMakeLists.txt +++ b/examples/qtconcurrent/wordcount/CMakeLists.txt @@ -1,41 +1,33 @@ -# Generated from wordcount.pro. +# Copyright (C) 2022 The Qt Company Ltd. +# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause cmake_minimum_required(VERSION 3.16) project(wordcount LANGUAGES CXX) -set(CMAKE_INCLUDE_CURRENT_DIR ON) +find_package(Qt6 REQUIRED COMPONENTS Concurrent Core Gui Widgets) -set(CMAKE_AUTOMOC ON) -set(CMAKE_AUTORCC ON) -set(CMAKE_AUTOUIC ON) - -if(NOT DEFINED INSTALL_EXAMPLESDIR) - set(INSTALL_EXAMPLESDIR "examples") -endif() - -set(INSTALL_EXAMPLEDIR "${INSTALL_EXAMPLESDIR}/qtconcurrent/wordcount") - -find_package(Qt6 COMPONENTS Core) -find_package(Qt6 COMPONENTS Gui) -find_package(Qt6 COMPONENTS Concurrent) -find_package(Qt6 COMPONENTS Widgets) +qt_standard_project_setup() qt_add_executable(wordcount main.cpp ) -set_target_properties(wordcount PROPERTIES - WIN32_EXECUTABLE FALSE - MACOSX_BUNDLE FALSE -) -target_link_libraries(wordcount PUBLIC - Qt::Concurrent - Qt::Core - Qt::Gui - Qt::Widgets + +target_link_libraries(wordcount PRIVATE + Qt6::Concurrent + Qt6::Core + Qt6::Gui + Qt6::Widgets ) install(TARGETS wordcount - RUNTIME DESTINATION "${INSTALL_EXAMPLEDIR}" - BUNDLE DESTINATION "${INSTALL_EXAMPLEDIR}" - LIBRARY DESTINATION "${INSTALL_EXAMPLEDIR}" + BUNDLE DESTINATION . + RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR} + LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR} +) + +qt_generate_deploy_app_script( + TARGET wordcount + OUTPUT_SCRIPT deploy_script + NO_UNSUPPORTED_PLATFORM_ERROR ) +install(SCRIPT ${deploy_script}) diff --git a/examples/qtconcurrent/wordcount/doc/src/qtconcurrent-wordcount.qdoc b/examples/qtconcurrent/wordcount/doc/src/qtconcurrent-wordcount.qdoc index 7486340c7b..adefdfdc59 100644 --- a/examples/qtconcurrent/wordcount/doc/src/qtconcurrent-wordcount.qdoc +++ b/examples/qtconcurrent/wordcount/doc/src/qtconcurrent-wordcount.qdoc @@ -1,39 +1,45 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** 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. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2023 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \example wordcount - \title QtConcurrent Word Count Example - \brief Demonstrates how to use the map-reduce algorithm. + \meta tags {threads, console} + \title Word Count \ingroup qtconcurrentexamples + \examplecategory {Data Processing & I/O} + \brief Demonstrates how to use the map-reduce algorithm. + + The Qt Concurrent \e {Word Count} example demonstrates the use of the + map-reduce algorithm when applied to the problem of counting words in a + collection of files. + + First, the Application starts a QFileDialog to select a starting + path, and then prints the output to the console. + + \include examples-run.qdocinc + + \section1 Comparing the operations + + Compare a single-threaded, sequential approach to counting the words in + the text files to a multithreaded approach with mappedReduced(): + + \dots + \snippet wordcount/main.cpp 1 + \dots + \snippet wordcount/main.cpp 2 + \dots + + The first argument to the \l {QtConcurrent::}{mappedReduced} function is the + container to operate on. The second argument is the mapping function + \c {countWords()}. It is called in parallel by multiple threads. The + third argument is the reducing function \c {reduce()}. It is called + once for each result returned by the mapping function, and generates the + final computation result. - The QtConcurrent Word Count example demonstrates the use of the map-reduce - algorithm when applied to the problem of counting words in a collection - of files. + The function returns a QFuture object of type \c WordCount. Call the + \l {QFuture::}{result} function immediately on this QFuture to block further + execution until the result becomes available. - This is a command-line application. + \note The mapping function must be thread-safe since it is called from + multiple threads. */ diff --git a/examples/qtconcurrent/wordcount/main.cpp b/examples/qtconcurrent/wordcount/main.cpp index f4de2886a8..4175641ce9 100644 --- a/examples/qtconcurrent/wordcount/main.cpp +++ b/examples/qtconcurrent/wordcount/main.cpp @@ -1,90 +1,18 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the examples 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 <QList> -#include <QMap> -#include <QTextStream> -#include <QString> -#include <QStringList> -#include <QDir> -#include <QElapsedTimer> -#include <QApplication> -#include <QDebug> - -#include <qtconcurrentmap.h> - -using namespace QtConcurrent; - -/* - Utility function that recursivily searches for files. -*/ -QStringList findFiles(const QString &startDir, const QStringList &filters) -{ - QStringList names; - QDir dir(startDir); +// Copyright (C) 2023 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause - const auto files = dir.entryList(filters, QDir::Files); - for (const QString &file : files) - names += startDir + '/' + file; - - const auto subdirs = dir.entryList(QDir::AllDirs | QDir::NoDotAndDotDot); - for (const QString &subdir : subdirs) - names += findFiles(startDir + '/' + subdir, filters); - return names; -} +#include <QtWidgets/qfiledialog.h> +#include <QtWidgets/qapplication.h> +#include <QtCore/qmimedatabase.h> +#include <QtCore/qelapsedtimer.h> +#include <QtConcurrent/qtconcurrentmap.h> typedef QMap<QString, int> WordCount; -/* - Single threaded word counter function. -*/ +void printHighestResult(const WordCount &, qsizetype); +QStringList findFiles(const QString &); + +// Single threaded word counter function. WordCount singleThreadedWordCount(const QStringList &files) { WordCount wordCount; @@ -93,7 +21,7 @@ WordCount singleThreadedWordCount(const QStringList &files) f.open(QIODevice::ReadOnly); QTextStream textStream(&f); while (!textStream.atEnd()) { - const auto words = textStream.readLine().split(' '); + const auto words = textStream.readLine().split(' ', Qt::SkipEmptyParts); for (const QString &word : words) wordCount[word] += 1; } @@ -101,7 +29,6 @@ WordCount singleThreadedWordCount(const QStringList &files) return wordCount; } - // countWords counts the words in a single file. This function is // called in parallel by several threads and must be thread // safe. @@ -113,7 +40,7 @@ WordCount countWords(const QString &file) WordCount wordCount; while (!textStream.atEnd()) { - const auto words = textStream.readLine().split(' '); + const auto words = textStream.readLine().split(' ', Qt::SkipEmptyParts); for (const QString &word : words) wordCount[word] += 1; } @@ -133,33 +60,93 @@ void reduce(WordCount &result, const WordCount &w) int main(int argc, char** argv) { QApplication app(argc, argv); - qDebug() << "finding files..."; - QStringList files = findFiles("../../", QStringList() << "*.cpp" << "*.h"); - qDebug() << files.count() << "files"; - - qDebug() << "warmup"; - { - WordCount total = singleThreadedWordCount(files); - } - - qDebug() << "warmup done"; - - int singleThreadTime = 0; + app.setOrganizationName("QtProject"); + app.setApplicationName(QCoreApplication::translate("main", "Word Count")); + + QFileDialog fileDialog; + fileDialog.setOption(QFileDialog::ReadOnly); + // Grab the directory path from the dialog + auto dirPath = QFileDialog::getExistingDirectory(nullptr, + QCoreApplication::translate("main","Select a Folder"), + QDir::currentPath()); + + QStringList files = findFiles(dirPath); + qDebug() << QCoreApplication::translate("main", "Indexing %1 files in %2") + .arg(files.size()).arg(dirPath); + + // Start the single threaded operation + qint64 singleThreadTime; { QElapsedTimer timer; timer.start(); + //! [1] WordCount total = singleThreadedWordCount(files); + //! [1] singleThreadTime = timer.elapsed(); - qDebug() << "single thread" << singleThreadTime; + qDebug() << QCoreApplication::translate("main", "Single threaded scanning took %1 ms") + .arg(singleThreadTime); } - - int mapReduceTime = 0; + // Start the multithreaded mappedReduced operation. + qint64 mapReduceTime; { QElapsedTimer timer; timer.start(); - WordCount total = mappedReduced(files, countWords, reduce).result(); + //! [2] + WordCount total = QtConcurrent::mappedReduced(files, countWords, reduce).result(); + //! [2] mapReduceTime = timer.elapsed(); - qDebug() << "MapReduce" << mapReduceTime; + qDebug() << QCoreApplication::translate("main", "MapReduce scanning took %1 ms") + .arg(mapReduceTime); + qDebug() << QCoreApplication::translate("main", "MapReduce speedup: %1") + .arg(((double)singleThreadTime - (double)mapReduceTime) / (double)mapReduceTime + 1); + printHighestResult(total, 10); } - qDebug() << "MapReduce speedup x" << ((double)singleThreadTime - (double)mapReduceTime) / (double)mapReduceTime + 1; +} + +// Utility function that recursively searches for text files. +QStringList findFiles(const QString &startDir) +{ + QStringList names; + QDir dir(startDir); + static const QMimeDatabase db; + + const auto files = dir.entryList(QDir::Files); + for (const QString &file : files) { + const auto path = startDir + QDir::separator() + file; + const QMimeType mime = db.mimeTypeForFile(QFileInfo(path)); + const auto mimeTypesForFile = mime.parentMimeTypes(); + + for (const auto &i : mimeTypesForFile) { + if (i.contains("text", Qt::CaseInsensitive) + || mime.comment().contains("text", Qt::CaseInsensitive)) { + names += startDir + QDir::separator() + file; + } + } + } + + const auto subdirs = dir.entryList(QDir::AllDirs | QDir::NoDotAndDotDot); + for (const QString &subdir : subdirs) { + if (names.length() >= 20000) { + qDebug() << QCoreApplication::translate("main", "Too many files! Aborting ..."); + exit(-1); + } + names += findFiles(startDir + QDir::separator() + subdir); + } + return names; +} + +// Utility function that prints the results of the map in decreasing order based on the value. +void printHighestResult(const WordCount &countedWords, qsizetype nResults) +{ + using pair = QPair<QString, int>; + QList<pair> vec; + + std::copy(countedWords.keyValueBegin(), countedWords.keyValueEnd(), + std::back_inserter<QList<pair>>(vec)); + std::sort(vec.begin(), vec.end(), + [](const pair &l, const pair &r) { return l.second > r.second; }); + + qDebug() << QCoreApplication::translate("main", "Most occurring words are:"); + for (qsizetype i = 0; i < qMin(vec.size(), nResults); ++i) + qDebug() << vec[i].first << " : " << vec[i].second; } |