cleaned up doxygen comments

[libfirm] / ir / ir / irop_t.h

diff --git a/ir/ir/irop_t.h b/ir/ir/irop_t.h
index 0e6cbb0..cca5987 100644 (file)
--- a/ir/ir/irop_t.h
+++ b/ir/ir/irop_t.h
@@ -1,16 +1,30 @@
 /*
- * Project:     libFIRM
- * File name:   ir/ir/irop_t.h
- * Purpose:     Representation of opcode of intermediate operation -- private header.
- * Author:      Christian Schaefer
- * Modified by: Goetz Lindenmaier
- * Created:
- * CVS-ID:      $Id$
- * Copyright:   (c) 1998-2003 Universität Karlsruhe
- * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
+ *
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
+ *
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
  */
-#ifndef _IROP_T_H_
-#define _IROP_T_H_
+
+/**
+ * @file
+ * @brief    Representation of opcode of intermediate operation -- private header.
+ * @author   Christian Schaefer, Goetz Lindenmaier
+ * @version  $Id$
+ */
+#ifndef FIRM_IR_IROP_T_H
+#define FIRM_IR_IROP_T_H
 
 #include "firm_config.h"
 #include "irop.h"
@@ -20,7 +34,7 @@
 
 /** The type of an ir_op. */
 struct ir_op {
-  opcode code;            /**< The unique opcode of the op. */
+  ir_opcode code;         /**< The unique opcode of the op. */
   ident *name;            /**< The name of the op. */
   size_t attr_size;       /**< Space needed in memory for private attributes. */
   op_pin_state op_pin_state_pinned; /**< How to deal with the node in CSE, PRE. */
@@ -101,11 +115,21 @@ static INLINE int is_op_constlike(const ir_op *op) {
   return op->flags & irop_flag_constlike;
 }
 
+/** Returns non-zero if operation must always be optimized */
+static INLINE int is_op_always_opt(const ir_op *op) {
+  return op->flags & irop_flag_always_opt;
+}
+
 /** Returns non-zero if operation is a keep-like op */
 static INLINE int is_op_keep(const ir_op *op) {
   return op->flags & irop_flag_keep;
 }
 
+/** Returns non-zero if operation must always be placed in the start block. */
+static INLINE int is_op_start_block_placed(const ir_op *op) {
+  return op->flags & irop_flag_start_block;
+}
+
 /** Returns non-zero if operation is a machine operation */
 static INLINE int is_op_machine(const ir_op *op) {
   return op->flags & irop_flag_machine;
@@ -121,7 +145,7 @@ static INLINE int is_op_machine_user(const ir_op *op, unsigned n) {
   return op->flags & (irop_flag_user << n);
 }
 
-static INLINE opcode _get_op_code(const ir_op *op) {
+static INLINE ir_opcode _get_op_code(const ir_op *op) {
   return op->code;
 }
 
@@ -160,4 +184,4 @@ static INLINE void *_get_op_tag(ir_op *op) {
 #define set_op_tag(op, tag)     _set_op_tag((op), (tag))
 #define get_op_tag(op)          _get_op_tag(op)
 
-#endif /* _IROP_T_H_ */
+#endif