enter.c File Reference

Enter buffer. More...

#include "config.h"
#include <stddef.h>
#include <wchar.h>
#include <wctype.h>
#include "mutt/lib.h"
#include "core/lib.h"
#include "enter.h"
#include "state.h"

Include dependency graph for enter.c:

Go to the source code of this file.

Macros
#define	COMB_CHAR(wc)
	combining mark / non-spacing character

Functions
int	editor_backspace (struct EnterState *es)
	Delete the char in front of the cursor.
int	editor_backward_char (struct EnterState *es)
	Move the cursor one character to the left.
int	editor_backward_word (struct EnterState *es)
	Move the cursor to the beginning of the word.
int	editor_bol (struct EnterState *es)
	Jump to the beginning of the line.
int	editor_case_word (struct EnterState *es, enum EnterCase ec)
	Change the case of the word.
int	editor_delete_char (struct EnterState *es)
	Delete the char under the cursor.
int	editor_eol (struct EnterState *es)
	Jump to the end of the line.
int	editor_forward_char (struct EnterState *es)
	Move the cursor one character to the right.
int	editor_forward_word (struct EnterState *es)
	Move the cursor to the end of the word.
int	editor_kill_eol (struct EnterState *es)
	Delete chars from cursor to end of line.
int	editor_kill_eow (struct EnterState *es)
	Delete chars from the cursor to the end of the word.
int	editor_kill_line (struct EnterState *es)
	Delete chars from cursor to beginning the line.
int	editor_kill_whole_line (struct EnterState *es)
	Delete all chars on the line.
int	editor_kill_word (struct EnterState *es)
	Delete the word in front of the cursor.
int	editor_transpose_chars (struct EnterState *es)
	Transpose character under cursor with previous.
bool	editor_buffer_is_empty (struct EnterState *es)
	Is the Enter buffer empty?

Detailed Description

Enter buffer.

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

Macro Definition Documentation

COMB_CHAR

#define COMB_CHAR

(

wc

)

Value:

(IsWPrint(wc) && (wcwidth(wc) == 0))

combining mark / non-spacing character

Definition at line 39 of file enter.c.

Function Documentation

editor_backspace()

int editor_backspace

(

struct EnterState *

es

)

Delete the char in front of the cursor.

Parameters

es	State of the Enter buffer

Return values

FR_SUCCESS	Character deleted
FR_ERROR	Failed, cursor was at the start of the buffer

Definition at line 47 of file enter.c.

{
  if (!es || (es->curpos == 0))
    return FR_ERROR;
 
  size_t i = es->curpos;
  while ((i > 0) && COMB_CHAR(es->wbuf[i - 1]))
    i--;
  if (i > 0)
    i--;
  wmemmove(es->wbuf + i, es->wbuf + es->curpos, es->lastchar - es->curpos);
  es->lastchar -= es->curpos - i;
  es->curpos = i;
 
  return FR_SUCCESS;
}

Here is the caller graph for this function:

editor_backward_char()

int editor_backward_char

(

struct EnterState *

es

)

Move the cursor one character to the left.

Parameters

es	State of the Enter buffer

Return values

FR_SUCCESS	Cursor moved
FR_ERROR	Failed, cursor was at the start of the buffer

Definition at line 70 of file enter.c.

{
  if (!es || (es->curpos == 0))
    return FR_ERROR;
 
  while (es->curpos && COMB_CHAR(es->wbuf[es->curpos - 1]))
    es->curpos--;
  if (es->curpos)
    es->curpos--;
 
  return FR_SUCCESS;
}

Here is the caller graph for this function:

editor_backward_word()

int editor_backward_word

(

struct EnterState *

es

)

Move the cursor to the beginning of the word.

Parameters

es	State of the Enter buffer

Return values

FR_SUCCESS	Cursor moved
FR_ERROR	Failed, cursor was at the start of the buffer

Definition at line 89 of file enter.c.

{
  if (!es || (es->curpos == 0))
    return FR_ERROR;
 
  while (es->curpos && iswspace(es->wbuf[es->curpos - 1]))
    es->curpos--;
  while (es->curpos && !iswspace(es->wbuf[es->curpos - 1]))
    es->curpos--;
 
  return FR_SUCCESS;
}

Here is the caller graph for this function:

editor_bol()

int editor_bol

(

struct EnterState *

es

)

Jump to the beginning of the line.

Parameters

es	State of the Enter buffer

Return values

