summaryrefslogtreecommitdiffstats
path: root/sediff/policy_view.h
diff options
context:
space:
mode:
Diffstat (limited to 'sediff/policy_view.h')
-rw-r--r--sediff/policy_view.h84
1 files changed, 84 insertions, 0 deletions
diff --git a/sediff/policy_view.h b/sediff/policy_view.h
new file mode 100644
index 0000000..ee2c400
--- /dev/null
+++ b/sediff/policy_view.h
@@ -0,0 +1,84 @@
+/**
+ * @file
+ * Header for routines related to showing the parts of a policy --
+ * its statistics and its source, if available.
+ *
+ * @author Jeremy A. Mowery jmowery@tresys.com
+ * @author Jason Tang jtang@tresys.com
+ * @author Randy Wicks rwicks@tresys.com
+ *
+ * Copyright (C) 2004-2007 Tresys Technology, LLC
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+#ifndef POLICY_VIEW_H
+#define POLICY_VIEW_H
+
+#include "sediffx.h"
+#include "toplevel.h"
+
+typedef struct policy_view policy_view_t;
+
+/**
+ * Allocate and return an instance of a policy view object. This
+ * object is responsible for showing the statistics and policy source
+ * (if available) for a particular policy.
+ *
+ * @param top Toplevel object containing view's widgets.
+ * @param which Which policy to show.
+ *
+ * @return An initialized policy_view object, or NULL upon error. The
+ * caller must call policy_view_destroy() afterwards.
+ */
+policy_view_t *policy_view_create(toplevel_t * top, sediffx_policy_e which);
+
+/**
+ * Deallocate all space associated with the referenced view. This
+ * does nothing if the pointer is already NULL.
+ *
+ * @param view Reference to a policy_view to destroy. Afterwards the
+ * pointer will be set to NULL.
+ */
+void policy_view_destroy(policy_view_t ** view);
+
+/**
+ * Direct the given policy view to update its display, to reflect the
+ * policy currently loaded. Note that this should be called prior to
+ * building the poldiff_t object, for poldiff_create() will take
+ * ownership of the policy.
+ *
+ * @parav view View to update.
+ */
+void policy_view_update(policy_view_t * view, apol_policy_t * policy, apol_policy_path_t * path);
+
+/**
+ * Direct the given policy view to show its source policy tab and then
+ * scroll to the given line number. Line numbers are zero indexed.
+ *
+ * @param view View whose source tab to show.
+ * @param line Line to show.
+ */
+void policy_view_show_policy_line(policy_view_t * view, unsigned long line);
+
+/**
+ * Get the currently showing text view for the policy view.
+ *
+ * @param view View containing text view.
+ *
+ * @return Currently visible text view.
+ */
+GtkTextView *policy_view_get_text_view(policy_view_t * view);
+
+#endif