include/vcl/implimagetree.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  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_INCLUDE_VCL_IMPLIMAGETREE_HXX
  21 #define INCLUDED_INCLUDE_VCL_IMPLIMAGETREE_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <memory>
  26 #include <unordered_map>
  27 #include <utility>
  28 #include <vector>
  29
  30 #include <com/sun/star/uno/Reference.hxx>
  31 #include <rtl/ustring.hxx>
  32 #include <vcl/bitmapex.hxx>
  33 #include <vcl/dllapi.h>
  34
  35 namespace com { namespace sun { namespace star { namespace container {
  36     class XNameAccess;
  37 } } } }
  38
  39 class ImplImageTree {
  40 public:
  41     VCL_DLLPUBLIC static ImplImageTree & get();
  42
  43     ImplImageTree();
  44
  45     ~ImplImageTree();
  46
  47     VCL_DLLPUBLIC OUString getImageUrl(
  48         OUString const & name, OUString const & style, OUString const & lang);
  49
  50     bool loadImage(
  51         OUString const & name, OUString const & style,
  52         BitmapEx & bitmap, bool localized = false, bool loadMissing = false );
  53
  54     bool loadDefaultImage(
  55         OUString const & style,
  56         BitmapEx& bitmap);
  57
  58     /** a crude form of life cycle control (called from DeInitVCL; otherwise,
  59      *  if the ImplImageTree singleton were destroyed during exit that would
  60      *  be too late for the destructors of the bitmaps in maIconCache)*/
  61     void shutDown();
  62
  63     css::uno::Reference< css::container::XNameAccess > getNameAccess();
  64
  65 private:
  66     ImplImageTree(const ImplImageTree&) SAL_DELETED_FUNCTION;
  67     ImplImageTree& operator=(const ImplImageTree&) SAL_DELETED_FUNCTION;
  68
  69     typedef std::unordered_map<OUString, std::pair<bool, BitmapEx>, OUStringHash> IconCache;
  70     typedef std::unordered_map<OUString, OUString, OUStringHash> IconLinkHash;
  71
  72     struct IconSet {
  73         OUString maURL;
  74         css::uno::Reference<css::container::XNameAccess> maNameAccess;
  75         IconCache maIconCache;
  76         IconLinkHash maLinkHash;
  77
  78         IconSet() {}
  79         IconSet(const OUString &aURL) : maURL(aURL) {}
  80     };
  81
  82     /// Map between the theme name(s) and the content.
  83     typedef std::unordered_map<OUString, IconSet, OUStringHash> StyleIconSet;
  84
  85     /// Remember all the (used) icon styles and individual icons in them.
  86     StyleIconSet maIconSet;
  87
  88     /// Styly used for the current operations; switches switch several times during fallback search.
  89     OUString maCurrentStyle;
  90
  91     bool doLoadImage(
  92         OUString const & name, OUString const & style,
  93         BitmapEx & bitmap, bool localized);
  94
  95     bool checkPathAccess();
  96
  97     void setStyle(OUString const & style );
  98
  99     void createStyle();
 100
 101     bool iconCacheLookup( OUString const & name, bool localized, BitmapEx & bitmap );
 102
 103     bool findImage(std::vector< OUString > const & paths, BitmapEx & bitmap );
 104
 105     void loadImageLinks();
 106
 107     void parseLinkFile(std::shared_ptr<SvStream> stream);
 108
 109     /// Return name of a real .png according to links.txt.
 110     OUString const & getRealImageName(OUString const & name);
 111
 112     /** Rerurn name of the fallback style for the provided one.
 113
 114         Must not be cyclic :-)  The last theme in the chain returns an empty string.
 115     */
 116     static OUString fallbackStyle(const OUString &style);
 117 };
 118
 119 #endif
 120
 121 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */