From dbb63129ffd45dc742763ee696b5f5fb65734f13 Mon Sep 17 00:00:00 2001 From: Rajdeep Roy Chowdhury Date: Wed, 5 Feb 2020 07:49:03 +0530 Subject: [PATCH] Pass methods arguments by const refs (#161) * Formatter methods arguments are passed by const refs * Download links to dependencies provided in README.md * SettingsManager method args changed to pass by const refs --- README.md | 3 +- include/Core/Formatter.hpp | 6 ++-- include/Core/SettingsManager.hpp | 56 ++++++++++++++++---------------- src/Core/Formatter.cpp | 6 ++-- src/Core/SettingsManager.cpp | 56 ++++++++++++++++---------------- 5 files changed, 64 insertions(+), 63 deletions(-) diff --git a/README.md b/README.md index da23c2a92..459209305 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,8 @@ You can also set hotkeys for some actions manually in `Preferences`. However the git submodule update ``` -2. Install Qt (5.12 or higher) and CMake. On Mac, run `brew install qt5`. +2. Install [Qt](https://www.qt.io/download) (5.12 or higher) and [CMake](https://cmake.org/download/) (3.12 or higher).
+On Mac, run `brew install qt5`. 3. Set environment variable `CMAKE_PREFIX_PATH=%QtPath%/%QtVersion%/%Compiler%/lib/cmake` if necessary (i.e. cmake can't find the Qt installation path.) On Mac, run `export CMAKE_PREFIX_PATH="/usr/local/Cellar/qt/5.13.0"`. diff --git a/include/Core/Formatter.hpp b/include/Core/Formatter.hpp index 94c21e7ca..b137f4fc1 100644 --- a/include/Core/Formatter.hpp +++ b/include/Core/Formatter.hpp @@ -27,10 +27,10 @@ namespace Core class Formatter { public: - Formatter(QString clangFormatBinary, const QString &clangFormatStyle, MessageLogger *log); + Formatter(const QString &clangFormatBinary, const QString &clangFormatStyle, MessageLogger *log); void format(QCodeEditor *editor, const QString &filePath, const QString &lang, bool selectionOnly); - static bool check(QString checkBinary, const QString &checkStyle); - void updateBinary(QString newBinary); + static bool check(const QString &checkBinary, const QString &checkStyle); + void updateBinary(const QString &newBinary); void updateStyle(const QString &newStyle); private: diff --git a/include/Core/SettingsManager.hpp b/include/Core/SettingsManager.hpp index a225ff10d..8d8ebf0b1 100644 --- a/include/Core/SettingsManager.hpp +++ b/include/Core/SettingsManager.hpp @@ -108,45 +108,45 @@ class SettingManager void setTimeLimit(int ms); QRect getGeometry(); - void setGeometry(QRect); + void setGeometry(const QRect &); QString getFont(); - void setFont(QString font); + void setFont(const QString &font); QString getDefaultLang(); - void setDefaultLanguage(QString lang); + void setDefaultLanguage(const QString &lang); QString getTemplatePathCpp(); QString getTemplatePathJava(); QString getTemplatePathPython(); - void setTemplatePathCpp(QString path); - void setTemplatePathJava(QString path); - void setTemplatePathPython(QString path); + void setTemplatePathCpp(const QString &path); + void setTemplatePathJava(const QString &path); + void setTemplatePathPython(const QString &path); QString getRuntimeArgumentsCpp(); QString getRuntimeArgumentsJava(); QString getRuntimeArgumentsPython(); - void setRuntimeArgumentsCpp(QString command); - void setRuntimeArgumentsJava(QString command); - void setRuntimeArgumentsPython(QString command); + void setRuntimeArgumentsCpp(const QString &command); + void setRuntimeArgumentsJava(const QString &command); + void setRuntimeArgumentsPython(const QString &command); QString getClangFormatBinary(); - void setClangFormatBinary(QString binary); + void setClangFormatBinary(const QString &binary); QString getClangFormatStyle(); void setClangFormatStyle(const QString &style); QString getCompileCommandCpp(); QString getCompileCommandJava(); - void setCompileCommandsCpp(QString command); - void setCompileCommandsJava(QString command); + void setCompileCommandsCpp(const QString &command); + void setCompileCommandsJava(const QString &command); QString getRunCommandJava(); QString getRunCommandPython(); - void setRunCommandJava(QString command); - void setRunCommandPython(QString command); + void setRunCommandJava(const QString &command); + void setRunCommandPython(const QString &command); QString getEditorTheme(); - void setEditorTheme(QString theme); + void setEditorTheme(const QString &theme); bool isHotkeyInUse(); void setHotKeyInUse(bool value); @@ -194,21 +194,21 @@ class SettingManager void setTransparency(int val); ViewMode getViewMode(); - void setViewMode(ViewMode v); + void setViewMode(const ViewMode &v); QByteArray getSplitterSizes(); - void setSplitterSizes(QByteArray state); + void setSplitterSizes(const QByteArray &state); QByteArray getRightSplitterSizes(); - void setRightSplitterSizes(QByteArray state); - - void setHotkeyFormat(QKeySequence sequence); - void setHotkeyKill(QKeySequence sequence); - void setHotkeyCompileRun(QKeySequence sequence); - void setHotkeyRun(QKeySequence sequence); - void setHotkeyCompile(QKeySequence sequence); - void setHotkeyViewModeToggler(QKeySequence sequence); - void setHotkeySnippets(QKeySequence sequence); + void setRightSplitterSizes(const QByteArray &state); + + void setHotkeyFormat(const QKeySequence &sequence); + void setHotkeyKill(const QKeySequence &sequence); + void setHotkeyCompileRun(const QKeySequence &sequence); + void setHotkeyRun(const QKeySequence &sequence); + void setHotkeyCompile(const QKeySequence &sequence); + void setHotkeyViewModeToggler(const QKeySequence &sequence); + void setHotkeySnippets(const QKeySequence &sequence); QKeySequence getHotkeyFormat(); QKeySequence getHotkeyKill(); QKeySequence getHotkeyCompileRun(); @@ -218,7 +218,7 @@ class SettingManager QKeySequence getHotkeySnippets(); QString getSnippet(QString lang, QString name); - void setSnippet(QString lang, QString name, QString content); + void setSnippet(const QString &lang, const QString &name, const QString &content); void removeSnippet(QString lang, QString name); QStringList getSnippetsNames(QString lang); @@ -231,7 +231,7 @@ class SettingManager void setEditorStatus(int index, const QMap &status); QString getCFPath(); - void setCFPath(QString path); + void setCFPath(const QString &path); void resetSettings(); diff --git a/src/Core/Formatter.cpp b/src/Core/Formatter.cpp index b27d80901..5d7b88d2f 100644 --- a/src/Core/Formatter.cpp +++ b/src/Core/Formatter.cpp @@ -22,14 +22,14 @@ namespace Core { -Formatter::Formatter(QString clangFormatBinary, const QString &clangFormatStyle, MessageLogger *log) +Formatter::Formatter(const QString &clangFormatBinary, const QString &clangFormatStyle, MessageLogger *log) { this->log = log; updateBinary(clangFormatBinary); updateStyle(clangFormatStyle); } -bool Formatter::check(QString checkBinary, const QString &checkStyle) +bool Formatter::check(const QString &checkBinary, const QString &checkStyle) { QTemporaryDir tmpDir; if (!tmpDir.isValid()) @@ -49,7 +49,7 @@ bool Formatter::check(QString checkBinary, const QString &checkStyle) return program.exitCode() == 0; } -void Formatter::updateBinary(QString newBinary) +void Formatter::updateBinary(const QString& newBinary) { binary = newBinary; } diff --git a/src/Core/SettingsManager.cpp b/src/Core/SettingsManager.cpp index e29c0863f..b78545bec 100644 --- a/src/Core/SettingsManager.cpp +++ b/src/Core/SettingsManager.cpp @@ -15,10 +15,10 @@ * */ +#include "Core/SettingsManager.hpp" #include "Core/MessageLogger.hpp" #include #include -#include "Core/SettingsManager.hpp" namespace Settings { @@ -304,19 +304,19 @@ void SettingManager::setTimeLimit(int val) mSettings->setValue("time_limit", val); } -void SettingManager::setRunCommandJava(QString command) +void SettingManager::setRunCommandJava(const QString &command) { mSettings->setValue("run_java", command); } -void SettingManager::setRunCommandPython(QString command) +void SettingManager::setRunCommandPython(const QString &command) { mSettings->setValue("run_python", command); } -void SettingManager::setCompileCommandsCpp(QString command) +void SettingManager::setCompileCommandsCpp(const QString &command) { mSettings->setValue("compile_cpp", command); } -void SettingManager::setEditorTheme(QString themeName) +void SettingManager::setEditorTheme(const QString &themeName) { mSettings->setValue("editor_theme", themeName); } @@ -324,11 +324,11 @@ QString SettingManager::getEditorTheme() { return mSettings->value("editor_theme", "Light").toString(); } -void SettingManager::setCompileCommandsJava(QString command) +void SettingManager::setCompileCommandsJava(const QString &command) { mSettings->setValue("compile_java", command); } -void SettingManager::setClangFormatBinary(QString binary) +void SettingManager::setClangFormatBinary(const QString &binary) { mSettings->setValue("clang_format_binary", binary); } @@ -336,40 +336,40 @@ void SettingManager::setClangFormatStyle(const QString &style) { mSettings->setValue("clang_format_style", style); } -void SettingManager::setTemplatePathCpp(QString path) +void SettingManager::setTemplatePathCpp(const QString &path) { mSettings->setValue("template_cpp", path); } -void SettingManager::setTemplatePathJava(QString path) +void SettingManager::setTemplatePathJava(const QString &path) { mSettings->setValue("template_java", path); } -void SettingManager::setTemplatePathPython(QString path) +void SettingManager::setTemplatePathPython(const QString &path) { mSettings->setValue("template_python", path); } -void SettingManager::setRuntimeArgumentsCpp(QString command) +void SettingManager::setRuntimeArgumentsCpp(const QString &command) { mSettings->setValue("runtime_cpp", command); } -void SettingManager::setRuntimeArgumentsJava(QString command) +void SettingManager::setRuntimeArgumentsJava(const QString &command) { mSettings->setValue("runtime_java", command); } -void SettingManager::setRuntimeArgumentsPython(QString command) +void SettingManager::setRuntimeArgumentsPython(const QString &command) { mSettings->setValue("runtime_python", command); } -void SettingManager::setDefaultLanguage(QString lang) +void SettingManager::setDefaultLanguage(const QString &lang) { mSettings->setValue("lang", lang); } -void SettingManager::setFont(QString font) +void SettingManager::setFont(const QString &font) { mSettings->setValue("font", font); } -void SettingManager::setGeometry(QRect rect) +void SettingManager::setGeometry(const QRect &rect) { mSettings->setValue("geometry", rect); } @@ -407,7 +407,7 @@ QString SettingManager::getSnippet(QString lang, QString name) { return mSettings->value("snippets/" + lang + "/" + name, "").toString(); } -void SettingManager::setSnippet(QString lang, QString name, QString content) +void SettingManager::setSnippet(const QString &lang, const QString &name, const QString &content) { mSettings->setValue("snippets/" + lang + "/" + name, content); } @@ -470,36 +470,36 @@ QString SettingManager::getCFPath() return mSettings->value("cf_path", "cf").toString(); } -void SettingManager::setCFPath(QString path) +void SettingManager::setCFPath(const QString &path) { mSettings->setValue("cf_path", path); } -void SettingManager::setHotkeyViewModeToggler(QKeySequence sequence) +void SettingManager::setHotkeyViewModeToggler(const QKeySequence &sequence) { mSettings->setValue("hotkey_mode_toggle", sequence.toString()); } -void SettingManager::setHotkeyCompile(QKeySequence sequence) +void SettingManager::setHotkeyCompile(const QKeySequence &sequence) { mSettings->setValue("hotkey_compile", sequence.toString()); } -void SettingManager::setHotkeyRun(QKeySequence sequence) +void SettingManager::setHotkeyRun(const QKeySequence &sequence) { mSettings->setValue("hotkey_run", sequence.toString()); } -void SettingManager::setHotkeyCompileRun(QKeySequence sequence) +void SettingManager::setHotkeyCompileRun(const QKeySequence &sequence) { mSettings->setValue("hotkey_compile_run", sequence.toString()); } -void SettingManager::setHotkeyKill(QKeySequence sequence) +void SettingManager::setHotkeyKill(const QKeySequence &sequence) { mSettings->setValue("hotkey_kill", sequence.toString()); } -void SettingManager::setHotkeyFormat(QKeySequence sequence) +void SettingManager::setHotkeyFormat(const QKeySequence &sequence) { mSettings->setValue("hotkey_format", sequence.toString()); } -void SettingManager::setHotkeySnippets(QKeySequence sequence) +void SettingManager::setHotkeySnippets(const QKeySequence &sequence) { mSettings->setValue("hotkey_snippets", sequence.toString()); } @@ -515,7 +515,7 @@ ViewMode SettingManager::getViewMode() return Settings::ViewMode::FULL_IO; } -void SettingManager::setViewMode(ViewMode v) +void SettingManager::setViewMode(const ViewMode &v) { QString ans; if (v == Settings::FULL_EDITOR) @@ -532,7 +532,7 @@ QByteArray SettingManager::getSplitterSizes() return mSettings->value("splitter_sizes").toByteArray(); } -void SettingManager::setSplitterSizes(QByteArray state) +void SettingManager::setSplitterSizes(const QByteArray &state) { mSettings->setValue("splitter_sizes", state); } @@ -542,7 +542,7 @@ QByteArray SettingManager::getRightSplitterSizes() return mSettings->value("right_splitter_sizes").toByteArray(); } -void SettingManager::setRightSplitterSizes(QByteArray state) +void SettingManager::setRightSplitterSizes(const QByteArray &state) { mSettings->setValue("right_splitter_sizes", state); }