FR_SUCCESS	Cursor moved
FR_ERROR	Error

Definition at line 108 of file enter.c.

{
  if (!es)
    return FR_ERROR;
 
  es->curpos = 0;
  return FR_SUCCESS;
}

Here is the caller graph for this function:

editor_case_word()

int editor_case_word	(	struct EnterState *	es,
		enum EnterCase	ec )

Change the case of the word.

Parameters

es	State of the Enter buffer
ec	Case change to make, e.g. EC_UPCASE

Return values

FR_SUCCESS	Case changed
FR_ERROR	Error

Definition at line 124 of file enter.c.

{
  if (!es || (es->curpos == es->lastchar))
    return FR_ERROR;
 
  while ((es->curpos < es->lastchar) && iswspace(es->wbuf[es->curpos]))
  {
    es->curpos++;
  }
  while ((es->curpos < es->lastchar) && !iswspace(es->wbuf[es->curpos]))
  {
    if (ec == EC_DOWNCASE)
    {
      es->wbuf[es->curpos] = towlower(es->wbuf[es->curpos]);
    }
    else
    {
      es->wbuf[es->curpos] = towupper(es->wbuf[es->curpos]);
      if (ec == EC_CAPITALIZE)
        ec = EC_DOWNCASE;
    }
    es->curpos++;
  }
  return FR_SUCCESS;
}

Here is the caller graph for this function:

editor_delete_char()

int editor_delete_char

(

struct EnterState *

es

)

Delete the char under the cursor.

Parameters

es	State of the Enter buffer

Return values

FR_SUCCESS	Character deleted
FR_ERROR	Failed, cursor was at the end of the buffer

Definition at line 156 of file enter.c.

{
  if (!es || (es->curpos == es->lastchar))
    return FR_ERROR;
 
  size_t i = es->curpos;
  if (i < es->lastchar)
    i++;
  while ((i < es->lastchar) && COMB_CHAR(es->wbuf[i]))
    i++;
  wmemmove(es->wbuf + es->curpos, es->wbuf + i, es->lastchar - i);
  es->lastchar -= i - es->curpos;
 
  return FR_SUCCESS;
}

Here is the caller graph for this function:

editor_eol()

int editor_eol

(

struct EnterState *

es

)

Jump to the end of the line.

Parameters

es	State of the Enter buffer

Return values

FR_SUCCESS	Cursor moved
FR_ERROR	Error

Definition at line 178 of file enter.c.

{
  if (!es)
    return FR_ERROR;
 
  es->curpos = es->lastchar;
  return FR_SUCCESS;
}

Here is the caller graph for this function:

editor_forward_char()

int editor_forward_char

(

struct EnterState *

es

)

Move the cursor one character to the right.

Parameters

es	State of the Enter buffer

Return values

FR_SUCCESS	Cursor moved
FR_ERROR	Failed, cursor was at the end of the buffer

Definition at line 193 of file enter.c.

{
  if (!es || (es->curpos == es->lastchar))
    return FR_ERROR;
 
  es->curpos++;
  while ((es->curpos < es->lastchar) && COMB_CHAR(es->wbuf[es->curpos]))
  {
    es->curpos++;
  }
 
  return FR_SUCCESS;
}

Here is the caller graph for this function:

editor_forward_word()

int editor_forward_word

(

struct EnterState *

es

)

Move the cursor to the end of the word.

Parameters

es	State of the Enter buffer

Return values

FR_SUCCESS	Cursor moved
FR_ERROR	Failed, cursor was at the end of the buffer

Definition at line 213 of file enter.c.

{
  if (!es || (es->curpos == es->lastchar))
    return FR_ERROR;
 
  while ((es->curpos < es->lastchar) && iswspace(es->wbuf[es->curpos]))
  {
    es->curpos++;
  }
  while ((es->curpos < es->lastchar) && !iswspace(es->wbuf[es->curpos]))
  {
    es->curpos++;
  }
 
  return FR_SUCCESS;
}

Here is the caller graph for this function:

editor_kill_eol()

int editor_kill_eol

(

struct EnterState *

es

)

Delete chars from cursor to end of line.

Parameters

es	State of the Enter buffer

Return values

FR_SUCCESS	Characters deleted
FR_ERROR	Error

Definition at line 236 of file enter.c.

{
  if (!es)
    return FR_ERROR;
 
  es->lastchar = es->curpos;
  return FR_SUCCESS;
}

Here is the caller graph for this function:

editor_kill_eow()

