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
|
/**************************************************************************
* *
* Regina - A Normal Surface Theory Calculator *
* Qt User Interface *
* *
* Copyright (c) 1999-2016, Ben Burton *
* For further details contact Ben Burton (bab@debian.org). *
* *
* This file is modified from the KDE syntax-highlighting framework, *
* which is copyright (C) 2016 Volker Krause <vkrause@kde.org> *
* and is distributed under the GNU Library General Public License as *
* published by the Free Software Foundation; either version 2 of the *
* License, or (at your option) any later version. *
* *
* This program is free software; you can redistribute it and/or *
* modify it under the terms of the GNU General Public License as *
* published by the Free Software Foundation; either version 2 of the *
* License, or (at your option) any later version. *
* *
* As an exception, when this program is distributed through (i) the *
* App Store by Apple Inc.; (ii) the Mac App Store by Apple Inc.; or *
* (iii) Google Play by Google Inc., then that store may impose any *
* digital rights management, device limits and/or redistribution *
* restrictions that are required by its terms of service. *
* *
* This program is distributed in the hope that it will be useful, but *
* WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
* General Public License for more details. *
* *
* You should have received a copy of the GNU General Public *
* License along with this program; if not, write to the Free *
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
* MA 02110-1301, USA. *
* *
**************************************************************************/
/**
* \file syntax/definitionref.h
* \brief Part of the private syntax highlighting framework that is shared
* between Regina's different graphical user interfaces.
*
* The syntax highlighting headers are private in the following sense: they are
* not installed along with Regina's other headers, they do not appear in the
* API documentation, and the syntax highlighting API is subject to change
* without notice between different versions of Regina.
*/
#ifndef __SYNTAX_DEFINITIONREF_H
#ifndef __DOXYGEN
#define __SYNTAX_DEFINITIONREF_H
#endif
#include "regina-core.h"
#include <memory>
namespace regina {
namespace syntax {
class Definition;
class DefinitionData;
class DefinitionPrivate;
/** Weak reference for Definition instances.
*
* This must be used when holding Definition instances
* in objects hold directly or indirectly by Definition
* to avoid reference count loops and thus memory leaks.
*
* @internal
*/
class REGINA_API DefinitionRef
{
public:
DefinitionRef();
explicit DefinitionRef(const Definition &def);
~DefinitionRef();
DefinitionRef& operator=(const Definition &def);
Definition definition() const;
private:
friend class DefinitionData;
std::weak_ptr<DefinitionData> d;
};
} } // namespace regina::syntax
#endif
|