summaryrefslogtreecommitdiff
path: root/svl/source/notify/broadcast.cxx
blob: bef049a84c5cbe75840d68f74f7cb268a8fc89c8 (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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
/* -*- 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 .
 */

#include <svl/broadcast.hxx>
#include <svl/listener.hxx>
#include <svl/hint.hxx>
#include <cassert>
#include <algorithm>

void SvtBroadcaster::Normalize() const
{
    if (!mbNormalized)
    {
        std::sort(maListeners.begin(), maListeners.end());
        mbNormalized = true;
    }

    if (!mbDestNormalized)
    {
        std::sort(maDestructedListeners.begin(), maDestructedListeners.end());
        mbDestNormalized = true;
    }
}

void SvtBroadcaster::Add( SvtListener* p )
{
    assert(!mbAboutToDie && "called inside my own destructor / after PrepareForDestruction()?");
    if (mbAboutToDie)
        return;
    // only reset mbNormalized if we are going to become unsorted
    if (!maListeners.empty() && maListeners.back() > p)
        mbNormalized = false;
    maListeners.push_back(p);
}

void SvtBroadcaster::Remove( SvtListener* p )
{
    if (mbAboutToDie)
    {
        // only reset mbDestNormalized if we are going to become unsorted
        if (!maDestructedListeners.empty() && maDestructedListeners.back() > p)
            mbDestNormalized = false;
        maDestructedListeners.push_back(p);
        return;
    }

    Normalize();

    auto it = std::lower_bound(maListeners.begin(), maListeners.end(), p);
    assert (it != maListeners.end() && *it == p);
    if (it != maListeners.end() && *it == p)
    {
        maListeners.erase(it);
    }

    if (maListeners.empty())
        ListenersGone();
}

SvtBroadcaster::SvtBroadcaster() : mbAboutToDie(false), mbNormalized(true), mbDestNormalized(true) {}

SvtBroadcaster::SvtBroadcaster( const SvtBroadcaster &rBC ) :
    mbAboutToDie(false),
    mbNormalized(true), mbDestNormalized(true)
{
    assert(!rBC.mbAboutToDie && "copying an object marked with PrepareForDestruction() / that is in it's destructor?");

    rBC.Normalize(); // so that insert into ourself is in-order, and therefore we do not need to Normalize()
    maListeners.reserve(rBC.maListeners.size());
    for (SvtListener* p : rBC.maListeners)
         p->StartListening(*this); // this will call back into this->Add()
}

SvtBroadcaster::~SvtBroadcaster()
{
    PrepareForDestruction();

    Normalize();

    {
        auto dest(maDestructedListeners.data());
        SfxHint aHint(SfxHintId::Dying);
        for (ListenersType::iterator it(maListeners.begin()); it != maListeners.end(); ++it)
        {
            auto destEnd(dest + maDestructedListeners.size());
            // skip the destructed ones
            while (dest != destEnd && (*dest < *it))
                ++dest;

            if (dest == destEnd || *dest != *it)
                (*it)->Notify(aHint);
        }
    }

    Normalize();

    // now when both lists are sorted, we can linearly unregister all
    // listeners, with the exception of those that already asked to be removed
    // during their own destruction
    {
        auto dest(maDestructedListeners.data());
        for (ListenersType::iterator it(maListeners.begin()); it != maListeners.end(); ++it)
        {
            auto destEnd(dest + maDestructedListeners.size());
            // skip the destructed ones
            while (dest != destEnd && (*dest < *it))
                ++dest;

            if (dest == destEnd || *dest != *it)
                (*it)->BroadcasterDying(*this);
        }
    }
}

void SvtBroadcaster::Broadcast( const SfxHint &rHint )
{
    assert(!mbAboutToDie && "broadcasting after PrepareForDestruction() / from inside my own destructor?");
    if (mbAboutToDie)
        return;

    ListenersType aListeners(maListeners); // this copy is important to avoid erasing entries while iterating
    for (SvtListener * p : aListeners)
        p->Notify(rHint);
}

void SvtBroadcaster::ListenersGone() {}

SvtBroadcaster::ListenersType& SvtBroadcaster::GetAllListeners()
{
    Normalize();
    return maListeners;
}

const SvtBroadcaster::ListenersType& SvtBroadcaster::GetAllListeners() const
{
    Normalize();
    return maListeners;
}

bool SvtBroadcaster::HasListeners() const
{
    return !maListeners.empty();
}

void SvtBroadcaster::PrepareForDestruction()
{
    mbAboutToDie = true;
    // the reserve() serves two purpose (1) performance (2) makes sure our iterators do not become invalid
    maDestructedListeners.reserve(maListeners.size());
}

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