functions_fuzzy.c File Reference

Sidebar fuzzy search functions. More...

#include "config.h"
#include <stdbool.h>
#include <string.h>
#include "private.h"
#include "mutt/lib.h"
#include "config/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "editor/lib.h"
#include "fuzzy/lib.h"
#include "history/lib.h"
#include "index/lib.h"
#include "key/lib.h"
#include "functions_sidebar.h"

Include dependency graph for functions_fuzzy.c:

Go to the source code of this file.

Functions
struct MenuDefinition *	sb_fuzzy_init_menu (void)
	Initialise the Fuzzy Search Menu - Implements ::init_keys_api.
int	sb_fuzzy_function_dispatcher (struct MuttWindow *win, const struct KeyEvent *event)
	Perform a Fuzzy Search function - Implements function_dispatcher_t -.
static void	sidebar_matcher_cb (const char *text, void *data)
	React to keys as they are entered - Implements get_field_callback_t.
int	op_sidebar_start_search (struct SidebarFunctionData *fdata, const struct KeyEvent *event)
	Selects the last unhidden mailbox - Implements sidebar_function_t -.

Variables
static const struct SidebarFunction	FuzzyFunctions []
	All the NeoMutt functions that the Sidebar Fuzzy Search supports.

Detailed Description

Sidebar fuzzy search 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 functions_fuzzy.c.

Function Documentation

sb_fuzzy_init_menu()

struct MenuDefinition * sb_fuzzy_init_menu

(

void

)

Initialise the Fuzzy Search Menu - Implements ::init_keys_api.

Return values

ptr	MenuDefinition for the fuzzy search

Definition at line 48 of file functions_fuzzy.c.

{
  struct MenuDefinition *md = menudef_new();
 
  struct SubMenu *sm_fuzzy = fuzzy_get_submenu();
  ASSERT(sm_fuzzy);
  struct SubMenu *sm_editor = editor_get_submenu();
  ASSERT(sm_editor);
 
  km_menu_add_submenu(md, sm_fuzzy);
  km_menu_add_submenu(md, sm_editor);
 
  return md;
}

Here is the call graph for this function:

Here is the caller graph for this function:

sidebar_matcher_cb()

static void sidebar_matcher_cb ( const char * text, void * data )

static

React to keys as they are entered - Implements get_field_callback_t.

Definition at line 120 of file functions_fuzzy.c.

{
  struct MuttWindow *win = data;
  struct SidebarWindowData *wdata = win->wdata;
  wdata->hil_index = -1;
  wdata->repage = true;
 
  struct SbEntry **sbep = NULL;
 
  if (text[0] == '\0')
  {
    ARRAY_FOREACH(sbep, &wdata->entries)
    {
      struct SbEntry *sbe = *sbep;
      sbe->mailbox->visible = true;
      sbe->score = -1;
      if (wdata->hil_index == -1)
        wdata->hil_index = ARRAY_FOREACH_IDX_sbep;
    }
    wdata->win->actions |= WA_RECALC;
    return;
  }
 
  struct FuzzyOptions opts = { .smart_case = true };
  struct FuzzyResult result = { 0 };
  int best_score = -1;
  int best_index = -1;
  struct Buffer *buf = buf_pool_get();
 
  ARRAY_FOREACH(sbep, &wdata->entries)
  {
    struct SbEntry *sbe = *sbep;
    buf_printf(buf, "%s %s", sbe->box, sbe->display);
    int score = fuzzy_match(text, buf_string(buf), FUZZY_ALGO_SUBSEQ, &opts, &result);
    if (score > 0)
    {
      // Extra 2 points for new (unseen) mail
      //       1 point  for old (seen)   mail
      score += (2 * sbe->mailbox->msg_new);
      score += (sbe->mailbox->msg_unread - sbe->mailbox->msg_new);
    }
    sbe->score = score;
    if (score >= 0)
    {
      if ((best_score == -1) || (score > best_score))
      {
        best_score = score;
        best_index = ARRAY_FOREACH_IDX_sbep;
      }
      sbe->mailbox->visible = true;
    }
    else
    {
      sbe->mailbox->visible = false;
    }
  }
 
  wdata->hil_index = best_index;
  wdata->win->actions |= WA_RECALC;
  buf_pool_release(&buf);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

FuzzyFunctions

const struct SidebarFunction FuzzyFunctions[]

static

Initial value:

= {
  
  { OP_FIRST_ENTRY,          op_sidebar_first },
  { OP_LAST_ENTRY,           op_sidebar_last },
  { OP_NEXT_ENTRY,           op_sidebar_next },
  { OP_NEXT_PAGE,            op_sidebar_page_down },
  { OP_PREV_ENTRY,           op_sidebar_prev },
  { OP_PREV_PAGE,            op_sidebar_page_up },
  { 0, NULL },
  
}

All the NeoMutt functions that the Sidebar Fuzzy Search supports.

Definition at line 66 of file functions_fuzzy.c.

                                                       {
  // clang-format off
  { OP_FIRST_ENTRY,          op_sidebar_first },
  { OP_LAST_ENTRY,           op_sidebar_last },
  { OP_NEXT_ENTRY,           op_sidebar_next },
  { OP_NEXT_PAGE,            op_sidebar_page_down },
  { OP_PREV_ENTRY,           op_sidebar_prev },
  { OP_PREV_PAGE,            op_sidebar_page_up },
  { 0, NULL },
  // clang-format on
};