vcl/inc/IconThemeScanner.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  */
   9
  10 #ifndef INCLUDED_VCL_ICONTHEMESCANNER_HXX
  11 #define INCLUDED_VCL_ICONTHEMESCANNER_HXX
  12
  13 #include <vcl/dllapi.h>
  14
  15 #include <rtl/ustring.hxx>
  16 #include <vcl/IconThemeInfo.hxx>
  17
  18 #include <memory>
  19 #include <vector>
  20
  21 // forward declaration of unit test class. Required for friend relationship.
  22 class IconThemeScannerTest;
  23
  24 namespace vcl
  25 {
  26 /** This class scans a folder for icon themes and provides the results.
  27  */
  28 class VCL_DLLPUBLIC IconThemeScanner
  29 {
  30 public:
  31     /** Factory method to create the object.
  32      * Provide a path to search for IconThemes.
  33      */
  34     static std::shared_ptr<IconThemeScanner> Create(std::u16string_view path);
  35
  36     /** This method will return the standard path where icon themes are located.
  37      */
  38     static OUString GetStandardIconThemePath();
  39
  40     const std::vector<IconThemeInfo>& GetFoundIconThemes() const { return mFoundIconThemes; }
  41
  42     /** Get the IconThemeInfo for a theme.
  43      * If the theme id is not among the found themes, a std::runtime_error will be thrown.
  44      * Use IconThemeIsInstalled() to check whether it is available.
  45      */
  46     const IconThemeInfo& GetIconThemeInfo(const OUString& themeId);
  47
  48     /** Checks whether the theme with the provided name has been found in the
  49      * scanned directory.
  50      */
  51     bool IconThemeIsInstalled(const OUString& themeId) const;
  52
  53 private:
  54     IconThemeScanner();
  55
  56     /** Scan a directory for icon themes.
  57      *
  58      * @return
  59      * There are several cases when this method will fail:
  60      * - The directory does not exist
  61      * - There are no files which match the pattern images_xxx.zip
  62      */
  63     void ScanDirectoryForIconThemes(std::u16string_view path);
  64
  65     /** Adds the provided icon theme by path.
  66      */
  67     bool AddIconThemeByPath(const OUString& path);
  68
  69     /** Scans the provided directory for icon themes.
  70      * The returned strings will contain the URLs to the icon themes.
  71      */
  72     static std::vector<OUString> ReadIconThemesFromPath(const OUString& dir);
  73
  74     /** Check whether a single file is valid */
  75     static bool FileIsValidIconTheme(const OUString&);
  76
  77     std::vector<IconThemeInfo> mFoundIconThemes;
  78
  79     friend class ::IconThemeScannerTest;
  80 };
  81
  82 } // end namespace vcl
  83
  84 #endif // INCLUDED_VCL_ICONTHEMESCANNER_HXX
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */