Improve gitignore for less noise in commits

Improve logging output

Reviewed-on: #9

.gitea/workflows/build.yaml

@@ -14,7 +14,7 @@ jobs:
       - name: install meson
         run: apt-get -yq install meson
       - name: Install build dependencies
-        run: apt-get -yq install libusb-1.0-0-dev libspdlog-dev libpango1.0-dev libcairo2-dev gcovr
+        run: apt-get -yq install libusb-1.0-0-dev libspdlog-dev libfmt-dev libpango1.0-dev libcairo2-dev gcovr
       - name: setup builddir
         run: meson setup builddir -Db_coverage=true
       - name: build all targets

.gitignore

@@ -1,9 +1,14 @@
+# Folder
 builddir/
+ptouch-print/
 subprojects/*
-!subprojects/*.wrap
 .cache/
+coverageReport/
+
+# Files
+ptprnt.log
+!subprojects/*.wrap
 .vscode/*
 !.vscode/c_cpp_properties.json
 !.vscode/settings.json
 !.vscode/launch.json
-ptouch-print/

.vscode/settings.json

@@ -85,5 +85,6 @@
   },
   "clang-tidy.buildPath": "builddir/",
   "clangd.onConfigChanged": "restart",
-  "C_Cpp.default.compileCommands": "builddir/compile_commands.json"
+  "C_Cpp.default.compileCommands": "builddir/compile_commands.json",
+  "mesonbuild.configureOnOpen": true
 }

README.md

@@ -19,7 +19,7 @@ pacman -S libusb spdlog pango cairo meson gcovr
 
 Install dependencies on Debian/Ubuntu
 ``` bash
-apt-get install libusb-1.0-0-dev libspdlog-dev libpango1.0-dev libcairo2-dev meson gcovr
+apt-get install libusb-1.0-0-dev libspdlog-dev libfmt-dev libpango1.0-dev libcairo2-dev meson gcovr
 ```
 
 ## Build

generate_coverage.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+SCRIPT_PATH="$( cd -- "$(dirname "$0")" >/dev/null 2>&1 ; pwd -P )"
+HTML_COV_PATH="coverageReport/html"
+HTML_START_FILE="index.html"
+
+echo "Generating Coverage report for ptouch-prnt"
+
+ninja -C builddir
+ninja -C builddir test
+
+mkdir -p ${HTML_COV_PATH}
+gcovr --html --html-details --html-syntax-highlighting --filter src --output ${HTML_COV_PATH}/${HTML_START_FILE}
+
+if [ $? ] 
+then
+  echo "Coverage report successful generated!"
+  echo "Open: file://${SCRIPT_PATH}/${HTML_COV_PATH}/${HTML_START_FILE}"
+else
+  echo "Error generating coverage report!"
+fi

meson.build

@@ -6,6 +6,7 @@ project('ptprnt', 'cpp',
 
 usb_dep = dependency('libusb-1.0')
 log_dep = dependency('spdlog')
+fmt_dep = dependency('fmt')
 pangocairo_dep = dependency('pangocairo')
 
 # CLI11 
@@ -17,45 +18,15 @@ endif
 
 incdir = include_directories('src')
 
-ptprnt_hpps = [
-    'src/libusbwrap/interface/IUsbDeviceFactory.hpp',
-    'src/libusbwrap/interface/IUsbDevice.hpp',
-    'src/libusbwrap/UsbDeviceFactory.hpp',
-    'src/libusbwrap/LibUsbTypes.hpp',
-    'src/libusbwrap/UsbDevice.hpp',
-    'src/interface/IPrinterDriver.hpp',
-    'src/interface/IPrinterTypes.hpp',
-    'src/P700Printer.hpp',
-    'src/PtouchPrint.hpp',
-    'src/graphics/Bitmap.hpp',
-    'src/graphics/Image.hpp',
-    'src/graphics/Monochrome.hpp'
-]
-
-ptprnt_srcs = [
-    'src/PtouchPrint.cpp',
-    'src/P700Printer.cpp',
-    'src/graphics/Image.cpp',
-    'src/graphics/Bitmap.cpp',
-    'src/graphics/Monochrome.cpp',
-    'src/libusbwrap/UsbDeviceFactory.cpp',
-    'src/libusbwrap/UsbDevice.cpp',
-]
-
-ptprnt_lib = library('ptprnt', 
-                     include_directories: incdir,
-                     install: true,
-                     dependencies: [usb_dep, log_dep, pangocairo_dep, cli11_dep],
-                     sources: [ptprnt_hpps, ptprnt_srcs])
-
-ptprnt_dep = declare_dependency(include_directories: incdir,
-                                link_with: ptprnt_lib)
+subdir('src')
 
 ptprnt_exe = executable(
     'ptprnt', 
     'src/main.cpp',
     install: true,
-    dependencies : [usb_dep, log_dep, cli11_dep, ptprnt_dep],
+    dependencies : [usb_dep, log_dep, fmt_dep, pangocairo_dep, cli11_dep],
+    include_directories: incdir,
+    sources: [ptprnt_srcs],
     cpp_args : ['-DPROJ_VERSION="'+meson.project_version()+'"'],
 )
 

src/PtouchPrint.cpp

@@ -16,14 +16,25 @@
     along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
  */
