tgid

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

/* 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, data types and fields belong to their trace and 
   are released at the same time. */

/* Obtain the name, description, facility, facility relative id, global id, 
   type and root field for an eventtype */

GQuark ltt_eventtype_name(LttEventType *et);

gchar *ltt_eventtype_description(LttEventType *et);

LttFacility *ltt_eventtype_facility(LttEventType *et);

unsigned ltt_eventtype_relative_id(LttEventType *et);

guint8 ltt_eventtype_id(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. */
 
GQuark ltt_type_name(LttType *t);

GQuark ltt_field_name(LttField *f);

LttTypeEnum ltt_type_class(LttType *t);

unsigned ltt_type_size(LttTrace *trace, LttType *t); 


/* The type of nested elements for arrays and sequences. */

LttType *ltt_type_element_type(LttType *t);


/* The number of elements for arrays. */

unsigned ltt_type_element_number(LttType *t);


/* The number of data members for structures and unions. */

guint ltt_type_member_number(LttType *t);


/* For enumerations, obtain the symbolic string associated with a value
   (0 to n - 1 for an enumeration of n elements). */

GQuark ltt_enum_string_get(LttType *t, gulong i);


/* The fields form a tree representing a depth first search of the 
   corresponding event type directed acyclic graph. Fields for arrays and
   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/trace specific offset values (for efficient access) and
   points back to the corresponding LttType for the rest. */

//LttField *ltt_field_element(LttField *f);

LttField *ltt_field_member_by_name(LttField *f, GQuark name);

LttField *ltt_field_member(LttField *f, guint i);

LttType *ltt_field_type(LttField *f);

int ltt_field_size(LttField * f);

guint ltt_eventtype_num_fields(LttEventType *event_type);

LttField *ltt_eventtype_field(LttEventType *event_type, guint i);

LttField *ltt_eventtype_field_by_name(LttEventType *event_type, GQuark name);

#endif // TYPE_H