mapping.h File Reference

Store links between a user-readable string and a constant. More...

#include <stddef.h>

Include dependency graph for mapping.h:

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

Go to the source code of this file.

Data Structures
struct	Mapping
	Mapping between user-readable string and a constant. More...

Functions
const char *	mutt_map_get_name (int val, const struct Mapping *map)
	Lookup a string for a constant.
int	mutt_map_get_value (const char *name, const struct Mapping *map)
	Lookup the constant for a string.
int	mutt_map_get_value_n (const char *name, size_t len, const struct Mapping *map)
	Lookup the constant for a string.

Detailed Description

Store links between a user-readable string and a constant.

Authors

• Richard Russon
• Pietro Cerutti

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 mapping.h.

Function Documentation

mutt_map_get_name()

const char * mutt_map_get_name	(	int	val,
		const struct Mapping *	map
	)

Lookup a string for a constant.

Parameters

val	ID to locate in map
map	NULL-terminated map of strings and constants

Return values

ptr	String matching ID
NULL	Error, or ID not found

Definition at line 42 of file mapping.c.

{
  if (!map)
    return NULL;
 
  for (size_t i = 0; map[i].name; i++)
    if (map[i].value == val)
      return map[i].name;
 
  return NULL;
}

Here is the caller graph for this function:

mutt_map_get_value()

int mutt_map_get_value	(	const char *	name,
		const struct Mapping *	map
	)

Lookup the constant for a string.

Parameters

name	String to locate in map
map	NULL-terminated map of strings and constants

Return values

num	ID matching string
-1	Error, or string not found

Definition at line 85 of file mapping.c.

{
  return mutt_map_get_value_n(name, mutt_str_len(name), map);
}

Here is the call graph for this function:

Here is the caller graph for this function:

mutt_map_get_value_n()

int mutt_map_get_value_n	(	const char *	name,
		size_t	len,
		const struct Mapping *	map
	)

Lookup the constant for a string.

Parameters

name	String to locate in map
len	Length of the name string (need not be null terminated)
map	NULL-terminated map of strings and constants

Return values

num	ID matching string
-1	Error, or string not found

Definition at line 62 of file mapping.c.

{
  if (!name || (len == 0) || !map)
    return -1;
 
  for (size_t i = 0; map[i].name; i++)
  {
    if (mutt_istrn_equal(map[i].name, name, len) && (map[i].name[len] == '\0'))
    {
      return map[i].value;
    }
  }
 
  return -1;
}

Here is the call graph for this function:

Here is the caller graph for this function: