Avoid potential negative array index access to cached text.
[LibreOffice.git] / vcl / inc / ControlCacheKey.hxx
blobe422004ca58e3c7c520b53b56a8cc8da8bc181ba
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
20 #ifndef INCLUDED_VCL_INC_CONTROLCACHEKEY_HXX
21 #define INCLUDED_VCL_INC_CONTROLCACHEKEY_HXX
23 #include <tools/gen.hxx>
24 #include <vcl/salnativewidgets.hxx>
25 #include <o3tl/hash_combine.hxx>
27 class ControlCacheKey
29 public:
30 ControlType mnType;
31 ControlPart mnPart;
32 ControlState mnState;
33 Size maSize;
35 ControlCacheKey(ControlType nType, ControlPart nPart, ControlState nState, const Size& rSize)
36 : mnType(nType)
37 , mnPart(nPart)
38 , mnState(nState)
39 , maSize(rSize)
43 bool operator==(ControlCacheKey const& aOther) const
45 return mnType == aOther.mnType && mnPart == aOther.mnPart && mnState == aOther.mnState
46 && maSize.Width() == aOther.maSize.Width()
47 && maSize.Height() == aOther.maSize.Height();
50 bool canCacheControl() const
52 switch (mnType)
54 case ControlType::Checkbox:
55 case ControlType::Radiobutton:
56 case ControlType::ListNode:
57 case ControlType::Slider:
58 case ControlType::LevelBar:
59 case ControlType::Progress:
60 // FIXME: these guys have complex state hidden in ImplControlValue
61 // structs which affects rendering, needs to be a and needs to be
62 // part of the key to our cache.
63 case ControlType::Spinbox:
64 case ControlType::SpinButtons:
65 case ControlType::TabItem:
66 return false;
68 case ControlType::Menubar:
69 if (mnPart == ControlPart::Entire)
70 return false;
71 break;
73 default:
74 break;
76 return true;
80 struct ControlCacheHashFunction
82 std::size_t operator()(ControlCacheKey const& aCache) const
84 std::size_t seed = 0;
85 o3tl::hash_combine(seed, aCache.mnType);
86 o3tl::hash_combine(seed, aCache.mnPart);
87 o3tl::hash_combine(seed, aCache.mnState);
88 o3tl::hash_combine(seed, aCache.maSize.Width());
89 o3tl::hash_combine(seed, aCache.maSize.Height());
90 return seed;
94 #endif // INCLUDED_VCL_INC_CONTROLCACHEKEY_HXX