Re: [PATCH v2 2/3] cli: refactor "notmuch tag" query tagging into a separate function
authorTomi Ollila <tomi.ollila@iki.fi>
Sun, 25 Mar 2012 21:26:50 +0000 (00:26 +0300)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 17:45:44 +0000 (09:45 -0800)
cd/bd3c7cdf5d5859ff41132b2f43d81a240cd470 [new file with mode: 0644]

diff --git a/cd/bd3c7cdf5d5859ff41132b2f43d81a240cd470 b/cd/bd3c7cdf5d5859ff41132b2f43d81a240cd470
new file mode 100644 (file)
index 0000000..51bf0c2
--- /dev/null
@@ -0,0 +1,274 @@
+Return-Path: <tomi.ollila@iki.fi>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id 68B6B431FAF\r
+       for <notmuch@notmuchmail.org>; Sun, 25 Mar 2012 14:26:53 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: 0\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none]\r
+       autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id uKOzCYjiU85q for <notmuch@notmuchmail.org>;\r
+       Sun, 25 Mar 2012 14:26:52 -0700 (PDT)\r
+Received: from guru.guru-group.fi (guru-group.fi [87.108.86.66])\r
+       by olra.theworths.org (Postfix) with ESMTP id 23A5B431FAE\r
+       for <notmuch@notmuchmail.org>; Sun, 25 Mar 2012 14:26:52 -0700 (PDT)\r
+Received: by guru.guru-group.fi (Postfix, from userid 501)\r
+       id 0D0F268055; Mon, 26 Mar 2012 00:26:50 +0300 (EEST)\r
+From: Tomi Ollila <tomi.ollila@iki.fi>\r
+To: Jani Nikula <jani@nikula.org>, notmuch@notmuchmail.org\r
+Subject: Re: [PATCH v2 2/3] cli: refactor "notmuch tag" query tagging into a\r
+       separate function\r
+In-Reply-To: <87limo2xpk.fsf@nikula.org>\r
+References: <cover.1332702915.git.jani@nikula.org>\r
+       <584067da00dd9f04a7f3982b76fd4b4918e4fe61.1332702915.git.jani@nikula.org>\r
+       <m262dse7f0.fsf@guru.guru-group.fi>\r
+       <87limo2xpk.fsf@nikula.org>User-Agent: Notmuch/0.12+71~gdacf76b\r
+       (http://notmuchmail.org) Emacs/23.3.1 (x86_64-unknown-linux-gnu)\r
+X-Face: HhBM'cA~<r"^Xv\KRN0P{vn'Y"Kd;zg_y3S[4)KSN~s?O\"QPoL\r
+       $[Xv_BD:i/F$WiEWax}R(MPS`^UaptOGD`*/=@\1lKoVa9tnrg0TW?"r7aRtgk[F\r
+       !)g;OY^,BjTbr)Np:%c_o'jj,Z\r
+Date: Mon, 26 Mar 2012 00:26:50 +0300\r
+Message-ID: <m2398we5id.fsf@guru.guru-group.fi>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=us-ascii\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sun, 25 Mar 2012 21:26:53 -0000\r
+\r
+Jani Nikula <jani@nikula.org> writes:\r
+\r
+> On Sun, 25 Mar 2012 23:45:39 +0300, Tomi Ollila <tomi.ollila@iki.fi> wrote:\r
+>> Jani Nikula <jani@nikula.org> writes:\r
+>> \r
+>> > Refactor to make tagging code easier to reuse in the future. No\r
+>> > functional changes.\r
+>> >\r
+>> > Signed-off-by: Jani Nikula <jani@nikula.org>\r
+>> > ---\r
+>> \r
+>> tag_query() is pretty generic name for a function which (also) does\r
+>> tagging operations (adds and removes tags based on tag_ops).\r
+>\r
+> Mmmh, if you think of "tag" as a verb, it fairly accurately describes\r
+> what the function does: tag (messages matching this) query (according\r
+> given arguments). I don't mind changing, but can't come up with anything\r
+> better right now either. notmuch_{search,query}_change_tags()? Meh?\r
+\r
+Hmmm, yes... -- tag...query... ok, I can live with that if no-one\r
+else get same impression I got first...\r
+\r
+>\r
+>> If, however, tag_opts != NULL (as is needs to be) but tag_opts[0] == NULL\r
+>> (now tag_query() would not do any tagging operations, but\r
+>> optimize_tag_query would mangle query string ( '*' to '()' and \r
+>> 'any_other' to '( any_other ) and ()' )\r
+>\r
+> I'm not sure I follow you. AFAICT the behaviour does not change from\r
+> what it was before, apart from the tag addition and removal being mixed\r
+> together.\r
+\r
+The thing is that notmuch_tag_command () check that there is at least\r
+one tagging operation to be done, but tag_query () doesn't do such\r
+checking...\r
+\r
+>> I.e. IMO the function name should be more spesific & the fact that this\r
+>> function needs tag changing data in tag_ops array should be documented.\r
+>\r
+> Documentation good. :)\r
+\r
+... therefore the requirement that there needs to tagging information\r
+in tag_ops is in place.\r
+\r
+>\r
+>> Minor thing in patch #1:\r
+>> \r
+>>  +      tag_ops[tag_ops_count].remove = argv[i][0] == '-';\r
+>> \r
+>> would be more clearer as:\r
+>> \r
+>>  +      tag_ops[tag_ops_count].remove = (argv[i][0] == '-');\r
+>\r
+> I usually don't add braces where they aren't needed, but can do here.\r
+\r
+Assigment is much lower in precedence than equality comparison -- but\r
+as this is so seldom-used construct, humans read (with understanding)\r
+the code faster with this added clarity.\r
+\r
+>> Everything else LGTM.\r
+>\r
+> Thanks for the review,\r
+> Jani.\r
+>\r
+>> \r
+>> Tomi\r
+\r
+Tomi\r
+\r
+>> \r
+>> \r
+>> >  notmuch-tag.c |  101 ++++++++++++++++++++++++++++++++-------------------------\r
+>> >  1 files changed, 57 insertions(+), 44 deletions(-)\r
+>> >\r
+>> > diff --git a/notmuch-tag.c b/notmuch-tag.c\r
+>> > index c39b235..edbfdec 100644\r
+>> > --- a/notmuch-tag.c\r
+>> > +++ b/notmuch-tag.c\r
+>> > @@ -106,6 +106,60 @@ _optimize_tag_query (void *ctx, const char *orig_query_string,\r
+>> >      return query_string;\r
+>> >  }\r
+>> >  \r
+>> > +static int\r
+>> > +tag_query (void *ctx, notmuch_database_t *notmuch, const char *query_string,\r
+>> > +    tag_operation_t *tag_ops, notmuch_bool_t synchronize_flags)\r
+>> > +{\r
+>> > +    notmuch_query_t *query;\r
+>> > +    notmuch_messages_t *messages;\r
+>> > +    notmuch_message_t *message;\r
+>> > +    int i;\r
+>> > +\r
+>> > +    /* Optimize the query so it excludes messages that already have\r
+>> > +     * the specified set of tags. */\r
+>> > +    query_string = _optimize_tag_query (ctx, query_string, tag_ops);\r
+>> > +    if (query_string == NULL) {\r
+>> > + fprintf (stderr, "Out of memory.\n");\r
+>> > + return 1;\r
+>> > +    }\r
+>> > +\r
+>> > +    query = notmuch_query_create (notmuch, query_string);\r
+>> > +    if (query == NULL) {\r
+>> > + fprintf (stderr, "Out of memory.\n");\r
+>> > + return 1;\r
+>> > +    }\r
+>> > +\r
+>> > +    /* tagging is not interested in any special sort order */\r
+>> > +    notmuch_query_set_sort (query, NOTMUCH_SORT_UNSORTED);\r
+>> > +\r
+>> > +    for (messages = notmuch_query_search_messages (query);\r
+>> > +  notmuch_messages_valid (messages) && !interrupted;\r
+>> > +  notmuch_messages_move_to_next (messages))\r
+>> > +    {\r
+>> > + message = notmuch_messages_get (messages);\r
+>> > +\r
+>> > + notmuch_message_freeze (message);\r
+>> > +\r
+>> > + for (i = 0; tag_ops[i].tag; i++) {\r
+>> > +     if (tag_ops[i].remove)\r
+>> > +         notmuch_message_remove_tag (message, tag_ops[i].tag);\r
+>> > +     else\r
+>> > +         notmuch_message_add_tag (message, tag_ops[i].tag);\r
+>> > + }\r
+>> > +\r
+>> > + notmuch_message_thaw (message);\r
+>> > +\r
+>> > + if (synchronize_flags)\r
+>> > +     notmuch_message_tags_to_maildir_flags (message);\r
+>> > +\r
+>> > + notmuch_message_destroy (message);\r
+>> > +    }\r
+>> > +\r
+>> > +    notmuch_query_destroy (query);\r
+>> > +\r
+>> > +    return interrupted;\r
+>> > +}\r
+>> > +\r
+>> >  int\r
+>> >  notmuch_tag_command (void *ctx, int argc, char *argv[])\r
+>> >  {\r
+>> > @@ -114,12 +168,10 @@ notmuch_tag_command (void *ctx, int argc, char *argv[])\r
+>> >      char *query_string;\r
+>> >      notmuch_config_t *config;\r
+>> >      notmuch_database_t *notmuch;\r
+>> > -    notmuch_query_t *query;\r
+>> > -    notmuch_messages_t *messages;\r
+>> > -    notmuch_message_t *message;\r
+>> >      struct sigaction action;\r
+>> >      notmuch_bool_t synchronize_flags;\r
+>> >      int i;\r
+>> > +    int ret;\r
+>> >  \r
+>> >      /* Setup our handler for SIGINT */\r
+>> >      memset (&action, 0, sizeof (struct sigaction));\r
+>> > @@ -166,14 +218,6 @@ notmuch_tag_command (void *ctx, int argc, char *argv[])\r
+>> >   return 1;\r
+>> >      }\r
+>> >  \r
+>> > -    /* Optimize the query so it excludes messages that already have\r
+>> > -     * the specified set of tags. */\r
+>> > -    query_string = _optimize_tag_query (ctx, query_string, tag_ops);\r
+>> > -    if (query_string == NULL) {\r
+>> > - fprintf (stderr, "Out of memory.\n");\r
+>> > - return 1;\r
+>> > -    }\r
+>> > -\r
+>> >      config = notmuch_config_open (ctx, NULL, NULL);\r
+>> >      if (config == NULL)\r
+>> >   return 1;\r
+>> > @@ -185,40 +229,9 @@ notmuch_tag_command (void *ctx, int argc, char *argv[])\r
+>> >  \r
+>> >      synchronize_flags = notmuch_config_get_maildir_synchronize_flags (config);\r
+>> >  \r
+>> > -    query = notmuch_query_create (notmuch, query_string);\r
+>> > -    if (query == NULL) {\r
+>> > - fprintf (stderr, "Out of memory.\n");\r
+>> > - return 1;\r
+>> > -    }\r
+>> > -\r
+>> > -    /* tagging is not interested in any special sort order */\r
+>> > -    notmuch_query_set_sort (query, NOTMUCH_SORT_UNSORTED);\r
+>> > +    ret = tag_query (ctx, notmuch, query_string, tag_ops, synchronize_flags);\r
+>> >  \r
+>> > -    for (messages = notmuch_query_search_messages (query);\r
+>> > -  notmuch_messages_valid (messages) && !interrupted;\r
+>> > -  notmuch_messages_move_to_next (messages))\r
+>> > -    {\r
+>> > - message = notmuch_messages_get (messages);\r
+>> > -\r
+>> > - notmuch_message_freeze (message);\r
+>> > -\r
+>> > - for (i = 0; tag_ops[i].tag; i++) {\r
+>> > -     if (tag_ops[i].remove)\r
+>> > -         notmuch_message_remove_tag (message, tag_ops[i].tag);\r
+>> > -     else\r
+>> > -         notmuch_message_add_tag (message, tag_ops[i].tag);\r
+>> > - }\r
+>> > -\r
+>> > - notmuch_message_thaw (message);\r
+>> > -\r
+>> > - if (synchronize_flags)\r
+>> > -     notmuch_message_tags_to_maildir_flags (message);\r
+>> > -\r
+>> > - notmuch_message_destroy (message);\r
+>> > -    }\r
+>> > -\r
+>> > -    notmuch_query_destroy (query);\r
+>> >      notmuch_database_close (notmuch);\r
+>> >  \r
+>> > -    return interrupted;\r
+>> > +    return ret;\r
+>> >  }\r
+>> > -- \r
+>> > 1.7.5.4\r
+>> >\r
+>> > _______________________________________________\r
+>> > notmuch mailing list\r
+>> > notmuch@notmuchmail.org\r
+>> > http://notmuchmail.org/mailman/listinfo/notmuch\r
+> _______________________________________________\r
+> notmuch mailing list\r
+> notmuch@notmuchmail.org\r
+> http://notmuchmail.org/mailman/listinfo/notmuch\r