[PATCH v2] lib: Start all function names in notmuch-private.h with

Charles Celerier cceleri at cs.stanford.edu
Tue May 13 02:44:05 PDT 2014


As noted in devel/STYLE, every private library function should start
with _notmuch. This patch corrects function naming that did not adhere
to this style in lib/notmuch-private.h. In particular, the old function
names that now begin with _notmuch are

    notmuch_sha1_of_file
    notmuch_sha1_of_string
    notmuch_message_file_close
    notmuch_message_file_get_header
    notmuch_message_file_open
    notmuch_message_get_author
    notmuch_message_set_author

Signed-off-by: Charles Celerier <cceleri at cs.stanford.edu>
---
 lib/database.cc       | 24 ++++++++++++------------
 lib/message-file.c    |  8 ++++----
 lib/message.cc        |  8 ++++----
 lib/notmuch-private.h | 14 +++++++-------
 lib/sha1.c            |  4 ++--
 lib/thread.cc         |  4 ++--
 6 files changed, 31 insertions(+), 31 deletions(-)

diff --git a/lib/database.cc b/lib/database.cc
index 1efb14d..d9a01b7 100644
--- a/lib/database.cc
+++ b/lib/database.cc
@@ -356,7 +356,7 @@ _message_id_compressed (void *ctx, const char *message_id)
 {
     char *sha1, *compressed;
 
-    sha1 = notmuch_sha1_of_string (message_id);
+    sha1 = _notmuch_sha1_of_string (message_id);
 
     compressed = talloc_asprintf (ctx, "notmuch-sha1-%s", sha1);
     free (sha1);
@@ -1356,7 +1356,7 @@ _notmuch_database_get_directory_db_path (const char *path)
     int term_len = strlen (_find_prefix ("directory")) + strlen (path);
 
     if (term_len > NOTMUCH_TERM_MAX)
-	return notmuch_sha1_of_string (path);
+	return _notmuch_sha1_of_string (path);
     else
 	return path;
 }
@@ -1758,12 +1758,12 @@ _notmuch_database_link_message_to_parents (notmuch_database_t *notmuch,
 				     _my_talloc_free_for_g_hash, NULL);
     this_message_id = notmuch_message_get_message_id (message);
 
-    refs = notmuch_message_file_get_header (message_file, "references");
+    refs = _notmuch_message_file_get_header (message_file, "references");
     last_ref_message_id = parse_references (message,
 					    this_message_id,
 					    parents, refs);
 
-    in_reply_to = notmuch_message_file_get_header (message_file, "in-reply-to");
+    in_reply_to = _notmuch_message_file_get_header (message_file, "in-reply-to");
     in_reply_to_message_id = parse_references (message,
 					       this_message_id,
 					       parents, in_reply_to);
