From 9dd86859e8582eefc958a14ba4787c2488730edc Mon Sep 17 00:00:00 2001
From: Aris Adamantiadis <aris@0xbadc0de.be>
Date: Mon, 1 Mar 2010 18:11:40 +0100
Subject: [PATCH] renamed ssh_list_get_head to ssh_list_pop_head

---
 include/libssh/misc.h | 12 ++++--------
 libssh/misc.c         |  9 ++++++++-
 libssh/server.c       |  4 ++--
 libssh/session.c      |  2 +-
 4 files changed, 15 insertions(+), 12 deletions(-)

diff --git a/include/libssh/misc.h b/include/libssh/misc.h
index 21104c78..3c33d0e1 100644
--- a/include/libssh/misc.h
+++ b/include/libssh/misc.h
@@ -49,11 +49,7 @@ struct ssh_iterator *ssh_list_get_iterator(const struct ssh_list *list);
 int ssh_list_add(struct ssh_list *list, const void *data);
 void ssh_list_remove(struct ssh_list *list, struct ssh_iterator *iterator);
 
-/** @brief fetch the head element of a list and remove it from list
- * @param list the ssh_list to use
- * @return the first element of the list
- */
-const void *_ssh_list_get_head(struct ssh_list *list);
+const void *_ssh_list_pop_head(struct ssh_list *list);
 
 #define ssh_iterator_value(type, iterator)\
   ((type)((iterator)->data))
@@ -61,9 +57,9 @@ const void *_ssh_list_get_head(struct ssh_list *list);
 /** @brief fetch the head element of a list and remove it from list
  * @param type type of the element to return
  * @param list the ssh_list to use
- * @return the first element of the list
+ * @return the first element of the list, or NULL if the list is empty
  */
-#define ssh_list_get_head(type, ssh_list)\
-  ((type)_ssh_list_get_head(ssh_list))
+#define ssh_list_pop_head(type, ssh_list)\
+  ((type)_ssh_list_pop_head(ssh_list))
 
 #endif /* MISC_H_ */
diff --git a/libssh/misc.c b/libssh/misc.c
index f64c395a..a86a163b 100644
--- a/libssh/misc.c
+++ b/libssh/misc.c
@@ -261,7 +261,14 @@ void ssh_list_remove(struct ssh_list *list, struct ssh_iterator *iterator){
   SAFE_FREE(iterator);
 }
 
-const void *_ssh_list_get_head(struct ssh_list *list){
+/** @internal
+ * @brief Removes the top element of the list and returns the data value attached
+ * to it
+ * @param list the ssh_list
+ * @returns pointer to the element being stored in head, or
+ * NULL if the list is empty.
+ */
+const void *_ssh_list_pop_head(struct ssh_list *list){
   struct ssh_iterator *iterator=list->root;
   const void *data;
   if(!list->root)
diff --git a/libssh/server.c b/libssh/server.c
index 79244edb..f5258c69 100644
--- a/libssh/server.c
+++ b/libssh/server.c
@@ -871,7 +871,7 @@ int ssh_execute_message_callbacks(ssh_session session){
   if(!session->ssh_message_list)
     return SSH_OK;
   if(session->ssh_message_callback){
-    while((msg=ssh_list_get_head(ssh_message , session->ssh_message_list)) != NULL){
+    while((msg=ssh_list_pop_head(ssh_message , session->ssh_message_list)) != NULL){
       ret=session->ssh_message_callback(session,msg);
       if(ret==1){
         ret = ssh_message_reply_default(msg);
@@ -880,7 +880,7 @@ int ssh_execute_message_callbacks(ssh_session session){
       }
     }
   } else {
-    while((msg=ssh_list_get_head(ssh_message , session->ssh_message_list)) != NULL){
+    while((msg=ssh_list_pop_head(ssh_message , session->ssh_message_list)) != NULL){
       ret = ssh_message_reply_default(msg);
       if(ret != SSH_OK)
         return ret;
diff --git a/libssh/session.c b/libssh/session.c
index b2c0368e..f1c36b80 100644
--- a/libssh/session.c
+++ b/libssh/session.c
@@ -155,7 +155,7 @@ void ssh_free(ssh_session session) {
   privatekey_free(session->rsa_key);
   if(session->ssh_message_list){
     ssh_message msg;
-    while((msg=ssh_list_get_head(ssh_message ,session->ssh_message_list))
+    while((msg=ssh_list_pop_head(ssh_message ,session->ssh_message_list))
         != NULL){
       ssh_message_free(msg);
     }