Util methods to modify the custom library search path

refs #615

src/blackmisc/librarypath.cpp

@@ -0,0 +1,46 @@
+/* Copyright (C) 2016
+ * swift project Community / Contributors
+ *
+ * This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
+ * directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
+ * including this file, may be copied, modified, propagated, or distributed except according to the terms
+ * contained in the LICENSE file.
+ */
+
+#include "librarypath.h"
+#include <QtGlobal>
+#include <QString>
+#include <vector>
+
+#ifdef Q_OS_WIN
+#include <Windows.h>
+#endif
+
+namespace BlackMisc
+{
+
+    void setCustomLibraryPath(const QString &path)
+    {
+    #ifdef Q_OS_WIN
+        std::wstring customLibraryPath = path.toStdWString();
+        SetDllDirectory(customLibraryPath.data());
+    #else
+        Q_UNUSED(path);
+        // do nothing.
+    #endif
+    }
+
+    QString getCustomLibraryPath()
+    {
+    #ifdef Q_OS_WIN
+        const DWORD nBufferLength = GetDllDirectory(0, nullptr);
+        std::vector<wchar_t> customLibraryPath(nBufferLength);
+        GetDllDirectory(nBufferLength, customLibraryPath.data());
+        return QString::fromWCharArray(customLibraryPath.data());
+    #else
+        // do nothing.
+        return {};
+    #endif
+    }
+
+} // ns

src/blackmisc/librarypath.h

@@ -0,0 +1,34 @@
+/* Copyright (C) 2016
+ * swift project Community / Contributors
+ *
+ * This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
+ * directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
+ * including this file, may be copied, modified, propagated, or distributed except according to the terms
+ * contained in the LICENSE file.
+ */
+
+//! \file
+
+#ifndef BLACKMISC_LIBRARYPATH_H
+#define BLACKMISC_LIBRARYPATH_H
+
+#include "blackmiscexport.h"
+
+namespace BlackMisc
+{
+
+    //! Sets the custom path to additionally search when loading libraries.
+    //! This does not change the default search paths.
+    //! \warning This is currently Windows only. Use rpath on Unix.
+    //! \sa getCustomLibraryPath
+    BLACKMISC_EXPORT void setCustomLibraryPath(const QString &path);
+
+    //! Get the custom path to search when loading libraries.
+    //! Returns an empty string when no custom library path is set.
+    //! \note This will not return the default search path.
+    //! \warning This is currently Windows only. Use rpath on Unix.
+    BLACKMISC_EXPORT QString getCustomLibraryPath();
+
+} // ns
+
+#endif // guard

tests/blackmisc/testblackmiscmain.cpp

@@ -20,6 +20,7 @@
 #include "testgeo.h"
 #include "testidentifier.h"
 #include "testinput.h"
+#include "testlibrarypath.h"
 #include "testmath.h"
 #include "testphysicalquantities.h"
 #include "testvaluecache.h"
@@ -47,6 +48,7 @@ namespace BlackMiscTest
             CTestValueCache valueCacheTests;
             CTestWeather weatherTests;
             CTestMath mathTests;
+            CTestLibraryPath libraryPathTests;
             status |= QTest::qExec(&pqBaseTests, argc, argv);
             status |= QTest::qExec(&avBaseTests, argc, argv);
             status |= QTest::qExec(&geoTests, argc, argv);
@@ -57,6 +59,7 @@ namespace BlackMiscTest
             status |= QTest::qExec(&valueCacheTests, argc, argv);
             status |= QTest::qExec(&weatherTests, argc, argv);
             status |= QTest::qExec(&mathTests, argc, argv);
+            status |= QTest::qExec(&libraryPathTests, argc, argv);
         }
         return status;
     }

tests/blackmisc/testlibrarypath.cpp

@@ -0,0 +1,40 @@
+/* Copyright (C) 2016
+ * swift Project Community / Contributors
+ *
+ * This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
+ * directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
+ * including this file, may be copied, modified, propagated, or distributed except according to the terms
+ * contained in the LICENSE file.
+ */
+
+//! \cond PRIVATE_TESTS
+
+/*!
+ * \file
+ * \ingroup testblackmisc
+ */
+
+#include "testlibrarypath.h"
+#include "blackmisc/librarypath.h"
+#include "blackmisc/buildconfig.h"
+
+namespace BlackMiscTest
+{
+    void CTestLibraryPath::libraryPath()
+    {
+        if (!BlackMisc::CBuildConfig::isRunningOnWindowsNtPlatform()) { return; }
+
+        auto emptyPath = BlackMisc::getCustomLibraryPath();
+        QVERIFY2(emptyPath.isEmpty(), "Default path should be empty");
+
+        QString customLibraryPath("c:\test");
+        BlackMisc::setCustomLibraryPath(customLibraryPath);
+        QVERIFY2(BlackMisc::getCustomLibraryPath() == customLibraryPath, "setLibraryPath failed");
+
+        BlackMisc::setCustomLibraryPath(emptyPath);
+        QVERIFY2(emptyPath.isEmpty(), "Path should be empty again.");
+    }
+
+} // namespace
+
+//! \endcond

tests/blackmisc/testlibrarypath.h

@@ -0,0 +1,43 @@
+/* Copyright (C) 2016
+ * swift project Community / Contributors
+ *
+ * This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
+ * directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
+ * including this file, may be copied, modified, propagated, or distributed except according to the terms
+ * contained in the LICENSE file.
+ */
+
+#ifndef BLACKMISCTEST_TESTLIBRARYPATH_H
+#define BLACKMISCTEST_TESTLIBRARYPATH_H
+
+//! \cond PRIVATE_TESTS
+
+/*!
+ * \file
+ * \ingroup testblackmisc
+ */
+
+#include <QtTest/QtTest>
+
+namespace BlackMiscTest
+{
+
+    //! Geo classes tests
+    class CTestLibraryPath : public QObject
+    {
+        Q_OBJECT
+
+    public:
+        //! Standard test case constructor
+        explicit CTestLibraryPath(QObject *parent = nullptr) : QObject(parent) {}
+
+    private slots:
+        //! Basic unit tests for library path
+        void libraryPath();
+    };
+
+} // namespace
+
+//! \endcond
+
+#endif // guard