X-Git-Url: http://nsz.repo.hu/git/?a=blobdiff_plain;f=type.h;h=502096d88ca00723e2c33deab96a6837c126aa9e;hb=ce8747dcdb81cc4c5000092807102283a1e62b68;hp=cf8730f167670108cbd3e7bef180a76ff0e3ca80;hpb=1b580cf22ca849edc62afa24304ff0432954877a;p=cparser

diff --git a/type.h b/type.h
index cf8730f..502096d 100644
--- a/type.h
+++ b/type.h
@@ -34,6 +34,7 @@ typedef unsigned char il_alignment_t;
 typedef enum atomic_type_kind_t {
 	ATOMIC_TYPE_INVALID = 0,
 	ATOMIC_TYPE_VOID,
+	ATOMIC_TYPE_BOOL,
 	ATOMIC_TYPE_WCHAR_T,
 	ATOMIC_TYPE_CHAR,
 	ATOMIC_TYPE_SCHAR,
@@ -49,9 +50,8 @@ typedef enum atomic_type_kind_t {
 	ATOMIC_TYPE_FLOAT,
 	ATOMIC_TYPE_DOUBLE,
 	ATOMIC_TYPE_LONG_DOUBLE,
-	ATOMIC_TYPE_BOOL,
 
-	ATOMIC_TYPE_LAST = ATOMIC_TYPE_BOOL
+	ATOMIC_TYPE_LAST = ATOMIC_TYPE_LONG_DOUBLE
 } atomic_type_kind_t;
 
 typedef enum atomic_type_flag_t {
@@ -94,9 +94,21 @@ typedef struct bitfield_type_t       bitfield_type_t;
 typedef struct typeof_type_t         typeof_type_t;
 typedef union  type_t                type_t;
 
-void init_types(void);
+/**
+ * Initializes the type system. Attempts to set some defaults on the atomic
+ * types based on a given machine size.
+ * These type properties are not final but you should adapt them to your system
+ * as your architecture and operating systems application binary interface (ABI)
+ * requires.
+ */
+void init_types(unsigned machine_size);
 void exit_types(void);
 
+/**
+ * Prints a type.
+ *
+ * @param type   The type.
+ */
 void print_type(const type_t *type);
 
 /**
@@ -106,68 +118,115 @@ void print_type(const type_t *type);
 void print_type_ext(const type_t *type, const symbol_t *symbol,
                     const scope_t *parameters);
 
-void print_type_qualifiers(type_qualifiers_t qualifiers);
+typedef enum QualifierSeparators {
+	QUAL_SEP_NONE  = 0,
+	QUAL_SEP_START = 1U << 0,
+	QUAL_SEP_END   = 1U << 1
+} QualifierSeparators;
+
+void print_type_qualifiers(type_qualifiers_t qualifiers, QualifierSeparators);
 
+/**
+ * Prints an enum definition.
+ *
+ * @param declaration  The enum's type declaration.
+ */
 void print_enum_definition(const enum_t *enume);
+
+/**
+ * Print the compound part of a compound type.
+ */
 void print_compound_definition(const compound_t *compound);
 
 void inc_type_visited(void);
 
 /**
- * returns true if type contains integer numbers
+ * Returns true if the given type is an integer type.
+ *
+ * @param type  The type to check.
+ * @return True if type is an integer type.
  */
 bool is_type_integer(const type_t *type);
 
 /**
  * Returns true if the given type is an enum type.
+ *
+ * @param type  The type to check.
+ * @return True if type is an enum type.
  */
 bool is_type_enum(const type_t *type);
 
 /**
- * return true if type contains signed numbers
+ * Returns true if the given type is a signed type.
+ *
+ * @param type  The type to check.
+ * @return True if type is a signed type.
  */
 bool is_type_signed(const type_t *type);
 
 /**
- * returns true if type contains floating point numbers
+ * Returns true if the given type is a floating point type.
+ *
+ * @param type  The type to check.
+ * @return True if type is a floating point type.
  */
 bool is_type_float(const type_t *type);
 
 /**
- * returns true if type contains complex numbers
+ * Returns true if the given type is a complex type.
+ *
+ * @param type  The type to check.
+ * @return True if type is a complex type.
  */
 bool is_type_complex(const type_t *type);
 
-bool is_type_real(const type_t *type);
-
 /**
- * returns true if the type is valid. A type is valid if it contains no
- * unresolved references anymore and is not of TYPE_INVALID.
+ * Returns true if the given type is an integer or float type.
+ *
+ * @param type  The type to check.
+ * @return True if type is an integer or float type.
  */
-bool type_valid(const type_t *type);
+bool is_type_real(const type_t *type);
 
 /**
- * returns true if the type is an arithmetic type (§6.2.5 clause 18)
+ * Returns true if the type is an arithmetic type (§6.2.5 clause 18)
+ *
+ * @param type  The type to check.
+ * @return True if type represents an arithmetic type.
  */
 bool is_type_arithmetic(const type_t *type);
 
 /**
- * returns true if the type is a scalar type (§6.2.5 clause 21)
+ * Returns true if the type is a scalar type (§6.2.5 clause 21)
+ *
+ * @param type  The type to check.
+ * @return True if type represents a scalar type.
  */
 bool is_type_scalar(const type_t *type);
 
+/**
+ * Check if a given type is incomplete.
+ *
+ * @param type  The type to check.
+ * @return True if the given type is incomplete (ie. just forward).
+ */
 bool is_type_incomplete(const type_t *type);
 
 bool is_type_object(const type_t *type);
 
 /**
- * returns true if teh type is the builtin va_list type.
+ * Check if two types are compatible.
  */
-bool is_builtin_va_list(type_t *type);
-
 bool types_compatible(const type_t *type1, const type_t *type2);
 
+/**
+ * Returns the unqualified type of a given type.
+ *
+ * @param type  The type.
+ * @returns The unqualified type.
+ */
 type_t *get_unqualified_type(type_t *type);
+
 type_t *get_qualified_type(type_t*, type_qualifiers_t);
 type_t *skip_typeref(type_t *type);
 
@@ -196,9 +255,6 @@ decl_modifiers_t get_type_modifiers(const type_t *type);
  */
 unsigned get_atomic_type_flags(atomic_type_kind_t kind);
 
-atomic_type_kind_t get_intptr_kind(void);
-atomic_type_kind_t get_uintptr_kind(void);
-
 /**
  * Find the atomic type kind representing a given size (signed).
  */
@@ -211,7 +267,16 @@ atomic_type_kind_t find_unsigned_int_atomic_type_kind_for_size(unsigned size);
 
 const char *get_atomic_kind_name(atomic_type_kind_t kind);
 
+/**
+ * Finish the construction of a struct type by calculating its size, offsets,
+ * alignment.
+ */
 void layout_struct_type(compound_type_t *type);
+
+/**
+ * Finish the construction of an union type by calculating
+ * its size and alignment.
+ */
 void layout_union_type(compound_type_t *type);
 
 #endif