Holds state of a search. More...

#include <stdbool.h>
#include <stdint.h>

Include dependency graph for search_state.h:

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

Data Structures
struct	SearchState
	Holds state of a search. More...

Macros
#define	SEARCH_NO_FLAGS 0
	No flags are set.

#define	SEARCH_PROMPT (1 << 0)
	Ask for search input.

#define	SEARCH_OPPOSITE (1 << 1)
	Search in the opposite direction.

Typedefs
typedef uint8_t	SearchFlags
	Flags for a specific search, e.g. SEARCH_PROMPT.

Functions
struct SearchState *	search_state_new (void)
	Create a new SearchState.

void	search_state_free (struct SearchState **search)
	Free a SearchState.

Detailed Description

Holds state of a search.

Authors

Richard Russon
Dennis Schön

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

Macro Definition Documentation

◆ SEARCH_NO_FLAGS

#define SEARCH_NO_FLAGS 0

No flags are set.

Definition at line 44 of file search_state.h.

◆ SEARCH_PROMPT

#define SEARCH_PROMPT (1 << 0)

Ask for search input.

Definition at line 45 of file search_state.h.

◆ SEARCH_OPPOSITE

#define SEARCH_OPPOSITE (1 << 1)

Search in the opposite direction.

Definition at line 46 of file search_state.h.

Typedef Documentation

◆ SearchFlags

typedef uint8_t SearchFlags

Flags for a specific search, e.g. SEARCH_PROMPT.

Definition at line 43 of file search_state.h.

Function Documentation

◆ search_state_new()

struct SearchState * search_state_new ( void )

Create a new SearchState.

Return values

ptr	New SearchState

Definition at line 39 of file search_state.c.

{
  struct SearchState *s = MUTT_MEM_CALLOC(1, struct SearchState);
  s->string = buf_pool_get();
  s->string_expn = buf_pool_get();
  return s;
}

Here is the call graph for this function:

Here is the caller graph for this function:

◆ search_state_free()

void search_state_free ( struct SearchState ** ptr )

Free a SearchState.

Parameters

ptr	SearchState to free

Definition at line 51 of file search_state.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct SearchState *s = *ptr;
  mutt_pattern_free(&s->pattern);
  buf_pool_release(&s->string);
  buf_pool_release(&s->string_expn);
 
  FREE(ptr);
}