window.c File Reference

GUI ask the user to enter a string. More...

#include "config.h"
#include <stdbool.h>
#include <string.h>
#include <wchar.h>
#include "mutt/lib.h"
#include "core/lib.h"
#include "gui/lib.h"
#include "lib.h"
#include "color/lib.h"
#include "complete/lib.h"
#include "history/lib.h"
#include "key/lib.h"
#include "functions.h"
#include "module_data.h"
#include "muttlib.h"
#include "state.h"
#include "wdata.h"

Include dependency graph for window.c:

Go to the source code of this file.

Functions
static int	my_addwch (struct MuttWindow *win, wchar_t wc)
	Display one wide character on screen.
bool	self_insert (struct EnterWindowData *wdata, int ch)
	Insert a normal character.
static int	enter_recalc (struct MuttWindow *win)
	Recalculate the Window data - Implements MuttWindow::recalc() -.
static int	enter_repaint (struct MuttWindow *win)
	Repaint the Window - Implements MuttWindow::repaint() -.
static bool	enter_recursor (struct MuttWindow *win)
	Recursor the Window - Implements MuttWindow::recursor() -.
int	mw_get_field_notify (const char *prompt, struct Buffer *buf, CompletionFlags complete, enum HistoryClass hclass, const struct CompleteOps *comp_api, void *cdata, get_field_callback_t callback, void *cb_data, const struct MenuDefinition *md, function_dispatcher_t fn_disp)
	Ask the user for a string and call a notify function on keypress.
int	mw_get_field (const char *prompt, struct Buffer *buf, CompletionFlags complete, enum HistoryClass hclass, const struct CompleteOps *comp_api, void *cdata)
	Ask the user for a string -.

Variables
static const struct Mapping	EditorHelp []
	Help Bar for the Command Line Editor.

Detailed Description

GUI ask the user to enter a string.

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 window.c.

Function Documentation

my_addwch()

static int my_addwch ( struct MuttWindow * win, wchar_t wc )

static

Display one wide character on screen.

Parameters

win	Window
wc	Character to display

Return values

OK	Success
ERR	Failure

Definition at line 70 of file window.c.

{
  int n = wcwidth(wc);
  if (IsWPrint(wc) && (n > 0))
    return mutt_addwch(win, wc);
  if (!(wc & ~0x7f))
    return mutt_window_printf(win, "^%c", ((int) wc + 0x40) & 0x7f);
  if (!(wc & ~0xffff))
    return mutt_window_printf(win, "\\u%04x", (int) wc);
  return mutt_window_printf(win, "\\u%08x", (int) wc);
}

Here is the call graph for this function:

Here is the caller graph for this function:

self_insert()

bool self_insert	(	struct EnterWindowData *	wdata,
		int	ch )

Insert a normal character.

Parameters

wdata	Enter window data
ch	Raw keypress

Return values

true	If done (enter pressed)

Definition at line 88 of file window.c.

