From f47026114173a51802e8915b1f49888eb4367b46 Mon Sep 17 00:00:00 2001
From: Sven Weidauer <sven.weidauer@gmail.com>
Date: Mon, 28 Feb 2011 15:24:02 +0000
Subject: Added API to enumerate entries in history tree.

svn path=/trunk/netsurf/; revision=11854
---
 desktop/history_core.c | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++
 desktop/history_core.h | 47 ++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 100 insertions(+)

diff --git a/desktop/history_core.c b/desktop/history_core.c
index 0449a3d18..347fe423a 100644
--- a/desktop/history_core.c
+++ b/desktop/history_core.c
@@ -94,6 +94,8 @@ static bool history_redraw_entry(struct history *history,
 		int x, int y, bool clip);
 static struct history_entry *history_find_position(struct history_entry *entry,
 		int x, int y);
+static bool history_enumerate_entry(const struct history *history, 
+		const struct history_entry *entry, history_enumerate_cb cb, void *ud);
 
 
 /**
@@ -766,3 +768,54 @@ struct history_entry *history_find_position(struct history_entry *entry,
 
 	return 0;
 }
+
+/* Documented in history_core.h */
+void history_enumerate(const struct history *history, history_enumerate_cb cb, 
+	void *user_data)
+{
+	history_enumerate_entry(history, history->start, cb, user_data);
+}
+
+/**
+ * Enumerate subentries in history
+ * See also history_enumerate()
+ *
+ * \param	history		history to enumerate
+ * \param	entry		entry to start enumeration at
+ * \param	cb			callback function
+ * \param	ud			context pointer passed to cb
+ * \return	true to continue enumeration, false to cancel
+ */
+static bool history_enumerate_entry(const struct history *history, 
+	const struct history_entry *entry, history_enumerate_cb cb, void *ud)
+{
+	const struct history_entry *child;
+	
+	if (!cb(history, entry->x, entry->y, entry->x + WIDTH, entry->y + HEIGHT,
+			entry, ud)) return false;
+	
+	for (child = entry->forward; child; child = child->next) {
+		if (!history_enumerate_entry(history, child, cb, ud))
+			return false;
+	}
+	
+	return true;
+}
+
+/* Documented in history_core.h */
+const char *history_entry_get_url(const struct history_entry *entry)
+{
+	return entry->page.url;
+}
+
+/* Documented in history_core.h */
+const char *history_entry_get_fragment_id(const struct history_entry *entry)
+{
+	return entry->page.frag_id;
+}
+
+/* Documented in history_core.h */
+const char *history_entry_get_title(const struct history_entry *entry)
+{
+	return entry->page.title;
+}
\ No newline at end of file
diff --git a/desktop/history_core.h b/desktop/history_core.h
index 55b4e0bf1..4f4cf0c2a 100644
--- a/desktop/history_core.h
+++ b/desktop/history_core.h
@@ -28,6 +28,7 @@
 struct hlcache_handle;
 struct history;
 struct browser_window;
+struct history_entry;
 
 struct history *history_create(void);
 struct history *history_clone(struct history *history);
@@ -47,4 +48,50 @@ bool history_click(struct browser_window *bw, struct history *history,
 		int x, int y, bool new_window);
 const char *history_position_url(struct history *history, int x, int y);
 
+/**
+ * Callback function type for history enumeration
+ *
+ * \param	history			history being enumerated
+ * \param	x0, y0, x1, y1	Coordinates of entry in history tree view
+ * \param	entry			Current history entry
+ * \return	true to continue enumeration, false to cancel enumeration
+ */
+typedef bool (*history_enumerate_cb)(const struct history *history, int x0, int y0, 
+	 int x1, int y1, 
+	 const struct history_entry *entry, void *user_data);
+
+/**
+ * Enumerate all entries in the history.
+ * Do not change the history while it is being enumerated.
+ *
+ * \param	history		history to enumerate
+ * \param	cb			callback function
+ * \param	user_data	context pointer passed to cb
+ */
+void history_enumerate(const struct history *history, history_enumerate_cb cb, void *user_data);
+
+/**
+ * Returns the URL to a history entry
+ *
+ * \param	entry		the history entry to retrieve the URL from
+ * \return	the URL
+ */
+const char *history_entry_get_url(const struct history_entry *entry);
+
+/**
+ * Returns the URL to a history entry
+ *
+ * \param	entry		the history entry to retrieve the fragment id from
+ * \return	the fragment id
+ */
+const char *history_entry_get_fragment_id(const struct history_entry *entry);
+
+/**
+ * Returns the title of a history entry
+ *
+ * \param	entry		the history entry to retrieve the title from
+ * \return	the title
+ */
+const char *history_entry_get_title(const struct history_entry *entry);
+
 #endif
-- 
cgit v1.2.3