int editor_kill_eow

(

struct EnterState *

es

)

Delete chars from the cursor to the end of the word.

Parameters

es	State of the Enter buffer

Return values

FR_SUCCESS	Characters deleted
FR_ERROR	Error

Definition at line 251 of file enter.c.

{
  if (!es)
    return FR_ERROR;
 
  /* first skip over whitespace */
  size_t i;
  for (i = es->curpos; (i < es->lastchar) && iswspace(es->wbuf[i]); i++)
  {
    // do nothing
  }
 
  /* if there are any characters left.. */
  if (i < es->lastchar)
  {
    /* if the current character is alphanumeric.. */
    if (iswalnum(es->wbuf[i]))
    {
      /* skip over the rest of the word consistent of only alphanumerics */
      for (; (i < es->lastchar) && iswalnum(es->wbuf[i]); i++)
        ; // do nothing
    }
    else
    {
      i++; // skip over one non-alphanumeric character
    }
  }
 
  wmemmove(es->wbuf + es->curpos, es->wbuf + i, es->lastchar - i);
  es->lastchar += es->curpos - i;
  return FR_SUCCESS;
}

Here is the caller graph for this function:

editor_kill_line()

int editor_kill_line

(

struct EnterState *

es

)

Delete chars from cursor to beginning the line.

Parameters

es	State of the Enter buffer

Return values

FR_SUCCESS	Characters deleted
FR_ERROR	Error

Definition at line 290 of file enter.c.

{
  if (!es)
    return FR_ERROR;
 
  size_t len = es->lastchar - es->curpos;
 
  wmemmove(es->wbuf, es->wbuf + es->curpos, len);
 
  es->lastchar = len;
  es->curpos = 0;
 
  return FR_SUCCESS;
}

Here is the caller graph for this function:

editor_kill_whole_line()

int editor_kill_whole_line

(

struct EnterState *

es

)

Delete all chars on the line.

Parameters

es	State of the Enter buffer

Return values

FR_SUCCESS	Characters deleted
FR_ERROR	Error

Definition at line 311 of file enter.c.

{
  if (!es)
    return FR_ERROR;
 
  es->lastchar = 0;
  es->curpos = 0;
 
  return FR_SUCCESS;
}

Here is the caller graph for this function:

editor_kill_word()

int editor_kill_word

(

struct EnterState *

es

)

Delete the word in front of the cursor.

Parameters

es	State of the Enter buffer

Return values

FR_SUCCESS	Characters deleted
FR_ERROR	Failed, cursor was at the start of the buffer

Definition at line 328 of file enter.c.

{
  if (!es || (es->curpos == 0))
    return FR_ERROR;
 
  size_t i = es->curpos;
  while (i && iswspace(es->wbuf[i - 1]))
    i--;
  if (i > 0)
  {
    if (iswalnum(es->wbuf[i - 1]))
    {
      for (--i; (i > 0) && iswalnum(es->wbuf[i - 1]); i--)
        ; // do nothing
    }
    else
    {
      i--;
    }
  }
  wmemmove(es->wbuf + i, es->wbuf + es->curpos, es->lastchar - es->curpos);
  es->lastchar += i - es->curpos;
  es->curpos = i;
 
  return FR_SUCCESS;
}

Here is the caller graph for this function:

editor_transpose_chars()

int editor_transpose_chars

(

struct EnterState *

es

)

Transpose character under cursor with previous.

Parameters

es	State of the Enter buffer

Return values

FR_SUCCESS	Characters switched
FR_ERROR	Failed, too few characters

Definition at line 361 of file enter.c.

{
  if (!es || (es->lastchar < 2))
    return FR_ERROR;
 
  if (es->curpos == 0)
    es->curpos = 2;
  else if (es->curpos < es->lastchar)
    es->curpos++;
 
  wchar_t wc = es->wbuf[es->curpos - 2];
  es->wbuf[es->curpos - 2] = es->wbuf[es->curpos - 1];
  es->wbuf[es->curpos - 1] = wc;
 
  return FR_SUCCESS;
}

Here is the caller graph for this function:

editor_buffer_is_empty()

bool editor_buffer_is_empty

(

struct EnterState *

es

)

Is the Enter buffer empty?

Parameters

es	State of the Enter buffer

Return values

true	If buffer is empty

Definition at line 385 of file enter.c.

{
  if (!es)
    return true;
 
  return (es->lastchar == 0);
}

Here is the caller graph for this function: