mdata.h File Reference

Notmuch-specific Mailbox data. More...

#include "query.h"

Include dependency graph for mdata.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	NmMboxData
	Notmuch-specific Mailbox data -. More...

Functions
void	nm_mdata_free (void **ptr)
	Free the private Mailbox data - Implements Mailbox::mdata_free() More...
struct NmMboxData *	nm_mdata_get (struct Mailbox *m)
	Get the Notmuch Mailbox data. More...
struct NmMboxData *	nm_mdata_new (const char *url)
	Create a new NmMboxData object from a query. More...

Detailed Description

Notmuch-specific Mailbox data.

Authors

• Richard Russon

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file mdata.h.

Function Documentation

nm_mdata_free()

void nm_mdata_free

(

void **

ptr

)

Free the private Mailbox data - Implements Mailbox::mdata_free()

The NmMboxData struct stores global Notmuch data, such as the connection to the database. This function will close the database, free the resources and the struct itself.

Definition at line 46 of file mdata.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct NmMboxData *mdata = *ptr;
 
  mutt_debug(LL_DEBUG1, "nm: freeing context data %p\n", mdata);
 
  url_free(&mdata->db_url);
  FREE(&mdata->db_query);
  progress_free(&mdata->progress);
  FREE(ptr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

nm_mdata_get()

struct NmMboxData * nm_mdata_get

(

struct Mailbox *

m

)

Get the Notmuch Mailbox data.

Parameters

m

Mailbox

Return values

ptr	Success
NULL	Failure, not a Notmuch mailbox

Definition at line 97 of file mdata.c.

{
  if (!m || (m->type != MUTT_NOTMUCH))
    return NULL;
 
  return m->mdata;
}

Here is the caller graph for this function:

nm_mdata_new()

struct NmMboxData * nm_mdata_new

(

const char *

url

)

Create a new NmMboxData object from a query.

Parameters

url	Notmuch query string

Return values

ptr	New NmMboxData struct

A new NmMboxData struct is created, then the query is parsed and saved within it. This should be freed using nm_mdata_free().

Definition at line 69 of file mdata.c.

{
  if (!url)
    return NULL;
 
  struct NmMboxData *mdata = mutt_mem_calloc(1, sizeof(struct NmMboxData));
  mutt_debug(LL_DEBUG1, "nm: initialize mailbox mdata %p\n", (void *) mdata);
 
  const short c_nm_db_limit = cs_subset_number(NeoMutt->sub, "nm_db_limit");
  const char *const c_nm_query_type = cs_subset_string(NeoMutt->sub, "nm_query_type");
  mdata->db_limit = c_nm_db_limit;
  mdata->query_type = nm_string_to_query_type(c_nm_query_type);
  mdata->db_url = url_parse(url);
  if (!mdata->db_url)
  {
    mutt_error(_("failed to parse notmuch url: %s"), url);
    FREE(&mdata);
    return NULL;
  }
  return mdata;
}

Here is the call graph for this function:

Here is the caller graph for this function: