Add copyright notices and some comments about status and TODO

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

diff --git a/ltt/branches/poly/include/ltt/event.h b/ltt/branches/poly/include/ltt/event.h
index 96c71ce7b49865cbd1d1599eb4c7cddce1fc2f94..4cee97133a0106767817540f0b8791657c6c83e5 100644 (file)
--- a/ltt/branches/poly/include/ltt/event.h
+++ b/ltt/branches/poly/include/ltt/event.h
@@ -1,3 +1,21 @@
+/* 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 EVENT_H
 #define EVENT_H
 
@@ -34,6 +52,24 @@ LttTime ltt_event_time(LttEvent *e);
 LttCycleCount ltt_event_cycle_count(LttEvent *e);
 
 
+/* Obtain the position of the event within the tracefile. This
+   is used to seek back to this position later or to seek to another
+   position, computed relative to this position. The event position
+   structure is opaque and contains several fields, only two
+   of which are user accessible: block number and event index
+   within the block. */
+
+void ltt_event_position(LttEvent *e, LttEventPosition *ep);
+
+LttEventPosition * ltt_event_position_new();
+
+void ltt_event_position_get(LttEventPosition *ep,
+    unsigned *block_number, unsigned *index_in_block, LttTracefile ** tf);
+
+void ltt_event_position_set(LttEventPosition *ep,
+    unsigned block_number, unsigned index_in_block);
+
+
 /* CPU id of the event */
 
 unsigned ltt_event_cpu_id(LttEvent *e);