dispatcher.c File Reference

Dispatcher of functions. More...

#include "config.h"
#include <stddef.h>
#include "mutt/lib.h"
#include "dispatcher.h"
#include "key/lib.h"

Include dependency graph for dispatcher.c:

Go to the source code of this file.

Functions
const char *	dispatcher_get_retval_name (int rv)
	Get the name of a return value.
void	dispatcher_flush_on_error (int rv)
	Flush pending keys after a dispatch error.

Variables
static const struct Mapping	RetvalNames []
	Lookup for function results.

Detailed Description

Dispatcher of functions.

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 dispatcher.c.

Function Documentation

dispatcher_get_retval_name()

const char * dispatcher_get_retval_name

(

int

rv

)

Get the name of a return value.

Parameters

rv	Return value, e.g. FR_ERROR

Return values

str	Name of the retval
""	Error

Definition at line 55 of file dispatcher.c.

{
  const char *name = mutt_map_get_name(rv, RetvalNames);
  return NONULL(name);
}

Here is the call graph for this function:

Here is the caller graph for this function:

dispatcher_flush_on_error()

void dispatcher_flush_on_error

(

int

rv

)

Flush pending keys after a dispatch error.

Parameters

rv	Return value, e.g. FR_ERROR

Definition at line 65 of file dispatcher.c.

{
  if (rv == FR_ERROR)
    mutt_flushinp();
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

RetvalNames

const struct Mapping RetvalNames[]

static

Initial value:

                           = {
  
  { "continue",  FR_CONTINUE },
  { "done",      FR_DONE },
  { "error",     FR_ERROR },
  { "no action", FR_NO_ACTION },
  { "not impl",  FR_NOT_IMPL },
  { "success",   FR_SUCCESS },
  { "unknown",   FR_UNKNOWN },
  { NULL, 0 },
  
}

Lookup for function results.

Definition at line 36 of file dispatcher.c.

                                          {
  // clang-format off
  { "continue",  FR_CONTINUE },
  { "done",      FR_DONE },
  { "error",     FR_ERROR },
  { "no action", FR_NO_ACTION },
  { "not impl",  FR_NOT_IMPL },
  { "success",   FR_SUCCESS },
  { "unknown",   FR_UNKNOWN },
  { NULL, 0 },
  // clang-format on
};