Mailing-list Function API

Prototype for a Mailing-list Function. More...

Collaboration diagram for Mailing-list Function API:

Functions
static int	op_quit (struct ListData *ld, const struct KeyEvent *event)
	Save changes and exit this dialog - Implements mlist_function_t -.
static int	op_select_action (struct ListData *ld, const struct KeyEvent *event)
	Execute the selected mailing-list action - Implements mlist_function_t -.

Detailed Description

Prototype for a Mailing-list Function.

Parameters

ld	Mailing-list dialog state
event	Event to process

Return values

enum	FunctionRetval

Precondition

ld is not NULL

event is not NULL

Function Documentation

op_quit()

static int op_quit ( struct ListData * ld, const struct KeyEvent * event )

static

Save changes and exit this dialog - Implements mlist_function_t -.

Parameters

ld	Dialog state
event	Event being handled

Return values

enum	FunctionRetval

Definition at line 187 of file functions.c.

{
  ld->done = true;
  return FR_SUCCESS;
}

op_select_action()

static int op_select_action ( struct ListData * ld, const struct KeyEvent * event )

static

Execute the selected mailing-list action - Implements mlist_function_t -.

Parameters

ld	Dialog state
event	Event being handled

Return values

enum	FunctionRetval

For a specific list opcode (e.g. OP_LIST_UNSUBSCRIBE) the matching action is used. If there are several matches (e.g. mailto: and https: links), the first match is selected, but the action is not performed. For a generic selection the currently highlighted action is used.

Definition at line 204 of file functions.c.

{
  const struct ListEntry *entry = NULL;
 
  if (event && (event->op != OP_GENERIC_SELECT_ENTRY))
  {
    int first_match = -1;
    int num_matches = 0;
    for (int i = 0; i < ARRAY_SIZE(&ld->entries); i++)
    {
      const struct ListEntry *candidate = ARRAY_GET(&ld->entries, i);
      if (candidate && (candidate->action->op == event->op))
      {
        if (first_match < 0)
          first_match = i;
        num_matches++;
      }
    }
 
    if (num_matches == 0)
      return FR_NO_ACTION;
 
    menu_set_index(ld->menu, first_match);
 
    // Several matches: just select the first, let the user choose
    if (num_matches > 1)
      return FR_SUCCESS;
 
    entry = ARRAY_GET(&ld->entries, first_match);
  }
  else
  {
    entry = ARRAY_GET(&ld->entries, menu_get_index(ld->menu));
  }
 
  if (!entry)
    return FR_NO_ACTION;
 
  ld->done = compose_list_action(ld, entry);
  return FR_SUCCESS;
}

Here is the call graph for this function: