Added new header
[libfirm] / ir / opt / opt_frame.h
1 /*
2  * Copyright (C) 1995-2007 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   Optimize the frame type.
23  * @date    15.03.2006
24  * @author  Michael Beck
25  * @version $Id$
26  * @summary
27  *   Optimize the frame type by removing unused type members.
28  */
29 #ifndef FIRM_OPT_FRAME_H
30 #define FIRM_OPT_FRAME_H
31
32 /**
33  * @file opt_frame.h
34  *
35  * Optimize the frame type by removing unused type members.
36  */
37
38 #include "firm_types.h"
39
40 /**
41  * Optimize the frame type of an irg by removing
42  * never touched entities.
43  *
44  * @param irg  The graph whose frame type will be optimized
45  *
46  * This function did not change the graph, only it's frame type.
47  * The layout state of the frame type will be set to layout_undefined
48  * if entities were removed.
49  */
50 void opt_frame_irg(ir_graph *irg);
51
52 #endif /* FIRM_OPT_FRAME_H */