cli: config: make notmuch_config_open() "is new" parameter input only

We now have a notmuch_config_is_new() function to query whether a
config was created or not. Change the notmuch_config_open() is_new
parameter into boolean create_new to determine whether the function
should create a new config if one doesn't exist. This reduces the
complexity of the API.

diff --git a/notmuch-client.h b/notmuch-client.h
index 07367e014ccacda58d9cf88ae69ac611d7dc8973..b3dcb21a5fa8eeb30b36aa2babaf3d40ad55378f 100644 (file)
--- a/notmuch-client.h
+++ b/notmuch-client.h
@@ -248,7 +248,7 @@ typedef struct _notmuch_config notmuch_config_t;
 notmuch_config_t *
 notmuch_config_open (void *ctx,
                     const char *filename,
 notmuch_config_t *
 notmuch_config_open (void *ctx,
                     const char *filename,

-                    notmuch_bool_t *is_new_ret);
+                    notmuch_bool_t create_new);

 
 void
 notmuch_config_close (notmuch_config_t *config);
 
 void
 notmuch_config_close (notmuch_config_t *config);

diff --git a/notmuch-config.c b/notmuch-config.c
index e733e92976ade780c9694d2dc088a84f5b464976..247fbe4ba1e394c0d4dc34b7142dd2c2f9da3f57 100644 (file)
--- a/notmuch-config.c
+++ b/notmuch-config.c
@@ -233,10 +233,9 @@ get_username_from_passwd_file (void *ctx)
 notmuch_config_t *
 notmuch_config_open (void *ctx,
                     const char *filename,
 notmuch_config_t *
 notmuch_config_open (void *ctx,
                     const char *filename,

-                    notmuch_bool_t *is_new_ret)
+                    notmuch_bool_t create_new)

 {
     GError *error = NULL;
 {
     GError *error = NULL;

-    int is_new = 0;

     size_t tmp;
     char *notmuch_config_env = NULL;
     int file_had_database_group;
     size_t tmp;
     char *notmuch_config_env = NULL;
     int file_had_database_group;


@@ -245,9 +244,6 @@ notmuch_config_open (void *ctx,
     int file_had_maildir_group;
     int file_had_search_group;
 
     int file_had_maildir_group;
     int file_had_search_group;
 

-    if (is_new_ret)
-       *is_new_ret = 0;
-

     notmuch_config_t *config = talloc (ctx, notmuch_config_t);
     if (config == NULL) {
        fprintf (stderr, "Out of memory.\n");
     notmuch_config_t *config = talloc (ctx, notmuch_config_t);
     if (config == NULL) {
        fprintf (stderr, "Out of memory.\n");


@@ -286,17 +282,16 @@ notmuch_config_open (void *ctx,
                                     G_KEY_FILE_KEEP_COMMENTS,
                                     &error))
     {
                                     G_KEY_FILE_KEEP_COMMENTS,
                                     &error))
     {

-       /* If the caller passed a non-NULL value for is_new_ret, then
-        * the caller is prepared for a default configuration file in
-        * the case of FILE NOT FOUND. Otherwise, any read failure is
-        * an error.
+       /* If create_new is true, then the caller is prepared for a
+        * default configuration file in the case of FILE NOT
+        * FOUND. Otherwise, any read failure is an error.

         */
         */

-       if (is_new_ret &&
+       if (create_new &&

            error->domain == G_FILE_ERROR &&
            error->code == G_FILE_ERROR_NOENT)
        {
            g_error_free (error);
            error->domain == G_FILE_ERROR &&
            error->code == G_FILE_ERROR_NOENT)
        {
            g_error_free (error);

-           is_new = 1;
+           config->is_new = TRUE;

        }
        else
        {
        }
        else
        {


@@ -379,7 +374,7 @@ notmuch_config_open (void *ctx,
     }
 
     if (notmuch_config_get_search_exclude_tags (config, &tmp) == NULL) {
     }
 
     if (notmuch_config_get_search_exclude_tags (config, &tmp) == NULL) {

-       if (is_new) {
+       if (config->is_new) {

            const char *tags[] = { "deleted", "spam" };
            notmuch_config_set_search_exclude_tags (config, tags, 2);
        } else {
            const char *tags[] = { "deleted", "spam" };
            notmuch_config_set_search_exclude_tags (config, tags, 2);
        } else {


@@ -399,7 +394,7 @@ notmuch_config_open (void *ctx,
     /* Whenever we know of configuration sections that don't appear in
      * the configuration file, we add some comments to help the user
      * understand what can be done. */
     /* Whenever we know of configuration sections that don't appear in
      * the configuration file, we add some comments to help the user
      * understand what can be done. */

-    if (is_new)
+    if (config->is_new)

     {
        g_key_file_set_comment (config->key_file, NULL, NULL,
                                toplevel_config_comment, NULL);
     {
        g_key_file_set_comment (config->key_file, NULL, NULL,
                                toplevel_config_comment, NULL);


@@ -434,11 +429,6 @@ notmuch_config_open (void *ctx,
                                search_config_comment, NULL);
     }
 
                                search_config_comment, NULL);
     }
 

-    if (is_new_ret)
-       *is_new_ret = is_new;
-
-    config->is_new = is_new;
-

     return config;
 }
 
     return config;
 }
 


@@ -719,7 +709,7 @@ notmuch_config_command_get (void *ctx, char *item)
 {
     notmuch_config_t *config;
 
 {
     notmuch_config_t *config;
 

-    config = notmuch_config_open (ctx, NULL, NULL);
+    config = notmuch_config_open (ctx, NULL, FALSE);

     if (config == NULL)
        return 1;
 
     if (config == NULL)
        return 1;
 


@@ -781,7 +771,7 @@ notmuch_config_command_set (void *ctx, char *item, int argc, char *argv[])
     if (_item_split (item, &group, &key))
        return 1;
 
     if (_item_split (item, &group, &key))
        return 1;
 

-    config = notmuch_config_open (ctx, NULL, NULL);
+    config = notmuch_config_open (ctx, NULL, FALSE);

     if (config == NULL)
        return 1;
 
     if (config == NULL)
        return 1;
 


@@ -818,7 +808,7 @@ notmuch_config_command_list (void *ctx)
     char **groups;
     size_t g, groups_length;
 
     char **groups;
     size_t g, groups_length;
 

-    config = notmuch_config_open (ctx, NULL, NULL);
+    config = notmuch_config_open (ctx, NULL, FALSE);

     if (config == NULL)
        return 1;
 
     if (config == NULL)
        return 1;
 

diff --git a/notmuch-count.c b/notmuch-count.c
index 2f9812821ebeb7cf2f18542541beaf9a8e37e4be..61722edbec2d571205470b1519447e548644eabe 100644 (file)
--- a/notmuch-count.c
+++ b/notmuch-count.c
@@ -62,7 +62,7 @@ notmuch_count_command (void *ctx, int argc, char *argv[])
        return 1;
     }
 
        return 1;
     }
 

-    config = notmuch_config_open (ctx, NULL, NULL);
+    config = notmuch_config_open (ctx, NULL, FALSE);

     if (config == NULL)
        return 1;
 
     if (config == NULL)
        return 1;
 

diff --git a/notmuch-dump.c b/notmuch-dump.c
index a3244e0a417e093945113154bf5d213a9eb87633..845a67e22247332cc834f159985b249773d437ea 100644 (file)
--- a/notmuch-dump.c
+++ b/notmuch-dump.c
@@ -34,7 +34,7 @@ notmuch_dump_command (unused (void *ctx), int argc, char *argv[])
     notmuch_tags_t *tags;
     const char *query_str = "";
 
     notmuch_tags_t *tags;
     const char *query_str = "";
 

-    config = notmuch_config_open (ctx, NULL, NULL);
+    config = notmuch_config_open (ctx, NULL, FALSE);

     if (config == NULL)
        return 1;
 
     if (config == NULL)
        return 1;
 

diff --git a/notmuch-new.c b/notmuch-new.c
index feb9c32fda52e6b9d6d5490320e86f5a107b03ac..491541801f5fc5bab63180474c09398a01bf7361 100644 (file)
--- a/notmuch-new.c
+++ b/notmuch-new.c
@@ -875,7 +875,7 @@ notmuch_new_command (void *ctx, int argc, char *argv[])
        return 1;
     }
 
        return 1;
     }
 

-    config = notmuch_config_open (ctx, NULL, NULL);
+    config = notmuch_config_open (ctx, NULL, FALSE);

     if (config == NULL)
        return 1;
 
     if (config == NULL)
        return 1;
 

diff --git a/notmuch-reply.c b/notmuch-reply.c
index 22c58ff36776f87ade88dcf8ead0b5d2a97076a9..9da42b933c10ccfb9ceba8750901a6749e8d5f47 100644 (file)
--- a/notmuch-reply.c
+++ b/notmuch-reply.c
@@ -762,7 +762,7 @@ notmuch_reply_command (void *ctx, int argc, char *argv[])
 
     notmuch_exit_if_unsupported_format ();
 
 
     notmuch_exit_if_unsupported_format ();
 

-    config = notmuch_config_open (ctx, NULL, NULL);
+    config = notmuch_config_open (ctx, NULL, FALSE);

     if (config == NULL)
        return 1;
 
     if (config == NULL)
        return 1;
 

diff --git a/notmuch-restore.c b/notmuch-restore.c
index cf26a423705fad8aee399e070416fbfb6c28425e..dd2507f310e757093e628a7ae3551c54d7818dce 100644 (file)
--- a/notmuch-restore.c
+++ b/notmuch-restore.c
@@ -139,7 +139,7 @@ notmuch_restore_command (unused (void *ctx), int argc, char *argv[])
     int opt_index;
     int input_format = DUMP_FORMAT_AUTO;
 
     int opt_index;
     int input_format = DUMP_FORMAT_AUTO;
 

-    config = notmuch_config_open (ctx, NULL, NULL);
+    config = notmuch_config_open (ctx, NULL, FALSE);

     if (config == NULL)
        return 1;
 
     if (config == NULL)
        return 1;
 

diff --git a/notmuch-search.c b/notmuch-search.c
index 0b0a879e7353e9b739180bf3a2cb2d16a9b9bd45..fac6663ff450e2ea509e664f024c59ca970c0991 100644 (file)
--- a/notmuch-search.c
+++ b/notmuch-search.c
@@ -371,7 +371,7 @@ notmuch_search_command (void *ctx, int argc, char *argv[])
 
     notmuch_exit_if_unsupported_format ();
 
 
     notmuch_exit_if_unsupported_format ();
 

-    config = notmuch_config_open (ctx, NULL, NULL);
+    config = notmuch_config_open (ctx, NULL, FALSE);

     if (config == NULL)
        return 1;
 
     if (config == NULL)
        return 1;
 

diff --git a/notmuch-setup.c b/notmuch-setup.c
index 94d0aa7bace6e96a8eb417ace7a71a8a8ed800d5..72d862aba691b66602ff3b99fc2fc99e962524a9 100644 (file)
--- a/notmuch-setup.c
+++ b/notmuch-setup.c
@@ -130,7 +130,6 @@ notmuch_setup_command (unused (void *ctx),
     size_t old_other_emails_len;
     GPtrArray *other_emails;
     unsigned int i;
     size_t old_other_emails_len;
     GPtrArray *other_emails;
     unsigned int i;

-    int is_new;

     const char **new_tags;
     size_t new_tags_len;
     const char **search_exclude_tags;
     const char **new_tags;
     size_t new_tags_len;
     const char **search_exclude_tags;


@@ -147,9 +146,9 @@ notmuch_setup_command (unused (void *ctx),
        chomp_newline (response);                               \
     } while (0)
 
        chomp_newline (response);                               \
     } while (0)
 

-    config = notmuch_config_open (ctx, NULL, &is_new);
+    config = notmuch_config_open (ctx, NULL, TRUE);

 
 

-    if (is_new)
+    if (notmuch_config_is_new (config))

        welcome_message_pre_setup ();
 
     prompt ("Your full name [%s]: ", notmuch_config_get_user_name (config));
        welcome_message_pre_setup ();
 
     prompt ("Your full name [%s]: ", notmuch_config_get_user_name (config));


@@ -229,7 +228,7 @@ notmuch_setup_command (unused (void *ctx),
 
 
     if (! notmuch_config_save (config)) {
 
 
     if (! notmuch_config_save (config)) {

-       if (is_new)
+       if (notmuch_config_is_new (config))

          welcome_message_post_setup ();
        return 0;
     } else {
          welcome_message_post_setup ();
        return 0;
     } else {

diff --git a/notmuch-show.c b/notmuch-show.c
index cbfc2d1cb6efb28a4202c5053fd6d22d0ad58b69..5ae5d7de1ab804d82ff09e8a6fef3cdbe46d58b8 100644 (file)
--- a/notmuch-show.c
+++ b/notmuch-show.c
@@ -1176,7 +1176,7 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
     else
        params.entire_thread = FALSE;
 
     else
        params.entire_thread = FALSE;
 

-    config = notmuch_config_open (ctx, NULL, NULL);
+    config = notmuch_config_open (ctx, NULL, FALSE);

     if (config == NULL)
        return 1;
 
     if (config == NULL)
        return 1;
 

diff --git a/notmuch-tag.c b/notmuch-tag.c
index d9daf8fbe44a39f50ba2464cb6a057cfe372afc1..148e856adbe6cda79d7c1487a7c6fd073bdb67af 100644 (file)
--- a/notmuch-tag.c
+++ b/notmuch-tag.c
@@ -236,7 +236,7 @@ notmuch_tag_command (void *ctx, int argc, char *argv[])
            return 1;
     }
 
            return 1;
     }
 

-    config = notmuch_config_open (ctx, NULL, NULL);
+    config = notmuch_config_open (ctx, NULL, FALSE);

     if (config == NULL)
        return 1;
 
     if (config == NULL)
        return 1;
 

diff --git a/notmuch.c b/notmuch.c
index ec2f20fa45713fd92c5564fa869a10f3e6b7c40f..e434d033136670eacf4911bc7c64fe5fd53e495d 100644 (file)
--- a/notmuch.c
+++ b/notmuch.c
@@ -202,16 +202,15 @@ static int
 notmuch_command (void *ctx, unused(int argc), unused(char *argv[]))
 {
     notmuch_config_t *config;
 notmuch_command (void *ctx, unused(int argc), unused(char *argv[]))
 {
     notmuch_config_t *config;

-    notmuch_bool_t is_new;

     char *db_path;
     struct stat st;
 
     char *db_path;
     struct stat st;
 

-    config = notmuch_config_open (ctx, NULL, &is_new);
+    config = notmuch_config_open (ctx, NULL, TRUE);

 
     /* If the user has never configured notmuch, then run
      * notmuch_setup_command which will give a nice welcome message,
      * and interactively guide the user through the configuration. */
 
     /* If the user has never configured notmuch, then run
      * notmuch_setup_command which will give a nice welcome message,
      * and interactively guide the user through the configuration. */

-    if (is_new) {
+    if (notmuch_config_is_new (config)) {

        notmuch_config_close (config);
        return notmuch_setup_command (ctx, 0, NULL);
     }
        notmuch_config_close (config);
        return notmuch_setup_command (ctx, 0, NULL);
     }

diff --git a/test/random-corpus.c b/test/random-corpus.c
index 8b7748ef28010535104225f33350b3927df32134..790193d2ee3eed2f5b7edbb4b4e7f3637f6f23d4 100644 (file)
--- a/test/random-corpus.c
+++ b/test/random-corpus.c
@@ -160,7 +160,7 @@ main (int argc, char **argv)
        exit (1);
     }
 
        exit (1);
     }
 

-    config = notmuch_config_open (ctx, config_path, NULL);
+    config = notmuch_config_open (ctx, config_path, FALSE);

     if (config == NULL)
        return 1;
 
     if (config == NULL)
        return 1;