Coverage Report

Created: 2025-07-07 10:01

/src/libreoffice/include/comphelper/flagguard.hxx
Line
Count
Source (jump to first uncovered line)
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_COMPHELPER_FLAGGUARD_HXX
21
#define INCLUDED_COMPHELPER_FLAGGUARD_HXX
22
23
#include <comphelper/scopeguard.hxx>
24
#include <utility>
25
26
namespace comphelper
27
{
28
29
    //= ValueRestorationGuard
30
31
    // note: can't store the originalValue in a ValueRestorationGuard member,
32
    // because it will be used from base class dtor
33
    template <typename T> struct ValueRestorationGuard_Impl
34
    {
35
        T& rVal;
36
        T const originalValue;
37
        ValueRestorationGuard_Impl(T& i_valRef)
38
3.24M
            : rVal(i_valRef), originalValue(i_valRef) {}
Unexecuted instantiation: comphelper::ValueRestorationGuard_Impl<unsigned char const*>::ValueRestorationGuard_Impl(unsigned char const*&)
comphelper::ValueRestorationGuard_Impl<bool>::ValueRestorationGuard_Impl(bool&)
Line
Count
Source
38
517k
            : rVal(i_valRef), originalValue(i_valRef) {}
Unexecuted instantiation: comphelper::ValueRestorationGuard_Impl<drawinglayer::primitive2d::StructureTagPrimitive2D const*>::ValueRestorationGuard_Impl(drawinglayer::primitive2d::StructureTagPrimitive2D const*&)
comphelper::ValueRestorationGuard_Impl<long>::ValueRestorationGuard_Impl(long&)
Line
Count
Source
38
2.72M
            : rVal(i_valRef), originalValue(i_valRef) {}
Unexecuted instantiation: comphelper::ValueRestorationGuard_Impl<unsigned char>::ValueRestorationGuard_Impl(unsigned char&)
39
        void operator()()
40
3.24M
        {
41
3.24M
            rVal = originalValue;
42
3.24M
        }
Unexecuted instantiation: comphelper::ValueRestorationGuard_Impl<unsigned char const*>::operator()()
comphelper::ValueRestorationGuard_Impl<bool>::operator()()
Line
Count
Source
40
517k
        {
41
517k
            rVal = originalValue;
42
517k
        }
Unexecuted instantiation: comphelper::ValueRestorationGuard_Impl<drawinglayer::primitive2d::StructureTagPrimitive2D const*>::operator()()
comphelper::ValueRestorationGuard_Impl<long>::operator()()
Line
Count
Source
40
2.72M
        {
41
2.72M
            rVal = originalValue;
42
2.72M
        }
Unexecuted instantiation: comphelper::ValueRestorationGuard_Impl<unsigned char>::operator()()
43
    };
44
45
    template <typename T>
46
    class ValueRestorationGuard : public ScopeGuard<ValueRestorationGuard_Impl<T>>
47
    {
48
    public:
49
        ValueRestorationGuard(T& i_valRef)
50
0
            : ScopeGuard<ValueRestorationGuard_Impl<T>>(ValueRestorationGuard_Impl(i_valRef))
51
0
        {}
52
53
        template <typename T1>
54
        ValueRestorationGuard(T& i_valRef, T1&& i_temporaryValue)
55
3.24M
            : ScopeGuard<ValueRestorationGuard_Impl<T>>(ValueRestorationGuard_Impl(i_valRef))
56
3.24M
        {
57
3.24M
            i_valRef = std::forward<T1>(i_temporaryValue);
58
3.24M
        }
comphelper::ValueRestorationGuard<bool>::ValueRestorationGuard<bool>(bool&, bool&&)
Line
Count
Source
55
517k
            : ScopeGuard<ValueRestorationGuard_Impl<T>>(ValueRestorationGuard_Impl(i_valRef))
56
517k
        {
57
517k
            i_valRef = std::forward<T1>(i_temporaryValue);
58
517k
        }
Unexecuted instantiation: comphelper::ValueRestorationGuard<drawinglayer::primitive2d::StructureTagPrimitive2D const*>::ValueRestorationGuard<drawinglayer::primitive2d::StructureTagPrimitive2D const*>(drawinglayer::primitive2d::StructureTagPrimitive2D const*&, drawinglayer::primitive2d::StructureTagPrimitive2D const*&&)
comphelper::ValueRestorationGuard<long>::ValueRestorationGuard<long>(long&, long&&)
Line
Count
Source
55
2.72M
            : ScopeGuard<ValueRestorationGuard_Impl<T>>(ValueRestorationGuard_Impl(i_valRef))
56
2.72M
        {
57
2.72M
            i_valRef = std::forward<T1>(i_temporaryValue);
58
2.72M
        }
Unexecuted instantiation: comphelper::ValueRestorationGuard<long>::ValueRestorationGuard<long&>(long&, long&)
Unexecuted instantiation: comphelper::ValueRestorationGuard<unsigned char>::ValueRestorationGuard<TextTypes>(unsigned char&, TextTypes&&)
59
    };
60
61
    typedef ValueRestorationGuard<bool> FlagRestorationGuard;
62
63
    //= FlagGuard
64
65
    // Guarantees that the flag is true within the scope of the guard, and is set to false after
66
    // its destruction, regardless of initial flag value
67
    class FlagGuard : public FlagRestorationGuard
68
    {
69
    public:
70
        // Set flag to false before passing its reference to base class ctor, so that it would be
71
        // reset back to false in base class dtor
72
        explicit FlagGuard(bool& i_flagRef)
73
0
            : FlagRestorationGuard((i_flagRef = false), true)
74
0
        {
75
0
        }
76
    };
77
78
79
} // namespace comphelper
80
81
82
#endif // INCLUDED_COMPHELPER_FLAGGUARD_HXX
83
84
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */