Merged changes in the trunk up to revision 35203.
[blender.git] / intern / memutil / MEM_RefCountedC-Api.h
1 /*
2  * $Id$
3  * ***** BEGIN GPL 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.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  *
19  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
20  * All rights reserved.
21  *
22  * The Original Code is: all of this file.
23  *
24  * Contributor(s): none yet.
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /** \file memutil/MEM_RefCountedC-Api.h
30  *  \ingroup memutil
31  */
32
33 /**
34  * @file        MEM_RefCountedC-Api.h
35  * Interface for C access to functionality relating to shared objects in the foundation library.
36  */
37
38 #ifndef MEM_REFCOUNTEDC_API_H
39 #define MEM_REFCOUNTEDC_API_H
40
41 /** A pointer to a private object. */
42 typedef struct MEM_TOpaqueObject* MEM_TObjectPtr;
43 /** A pointer to a shared object. */
44 typedef MEM_TObjectPtr MEM_TRefCountedObjectPtr;
45
46
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50
51
52 /** 
53  * Returns the reference count of this object.
54  * @param shared The object to query.
55  * @return The current reference count.
56  */
57 extern int      MEM_RefCountedGetRef(MEM_TRefCountedObjectPtr shared);
58
59 /** 
60  * Increases the reference count of this object.
61  * @param shared The object to query.
62  * @return The new reference count.
63  */
64 extern int      MEM_RefCountedIncRef(MEM_TRefCountedObjectPtr shared);
65
66 /** 
67  * Decreases the reference count of this object.
68  * If the the reference count reaches zero, the object self-destructs.
69  * @param shared The object to query.
70  * @return The new reference count.
71  */
72 extern int      MEM_RefCountedDecRef(MEM_TRefCountedObjectPtr shared);
73
74
75 #ifdef __cplusplus
76 }
77 #endif
78
79 #endif // MEM_REFCOUNTEDC_API_H