refactor(LineReader): Make use of the LineReader class in a much simpler way

The LineReader is made a concrete class whose declaration
is independent of the readline library.
Only its implementation depends on the presence or absence
of the readline library.
The LineReader code is embedded in a new library : line_reader,
to make the cli library independant of the USE_READLINE definition.

Author: aollier

src/CMakeLists.txt

@@ -48,7 +48,6 @@ set(core_SOURCES
         core/Totp.cpp
         core/Translator.cpp
         cli/Utils.cpp
-        cli/TextStream.cpp
         crypto/Crypto.cpp
         crypto/CryptoHash.cpp
         crypto/Random.cpp

src/cli/CMakeLists.txt

@@ -13,7 +13,23 @@
 #  You should have received a copy of the GNU General Public License
 #  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-set(cli_SOURCES
+# text_stream library
+add_library(text_stream STATIC TextStream.cpp)
+target_link_libraries(text_stream PUBLIC Qt6::Core)
+
+# line_reader library
+add_library(line_reader STATIC LineReader.cpp)
+target_link_libraries(line_reader PUBLIC Qt6::Core)
+find_package(Readline MODULE)
+if(READLINE_FOUND)
+    target_compile_definitions(line_reader PRIVATE "USE_READLINE")
+    target_link_libraries(line_reader PRIVATE ${Readline_LIBRARY})
+else()
+    target_link_libraries(line_reader PRIVATE text_stream)
+endif()
+
+# cli library
+add_library(cli STATIC
         Add.cpp
         AddGroup.cpp
         Analyze.cpp
@@ -44,21 +60,13 @@ set(cli_SOURCES
         Search.cpp
         Show.cpp)
 
-add_library(cli STATIC ${cli_SOURCES})
-target_link_libraries(cli ${ZXCVBN_LIBRARIES} Qt6::Core)
-
-find_package(Readline)
-
-if (READLINE_FOUND)
-    target_compile_definitions(cli PUBLIC USE_READLINE)
-    target_link_libraries(cli ${Readline_LIBRARY})
-endif()
+target_link_libraries(cli
+        PRIVATE ${ZXCVBN_LIBRARIES} text_stream
+        PUBLIC Qt6::Core)
 
 add_executable(keepassxc-cli keepassxc-cli.cpp)
 target_link_libraries(keepassxc-cli
-        ${GPGERROR_LIBRARIES}
-        cli
-        keepassxc_core)
+        PRIVATE ${GPGERROR_LIBRARIES} cli keepassxc_core line_reader)
 
 install(TARGETS keepassxc-cli
         BUNDLE DESTINATION . COMPONENT Runtime

src/cli/LineReader.cpp

@@ -0,0 +1,36 @@
+#include "LineReader.h"
+#ifdef USE_READLINE
+#include <readline/history.h>
+#include <readline/readline.h>
+#else
+#include "TextStream.h"
+#endif
+
+QString LineReader::readLine(const QString& prompt)
+{
+#ifdef USE_READLINE
+    char* result = readline(prompt.toStdString().c_str());
+    if (!result) {
+        m_finished = true;
+        return {};
+    }
+    add_history(result);
+    QString qstr(result);
+    free(result);
+    return qstr;
+#else
+    TextStream outStream(stdout, QIODevice::WriteOnly), inStream(stdin, QIODevice::ReadOnly);
+    outStream << prompt;
+    outStream.flush();
+    QString result = inStream.readLine();
+    if (result.isNull()) {
+        m_finished = true;
+    }
+    return result;
+#endif
+}
+
+bool LineReader::isFinished() const
+{
+    return m_finished;
+}

src/cli/LineReader.h

@@ -0,0 +1,19 @@
+#ifndef LINEREADER_H
+#define LINEREADER_H
+
+#include <QString>
+
+class LineReader
+{
+    bool m_finished{false};
+
+public:
+    LineReader() = default;
+    LineReader(const LineReader&) = delete;
+    ~LineReader() = default;
+    LineReader& operator=(const LineReader&) = delete;
+    QString readLine(const QString& prompt);
+    [[nodiscard]] bool isFinished() const;
+};
+
+#endif // LINEREADER_H

src/cli/keepassxc-cli.cpp

@@ -19,8 +19,8 @@
 #include <QFileInfo>
 
 #include "Command.h"
+#include "LineReader.h"
 #include "Open.h"
-#include "TextStream.h"
 #include "Utils.h"
 #include "config-keepassx.h"
 #include "core/Bootstrap.h"
@@ -33,83 +33,6 @@
 #include <sanitizer/lsan_interface.h>
 #endif
 
-#if defined(USE_READLINE)
-#include <readline/history.h>
-#include <readline/readline.h>
-#endif
-
-class LineReader
-{
-public:
-    virtual ~LineReader() = default;
-    virtual QString readLine(QString prompt) = 0;
-    virtual bool isFinished() = 0;
-};
-
-class SimpleLineReader : public LineReader
-{
-public:
-    SimpleLineReader()
-        : inStream(stdin, QIODevice::ReadOnly)
-        , outStream(stdout, QIODevice::WriteOnly)
-        , finished(false)
-    {
-    }
-
-    QString readLine(QString prompt) override
-    {
-        outStream << prompt;
-        outStream.flush();
-        QString result = inStream.readLine();
-        if (result.isNull()) {
-            finished = true;
-        }
-        return result;
-    }
-
-    bool isFinished() override
-    {
-        return finished;
-    }
-
-private:
-    TextStream inStream;
-    TextStream outStream;
-    bool finished;
-};
-
-#if defined(USE_READLINE)
-class ReadlineLineReader : public LineReader
-{
-public:
-    ReadlineLineReader()
-        : finished(false)
-    {
-    }
-
-    QString readLine(QString prompt) override
-    {
-        char* result = readline(prompt.toStdString().c_str());
-        if (!result) {
-            finished = true;
-            return {};
-        }
-        add_history(result);
-        QString qstr(result);
-        free(result);
-        return qstr;
-    }
-
-    bool isFinished() override
-    {
-        return finished;
-    }
-
-private:
-    bool finished;
-};
-#endif
-
 int enterInteractiveMode(const QStringList& arguments)
 {
     auto& err = Utils::STDERR;
@@ -123,16 +46,9 @@ int enterInteractiveMode(const QStringList& arguments)
         return EXIT_FAILURE;
     };
 
-    QScopedPointer<LineReader> reader;
-#if defined(USE_READLINE)
-    reader.reset(new ReadlineLineReader());
-#else
-    reader.reset(new SimpleLineReader());
-#endif
-
+    LineReader reader;
     QSharedPointer<Database> currentDatabase(openCmd.currentDatabase);
 
-    QString command;
     while (true) {
         QString prompt;
         if (currentDatabase) {
@@ -142,8 +58,8 @@ int enterInteractiveMode(const QStringList& arguments)
             }
         }
         prompt += "> ";
-        command = reader->readLine(prompt);
-        if (reader->isFinished()) {
+        QString command = reader.readLine(prompt);
+        if (reader.isFinished()) {
             break;
         }