Add copyright notices and some comments about status and TODO

[lttv.git] / ltt / branches / poly / include / ltt / type.h

diff --git a/ltt/branches/poly/include/ltt/type.h b/ltt/branches/poly/include/ltt/type.h
index 822e2c3445185178e9b56bb160a6c67a4180b1df..918281260cca81b45cce21e1c469c7d36577e438 100644 (file)
--- a/ltt/branches/poly/include/ltt/type.h
+++ b/ltt/branches/poly/include/ltt/type.h
@@ -1,54 +1,86 @@
+/* This file is part of the Linux Trace Toolkit trace reading library
+ * Copyright (C) 2003-2004 Michel Dagenais
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License Version 2.1 as published by the Free Software Foundation.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
 #ifndef TYPE_H
 #define TYPE_H
 
+
+/* Different types allowed */
+
 #include <ltt/ltt.h>
 
-/* All event types and data types belong to their facilities and 
-   are released at the same time. All fields belong to their tracefile and
+
+/* All event types, data types and fields belong to their trace and 
    are released at the same time. */
 
-char *ltt_eventtype_name(ltt_eventtype *et);
+/* Obtain the name, description, facility, facility relative id, global id, 
+   type and root field for an eventtype */
+
+char *ltt_eventtype_name(LttEventType *et);
 
-char *ltt_eventtype_description(ltt_eventtype *et);
+char *ltt_eventtype_description(LttEventType *et);
 
-ltt_type *ltt_eventtype_type(ltt_eventtype *et);
+LttFacility *ltt_eventtype_facility(LttEventType *et);
+
+unsigned ltt_eventtype_relative_id(LttEventType *et);
+
+unsigned ltt_eventtype_id(LttEventType *et);
+
+LttType *ltt_eventtype_type(LttEventType *et);
+
+LttField *ltt_eventtype_field(LttEventType *et);
 
 
 /* obtain the type name and size. The size is the number of bytes for
    primitive types (INT, UINT, FLOAT, ENUM), or the size for the unsigned
    integer length count for sequences. */
  
-char *ltt_type_name(ltt_type *t);
+char *ltt_type_name(LttType *t);
 
-ltt_type_enum ltt_type_class(ltt_type *t);
+LttTypeEnum ltt_type_class(LttType *t);
 
-unsigned ltt_type_size(ltt_tracefile * tf, ltt_type *t); 
+unsigned ltt_type_size(LttTrace *trace, LttType *t); 
 
 
 /* The type of nested elements for arrays and sequences. */
 
-ltt_type *ltt_type_element_type(ltt_type *t);
+LttType *ltt_type_element_type(LttType *t);
 
 
 /* The number of elements for arrays. */
 
-unsigned ltt_type_element_number(ltt_type *t);
+unsigned ltt_type_element_number(LttType *t);
 
 
-/* The number of data members for structures. */
+/* The number of data members for structures and unions. */
 
-unsigned ltt_type_member_number(ltt_type *t);
+unsigned ltt_type_member_number(LttType *t);
 
 
 /* The type of a data member in a structure. */
 
-ltt_type *ltt_type_member_type(ltt_type *t, unsigned i);
+LttType *ltt_type_member_type(LttType *t, unsigned i, char ** name);
 
 
 /* For enumerations, obtain the symbolic string associated with a value
    (0 to n - 1 for an enumeration of n elements). */
 
-char *ltt_enum_string_get(ltt_type *t, unsigned i);
+char *ltt_enum_string_get(LttType *t, unsigned i);
 
 
 /* The fields form a tree representing a depth first search of the 
@@ -56,13 +88,15 @@ char *ltt_enum_string_get(ltt_type *t, unsigned i);
    sequences simply point to one nested field representing the currently
    selected element among all the (identically typed) elements. For structures,
    a nested field exists for each data member. Each field stores the
-   platform/tracefile specific offset values (for efficient access) and
-   points back to the corresponding ltt_type for the rest. */
+   platform/trace specific offset values (for efficient access) and
+   points back to the corresponding LttType for the rest. */
+
+LttField *ltt_field_element(LttField *f);
 
-ltt_field *ltt_field_element(ltt_field *f);
+LttField *ltt_field_member(LttField *f, unsigned i);
 
-ltt_field *ltt_field_member(ltt_field *f, unsigned i);
+LttType *ltt_field_type(LttField *f);
 
-ltt_type *ltt_field_type(ltt_field *f);
+int ltt_field_size(LttField * f);
 
 #endif // TYPE_H