summaryrefslogtreecommitdiff
path: root/meshmc/launcher/Usable.h
blob: b50b0820eed5e793f4c6ce5795204740ac479a99 (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
/* SPDX-FileCopyrightText: 2026 Project Tick
 * SPDX-FileContributor: Project Tick
 * SPDX-License-Identifier: GPL-3.0-or-later
 *
 *   MeshMC - A Custom Launcher for Minecraft
 *   Copyright (C) 2026 Project Tick
 *
 *   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 3 of the License, or
 *   (at your option) any later version.
 *
 *   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, see <https://www.gnu.org/licenses/>.
 */

#pragma once

#include <cstddef>
#include <memory>

#include "QObjectPtr.h"

class Usable;

/**
 * Base class for things that can be used by multiple other things and we want
 * to track the use count.
 *
 * @see UseLock
 */
class Usable
{
	friend class UseLock;

  public:
	std::size_t useCount() const
	{
		return m_useCount;
	}
	bool isInUse() const
	{
		return m_useCount > 0;
	}

  protected:
	virtual void decrementUses()
	{
		m_useCount--;
	}
	virtual void incrementUses()
	{
		m_useCount++;
	}

  private:
	std::size_t m_useCount = 0;
};

/**
 * Lock class to use for keeping track of uses of other things derived from
 * Usable
 *
 * @see Usable
 */
class UseLock
{
  public:
	UseLock(shared_qobject_ptr<Usable> usable) : m_usable(usable)
	{
		// this doesn't use shared pointer use count, because that wouldn't be
		// correct. this count is separate.
		m_usable->incrementUses();
	}
	~UseLock()
	{
		m_usable->decrementUses();
	}

  private:
	shared_qobject_ptr<Usable> m_usable;
};