{
  if (!wdata)
    return true;
 
  wdata->tabs = 0;
  wchar_t wc = 0;
 
  /* quietly ignore all other function keys */
  if (ch & ~0xff)
    return false;
 
  /* gather the bytes into a wide character */
  {
    char c = ch;
    size_t k = mbrtowc(&wc, &c, 1, wdata->mbstate);
    if (k == ICONV_BUF_TOO_SMALL)
    {
      return false;
    }
    else if ((k != 0) && (k != 1))
    {
      memset(wdata->mbstate, 0, sizeof(*wdata->mbstate));
      return false;
    }
  }
 
  if (wdata->first && (wdata->flags & MUTT_COMP_CLEAR))
  {
    wdata->first = false;
    if (IsWPrint(wc)) /* why? */
    {
      wdata->state->curpos = 0;
      wdata->state->lastchar = 0;
    }
  }
 
  if ((wc == '\r') || (wc == '\n'))
  {
    /* Convert from wide characters */
    buf_mb_wcstombs(wdata->buffer, wdata->state->wbuf, wdata->state->lastchar);
    if (!wdata->pass)
      mutt_hist_add(wdata->hclass, buf_string(wdata->buffer), true);
 
    if (wdata->cdata)
    {
      struct FileCompletionData *cdata = wdata->cdata;
      if (cdata->multiple)
      {
        char **tfiles = NULL;
        *cdata->numfiles = 1;
        tfiles = MUTT_MEM_CALLOC(*cdata->numfiles, char *);
        expand_path(wdata->buffer, false);
        tfiles[0] = buf_strdup(wdata->buffer);
        *cdata->files = tfiles;
      }
    }
    return true;
  }
  else if (wc && ((wc < ' ') || IsWPrint(wc))) /* why? */
  {
    enter_state_resize(wdata->state, wdata->state->lastchar + 1);
    memmove(wdata->state->wbuf + wdata->state->curpos + 1,
            wdata->state->wbuf + wdata->state->curpos,
            (wdata->state->lastchar - wdata->state->curpos) * sizeof(wchar_t));
    wdata->state->wbuf[wdata->state->curpos++] = wc;
    wdata->state->lastchar++;
  }
  else
  {
    mutt_flushinp();
    mutt_beep(false);
  }
 
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

mw_get_field_notify()

int mw_get_field_notify	(	const char *	prompt,
		struct Buffer *	buf,
		CompletionFlags	complete,
		enum HistoryClass	hclass,
		const struct CompleteOps *	comp_api,
		void *	cdata,
		get_field_callback_t	callback,
		void *	cb_data,
		const struct MenuDefinition *	md,
		function_dispatcher_t	fn_disp )

Ask the user for a string and call a notify function on keypress.

Parameters

[in]	prompt	Prompt
[in]	buf	Buffer for the result
[in]	hclass	History class to use
[in]	complete	Flags, see CompletionFlags
[in]	comp_api	Auto-completion API
[in]	cdata	Auto-completion private data
[in]	callback	Callback function used for notification
[in]	cb_data	Data to pass to callback function
[in]	md	Menu Definition
[in]	fn_disp	Function dispatcher

Return values

0	Selection made
-1	Aborted

Definition at line 266 of file window.c.

{
  struct EditorModuleData *mod_data = neomutt_get_module_data(NeoMutt, MODULE_ID_EDITOR);
  ASSERT(mod_data);
 
  struct MuttWindow *win = mutt_window_new(WT_CUSTOM, MUTT_WIN_ORIENT_VERTICAL, MUTT_WIN_SIZE_FIXED,
                                           MUTT_WIN_SIZE_UNLIMITED, 1);
 
  GetChFlags flags = GETCH_NO_FLAGS;
  if (complete & MUTT_COMP_UNBUFFERED)
    flags = GETCH_IGNORE_MACRO;
 
  struct Buffer *cbuf = NULL;
  if (callback)
    cbuf = buf_pool_get();
 
  if (!md)
    md = mod_data->md_editor;
 
  int rc = 0;
 
  struct EnterState *es = enter_state_new();
 
  win->help_data = EditorHelp;
  win->help_md = mod_data->md_editor;
 
  msgcont_push_window(win);
  struct MuttWindow *old_focus = window_set_focus(win);
 
  mbstate_t mbstate = { 0 };
  // clang-format off
  struct EnterWindowData wdata = { buf, complete, es, hclass, comp_api, cdata, prompt, ENTER_REDRAW_NONE, (complete & MUTT_COMP_PASS), true, NULL, 0, &mbstate, 0, false, NULL, 0, 0 };
  // clang-format on
 
  win->wdata = &wdata;
  win->wdata_free = NULL; // No need, we hold the data
  win->recalc = enter_recalc;
  win->repaint = enter_repaint;
  win->recursor = enter_recursor;
 
  window_redraw(win);
 
  if (es->wbuf[0] == L'\0')
  {
    /* Initialise wbuf from buf */
    wdata.state->wbuflen = 0;
    wdata.state->lastchar = mutt_mb_mbstowcs(&wdata.state->wbuf, &wdata.state->wbuflen,
                                             0, buf_string(wdata.buffer));
    wdata.redraw = ENTER_REDRAW_INIT;
  }
  else
  {
    wdata.redraw = ENTER_REDRAW_LINE;
    wdata.first = false;
  }
 
  do
  {
    memset(&mbstate, 0, sizeof(mbstate));
 
    do
    {
      if (wdata.redraw != ENTER_REDRAW_NONE)
        win->actions |= WA_REPAINT;
 
      mutt_curses_set_cursor(MUTT_CURSOR_INVISIBLE);
      window_redraw(NULL);
      mutt_curses_set_cursor(MUTT_CURSOR_VISIBLE);
      struct KeyEvent event = km_dokey(md, flags);
      if ((event.op == OP_TIMEOUT) || (event.op == OP_REPAINT))
      {
        continue;
      }
 
      if (event.op == OP_ABORT)
      {
        rc = -1;
        goto bye;
      }
 
      if (event.op == OP_NULL)
      {
        if (complete & MUTT_COMP_PASS)
          mutt_debug(LL_DEBUG5, "Got char *\n");
        else
          mutt_debug(LL_DEBUG5, "Got char %c (0x%02x)\n", event.ch, event.ch);
 
        if (self_insert(&wdata, event.ch))
        {
          rc = 0;
          goto bye;
        }
        win->actions |= WA_REPAINT;
        goto notify;
      }
      else
      {
        mutt_debug(LL_DEBUG1, "Got op %s (%d)\n", opcodes_get_name(event.op),
                   event.op);
      }
 
      wdata.first = false;
      if ((event.op != OP_EDITOR_COMPLETE) && (event.op != OP_EDITOR_COMPLETE_QUERY))
        wdata.tabs = 0;
 
      wdata.redraw = ENTER_REDRAW_LINE;
 
      int rc_disp = FR_UNKNOWN;
      if (fn_disp)
      {
        rc_disp = fn_disp(cb_data, &event);
        if (rc_disp == FR_SUCCESS)
          rc_disp = FR_CONTINUE;
      }
 
      if (rc_disp == FR_UNKNOWN)
        rc_disp = enter_function_dispatcher(win, &event);
 
      switch (rc_disp)
      {
        case FR_NO_ACTION:
        {
          if (self_insert(&wdata, event.ch))
          {
            rc = 0;
            goto bye;
          }
          break;
        }
        case FR_CONTINUE: // repaint
          rc = 1;
          goto bye;
 
        case FR_DONE:
          wdata.done = true;
          rc = 0;
          break;
 
        case FR_SUCCESS:
          rc = 0;
          break;
 
        case FR_UNKNOWN:
        case FR_ERROR:
        default:
          mutt_beep(false);
      }
 
    notify:
      if (callback)
      {
        buf_mb_wcstombs(cbuf, wdata.state->wbuf, wdata.state->lastchar);
        callback(buf_string(cbuf), cb_data);
      }
 
    } while (!wdata.done);
 
  bye:
    mutt_hist_reset_state(wdata.hclass);
    FREE(&wdata.tempbuf);
  } while (rc == 1);
 
  completion_data_free(&wdata.cd);
  msgcont_pop_window();
  window_set_focus(old_focus);
  mutt_window_free(&win);
 
  if (rc == 0)
    buf_fix_dptr(buf);
  else
    buf_reset(buf);
 
  buf_pool_release(&cbuf);
 
  enter_state_free(&es);
 
  return rc;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

EditorHelp

const struct Mapping EditorHelp[]

static

Initial value:

= {
  
  { N_("Help"),        OP_HELP },
  { N_("Complete"),    OP_EDITOR_COMPLETE },
  { N_("Hist Up"),     OP_EDITOR_HISTORY_UP },
  { N_("Hist Down"),   OP_EDITOR_HISTORY_DOWN },
  { N_("Hist Search"), OP_EDITOR_HISTORY_SEARCH },
  { N_("Begin Line"),  OP_EDITOR_BOL },
  { N_("End Line"),    OP_EDITOR_EOL },
  { N_("Kill Line"),   OP_EDITOR_KILL_LINE },
  { N_("Kill Word"),   OP_EDITOR_KILL_WORD },
  { NULL, 0 },
  
}

Help Bar for the Command Line Editor.

Definition at line 48 of file window.c.

                                           {
  // clang-format off
  { N_("Help"),        OP_HELP },
  { N_("Complete"),    OP_EDITOR_COMPLETE },
  { N_("Hist Up"),     OP_EDITOR_HISTORY_UP },
  { N_("Hist Down"),   OP_EDITOR_HISTORY_DOWN },
  { N_("Hist Search"), OP_EDITOR_HISTORY_SEARCH },
  { N_("Begin Line"),  OP_EDITOR_BOL },
  { N_("End Line"),    OP_EDITOR_EOL },
  { N_("Kill Line"),   OP_EDITOR_KILL_LINE },
  { N_("Kill Word"),   OP_EDITOR_KILL_WORD },
  { NULL, 0 },
  // clang-format on
};