Add copyright notices and some comments about status and TODO

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

diff --git a/ltt/branches/poly/include/ltt/facility.h b/ltt/branches/poly/include/ltt/facility.h
index eda320f96efafa2a50daa57f771273a2d6b56a9a..8fda81e9b6f0470daf94c287dfec592f577fad8b 100644 (file)
--- a/ltt/branches/poly/include/ltt/facility.h
+++ b/ltt/branches/poly/include/ltt/facility.h
@@ -1,29 +1,49 @@
+/* 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 FACILITY_H
+#define FACILITY_H
 
 #include <ltt/ltt.h>
 
-/* A facility is obtained from a .event file containing event type
-   declarations. The facility content must have the specified checksum.
-   The structures associated with a facility may be released with
-   a call to ltt_close_facility if its usage count is 0. */
+/* Facilities are obtained from an opened trace. The structures associated 
+   with a facility are released when the trace is closed. Each facility
+   is characterized by its name and checksum. */
 
-ltt_facility *ltt_facility_open(char *pathname, ltt_checksum c);
+char *ltt_facility_name(LttFacility *f);
 
-int ltt_facility_close(ltt_facility *f);
+LttChecksum ltt_facility_checksum(LttFacility *f);
 
+/* open facility */
+void ltt_facility_open(LttTrace * t, char * facility_name);
 
-/* Obtain the name and checksum of the facility */
-
-char *ltt_facility_name(ltt_facility *f);
-
-ltt_checksum ltt_facility_checksum(ltt_facility *f);
+/* Discover the event types within the facility. The event type integer id
+   relative to the trace is from 0 to nb_event_types - 1. The event
+   type id within the trace is the relative id + the facility base event
+   id. */
 
+unsigned ltt_facility_base_id(LttFacility *f);
 
-/* Discover the event types within the facility. The event type integer id
-   used here is specific to the trace (from 0 to nb_event_types - 1). */
+unsigned ltt_facility_eventtype_number(LttFacility *f);
 
-unsigned ltt_facility_eventtype_number(ltt_facility *f);
+LttEventType *ltt_facility_eventtype_get(LttFacility *f, unsigned i);
 
-ltt_eventtype *ltt_facility_eventtype_get(ltt_facility *f, unsigned i);
+LttEventType *ltt_facility_eventtype_get_by_name(LttFacility *f, char *name);
 
-ltt_eventtype *ltt_facility_eventtype_get_by_name(ltt_facility *f, char *name);
+#endif // FACILITY_H