summaryrefslogtreecommitdiff
path: root/include/comphelper/scopeguard.hxx
blob: a361c7c5f2b0e43be53aa96eff7dbd92c9ae4ece (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef INCLUDED_COMPHELPER_SCOPEGUARD_HXX
#define INCLUDED_COMPHELPER_SCOPEGUARD_HXX

#include <sal/log.hxx>
#include <com/sun/star/uno/Exception.hpp>


// For some reason, Android buildbot issues -Werror like this:
//   In file included from
//   /home/android/lo/master-android-arm/filter/source/xmlfilteradaptor/XmlFilterAdaptor.cxx:50:
//   /home/android/lo/master-android-arm/include/comphelper/scopeguard.hxx:36:14:
//   error: function 'comphelper::<deduction guide for ScopeGuard><(lambda at
//   /home/android/lo/master-android-arm/filter/source/xmlfilteradaptor/XmlFilterAdaptor.cxx:146:34)>'
//   has internal linkage but is not defined [-Werror,-Wundefined-internal]
//       explicit ScopeGuard( Func && func ) : m_func( std::move(func) ) {}
//                ^
//   /home/android/lo/master-android-arm/filter/source/xmlfilteradaptor/XmlFilterAdaptor.cxx:146:28:
//   note: used here
//       comphelper::ScopeGuard guard([&]() {
//                              ^
#ifdef ANDROID
#if defined __clang__
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wundefined-internal"
#endif
#endif


namespace comphelper {

/** ScopeGuard to ease writing exception-safe code.
 */
template <class Func> class ScopeGuard
{
public:
    /** @param func function object to be executed in dtor
    */
    explicit ScopeGuard( Func && func ) : m_func( std::move(func) ) {}

    ~ScopeGuard()
    {
        if (m_bDismissed)
            return;
        try
        {
            m_func();
        }
        catch (css::uno::Exception& exc)
        {
            SAL_WARN("comphelper", "UNO exception occurred: " << exc);
        }
        catch (...)
        {
            SAL_WARN("comphelper", "unknown exception occurred!");
        }
    }

    /** Dismisses the scope guard, i.e. the function won't
        be executed.
    */
    void dismiss() { m_bDismissed = true; }

private:
    // noncopyable until we have good reasons...
    ScopeGuard(const ScopeGuard&) = delete;
    ScopeGuard& operator=(const ScopeGuard&) = delete;

    Func m_func;
    bool m_bDismissed = false;
};

} // namespace comphelper

#ifdef ANDROID
#if defined __clang__
#pragma clang diagnostic pop
#endif
#endif

#endif // ! defined(INCLUDED_COMPHELPER_SCOPEGUARD_HXX)

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */