uhd: added image utils code to search the images paths for image files

7 files changed, 87 insertions, 17 deletions

diff --git a/host/docs/coding.rst b/host/docs/coding.rst
index 84f9abf3e..23f350b0f 100644
--- a/host/docs/coding.rst
+++ b/host/docs/coding.rst
@@ -64,7 +64,12 @@ Integrating custom hardware
 ------------------------------------------------------------------------
 Creators of custom hardware can create drivers that use the UHD API.
 These drivers can be built as dynamically loadable modules that the UHD will load at runtime.
-For a module to be loaded at runtime, it must be found in the UHD_MODULE_PATH environment variable.
+
+For a module to be loaded at runtime, it must be:
+
+* found in the UHD_MODULE_PATH environment variable,
+* installed into the <prefix>/share/uhd/modules directory,
+* or installed into /usr/share/uhd/modules directory (unix only).
 
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Custom motherboard
diff --git a/host/docs/images.rst b/host/docs/images.rst
index ff5c5404e..612a00aa5 100644
--- a/host/docs/images.rst
+++ b/host/docs/images.rst
@@ -58,8 +58,7 @@ Where <prefix> was set by the CMAKE_INSTALL_PREFIX at configure-time.
 **Option 2:**
 
 Unpack the archive anywhere and set the UHD_IMAGE_PATH environment variable.
-The UHD_IMAGE_PATH may contain a list of directories to search for image files,
-or paths to specific image files.
+The UHD_IMAGE_PATH may contain a list of directories to search for image files.
 
 ------------------------------------------------------------------------
 Building images
diff --git a/host/include/uhd/utils/CMakeLists.txt b/host/include/uhd/utils/CMakeLists.txt
index ef8e64ce0..b39b6083c 100644
--- a/host/include/uhd/utils/CMakeLists.txt
+++ b/host/include/uhd/utils/CMakeLists.txt
@@ -23,6 +23,7 @@ INSTALL(FILES
     byteswap.ipp
     exception.hpp
     gain_group.hpp
+    images.hpp
     pimpl.hpp
     props.hpp
     safe_main.hpp
diff --git a/host/include/uhd/utils/images.hpp b/host/include/uhd/utils/images.hpp
new file mode 100644
index 000000000..8b5a1eedd
--- /dev/null
+++ b/host/include/uhd/utils/images.hpp
@@ -0,0 +1,38 @@
+//
+// Copyright 2010 Ettus Research LLC
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+#ifndef INCLUDED_UHD_UTILS_IMAGES_HPP
+#define INCLUDED_UHD_UTILS_IMAGES_HPP
+
+#include <uhd/config.hpp>
+#include <string>
+
+namespace uhd{
+
+    /*!
+     * Search for an image in the system image paths:
+     * Search compiled-in paths and environment variable paths
+     * for a specific image file with the provided file name.
+     * \param image_name the name of the file
+     * \return the full system path to the file
+     * \throw exception if the image was not found
+     */
+    UHD_API std::string find_image_path(const std::string &image_name);
+
+} //namespace uhd
+
+#endif /* INCLUDED_UHD_UTILS_IMAGES_HPP */
diff --git a/host/lib/utils/CMakeLists.txt b/host/lib/utils/CMakeLists.txt
index 68945545a..32b679d49 100644
--- a/host/lib/utils/CMakeLists.txt
+++ b/host/lib/utils/CMakeLists.txt
@@ -79,6 +79,7 @@ ENDIF(HAVE_DLFCN_H)
 LIBUHD_APPEND_SOURCES(
     ${CMAKE_SOURCE_DIR}/lib/utils/assert.cpp
     ${CMAKE_SOURCE_DIR}/lib/utils/gain_group.cpp
+    ${CMAKE_SOURCE_DIR}/lib/utils/images.cpp
     ${CMAKE_SOURCE_DIR}/lib/utils/load_modules.cpp
     ${CMAKE_SOURCE_DIR}/lib/utils/paths.cpp
     ${CMAKE_SOURCE_DIR}/lib/utils/props.cpp
diff --git a/host/lib/utils/images.cpp b/host/lib/utils/images.cpp
new file mode 100644
index 000000000..395e542c1
--- /dev/null
+++ b/host/lib/utils/images.cpp
@@ -0,0 +1,40 @@
+//
+// Copyright 2010 Ettus Research LLC
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+//
+
+#include <uhd/utils/images.hpp>
+#include <boost/foreach.hpp>
+#include <boost/filesystem.hpp>
+#include <stdexcept>
+#include <vector>
+
+namespace fs = boost::filesystem;
+
+std::vector<fs::path> get_image_paths(void); //defined in paths.cpp
+
+/***********************************************************************
+ * Find a image in the image paths
+ **********************************************************************/
+std::string uhd::find_image_path(const std::string &image_name){
+    if (fs::exists(image_name)){
+        return fs::system_complete(image_name).file_string();
+    }
+    BOOST_FOREACH(const fs::path &path, get_image_paths()){
+        fs::path image_path = path / image_name;
+        if (fs::exists(image_path)) return image_path.file_string();
+    }
+    throw std::runtime_error("Could not find path for image: " + image_name);
+}
diff --git a/host/lib/utils/paths.cpp b/host/lib/utils/paths.cpp
index 6ad12d3cc..9e9525caf 100644
--- a/host/lib/utils/paths.cpp
+++ b/host/lib/utils/paths.cpp
@@ -85,17 +85,3 @@ std::vector<fs::path> get_module_paths(void){
         paths.push_back(fs::path(INSTALLER_PKG_DATA_DIR) / "modules");
     return paths;
 }
-
-/***********************************************************************
- * Find a image in the image paths
- **********************************************************************/
-std::string find_image_path(const std::string &image_name){
-    if (fs::exists(image_name)){
-        return fs::system_complete(image_name).file_string();
-    }
-    BOOST_FOREACH(const fs::path &path, get_image_paths()){
-        fs::path image_path = path / image_name;
-        if (fs::exists(image_path)) return image_path.file_string();
-    }
-    throw std::runtime_error("Could not find path for image: " + image_name);
-}