tv: Let fc_comp() return an ir_relation instead of magic numbers.

[libfirm] / ir / tv / strcalc.h

diff --git a/ir/tv/strcalc.h b/ir/tv/strcalc.h
index cd0c002..8d74b81 100644 (file)
--- a/ir/tv/strcalc.h
+++ b/ir/tv/strcalc.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2011 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
@@ -22,8 +22,7 @@
  * @brief    Provides basic mathematical operations on values represented as strings.
  * @date     2003
  * @author   Mathias Heil
- * @version  $Id$
- * @summary
+ * @brief
  *
  * The module uses a string to represent values, and provides operations
  * to perform calculations with these values.
@@ -107,6 +106,11 @@ void sc_neg(const void *value, void *buffer);
  */
 void sc_and(const void *value1, const void *value2, void *buffer);
 
+/**
+ * buffer = value1 & ~value2
+ */
+void sc_andnot(const void *value1, const void *value2, void *buffer);
+
 /**
  * buffer = value1 | value2
  */
@@ -129,35 +133,59 @@ void sc_mul(const void *value1, const void *value2, void *buffer);
 
 /**
  * buffer = value1 / value2
- *
- * @return non-zero if the remainder is null.
  */
-int sc_div(const void *value1, const void *value2, void *buffer);
+void sc_div(const void *value1, const void *value2, void *buffer);
 
 /**
  * buffer = value1 % value2
  */
 void sc_mod(const void *value1, const void *value2, void *buffer);
 
+/**
+ * div_buffer = value1 / value2
+ * mod_buffer = value1 % value2
+ */
+void sc_divmod(const void *value1, const void *value2, void *div_buffer, void *mod_buffer);
+
+/**
+ * buffer = value1 << offset
+ */
+void sc_shlI(const void *val1, long shift_cnt, int bitsize, int sign, void *buffer);
+
 /**
  * buffer = value1 << value2
  */
-void sc_shl(const void *value1, const void *value2, int radius, int sign, void *buffer);
+void sc_shl(const void *value1, const void *value2, int bitsize, int sign, void *buffer);
+
+/**
+ * buffer = value1 >>u offset
+ */
+void sc_shrI(const void *val1, long shift_cnt, int bitsize, int sign, void *buffer);
 
 /**
  * buffer = value1 >>u value2
  */
-void sc_shr(const void *value1, const void *value2, int radius, int sign, void *buffer);
+void sc_shr(const void *value1, const void *value2, int bitsize, int sign, void *buffer);
+
+/**
+ * buffer = value1 >>s offset
+ */
+void sc_shrsI(const void *val1, long shift_cnt, int bitsize, int sign, void *buffer);
 
 /**
  * buffer = value1 >>s value2
  */
-void sc_shrs(const void *value1, const void *value2, int radius, int sign, void *buffer);
+void sc_shrs(const void *value1, const void *value2, int bitsize, int sign, void *buffer);
 
 /**
- * buffer = value1 <<>> value2
+ * buffer = value1 <<left>> value2
  */
-void sc_rot(const void *value1, const void *value2, int radius, int sign, void *buffer);
+void sc_rotl(const void *value1, const void *value2, int bitsize, int sign, void *buffer);
+
+/**
+ * buffer = 0
+ */
+void sc_zero(void *buffer);
 
 /*
  * function declarations
@@ -165,10 +193,14 @@ void sc_rot(const void *value1, const void *value2, int radius, int sign, void *
 const void *sc_get_buffer(void);
 int sc_get_buffer_length(void);
 
-void sign_extend(char *calc_buffer, ir_mode *mode);
+void sign_extend(void *buffer, ir_mode *mode);
 
-/** create an value form a string representation */
-void sc_val_from_str(const char *str, unsigned int len, void *buffer, ir_mode *mode);
+/**
+ * create an value form a string representation
+ * @return 1 if ok, 0 in case of parse error
+ */
+int sc_val_from_str(char sign, unsigned base, const char *str,
+                    size_t len, void *buffer);
 
 /** create a value from a long */
 void sc_val_from_long(long l, void *buffer);
@@ -181,6 +213,9 @@ long sc_val_to_long(const void *val);
 void sc_min_from_bits(unsigned int num_bits, unsigned int sign, void *buffer);
 void sc_max_from_bits(unsigned int num_bits, unsigned int sign, void *buffer);
 
+/** truncates a value to lowest @p num_bits bits */
+void sc_truncate(unsigned num_bits, void *buffer);
+
 /**
  * Compares val1 and val2
  */
@@ -190,7 +225,14 @@ int sc_get_highest_set_bit(const void *value);
 int sc_get_lowest_set_bit(const void *value);
 int sc_is_zero(const void *value);
 int sc_is_negative(const void *value);
-int sc_had_carry(void);
+
+/**
+ * Return the bits of a tarval at a given byte-offset.
+ *
+ * @param value     the value
+ * @param len       number of valid bits in the value
+ * @param byte_ofs  the byte offset
+ */
 unsigned char sc_sub_bits(const void *value, int len, unsigned byte_ofs);
 
 /**
@@ -214,4 +256,13 @@ void init_strcalc(int precision_in_bytes);
 void finish_strcalc(void);
 int sc_get_precision(void);
 
+/** Return the bit at a given position. */
+int sc_get_bit_at(const void *value, unsigned pos);
+
+/** Set the bit at the specified position. */
+void sc_set_bit_at(void *value, unsigned pos);
+
+/* Strange semantics */
+int sc_had_carry(void);
+
 #endif /* FIRM_TV_STRCALC_H */