updated Header
[libfirm] / ir / opt / return.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   Normalize returns.
23  * @author  Michael Beck
24  * @version $Id$
25  */
26 #ifndef FIRM_OPT_RETURN_H
27 #define FIRM_OPT_RETURN_H
28
29 #include "firm_types.h"
30
31 /**
32  * Normalize the Returns of a graph by creating a new End block
33  * with One Return(Phi).
34  * This is the preferred input for the if-conversion.
35  *
36  * In pseudocode, it means:
37  *
38  * if (a)
39  *   return b;
40  * else
41  *   return c;
42  *
43  * is transformed into
44  *
45  * if (a)
46  *   res = b;
47  * else
48  *   res = c;
49  * return res;
50  */
51 void normalize_one_return(ir_graph *irg);
52
53 /**
54  * Normalize the Returns of a graph by moving
55  * the Returns upwards as much as possible.
56  * This might be preferred for code generation.
57  *
58  * In pseudocode, it means:
59  *
60  * if (a)
61  *   res = b;
62  * else
63  *   res = c;
64  * return res;
65  *
66  * is transformed into
67  *
68  * if (a)
69  *   return b;
70  * else
71  *   return c;
72  */
73 void normalize_n_returns(ir_graph *irg);
74
75 #endif /* FIRM_OPT_RETURN_H */