msn.h File Reference

IMAP MSN helper functions. More...

#include <stdlib.h>

Include dependency graph for msn.h:

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

Go to the source code of this file.

Functions
void	imap_msn_free (struct MSNArray *msn)
	Free the cache.
struct Email *	imap_msn_get (const struct MSNArray *msn, size_t idx)
	Return the Email associated with an msn.
size_t	imap_msn_highest (const struct MSNArray *msn)
	Return the highest MSN in use.
void	imap_msn_remove (struct MSNArray *msn, size_t idx)
	Remove an entry from the cache.
void	imap_msn_reserve (struct MSNArray *msn, size_t num)
	Create / reallocate the cache.
void	imap_msn_set (struct MSNArray *msn, size_t idx, struct Email *e)
	Cache an Email into a given position.
size_t	imap_msn_shrink (struct MSNArray *msn, size_t num)
	Remove a number of entries from the end of the cache.

Detailed Description

IMAP MSN helper functions.

Authors

• Pietro Cerutti
• 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 msn.h.

Function Documentation

imap_msn_free()

void imap_msn_free

(

struct MSNArray *

msn

)

Free the cache.

Parameters

msn	MSN structure

Definition at line 60 of file msn.c.

{
  ARRAY_FREE(msn);
}

Here is the caller graph for this function:

imap_msn_get()

struct Email * imap_msn_get	(	const struct MSNArray *	msn,
		size_t	idx
	)

Return the Email associated with an msn.

Parameters

msn	MSN structure
idx	Index to retrieve

Return values

ptr	Pointer to Email or NULL

Definition at line 81 of file msn.c.

{
  struct Email **ep = ARRAY_GET(msn, idx);
  return ep ? *ep : NULL;
}

Here is the caller graph for this function:

imap_msn_highest()

size_t imap_msn_highest

(

const struct MSNArray *

msn

)

Return the highest MSN in use.

Parameters

msn	MSN structure

Return values

num	The highest MSN in use

Definition at line 70 of file msn.c.

{
  return ARRAY_SIZE(msn);
}

Here is the caller graph for this function:

imap_msn_remove()

void imap_msn_remove	(	struct MSNArray *	msn,
		size_t	idx
	)

Remove an entry from the cache.

Parameters

msn	MSN structure
idx	Index to invalidate

Definition at line 114 of file msn.c.

{
  struct Email **ep = ARRAY_GET(msn, idx);
  if (ep)
    *ep = NULL;
}

Here is the caller graph for this function:

imap_msn_reserve()

void imap_msn_reserve	(	struct MSNArray *	msn,
		size_t	num
	)

Create / reallocate the cache.

Parameters

msn	MSN structure
num	Number of MSNs to make room for

Definition at line 42 of file msn.c.

{
  /* This is a conservative check to protect against a malicious imap
   * server.  Most likely size_t is bigger than an unsigned int, but
   * if msn_count is this big, we have a serious problem. */
  if (num >= (UINT_MAX / sizeof(struct Email *)))
  {
    mutt_error(_("Out of memory"));
    mutt_exit(1);
  }
 
  ARRAY_RESERVE(msn, num);
}

Here is the call graph for this function:

Here is the caller graph for this function:

imap_msn_set()

void imap_msn_set	(	struct MSNArray *	msn,
		size_t	idx,
		struct Email *	e
	)

Cache an Email into a given position.

Parameters

msn	MSN structure
idx	Index in the cache
e	Email to cache

Definition at line 93 of file msn.c.

{
  ARRAY_SET(msn, idx, e);
}

Here is the caller graph for this function:

imap_msn_shrink()

size_t imap_msn_shrink	(	struct MSNArray *	msn,
		size_t	num
	)

Remove a number of entries from the end of the cache.

Parameters

msn	MSN structure
num	Number of entries to remove

Return values

num	Number of entries actually removed

Definition at line 104 of file msn.c.

{
  return ARRAY_SHRINK(msn, num);
}

Here is the caller graph for this function: