Return-Path: X-Original-To: notmuch@notmuchmail.org Delivered-To: notmuch@notmuchmail.org Received: from localhost (localhost [127.0.0.1]) by olra.theworths.org (Postfix) with ESMTP id DE2CC431FBC for ; Fri, 20 Jul 2012 02:14:08 -0700 (PDT) X-Virus-Scanned: Debian amavisd-new at olra.theworths.org X-Spam-Flag: NO X-Spam-Score: 0 X-Spam-Level: X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none] autolearn=disabled Received: from olra.theworths.org ([127.0.0.1]) by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 5kNdJfN71GQs for ; Fri, 20 Jul 2012 02:14:07 -0700 (PDT) Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34]) by olra.theworths.org (Postfix) with ESMTP id 63AA0431FAE for ; Fri, 20 Jul 2012 02:14:07 -0700 (PDT) Received: by guru.guru-group.fi (Postfix, from userid 501) id 48B7010014D; Fri, 20 Jul 2012 12:14:18 +0300 (EEST) From: Tomi Ollila To: craven@gmx.net, notmuch@notmuchmail.org Subject: Re: [PATCH v7 3/3] Use the structured formatters in notmuch-search.c. In-Reply-To: <1342766173-1344-4-git-send-email-craven@gmx.net> References: <20120718194819.GP31670@mit.edu> <1342766173-1344-1-git-send-email-craven@gmx.net> <1342766173-1344-4-git-send-email-craven@gmx.net> User-Agent: Notmuch/0.13.2+93~ge4fdd97 (http://notmuchmail.org) Emacs/23.1.1 (x86_64-redhat-linux-gnu) X-Face: HhBM'cA~ MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-BeenThere: notmuch@notmuchmail.org X-Mailman-Version: 2.1.13 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 20 Jul 2012 09:14:09 -0000 On Fri, Jul 20 2012, craven@gmx.net wrote: > From: > > This patch switches from the current ad-hoc printer to the structured > formatters in sprinter.h, sprinter-text.c and sprinter-json.c. > > The JSON tests are changed slightly in order to make them PASS for the > new structured output formatter. > > The text tests pass without adaptation. > --- > notmuch-search.c | 301 ++++++++++++++++---------------------------------= ------ > test/json | 34 ++++--- > 2 files changed, 103 insertions(+), 232 deletions(-) > > diff --git a/notmuch-search.c b/notmuch-search.c > index 3be296d..07211e8 100644 > --- a/notmuch-search.c > +++ b/notmuch-search.c > @@ -19,6 +19,7 @@ > */ >=20=20 > #include "notmuch-client.h" > +#include "sprinter.h" >=20=20 > typedef enum { > OUTPUT_SUMMARY, > @@ -28,92 +29,6 @@ typedef enum { > OUTPUT_TAGS > } output_t; >=20=20 > -typedef struct search_format { > - const char *results_start; > - const char *item_start; > - void (*item_id) (const void *ctx, > - const char *item_type, > - const char *item_id); > - void (*thread_summary) (const void *ctx, > - const char *thread_id, > - const time_t date, > - const int matched, > - const int total, > - const char *authors, > - const char *subject); > - const char *tag_start; > - const char *tag; > - const char *tag_sep; > - const char *tag_end; > - const char *item_sep; > - const char *item_end; > - const char *results_end; > - const char *results_null; > -} search_format_t; > - > -static void > -format_item_id_text (const void *ctx, > - const char *item_type, > - const char *item_id); > - > -static void > -format_thread_text (const void *ctx, > - const char *thread_id, > - const time_t date, > - const int matched, > - const int total, > - const char *authors, > - const char *subject); > -static const search_format_t format_text =3D { > - "", > - "", > - format_item_id_text, > - format_thread_text, > - " (", > - "%s", " ", > - ")", "\n", > - "", > - "\n", > - "", > -}; > - > -static void > -format_item_id_json (const void *ctx, > - const char *item_type, > - const char *item_id); > - > -static void > -format_thread_json (const void *ctx, > - const char *thread_id, > - const time_t date, > - const int matched, > - const int total, > - const char *authors, > - const char *subject); > - > -/* Any changes to the JSON format should be reflected in the file > - * devel/schemata. */ > -static const search_format_t format_json =3D { > - "[", > - "{", > - format_item_id_json, > - format_thread_json, > - "\"tags\": [", > - "\"%s\"", ", ", > - "]", ",\n", > - "}", > - "]\n", > - "]\n", > -}; > - > -static void > -format_item_id_text (unused (const void *ctx), > - const char *item_type, > - const char *item_id) > -{ > - printf ("%s%s", item_type, item_id); > -} > - > static char * > sanitize_string (const void *ctx, const char *str) > { > @@ -131,72 +46,8 @@ sanitize_string (const void *ctx, const char *str) > return out; > } >=20=20 > -static void > -format_thread_text (const void *ctx, > - const char *thread_id, > - const time_t date, > - const int matched, > - const int total, > - const char *authors, > - const char *subject) > -{ > - void *ctx_quote =3D talloc_new (ctx); > - > - printf ("thread:%s %12s [%d/%d] %s; %s", > - thread_id, > - notmuch_time_relative_date (ctx, date), > - matched, > - total, > - sanitize_string (ctx_quote, authors), > - sanitize_string (ctx_quote, subject)); > - > - talloc_free (ctx_quote); > -} > - > -static void > -format_item_id_json (const void *ctx, > - unused (const char *item_type), > - const char *item_id) > -{ > - void *ctx_quote =3D talloc_new (ctx); > - > - printf ("%s", json_quote_str (ctx_quote, item_id)); > - > - talloc_free (ctx_quote); > -=20=20=20=20 > -} > - > -static void > -format_thread_json (const void *ctx, > - const char *thread_id, > - const time_t date, > - const int matched, > - const int total, > - const char *authors, > - const char *subject) > -{ > - void *ctx_quote =3D talloc_new (ctx); > - > - printf ("\"thread\": %s,\n" > - "\"timestamp\": %ld,\n" > - "\"date_relative\": \"%s\",\n" > - "\"matched\": %d,\n" > - "\"total\": %d,\n" > - "\"authors\": %s,\n" > - "\"subject\": %s,\n", > - json_quote_str (ctx_quote, thread_id), > - date, > - notmuch_time_relative_date (ctx, date), > - matched, > - total, > - json_quote_str (ctx_quote, authors), > - json_quote_str (ctx_quote, subject)); > - > - talloc_free (ctx_quote); > -} > - > static int > -do_search_threads (const search_format_t *format, > +do_search_threads (sprinter_t *format, > notmuch_query_t *query, > notmuch_sort_t sort, > output_t output, > @@ -207,7 +58,6 @@ do_search_threads (const search_format_t *format, > notmuch_threads_t *threads; > notmuch_tags_t *tags; > time_t date; > - int first_thread =3D 1; > int i; >=20=20 > if (offset < 0) { > @@ -220,14 +70,12 @@ do_search_threads (const search_format_t *format, > if (threads =3D=3D NULL) > return 1; >=20=20 > - fputs (format->results_start, stdout); > + format->begin_list (format); >=20=20 > for (i =3D 0; > notmuch_threads_valid (threads) && (limit < 0 || i < offset + limit); > notmuch_threads_move_to_next (threads), i++) > { > - int first_tag =3D 1; > - > thread =3D notmuch_threads_get (threads); >=20=20 > if (i < offset) { > @@ -235,60 +83,97 @@ do_search_threads (const search_format_t *format, > continue; > } >=20=20 > - if (! first_thread) > - fputs (format->item_sep, stdout); > - > if (output =3D=3D OUTPUT_THREADS) { > - format->item_id (thread, "thread:", > - notmuch_thread_get_thread_id (thread)); > + format->set_prefix (format, "thread"); > + format->string (format, > + notmuch_thread_get_thread_id (thread)); > + format->separator (format); > } else { /* output =3D=3D OUTPUT_SUMMARY */ > - fputs (format->item_start, stdout); > + void *ctx_quote =3D talloc_new (thread); > + const char *authors =3D notmuch_thread_get_authors (thread); > + const char *subject =3D notmuch_thread_get_subject (thread); > + const char *thread_id =3D notmuch_thread_get_thread_id (thread); > + int matched =3D notmuch_thread_get_matched_messages (thread); > + int total =3D notmuch_thread_get_total_messages (thread); > + const char *relative_date =3D NULL; > + notmuch_bool_t first_tag =3D TRUE; > + > + format->begin_map (format); >=20=20 > if (sort =3D=3D NOTMUCH_SORT_OLDEST_FIRST) > date =3D notmuch_thread_get_oldest_date (thread); > else > date =3D notmuch_thread_get_newest_date (thread); >=20=20 > - format->thread_summary (thread, > - notmuch_thread_get_thread_id (thread), > - date, > - notmuch_thread_get_matched_messages (thread), > - notmuch_thread_get_total_messages (thread), > - notmuch_thread_get_authors (thread), > - notmuch_thread_get_subject (thread)); > + relative_date =3D notmuch_time_relative_date (ctx_quote, date); > + > + if (format->is_text_printer) { > + /* Special case for the text formatter */ > + printf ("thread:%s %12s [%d/%d] %s; %s (", > + thread_id, > + relative_date, > + matched, > + total, > + sanitize_string (ctx_quote, authors), > + sanitize_string (ctx_quote, subject)); > + } else { /* Structured Output */ > + format->map_key (format, "thread"); > + format->string (format, thread_id); > + format->map_key (format, "timestamp"); > + format->integer (format, date); > + format->map_key (format, "date_relative"); > + format->string (format, relative_date); > + format->map_key (format, "matched"); > + format->integer (format, matched); > + format->map_key (format, "total"); > + format->integer (format, total); > + format->map_key (format, "authors"); > + format->string (format, authors); > + format->map_key (format, "subject"); > + format->string (format, subject); > + } > + > + talloc_free (ctx_quote); >=20=20 > - fputs (format->tag_start, stdout); > + format->map_key (format, "tags"); > + format->begin_list (format); >=20=20 > for (tags =3D notmuch_thread_get_tags (thread); > notmuch_tags_valid (tags); > notmuch_tags_move_to_next (tags)) > { > - if (! first_tag) > - fputs (format->tag_sep, stdout); > - printf (format->tag, notmuch_tags_get (tags)); > - first_tag =3D 0; > + const char *tag =3D notmuch_tags_get (tags); > + > + if (format->is_text_printer) { > + /* Special case for the text formatter */ > + if (first_tag) > + first_tag =3D FALSE; > + else > + fputc (' ', stdout); > + fputs (tag, stdout); > + } else { /* Structured Output */ > + format->string (format, tag); > + } > } >=20=20 > - fputs (format->tag_end, stdout); > + if (format->is_text_printer) > + printf (")"); >=20=20 > - fputs (format->item_end, stdout); > + format->end (format); > + format->end (format); > + format->separator (format); > } >=20=20 > - first_thread =3D 0; > - > notmuch_thread_destroy (thread); > } >=20=20 > - if (first_thread) > - fputs (format->results_null, stdout); > - else > - fputs (format->results_end, stdout); > + format->end (format); >=20=20 > return 0; > } >=20=20 > static int > -do_search_messages (const search_format_t *format, > +do_search_messages (sprinter_t *format, > notmuch_query_t *query, > output_t output, > int offset, > @@ -297,7 +182,6 @@ do_search_messages (const search_format_t *format, > notmuch_message_t *message; > notmuch_messages_t *messages; > notmuch_filenames_t *filenames; > - int first_message =3D 1; > int i; >=20=20 > if (offset < 0) { > @@ -310,7 +194,7 @@ do_search_messages (const search_format_t *format, > if (messages =3D=3D NULL) > return 1; >=20=20 > - fputs (format->results_start, stdout); > + format->begin_list (format); >=20=20 > for (i =3D 0; > notmuch_messages_valid (messages) && (limit < 0 || i < offset + limit); > @@ -328,24 +212,17 @@ do_search_messages (const search_format_t *format, > notmuch_filenames_valid (filenames); > notmuch_filenames_move_to_next (filenames)) > { > - if (! first_message) > - fputs (format->item_sep, stdout); > - > - format->item_id (message, "", > - notmuch_filenames_get (filenames)); > - > - first_message =3D 0; > + format->string (format, notmuch_filenames_get (filenames)); > + format->separator (format); > } >=20=20=09=20=20=20=20 > notmuch_filenames_destroy( filenames ); >=20=20 > } else { /* output =3D=3D OUTPUT_MESSAGES */ > - if (! first_message) > - fputs (format->item_sep, stdout); > - > - format->item_id (message, "id:", > - notmuch_message_get_message_id (message)); > - first_message =3D 0; > + format->set_prefix (format, "id"); > + format->string (format, > + notmuch_message_get_message_id (message)); > + format->separator (format); > } >=20=20 > notmuch_message_destroy (message); > @@ -353,23 +230,19 @@ do_search_messages (const search_format_t *format, >=20=20 > notmuch_messages_destroy (messages); >=20=20 > - if (first_message) > - fputs (format->results_null, stdout); > - else > - fputs (format->results_end, stdout); > + format->end (format); >=20=20 > return 0; > } >=20=20 > static int > do_search_tags (notmuch_database_t *notmuch, > - const search_format_t *format, > + sprinter_t *format, > notmuch_query_t *query) > { > notmuch_messages_t *messages =3D NULL; > notmuch_tags_t *tags; > const char *tag; > - int first_tag =3D 1; >=20=20 > /* should the following only special case if no excluded terms > * specified? */ > @@ -387,7 +260,7 @@ do_search_tags (notmuch_database_t *notmuch, > if (tags =3D=3D NULL) > return 1; >=20=20 > - fputs (format->results_start, stdout); > + format->begin_list (format); >=20=20 > for (; > notmuch_tags_valid (tags); > @@ -395,12 +268,9 @@ do_search_tags (notmuch_database_t *notmuch, > { > tag =3D notmuch_tags_get (tags); >=20=20 > - if (! first_tag) > - fputs (format->item_sep, stdout); > + format->string (format, tag); > + format->separator (format); >=20=20 > - format->item_id (tags, "", tag); > - > - first_tag =3D 0; > } >=20=20 > notmuch_tags_destroy (tags); > @@ -408,10 +278,7 @@ do_search_tags (notmuch_database_t *notmuch, > if (messages) > notmuch_messages_destroy (messages); >=20=20 > - if (first_tag) > - fputs (format->results_null, stdout); > - else > - fputs (format->results_end, stdout); > + format->end (format); >=20=20 > return 0; > } > @@ -430,7 +297,7 @@ notmuch_search_command (void *ctx, int argc, char *ar= gv[]) > notmuch_query_t *query; > char *query_str; > notmuch_sort_t sort =3D NOTMUCH_SORT_NEWEST_FIRST; > - const search_format_t *format =3D &format_text; > + sprinter_t *format =3D NULL; due to this change -- dropping "fallback" setting due to ... > int opt_index, ret; > output_t output =3D OUTPUT_SUMMARY; > int offset =3D 0; > @@ -475,10 +342,10 @@ notmuch_search_command (void *ctx, int argc, char *= argv[]) >=20=20 > switch (format_sel) { > case NOTMUCH_FORMAT_TEXT: > - format =3D &format_text; > + format =3D sprinter_text_create (ctx, stdout); > break; > case NOTMUCH_FORMAT_JSON: > - format =3D &format_json; > + format =3D sprinter_json_create (ctx, stdout); > break; > } ... the dynamically created structure above, should we have 'default:' case which executes INTERNAL_ERROR() (or something) instead of allowing NULL derefencing (and crash) if one ever encounters such a situation ? Tomi > @@ -546,5 +413,7 @@ notmuch_search_command (void *ctx, int argc, char *ar= gv[]) > notmuch_query_destroy (query); > notmuch_database_destroy (notmuch); >=20=20 > + talloc_free (format); > + > return ret; > } > diff --git a/test/json b/test/json > index 6439788..337b3f5 100755 > --- a/test/json > +++ b/test/json > @@ -9,15 +9,16 @@ test_expect_equal "$output" "[[[{\"id\": \"${gen_msg_id= }\", \"match\": true, \"e >=20=20 > test_begin_subtest "Search message: json" > add_message "[subject]=3D\"json-search-subject\"" "[date]=3D\"Sat, 01 Ja= n 2000 12:00:00 -0000\"" "[body]=3D\"json-search-message\"" > -output=3D$(notmuch search --format=3Djson "json-search-message" | notmuc= h_search_sanitize) > +output=3D$(notmuch search --format=3Djson "json-search-message" | notmuc= h_json_show_sanitize | notmuch_search_sanitize) > test_expect_equal "$output" "[{\"thread\": \"XXX\", > -\"timestamp\": 946728000, > -\"date_relative\": \"2000-01-01\", > -\"matched\": 1, > -\"total\": 1, > -\"authors\": \"Notmuch Test Suite\", > -\"subject\": \"json-search-subject\", > -\"tags\": [\"inbox\", \"unread\"]}]" > + \"timestamp\": 946728000, > + \"date_relative\": \"2000-01-01\", > + \"matched\": 1, > + \"total\": 1, > + \"authors\": \"Notmuch Test Suite\", > + \"subject\": \"json-search-subject\", > + \"tags\": [\"inbox\", > + \"unread\"]}]" >=20=20 > test_begin_subtest "Show message: json, utf-8" > add_message "[subject]=3D\"json-show-utf8-body-s=C3=BCbj=C3=A9ct\"" "[da= te]=3D\"Sat, 01 Jan 2000 12:00:00 -0000\"" "[body]=3D\"js=C3=B6n-show-m=C3= =A9ssage\"" > @@ -39,14 +40,15 @@ test_expect_equal "$output" "[[[{\"id\": \"$id\", \"m= atch\": true, \"excluded\": >=20=20 > test_begin_subtest "Search message: json, utf-8" > add_message "[subject]=3D\"json-search-utf8-body-s=C3=BCbj=C3=A9ct\"" "[= date]=3D\"Sat, 01 Jan 2000 12:00:00 -0000\"" "[body]=3D\"js=C3=B6n-search-m= =C3=A9ssage\"" > -output=3D$(notmuch search --format=3Djson "js=C3=B6n-search-m=C3=A9ssage= " | notmuch_search_sanitize) > +output=3D$(notmuch search --format=3Djson "js=C3=B6n-search-m=C3=A9ssage= " | notmuch_json_show_sanitize | notmuch_search_sanitize) > test_expect_equal "$output" "[{\"thread\": \"XXX\", > -\"timestamp\": 946728000, > -\"date_relative\": \"2000-01-01\", > -\"matched\": 1, > -\"total\": 1, > -\"authors\": \"Notmuch Test Suite\", > -\"subject\": \"json-search-utf8-body-s=C3=BCbj=C3=A9ct\", > -\"tags\": [\"inbox\", \"unread\"]}]" > + \"timestamp\": 946728000, > + \"date_relative\": \"2000-01-01\", > + \"matched\": 1, > + \"total\": 1, > + \"authors\": \"Notmuch Test Suite\", > + \"subject\": \"json-search-utf8-body-s=C3=BCbj=C3=A9ct\", > + \"tags\": [\"inbox\", > + \"unread\"]}]" >=20=20 > test_done > --=20 > 1.7.11.2 > > _______________________________________________ > notmuch mailing list > notmuch@notmuchmail.org > http://notmuchmail.org/mailman/listinfo/notmuch