+#define SPDLOG_ACTIVE_LEVEL SPDLOG_LEVEL_TRACE
+#define SPDLOG_DEBUG_ON
+#define SPDLOG_TRACE_ON
 
 #include "PtouchPrint.hpp"
 
 #include <CLI/App.hpp>
+#include <fmt/core.h>
 #include <spdlog/common.h>
+#include <spdlog/details/synchronous_factory.h>
+#include <spdlog/logger.h>
+#include <spdlog/sinks/base_sink.h>
+#include <spdlog/sinks/basic_file_sink.h>
+#include <spdlog/sinks/stdout_color_sinks.h>
 #include <spdlog/spdlog.h>
 
 #include <functional>
+#include <memory>
+#include <vector>
 
 #include "CLI/Option.hpp"
 #include "P700Printer.hpp"
@@ -45,9 +56,9 @@ int PtouchPrint::init(int argc, char** argv) {
     }
 
     if (mVerboseFlag) {
-        setupLogger(spdlog::level::trace);
+        setupLogger(spdlog::level::debug);
     } else {
-        setupLogger(spdlog::level::critical);
+        setupLogger(spdlog::level::err);
     }
 
     if (!mUsbDeviceFactory.init()) {
@@ -59,10 +70,12 @@ int PtouchPrint::init(int argc, char** argv) {
 }
 
 int PtouchPrint::run() {
+    spdlog::debug("ptprnt version {}", mVersionString);
+    SPDLOG_TRACE("testing trace");
     auto numFoundPrinters = getCompatiblePrinters();
     if (numFoundPrinters == 0) {
         spdlog::error(
-            "No compatible printers found, please make sure if they are turned on and connected");
+            "No compatible printers found, please make sure that they are turned on and connected");
         return -1;
     } else if (numFoundPrinters > 1) {
         spdlog::warn("Found more than one compatible printer. Currently not supported.");
@@ -84,7 +97,7 @@ int PtouchPrint::run() {
     //printer->printText("wurst", 1);
 
     for (auto& cmd : mCommands) {
-        std::cout << cmd.second << std::endl;
+        spdlog::debug("Command: {}", cmd.second);
     }
 
     return 0;
@@ -113,13 +126,22 @@ unsigned int PtouchPrint::getCompatiblePrinters() {
 }
 
 void PtouchPrint::setupLogger(spdlog::level::level_enum lvl) {
-    spdlog::set_level(lvl);
-    spdlog::debug("Starting ptprnt {}", mVersionString);
+    auto consoleSink = std::make_shared<spdlog::sinks::stdout_color_sink_mt>();
+    consoleSink->set_level(lvl);
+    consoleSink->set_pattern("%^%L:%$ %v");
+
+    auto fileSink = std::make_shared<spdlog::sinks::basic_file_sink_mt>("ptprnt.log", true);
+    fileSink->set_level(spdlog::level::trace);
+    fileSink->set_pattern("%Y-%m-%d %H:%m:%S:%e [pid:%P tid:%t] [%^%l%$] %v (%@)");
+    std::vector<spdlog::sink_ptr> sinks{consoleSink, fileSink};
+    auto logger = std::make_shared<spdlog::logger>("default_logger", sinks.begin(), sinks.end());
+    logger->set_level(spdlog::level::trace);
+    spdlog::set_default_logger(logger);
 }
 
 void PtouchPrint::setupCliParser() {
     auto printVersion = [this](std::size_t) {
-        std::cout << "ptprnt version: " << mVersionString << std::endl;
+        fmt::print("ptprnt version: {}\n", mVersionString);
     };
 
     // General options

src/graphics/Bitmap.cpp

@@ -52,6 +52,11 @@ bool Bitmap<T>::setPixels(const std::vector<T>& pixels) {
     return true;
 }
 
+template <class T>
+std::vector<T> Bitmap<T>::getPixelsCpy() {
+    return mPixels;
+}
+
 template <class T>
 std::optional<std::vector<T>> Bitmap<T>::getLine(uint16_t line) {
     if (line >= mHeight) {

src/graphics/Bitmap.hpp

@@ -22,6 +22,7 @@
 #include <stdint.h>
 
 #include <cstdint>
+#include <memory>
 #include <optional>
 #include <vector>
 
@@ -41,6 +42,7 @@ class Bitmap {
     uint16_t getWidth();
     uint16_t getHeight();
     bool setPixels(const std::vector<T>& pixels);
+    std::vector<T> getPixelsCpy();
     std::optional<std::vector<T>> getLine(uint16_t line);
     std::optional<std::vector<T>> getCol(uint16_t col);
 

src/interface/IPrinterDriver.hpp

@@ -30,6 +30,7 @@ namespace ptprnt {
 
 class IPrinterDriver {
    public:
+    virtual ~IPrinterDriver()                                                     = default;
     virtual const std::string_view getDriverName()                                = 0;
     virtual const std::string_view getName()                                      = 0;
     virtual const std::string_view getVersion()                                   = 0;

src/libusbwrap/UsbDevice.hpp

@@ -29,8 +29,8 @@
 namespace libusbwrap {
 class UsbDevice : public IUsbDevice {
    public:
-    UsbDevice(libusb_context* ctx, libusb_device* dev);
-    ~UsbDevice();
+    explicit UsbDevice(libusb_context* ctx, libusb_device* dev);
+    ~UsbDevice() override;
 
     // delete copy ctor and assignment
     UsbDevice(const UsbDevice&)      = delete;

src/libusbwrap/interface/IUsbDevice.hpp

@@ -24,8 +24,9 @@ enum class Speed {
 
 class IUsbDevice {
    public:
-    virtual bool open()  = 0;
-    virtual void close() = 0;
+    virtual ~IUsbDevice() = default;
+    virtual bool open()   = 0;
+    virtual void close()  = 0;
 
     // libusb wrappers
     virtual bool detachKernelDriver(int interfaceNo) = 0;

src/libusbwrap/interface/IUsbDeviceFactory.hpp

@@ -9,7 +9,8 @@
 namespace libusbwrap {
 class IUsbDeviceFactory {
    public:
-    virtual std::vector<std::shared_ptr<IUsbDevice>> findAllDevices()                        = 0;
+    virtual ~IUsbDeviceFactory()                                      = default;
+    virtual std::vector<std::shared_ptr<IUsbDevice>> findAllDevices() = 0;
     virtual std::vector<std::shared_ptr<IUsbDevice>> findDevices(uint16_t vid, uint16_t pid) = 0;
 };
 }  // namespace libusbwrap

src/main.cpp

@@ -16,10 +16,6 @@
     along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
  */
-
-#include <spdlog/common.h>
-#include <spdlog/spdlog.h>
-
 #include "PtouchPrint.hpp"
 
 int main(int argc, char** argv) {

src/meson.build

@@ -0,0 +1,24 @@
+ptprnt_hpps = files (
+    'libusbwrap/interface/IUsbDeviceFactory.hpp',
+    'libusbwrap/interface/IUsbDevice.hpp',
+    'libusbwrap/UsbDeviceFactory.hpp',
+    'libusbwrap/LibUsbTypes.hpp',
+    'libusbwrap/UsbDevice.hpp',
+    'interface/IPrinterDriver.hpp',
+    'interface/IPrinterTypes.hpp',
+    'P700Printer.hpp',
+    'PtouchPrint.hpp',
+    'graphics/Bitmap.hpp',
+    'graphics/Image.hpp',
+    'graphics/Monochrome.hpp'
+)
+
+ptprnt_srcs = files (
+    'PtouchPrint.cpp',
+    'P700Printer.cpp',
+    'graphics/Image.cpp',
+    'graphics/Bitmap.cpp',
+    'graphics/Monochrome.cpp',
+    'libusbwrap/UsbDeviceFactory.cpp',
+    'libusbwrap/UsbDevice.cpp',
+)

tests/bitmap_test/bitmap_test.cpp

@@ -21,7 +21,9 @@
 
 #include <gtest/gtest.h>
 
+#include <cstdint>
 #include <optional>
+#include <vector>
 
 TEST(basic_test, Bitmap_createBitmapWithCertainSize_yieldsSpecifiedSize) {
     auto bm     = ptprnt::graphics::Bitmap<ptprnt::graphics::ALPHA8>(16, 8);
@@ -64,3 +66,36 @@ TEST(basic_test, Bitmap_getBitmapColInsideOfImage_yieldsValidColSize) {
     auto colSize = col->size();
     ASSERT_EQ(8, colSize);
 }
+
+TEST(basic_test, Bitmap_setPixels_setsGivenPixels) {
+    auto bm = ptprnt::graphics::Bitmap<ptprnt::graphics::ALPHA8>(16, 8);
+    std::vector<uint8_t> pix(16 * 8);
+
+    bm.setPixels(pix);
+    auto pixCpy = bm.getPixelsCpy();
+
+    ASSERT_EQ(pix, pixCpy);
+}
+
+TEST(basic_test, Bitmap_setPixels_isSuccessfulWithValidPixels) {
+    auto bm = ptprnt::graphics::Bitmap<ptprnt::graphics::ALPHA8>(16, 8);
+    std::vector<uint8_t> pix(16 * 8);
+
+    ASSERT_TRUE(bm.setPixels(pix));
+}
+
+TEST(basic_test, Bitmap_setPixels_yieldsSamePixelsBack) {
+    auto bm = ptprnt::graphics::Bitmap<ptprnt::graphics::ALPHA8>(16, 8);
+    std::vector<uint8_t> pix(16 * 8);
+
+    bm.setPixels(pix);
+    auto pixCpy = bm.getPixelsCpy();
+    ASSERT_EQ(pix, pixCpy);
+}
+
+TEST(basic_test, Bitmap_setPixelsWithWrongSize_isFailing) {
+    auto bm = ptprnt::graphics::Bitmap<ptprnt::graphics::ALPHA8>(5, 8);
+    std::vector<uint8_t> pix(16 * 8);
+
+    ASSERT_FALSE(bm.setPixels(pix));
+}

tests/meson.build

@@ -1,6 +1,6 @@
-tests = [['bitmap_test', 'bitmap_test_exe', ['bitmap_test/bitmap_test.cpp']],
-         ['image_test', 'image_test_exe', ['image_test/image_test.cpp']],
-         ['monochrome_test', 'monochrome_test_exe', ['monochrome_test/monochrome_test.cpp']]
+tests = [['bitmap_test', 'bitmap_test_exe', ptprnt_srcs + ['bitmap_test/bitmap_test.cpp']],
+         ['image_test', 'image_test_exe', ptprnt_srcs +['image_test/image_test.cpp']],
+         ['monochrome_test', 'monochrome_test_exe', ptprnt_srcs +['monochrome_test/monochrome_test.cpp']]
         ]
 
 foreach test : tests
@@ -8,8 +8,7 @@ foreach test : tests
          executable(test.get(1),
                     sources: test.get(2),
                     include_directories: incdir,
-                    link_with:[ptprnt_lib],
-                    dependencies: [gtest_dep, pangocairo_dep]
+                    dependencies: [gtest_dep, usb_dep, log_dep, pangocairo_dep, cli11_dep]
          )
     )
 endforeach