data.h File Reference

String auto-completion data. More...

#include "config.h"
#include <stdbool.h>

Include dependency graph for data.h:

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

Go to the source code of this file.

Data Structures
struct	CompletionData
	State data for auto-completion. More...

Functions
void	completion_data_free (struct CompletionData **ptr)
	Free the Completion Data.
void	completion_data_free_match_strings (struct CompletionData *cd)
	Free the Completion strings.
struct CompletionData *	completion_data_new (void)
	Create new Completion Data.
void	completion_data_reset (struct CompletionData *cd)
	Wipe the stored Completion Data.

Detailed Description

String auto-completion data.

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

Function Documentation

completion_data_free()

void completion_data_free

(

struct CompletionData **

ptr

)

Free the Completion Data.

Parameters

ptr	CompletionData to free

Definition at line 53 of file data.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct CompletionData *cd = *ptr;
 
  completion_data_free_match_strings(cd);
 
  FREE(&cd->match_list);
 
  FREE(ptr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

completion_data_free_match_strings()

void completion_data_free_match_strings

(

struct CompletionData *

cd

)

Free the Completion strings.

Parameters

cd	Completion Data

Definition at line 38 of file data.c.

{
  if (!cd || !cd->free_match_strings)
    return;
 
  for (int i = 0; i < cd->num_matched; i++)
    FREE(&cd->match_list[i]);
 
  cd->free_match_strings = false;
}

Here is the caller graph for this function:

completion_data_new()

struct CompletionData * completion_data_new

(

void

)

Create new Completion Data.

Return values

ptr	New Completion Data

Definition at line 71 of file data.c.

{
  struct CompletionData *cd = mutt_mem_calloc(1, sizeof(struct CompletionData));
 
  cd->match_list_len = 512;
  cd->match_list = mutt_mem_calloc(cd->match_list_len, sizeof(char *));
 
  return cd;
}

Here is the call graph for this function:

Here is the caller graph for this function:

completion_data_reset()

void completion_data_reset

(

struct CompletionData *

cd

)

Wipe the stored Completion Data.

Parameters

cd	Completion Data

Definition at line 85 of file data.c.

{
  if (!cd)
    return;
 
  completion_data_free_match_strings(cd);
 
  memset(cd->user_typed, 0, sizeof(cd->user_typed));
  memset(cd->completed, 0, sizeof(cd->completed));
  memset(cd->match_list, 0, cd->match_list_len * sizeof(char *));
  cd->num_matched = 0;
  cd->free_match_strings = false;
}

Here is the call graph for this function:

Here is the caller graph for this function: