lib.h File Reference

Ask the user a question. More...

#include "config/lib.h"

Include dependency graph for lib.h:

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

Go to the source code of this file.

Functions
int	mw_multi_choice (const char *prompt, const char *letters)
	Offer the user a multiple choice question -.
enum QuadOption	query_yesorno (const char *prompt, enum QuadOption def)
	Ask the user a Yes/No question.
enum QuadOption	query_yesorno_ignore_macro (const char *prompt, enum QuadOption def)
	Ask the user a Yes/No question ignoring the macro buffer.
enum QuadOption	query_yesorno_help (const char *prompt, enum QuadOption def, struct ConfigSubset *sub, const char *name)
	Ask the user a Yes/No question offering help.
enum QuadOption	query_quadoption (const char *prompt, struct ConfigSubset *sub, const char *name)
	Ask the user a quad-question.

Detailed Description

Ask the user a question.

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

Function Documentation

query_yesorno()

enum QuadOption query_yesorno	(	const char *	prompt,
		enum QuadOption	def )

Ask the user a Yes/No question.

Parameters

prompt	Prompt
def	Default answer, e.g. MUTT_YES

Return values

enum	QuadOption, Selection made

Wrapper for mw_yesorno().

Definition at line 326 of file question.c.

{
  return mw_yesorno(prompt, def, NULL, GETCH_NO_FLAGS);
}

Here is the call graph for this function:

Here is the caller graph for this function:

query_yesorno_ignore_macro()

enum QuadOption query_yesorno_ignore_macro	(	const char *	prompt,
		enum QuadOption	def )

Ask the user a Yes/No question ignoring the macro buffer.

Parameters

prompt	Prompt
def	Default answer, e.g. MUTT_YES

Return values

enum	QuadOption, Selection made

Like query_yesorno but don't read from the macro events buffer.

Definition at line 339 of file question.c.

{
  return mw_yesorno(prompt, def, NULL, GETCH_IGNORE_MACRO);
}

Here is the call graph for this function:

Here is the caller graph for this function:

query_yesorno_help()

enum QuadOption query_yesorno_help	(	const char *	prompt,
		enum QuadOption	def,
		struct ConfigSubset *	sub,
		const char *	name )

Ask the user a Yes/No question offering help.

Parameters

prompt	Prompt
def	Default answer, e.g. MUTT_YES
sub	Config Subset
name	Name of controlling config variable

Return values

enum	QuadOption, Selection made

Wrapper for mw_yesorno().

Definition at line 354 of file question.c.

{
  struct HashElem *he = cs_subset_create_inheritance(sub, name);
  struct HashElem *he_base = cs_get_base(he);
  ASSERT(CONFIG_TYPE(he_base->type) == DT_BOOL);
 
  intptr_t value = cs_subset_he_native_get(sub, he, NULL);
  ASSERT(value != INT_MIN);
 
  struct ConfigDef *cdef = he_base->data;
  return mw_yesorno(prompt, def, cdef, GETCH_NO_FLAGS);
}

Here is the call graph for this function:

Here is the caller graph for this function:

query_quadoption()

enum QuadOption query_quadoption	(	const char *	prompt,
		struct ConfigSubset *	sub,
		const char *	name )

Ask the user a quad-question.

Parameters

prompt	Message to show to the user
sub	Config Subset
name	Name of controlling config variable

Return values

QuadOption

Result, e.g. MUTT_NO

If the config variable is set to 'yes' or 'no', the function returns immediately. Otherwise, the job is delegated to mw_yesorno().

Definition at line 378 of file question.c.

{
  struct HashElem *he = cs_subset_create_inheritance(sub, name);
  struct HashElem *he_base = cs_get_base(he);
  ASSERT(CONFIG_TYPE(he_base->type) == DT_QUAD);
 
  intptr_t value = cs_subset_he_native_get(sub, he, NULL);
  ASSERT(value != INT_MIN);
 
  if ((value == MUTT_YES) || (value == MUTT_NO))
    return value;
 
  struct ConfigDef *cdef = he_base->data;
  enum QuadOption def = (value == MUTT_ASKYES) ? MUTT_YES : MUTT_NO;
  return mw_yesorno(prompt, def, cdef, GETCH_NO_FLAGS);
}

Here is the call graph for this function:

Here is the caller graph for this function: