LibreOffice: salhelper/refobj.hxx Source File

LibreOffice LibreOffice 7.1 SDK C/C++ API Reference

refobj.hxx
Go to the documentation of this file.
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_SALHELPER_REFOBJ_HXX
21#define INCLUDED_SALHELPER_REFOBJ_HXX
22
23#include <cassert>
24
25#include "sal/types.h"
26#include "rtl/alloc.h"
27#include "osl/interlck.h"
28
29namespace salhelper
30{
31
36 class ReferenceObject
37{
40 oslInterlockedCount m_nReferenceCount;
41
42 ReferenceObject (const ReferenceObject&) SAL_DELETED_FUNCTION;
43 ReferenceObject& operator= (const ReferenceObject&) SAL_DELETED_FUNCTION;
44
45public:
48 static void* operator new (size_t n)
49 {
50 return ::rtl_allocateMemory (n);
51 }
52 static void operator delete (void* p)
53 {
54 ::rtl_freeMemory (p);
55 }
56 static void* operator new (size_t, void* p)
57 {
58 return p;
59 }
60 static void operator delete (void*, void*)
61 {}
62
63public:
66 ReferenceObject() : m_nReferenceCount(0)
67 {}
68
69
70 void SAL_CALL acquire()
71 {
72 osl_atomic_increment(&m_nReferenceCount);
73 }
74
75 void SAL_CALL release()
76 {
77 if (osl_atomic_decrement(&m_nReferenceCount) == 0)
78 {
79 // Last reference released.
80 delete this;
81 }
82 }
83
84protected:
87 virtual ~ReferenceObject()
88 {
89 assert(m_nReferenceCount == 0);
90 }
91};
92
93
94} // namespace salhelper
95
96#endif /* ! INCLUDED_SALHELPER_REFOBJ_HXX */
97
98/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
types.h
SAL_DELETED_FUNCTION
#define SAL_DELETED_FUNCTION
short-circuit extra-verbose API namespaces
Definition: types.h:374
alloc.h
rtl_freeMemory
SAL_DLLPUBLIC void rtl_freeMemory(void *Ptr) SAL_THROW_EXTERN_C()
Free memory.
rtl_allocateMemory
SAL_DLLPUBLIC void * rtl_allocateMemory(sal_Size Bytes) SAL_THROW_EXTERN_C()
Allocate memory.
interlck.h
oslInterlockedCount
sal_Int32 oslInterlockedCount
Definition: interlck.h:40
salhelper
Definition: condition.hxx:31
salhelper::ReferenceObject
A base implementation for reference-counted objects.
Definition: refobj.hxx:37
salhelper::ReferenceObject::acquire
void acquire()
Definition: refobj.hxx:70
salhelper::ReferenceObject::~ReferenceObject
virtual ~ReferenceObject()
Destruction.
Definition: refobj.hxx:87
salhelper::ReferenceObject::ReferenceObject
ReferenceObject()
Construction.
Definition: refobj.hxx:66
salhelper::ReferenceObject::release
void release()
Definition: refobj.hxx:75