lib: Expose query debug output via an environment variable

Allow query debugging to be enabled at run-time by setting the
NOTMUCH_DEBUG_QUERY environment variable to a non-empty string.

Previously, enabling query debugging required recompiling, but parsed
queries are often useful for tracking down bugs in situations where
recompiling is inconvenient.
This commit is contained in:
Austin Clements 2012-03-13 22:31:30 -04:00 committed by David Bremner
parent b3e4417897
commit 75a0552633

View file

@ -64,15 +64,21 @@ _notmuch_doc_id_set_init (void *ctx,
notmuch_doc_id_set_t *doc_ids, notmuch_doc_id_set_t *doc_ids,
GArray *arr); GArray *arr);
static notmuch_bool_t
_debug_query (void)
{
char *env = getenv ("NOTMUCH_DEBUG_QUERY");
return (env && strcmp (env, "") != 0);
}
notmuch_query_t * notmuch_query_t *
notmuch_query_create (notmuch_database_t *notmuch, notmuch_query_create (notmuch_database_t *notmuch,
const char *query_string) const char *query_string)
{ {
notmuch_query_t *query; notmuch_query_t *query;
#ifdef DEBUG_QUERY if (_debug_query ())
fprintf (stderr, "Query string is:\n%s\n", query_string); fprintf (stderr, "Query string is:\n%s\n", query_string);
#endif
query = talloc (NULL, notmuch_query_t); query = talloc (NULL, notmuch_query_t);
if (unlikely (query == NULL)) if (unlikely (query == NULL))
@ -255,9 +261,9 @@ notmuch_query_search_messages (notmuch_query_t *query)
break; break;
} }
#if DEBUG_QUERY if (_debug_query ())
fprintf (stderr, "Final query is:\n%s\n", final_query.get_description().c_str()); fprintf (stderr, "Final query is:\n%s\n",
#endif final_query.get_description ().c_str ());
enquire.set_query (final_query); enquire.set_query (final_query);
@ -531,9 +537,9 @@ notmuch_query_count_messages (notmuch_query_t *query)
enquire.set_weighting_scheme(Xapian::BoolWeight()); enquire.set_weighting_scheme(Xapian::BoolWeight());
enquire.set_docid_order(Xapian::Enquire::ASCENDING); enquire.set_docid_order(Xapian::Enquire::ASCENDING);
#if DEBUG_QUERY if (_debug_query ())
fprintf (stderr, "Final query is:\n%s\n", final_query.get_description().c_str()); fprintf (stderr, "Final query is:\n%s\n",
#endif final_query.get_description ().c_str ());
enquire.set_query (final_query); enquire.set_query (final_query);