Added missing API docu, improved existing API docu
[libfirm] / include / libfirm / adt / obst.h
1 /*
2  * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
3  *
4  * This file is part of libFirm.
5  *
6  * This file may be distributed and/or modified under the terms of the
7  * GNU General Public License version 2 as published by the Free Software
8  * Foundation and appearing in the file LICENSE.GPL included in the
9  * packaging of this file.
10  *
11  * Licensees holding valid libFirm Professional Edition licenses may use
12  * this file in accordance with the libFirm Commercial License.
13  * Agreement provided with the Software.
14  *
15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE.
18  */
19
20 /**
21  * @file
22  * @brief     Provides obstack_chunk_alloc and obstack_chunk_free for obstack.h
23  * @author    Martin Trapp, Christian Schaefer
24  */
25 #ifndef FIRM_ADT_OBST_H
26 #define FIRM_ADT_OBST_H
27
28 #include "obstack.h"
29 #include "xmalloc.h"
30
31 /** @cond PRIVATE */
32 #define obstack_chunk_alloc xmalloc
33 #define obstack_chunk_free  free
34 /** @endcond */
35
36 /** An obstack initializer containing zero values. Can be used to initialize
37  * obstacks in an initializer. */
38 #define NULL_OBST     { 0, NULL, NULL, NULL, NULL, 0, 0, NULL, NULL, NULL, 0, 0, 0 }
39
40 #endif