@@ -1961,7 +1961,7 @@ notmuch_database_add_message (notmuch_database_t *notmuch,
     if (ret)
 	return ret;
 
-    message_file = notmuch_message_file_open (filename);
+    message_file = _notmuch_message_file_open (filename);
     if (message_file == NULL)
 	return NOTMUCH_STATUS_FILE_ERROR;
 
@@ -1982,9 +1982,9 @@ notmuch_database_add_message (notmuch_database_t *notmuch,
 	 * let's make sure that what we're looking at looks like an
 	 * actual email message.
 	 */
-	from = notmuch_message_file_get_header (message_file, "from");
-	subject = notmuch_message_file_get_header (message_file, "subject");
-	to = notmuch_message_file_get_header (message_file, "to");
+	from = _notmuch_message_file_get_header (message_file, "from");
+	subject = _notmuch_message_file_get_header (message_file, "subject");
+	to = _notmuch_message_file_get_header (message_file, "to");
 
 	if ((from == NULL || *from == '\0') &&
 	    (subject == NULL || *subject == '\0') &&
@@ -1997,7 +1997,7 @@ notmuch_database_add_message (notmuch_database_t *notmuch,
 	/* Now that we're sure it's mail, the first order of business
 	 * is to find a message ID (or else create one ourselves). */
 
-	header = notmuch_message_file_get_header (message_file, "message-id");
+	header = _notmuch_message_file_get_header (message_file, "message-id");
 	if (header && *header != '\0') {
 	    message_id = _parse_message_id (message_file, header, NULL);
 
@@ -2018,7 +2018,7 @@ notmuch_database_add_message (notmuch_database_t *notmuch,
 	if (message_id == NULL ) {
 	    /* No message-id at all, let's generate one by taking a
 	     * hash over the file's contents. */
-	    char *sha1 = notmuch_sha1_of_file (filename);
+	    char *sha1 = _notmuch_sha1_of_file (filename);
 
 	    /* If that failed too, something is really wrong. Give up. */
 	    if (sha1 == NULL) {
@@ -2058,7 +2058,7 @@ notmuch_database_add_message (notmuch_database_t *notmuch,
 	    if (ret)
 		goto DONE;
 
-	    date = notmuch_message_file_get_header (message_file, "date");
+	    date = _notmuch_message_file_get_header (message_file, "date");
 	    _notmuch_message_set_header_values (message, date, from, subject);
 
 	    ret = _notmuch_message_index_file (message, message_file);
@@ -2087,7 +2087,7 @@ notmuch_database_add_message (notmuch_database_t *notmuch,
     }
 
     if (message_file)
-	notmuch_message_file_close (message_file);
+	_notmuch_message_file_close (message_file);
 
     ret2 = notmuch_database_end_atomic (notmuch);
     if ((ret == NOTMUCH_STATUS_SUCCESS ||
diff --git a/lib/message-file.c b/lib/message-file.c
index 6782882..f702eb5 100644
--- a/lib/message-file.c
+++ b/lib/message-file.c
@@ -99,19 +99,19 @@ _notmuch_message_file_open_ctx (void *ctx, const char *filename)
 
   FAIL:
     fprintf (stderr, "Error opening %s: %s\n", filename, strerror (errno));
-    notmuch_message_file_close (message);
+    _notmuch_message_file_close (message);
 
     return NULL;
 }
 
 notmuch_message_file_t *
-notmuch_message_file_open (const char *filename)
+_notmuch_message_file_open (const char *filename)
 {
     return _notmuch_message_file_open_ctx (NULL, filename);
 }
 
 void
-notmuch_message_file_close (notmuch_message_file_t *message)
+_notmuch_message_file_close (notmuch_message_file_t *message)
 {
     talloc_free (message);
 }
@@ -277,7 +277,7 @@ _notmuch_message_file_get_combined_header (notmuch_message_file_t *message,
 }
 
 const char *
-notmuch_message_file_get_header (notmuch_message_file_t *message,
+_notmuch_message_file_get_header (notmuch_message_file_t *message,
 				 const char *header)
 {
     const char *value;
diff --git a/lib/message.cc b/lib/message.cc
index 9243b76..eec8428 100644
--- a/lib/message.cc
+++ b/lib/message.cc
@@ -439,7 +439,7 @@ notmuch_message_get_header (notmuch_message_t *message, const char *header)
     if (message->message_file == NULL)
 	return NULL;
 
-    return notmuch_message_file_get_header (message->message_file, header);
+    return _notmuch_message_file_get_header (message->message_file, header);
 }
 
 /* Return the message ID from the In-Reply-To header of 'message'.
@@ -898,13 +898,13 @@ notmuch_message_get_tags (notmuch_message_t *message)
 }
 
 const char *
-notmuch_message_get_author (notmuch_message_t *message)
+_notmuch_message_get_author (notmuch_message_t *message)
 {
     return message->author;
 }
 
 void
-notmuch_message_set_author (notmuch_message_t *message,
+_notmuch_message_set_author (notmuch_message_t *message,
 			    const char *author)
 {
     if (message->author)
@@ -971,7 +971,7 @@ void
 _notmuch_message_close (notmuch_message_t *message)
 {
     if (message->message_file) {
-	notmuch_message_file_close (message->message_file);
+	_notmuch_message_file_close (message->message_file);
 	message->message_file = NULL;
     }
 }
diff --git a/lib/notmuch-private.h b/lib/notmuch-private.h
index 703ae7b..17f3061 100644
--- a/lib/notmuch-private.h
+++ b/lib/notmuch-private.h
@@ -316,11 +316,11 @@ _notmuch_message_clear_data (notmuch_message_t *message);
 /* Set the author member of 'message' - this is the representation used
  * when displaying the message */
 void
-notmuch_message_set_author (notmuch_message_t *message, const char *author);
+_notmuch_message_set_author (notmuch_message_t *message, const char *author);
 
 /* Get the author member of 'message' */
 const char *
-notmuch_message_get_author (notmuch_message_t *message);
+_notmuch_message_get_author (notmuch_message_t *message);
 
 /* message-file.c */
 
@@ -337,7 +337,7 @@ typedef struct _notmuch_message_file notmuch_message_file_t;
  * Returns NULL if any error occurs.
  */
 notmuch_message_file_t *
-notmuch_message_file_open (const char *filename);
+_notmuch_message_file_open (const char *filename);
 
 /* Like notmuch_message_file_open but with 'ctx' as the talloc owner. */
 notmuch_message_file_t *
@@ -345,7 +345,7 @@ _notmuch_message_file_open_ctx (void *ctx, const char *filename);
 
 /* Close a notmuch message previously opened with notmuch_message_open. */
 void
-notmuch_message_file_close (notmuch_message_file_t *message);
+_notmuch_message_file_close (notmuch_message_file_t *message);
 
 /* Parse the message.
  *
@@ -386,7 +386,7 @@ _notmuch_message_file_get_mime_message (notmuch_message_file_t *message,
  * contain a header line matching 'header'.
  */
 const char *
-notmuch_message_file_get_header (notmuch_message_file_t *message,
+_notmuch_message_file_get_header (notmuch_message_file_t *message,
 				 const char *header);
 
 /* index.cc */
@@ -455,10 +455,10 @@ _notmuch_message_add_reply (notmuch_message_t *message,
 /* sha1.c */
 
 char *
-notmuch_sha1_of_string (const char *str);
+_notmuch_sha1_of_string (const char *str);
 
 char *
-notmuch_sha1_of_file (const char *filename);
+_notmuch_sha1_of_file (const char *filename);
 
 /* string-list.c */
 
diff --git a/lib/sha1.c b/lib/sha1.c
index cc48108..94060d5 100644
--- a/lib/sha1.c
+++ b/lib/sha1.c
@@ -50,7 +50,7 @@ _hex_of_sha1_digest (const unsigned char digest[SHA1_DIGEST_SIZE])
  * should free() when finished.
  */
 char *
-notmuch_sha1_of_string (const char *str)
+_notmuch_sha1_of_string (const char *str)
 {
     sha1_ctx sha1;
     unsigned char digest[SHA1_DIGEST_SIZE];
@@ -74,7 +74,7 @@ notmuch_sha1_of_string (const char *str)
  * file not found, etc.), this function returns NULL.
  */
 char *
-notmuch_sha1_of_file (const char *filename)
+_notmuch_sha1_of_file (const char *filename)
 {
     FILE *file;
 #define BLOCK_SIZE 4096
diff --git a/lib/thread.cc b/lib/thread.cc
index 8f53e12..8922403 100644
--- a/lib/thread.cc
+++ b/lib/thread.cc
@@ -284,7 +284,7 @@ _thread_add_message (notmuch_thread_t *thread,
 	    }
 	    clean_author = _thread_cleanup_author (thread, author, from);
 	    _thread_add_author (thread, clean_author);
-	    notmuch_message_set_author (message, clean_author);
+	    _notmuch_message_set_author (message, clean_author);
 	}
 	g_object_unref (G_OBJECT (list));
     }
@@ -373,7 +373,7 @@ _thread_add_matched_message (notmuch_thread_t *thread,
 				  NOTMUCH_MESSAGE_FLAG_MATCH, 1);
     }
 
-    _thread_add_matched_author (thread, notmuch_message_get_author (hashed_message));
+    _thread_add_matched_author (thread, _notmuch_message_get_author (hashed_message));
 }
 
 static void
-- 
1.8.5.2 (Apple Git-48)



More information about the notmuch mailing list