Yes I did it again ;)
[blender-staging.git] / intern / memutil / MEM_RefCountedC-Api.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version. The Blender
9  * Foundation also sells licenses for use in proprietary software under
10  * the Blender License.  See http://www.blender.org/BL/ for information
11  * about this.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
30  */
31
32 /**
33
34  * $Id$
35  * Copyright (C) 2001 NaN Technologies B.V.
36  * Interface for C access to functionality relating to shared objects in the foundation library.
37  * @author      Maarten Gribnau
38  * @date        June 17, 2001
39  */
40
41 #ifndef _H_MEM_REF_COUNTED_C_API
42 #define _H_MEM_REF_COUNTED_C_API
43
44 #ifdef HAVE_CONFIG_H
45 #include <config.h>
46 #endif
47
48
49 /** A pointer to a private object. */
50 typedef struct MEM_TOpaqueObject* MEM_TObjectPtr;
51 /** A pointer to a shared object. */
52 typedef MEM_TObjectPtr MEM_TRefCountedObjectPtr;
53
54
55 #ifdef __cplusplus
56 extern "C" {
57 #endif
58
59
60 /**
61  * A shared object in an object with reference counting.
62  * When a shared object is ceated, it has reference count == 1.
63  * If the the reference count of a shared object reaches zero, the object self-destructs.
64  * The default constrcutor and destructor of this object have been made protected on purpose.
65  * This disables the creation and disposal of shared objects on the stack.
66  */
67
68 /** 
69  * Returns the reference count of this object.
70  * @param shared The object to query.
71  * @return The current reference count.
72  */
73 extern int      MEM_RefCountedGetRef(MEM_TRefCountedObjectPtr shared);
74
75 /** 
76  * Increases the reference count of this object.
77  * @param shared The object to query.
78  * @return The new reference count.
79  */
80 extern int      MEM_RefCountedIncRef(MEM_TRefCountedObjectPtr shared);
81
82 /** 
83  * Decreases the reference count of this object.
84  * If the the reference count reaches zero, the object self-destructs.
85  * @param shared The object to query.
86  * @return The new reference count.
87  */
88 extern int      MEM_RefCountedDecRef(MEM_TRefCountedObjectPtr shared);
89
90
91 #ifdef __cplusplus
92 }
93 #endif
94
95 #endif // _H_MEM_REF_COUNTED_C_API
96