masscollaborationlabs/emacs
2
0
Fork 0
mirror of https://github.com/masscollaborationlabs/emacs.git synced 2025-07-03 10:53:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
emacs/src/textconv.c

1839 lines
47 KiB
C
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/* String conversion support for graphics terminals.
Copyright (C) 2023 Free Software Foundation, Inc.
This file is part of GNU Emacs.
GNU Emacs 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 3 of the License, or (at
your option) any later version.
GNU Emacs 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 GNU Emacs. If not, see <https://www.gnu.org/licenses/>. */
/* String conversion support.
Many input methods require access to text surrounding the cursor.
They may then request that the text editor remove or substitute
that text for something else, for example when providing the
ability to ``undo'' or ``edit'' previously composed text. This is
most commonly seen in input methods for CJK laguages for X Windows,
and is extensively used throughout Android by input methods for all
kinds of scripts.
In addition, these input methods may also need to make detailed
edits to the content of a buffer. That is also handled here. */
#include <config.h>
#include "textconv.h"
#include "buffer.h"
#include "syntax.h"
#include "blockinput.h"
/* The window system's text conversion interface. NULL when the
window system has not set up text conversion. */
static struct textconv_interface *text_interface;
/* How many times text conversion has been disabled. */
static int suppress_conversion_count;
/* Flags used to determine what must be sent after a batch edit
ends. */
enum textconv_batch_edit_flags
{
PENDING_POINT_CHANGE = 1,
PENDING_COMPOSE_CHANGE = 2,
};
/* Copy the portion of the current buffer described by BEG, BEG_BYTE,
END, END_BYTE to the buffer BUFFER, which is END_BYTE - BEG_BYTEs
long. */
static void
copy_buffer (ptrdiff_t beg, ptrdiff_t beg_byte,
ptrdiff_t end, ptrdiff_t end_byte,
char *buffer)
{
ptrdiff_t beg0, end0, beg1, end1, size;
if (beg_byte < GPT_BYTE && GPT_BYTE < end_byte)
{
/* Two regions, before and after the gap. */
beg0 = beg_byte;
end0 = GPT_BYTE;
beg1 = GPT_BYTE + GAP_SIZE - BEG_BYTE;
end1 = end_byte + GAP_SIZE - BEG_BYTE;
}
else
{
/* The only region. */
beg0 = beg_byte;
end0 = end_byte;
beg1 = -1;
end1 = -1;
}
size = end0 - beg0;
memcpy (buffer, BYTE_POS_ADDR (beg0), size);
if (beg1 != -1)
memcpy (buffer + size, BEG_ADDR + beg1, end1 - beg1);
}
/* Conversion query. */
/* Return the position of the active mark, or -1 if there is no mark
or it is not active. */
static ptrdiff_t
get_mark (void)
{
if (!NILP (BVAR (current_buffer, mark_active))
&& XMARKER (BVAR (current_buffer, mark))->buffer)
return marker_position (BVAR (current_buffer,
mark));
return -1;
}
/* Like Fselect_window. However, if WINDOW is a mini buffer window
but not the active minibuffer window, select its frame's selected
window instead. */
static void
select_window (Lisp_Object window, Lisp_Object norecord)
{
struct window *w;
w = XWINDOW (window);
if (MINI_WINDOW_P (w)
&& WINDOW_LIVE_P (window)
&& !EQ (window, Factive_minibuffer_window ()))
window = WINDOW_XFRAME (w)->selected_window;
Fselect_window (window, norecord);
}
/* Perform the text conversion operation specified in QUERY and return
the results.
Find the text between QUERY->position from point on F's selected
window and QUERY->factor times QUERY->direction from that
position. Return it in QUERY->text.
If QUERY->position is TYPE_MINIMUM (EMACS_INT) or EMACS_INT_MAX,
start at the window's last point or mark, whichever is greater or
smaller.
Then, either delete that text from the buffer if QUERY->operation
is TEXTCONV_SUBSTITUTION, or return 0.
If FLAGS & TEXTCONV_SKIP_CONVERSION_REGION, then first move PT past
the conversion region in the specified direction if it is inside.
Value is 0 if QUERY->operation was not TEXTCONV_SUBSTITUTION
or if deleting the text was successful, and 1 otherwise. */
int
textconv_query (struct frame *f, struct textconv_callback_struct *query,
int flags)
{
specpdl_ref count;
ptrdiff_t pos, pos_byte, end, end_byte, start;
ptrdiff_t temp, temp1, mark;
char *buffer;
struct window *w;
/* Save the excursion, as there will be extensive changes to the
selected window. */
count = SPECPDL_INDEX ();
record_unwind_protect_excursion ();
/* Inhibit quitting. */
specbind (Qinhibit_quit, Qt);
/* Temporarily switch to F's selected window at the time of the last
redisplay. */
select_window ((WINDOW_LIVE_P (f->old_selected_window)
? f->old_selected_window
: f->selected_window), Qt);
w = XWINDOW (selected_window);
/* Now find the appropriate text bounds for QUERY. First, move
point QUERY->position steps forward or backwards. */
pos = PT;
/* If QUERY->position is EMACS_INT_MAX, use the last mark or the
ephemeral last point, whichever is greater.
The opposite applies for EMACS_INT_MIN. */
mark = get_mark ();
if (query->position == EMACS_INT_MAX)
{
pos = (mark == -1
? w->ephemeral_last_point
: max (w->ephemeral_last_point, mark));
goto escape1;
}
else if (query->position == TYPE_MINIMUM (EMACS_INT))
{
pos = (mark == -1
? w->ephemeral_last_point
: min (w->ephemeral_last_point, mark));
goto escape1;
}
/* Next, if POS lies within the conversion region and the caller
asked for it to be moved away, move it away from the conversion
region. */
if (flags & TEXTCONV_SKIP_CONVERSION_REGION
&& MARKERP (f->conversion.compose_region_start))
{
start = marker_position (f->conversion.compose_region_start);
end = marker_position (f->conversion.compose_region_end);
if (pos >= start && pos < end)
{
switch (query->direction)
{
case TEXTCONV_FORWARD_CHAR:
case TEXTCONV_FORWARD_WORD:
case TEXTCONV_CARET_DOWN:
case TEXTCONV_NEXT_LINE:
case TEXTCONV_LINE_START:
pos = end;
break;
default:
pos = max (BEGV, start - 1);
break;
}
}
}
/* If pos is outside the accessible part of the buffer or if it
overflows, move back to point or to the extremes of the
accessible region. */
if (ckd_add (&pos, pos, query->position))
pos = PT;
escape1:
if (pos < BEGV)
pos = BEGV;
if (pos > ZV)
pos = ZV;
/* Move to pos. */
set_point (pos);
pos = PT;
pos_byte = PT_BYTE;
/* Now scan forward or backwards according to what is in QUERY. */
switch (query->direction)
{
case TEXTCONV_FORWARD_CHAR:
/* Move forward by query->factor characters. */
if (ckd_add (&end, pos, query->factor) || end > ZV)
end = ZV;
end_byte = CHAR_TO_BYTE (end);
break;
case TEXTCONV_BACKWARD_CHAR:
/* Move backward by query->factor characters. */
if (ckd_sub (&end, pos, query->factor) || end < BEGV)
end = BEGV;
end_byte = CHAR_TO_BYTE (end);
break;
case TEXTCONV_FORWARD_WORD:
/* Move forward by query->factor word. */
end = scan_words (pos, (EMACS_INT) query->factor);
if (!end)
{
end = ZV;
end_byte = ZV_BYTE;
}
else
end_byte = CHAR_TO_BYTE (end);
break;
case TEXTCONV_BACKWARD_WORD:
/* Move backwards by query->factor word. */
end = scan_words (pos, 0 - (EMACS_INT) query->factor);
if (!end)
{
end = BEGV;
end_byte = BEGV_BYTE;
}
else
end_byte = CHAR_TO_BYTE (end);
break;
case TEXTCONV_CARET_UP:
/* Move upwards one visual line, keeping the column intact. */
Fvertical_motion (Fcons (Fcurrent_column (), make_fixnum (-1)),
Qnil, Qnil);
end = PT;
end_byte = PT_BYTE;
break;
case TEXTCONV_CARET_DOWN:
/* Move downwards one visual line, keeping the column
intact. */
Fvertical_motion (Fcons (Fcurrent_column (), make_fixnum (1)),
Qnil, Qnil);
end = PT;
end_byte = PT_BYTE;
break;
case TEXTCONV_NEXT_LINE:
/* Move one line forward. */
scan_newline (pos, pos_byte, ZV, ZV_BYTE,
query->factor, false);
end = PT;
end_byte = PT_BYTE;
break;
case TEXTCONV_PREVIOUS_LINE:
/* Move one line backwards. */
scan_newline (pos, pos_byte, BEGV, BEGV_BYTE,
0 - (EMACS_INT) query->factor, false);
end = PT;
end_byte = PT_BYTE;
break;
case TEXTCONV_LINE_START:
/* Move to the beginning of the line. */
Fbeginning_of_line (Qnil);
end = PT;
end_byte = PT_BYTE;
break;
case TEXTCONV_LINE_END:
/* Move to the end of the line. */
Fend_of_line (Qnil);
end = PT;
end_byte = PT_BYTE;
break;
case TEXTCONV_ABSOLUTE_POSITION:
/* How to implement this is unclear. */
SET_PT (query->factor);
end = PT;
end_byte = PT_BYTE;
break;
default:
unbind_to (count, Qnil);
return 1;
}
/* Sort end and pos. */
if (end < pos)
{
eassert (end_byte < pos_byte);
temp = pos_byte;
temp1 = pos;
pos_byte = end_byte;
pos = end;
end = temp1;
end_byte = temp;
}
/* Return the string first. */
buffer = xmalloc (end_byte - pos_byte);
copy_buffer (pos, pos_byte, end, end_byte, buffer);
query->text.text = buffer;
query->text.length = end - pos;
query->text.bytes = end_byte - pos_byte;
/* Next, perform any operation specified. */
switch (query->operation)
{
case TEXTCONV_SUBSTITUTION:
if (safe_del_range (pos, end))
{
/* Undo any changes to the excursion. */
unbind_to (count, Qnil);
return 1;
}
default:
break;
}
/* Undo any changes to the excursion. */
unbind_to (count, Qnil);
return 0;
}
/* Update the overlay displaying the conversion area on F after a
change to the conversion region. */
static void
sync_overlay (struct frame *f)
{
if (MARKERP (f->conversion.compose_region_start)
&& !NILP (Vtext_conversion_face))
{
if (NILP (f->conversion.compose_region_overlay))
{
f->conversion.compose_region_overlay
= Fmake_overlay (f->conversion.compose_region_start,
f->conversion.compose_region_end, Qnil,
Qt, Qnil);
Foverlay_put (f->conversion.compose_region_overlay,
Qface, Vtext_conversion_face);
}
Fmove_overlay (f->conversion.compose_region_overlay,
f->conversion.compose_region_start,
f->conversion.compose_region_end, Qnil);
}
else if (!NILP (f->conversion.compose_region_overlay))
{
Fdelete_overlay (f->conversion.compose_region_overlay);
f->conversion.compose_region_overlay = Qnil;
}
}
/* Record a change to the current buffer as a result of an
asynchronous text conversion operation on F.
Consult the doc string of `text-conversion-edits' for the meaning
of BEG, END, and EPHEMERAL. */
static void
record_buffer_change (ptrdiff_t beg, ptrdiff_t end,
Lisp_Object ephemeral)
{
Lisp_Object buffer, beg_marker, end_marker;
XSETBUFFER (buffer, current_buffer);
/* Make markers for both BEG and END. */
beg_marker = build_marker (current_buffer, beg,
CHAR_TO_BYTE (beg));
/* If BEG and END are identical, make sure to keep the markers
eq. */
if (beg == end)
end_marker = beg_marker;
else
{
end_marker = build_marker (current_buffer, end,
CHAR_TO_BYTE (end));
/* Otherwise, make sure the marker extends past inserted
text. */
Fset_marker_insertion_type (end_marker, Qt);
}
Vtext_conversion_edits
= Fcons (list4 (buffer, beg_marker, end_marker,
ephemeral),
Vtext_conversion_edits);
}
/* Reset F's text conversion state. Delete any overlays or
markers inside. */
void
reset_frame_state (struct frame *f)
{
struct text_conversion_action *last, *next;
/* Make the composition region markers point elsewhere. */
if (!NILP (f->conversion.compose_region_start))
{
Fset_marker (f->conversion.compose_region_start, Qnil, Qnil);
Fset_marker (f->conversion.compose_region_end, Qnil, Qnil);
f->conversion.compose_region_start = Qnil;
f->conversion.compose_region_end = Qnil;
}
/* Delete the composition region overlay. */
if (!NILP (f->conversion.compose_region_overlay))
Fdelete_overlay (f->conversion.compose_region_overlay);
/* Delete each text conversion action queued up. */
next = f->conversion.actions;
while (next)
{
last = next;
next = next->next;
/* Say that the conversion is finished. */
if (text_interface && text_interface->notify_conversion)
text_interface->notify_conversion (last->counter);
xfree (last);
}
f->conversion.actions = NULL;
/* Clear batch edit state. */
f->conversion.batch_edit_count = 0;
f->conversion.batch_edit_flags = 0;
}
/* Return whether or not there are pending edits from an input method
on any frame. */
bool
detect_conversion_events (void)
{
Lisp_Object tail, frame;
FOR_EACH_FRAME (tail, frame)
{
if (XFRAME (frame)->conversion.actions)
return true;
}
return false;
}
/* Restore the selected window WINDOW. */
static void
restore_selected_window (Lisp_Object window)
{
/* FIXME: not sure what to do if WINDOW has been deleted. */
select_window (window, Qt);
}
/* Commit the given text in the composing region. If there is no
composing region, then insert the text after F's selected window's
last point instead. Finally, remove the composing region.
Then, move point to POSITION relative to TEXT. If POSITION is
greater than zero, it is relative to the character at the end of
TEXT; otherwise, it is relative to the start of TEXT. */
static void
really_commit_text (struct frame *f, EMACS_INT position,
Lisp_Object text)
{
specpdl_ref count;
ptrdiff_t wanted, start, end;
struct window *w;
/* If F's old selected window is no longer live, fail. */
if (!WINDOW_LIVE_P (f->old_selected_window))
return;
count = SPECPDL_INDEX ();
record_unwind_protect (restore_selected_window,
selected_window);
/* Temporarily switch to F's selected window at the time of the last
redisplay. */
select_window (f->old_selected_window, Qt);
/* Now detect whether or not there is a composing region.
If there is, then replace it with TEXT. Don't do that
otherwise. */
if (MARKERP (f->conversion.compose_region_start))
{
/* Replace its contents. */
start = marker_position (f->conversion.compose_region_start);
end = marker_position (f->conversion.compose_region_end);
del_range (start, end);
record_buffer_change (start, start, Qnil);
Finsert (1, &text);
record_buffer_change (start, PT, text);
/* Move to a the position specified in POSITION. If POSITION is
less than zero, it is relative to the start of the text that
was inserted. */
if (position <= 0)
{
wanted
= marker_position (f->conversion.compose_region_start);
if (INT_ADD_WRAPV (wanted, position, &wanted)
|| wanted < BEGV)
wanted = BEGV;
if (wanted > ZV)
wanted = ZV;
set_point (wanted);
}
else
{
/* Otherwise, it is relative to the last character in
TEXT. */
wanted
= marker_position (f->conversion.compose_region_end);
if (INT_ADD_WRAPV (wanted, position - 1, &wanted)
|| wanted > ZV)
wanted = ZV;
if (wanted < BEGV)
wanted = BEGV;
set_point (wanted);
}
/* Make the composition region markers point elsewhere. */
if (!NILP (f->conversion.compose_region_start))
{
Fset_marker (f->conversion.compose_region_start, Qnil, Qnil);
Fset_marker (f->conversion.compose_region_end, Qnil, Qnil);
f->conversion.compose_region_start = Qnil;
f->conversion.compose_region_end = Qnil;
}
/* Delete the composition region overlay. */
if (!NILP (f->conversion.compose_region_overlay))
Fdelete_overlay (f->conversion.compose_region_overlay);
}
else
{
/* Otherwise, move the text and point to an appropriate
location. */
wanted = PT;
Finsert (1, &text);
record_buffer_change (wanted, PT, text);
if (position <= 0)
{
if (INT_ADD_WRAPV (wanted, position, &wanted)
|| wanted < BEGV)
wanted = BEGV;
if (wanted > ZV)
wanted = ZV;
set_point (wanted);
}
else
{
wanted = PT;
if (INT_ADD_WRAPV (wanted, position - 1, &wanted)
|| wanted > ZV)
wanted = ZV;
if (wanted < BEGV)
wanted = BEGV;
set_point (wanted);
}
}
/* This should deactivate the mark. */
call0 (Qdeactivate_mark);
/* Update the ephemeral last point. */
w = XWINDOW (selected_window);
w->ephemeral_last_point = PT;
unbind_to (count, Qnil);
}
/* Remove the composition region on the frame F, while leaving its
contents intact. */
static void
really_finish_composing_text (struct frame *f)
{
if (!NILP (f->conversion.compose_region_start))
{
Fset_marker (f->conversion.compose_region_start, Qnil, Qnil);
Fset_marker (f->conversion.compose_region_end, Qnil, Qnil);
f->conversion.compose_region_start = Qnil;
f->conversion.compose_region_end = Qnil;
}
/* Delete the composition region overlay. */
if (!NILP (f->conversion.compose_region_overlay))
Fdelete_overlay (f->conversion.compose_region_overlay);
}
/* Set the composing text on F to TEXT. Then, move point to an
appropriate position relative to POSITION, and call
`compose_region_changed' in the text conversion interface should
point not have been changed relative to F's old selected window's
last point. */
static void
really_set_composing_text (struct frame *f, ptrdiff_t position,
Lisp_Object text)
{
specpdl_ref count;
ptrdiff_t start, wanted, end;
struct window *w;
/* If F's old selected window is no longer live, fail. */
if (!WINDOW_LIVE_P (f->old_selected_window))
return;
count = SPECPDL_INDEX ();
record_unwind_protect (restore_selected_window,
selected_window);
/* Temporarily switch to F's selected window at the time of the last
redisplay. */
w = XWINDOW (f->old_selected_window);
select_window (f->old_selected_window, Qt);
/* Now set up the composition region if necessary. */
if (!MARKERP (f->conversion.compose_region_start))
{
f->conversion.compose_region_start
= build_marker (current_buffer, PT, PT_BYTE);
f->conversion.compose_region_end
= build_marker (current_buffer, PT, PT_BYTE);
Fset_marker_insertion_type (f->conversion.compose_region_end,
Qt);
start = position;
}
else
{
/* Delete the text between the start of the composing region and
its end. */
start = marker_position (f->conversion.compose_region_start);
end = marker_position (f->conversion.compose_region_end);
del_range (start, end);
set_point (start);
if (start != end)
record_buffer_change (start, start, Qnil);
}
/* Insert the new text. */
Finsert (1, &text);
if (start != PT)
record_buffer_change (start, PT, Qnil);
/* Now move point to an appropriate location. */
if (position < 0)
{
wanted = start;
if (INT_SUBTRACT_WRAPV (wanted, position, &wanted)
|| wanted < BEGV)
wanted = BEGV;
if (wanted > ZV)
wanted = ZV;
}
else
{
end = marker_position (f->conversion.compose_region_end);
wanted = end;
/* end should be PT after the edit. */
eassert (end == PT);
if (INT_ADD_WRAPV (wanted, position - 1, &wanted)
|| wanted > ZV)
wanted = ZV;
if (wanted < BEGV)
wanted = BEGV;
}
set_point (wanted);
/* This should deactivate the mark. */
call0 (Qdeactivate_mark);
/* Move the composition overlay. */
sync_overlay (f);
/* If PT hasn't changed, the conversion region definitely has.
Otherwise, redisplay will update the input method instead. */
if (PT == w->ephemeral_last_point
&& text_interface
&& text_interface->compose_region_changed)
{
if (f->conversion.batch_edit_count > 0)
f->conversion.batch_edit_flags |= PENDING_COMPOSE_CHANGE;
else
text_interface->compose_region_changed (f);
}
/* Update the ephemeral last point. */
w = XWINDOW (selected_window);
w->ephemeral_last_point = PT;
unbind_to (count, Qnil);
}
/* Set the composing region to START by END. Make it that it is not
already set. */
static void
really_set_composing_region (struct frame *f, ptrdiff_t start,
ptrdiff_t end)
{
specpdl_ref count;
struct window *w;
/* If F's old selected window is no longer live, fail. */
if (!WINDOW_LIVE_P (f->old_selected_window))
return;
/* If MAX (0, start) == end, then this should behave the same as
really_finish_composing_text. */
if (max (0, start) == max (0, end))
{
really_finish_composing_text (f);
return;
}
count = SPECPDL_INDEX ();
record_unwind_protect (restore_selected_window,
selected_window);
/* Temporarily switch to F's selected window at the time of the last
redisplay. */
select_window (f->old_selected_window, Qt);
/* Now set up the composition region if necessary. */
if (!MARKERP (f->conversion.compose_region_start))
{
f->conversion.compose_region_start = Fmake_marker ();
f->conversion.compose_region_end = Fmake_marker ();
Fset_marker_insertion_type (f->conversion.compose_region_end,
Qt);
}
Fset_marker (f->conversion.compose_region_start,
make_fixnum (start), Qnil);
Fset_marker (f->conversion.compose_region_end,
make_fixnum (end), Qnil);
sync_overlay (f);
/* Update the ephemeral last point. */
w = XWINDOW (selected_window);
w->ephemeral_last_point = PT;
unbind_to (count, Qnil);
}
/* Delete LEFT and RIGHT chars around point or the active mark,
whichever is larger, avoiding the composing region if
necessary. */
static void
really_delete_surrounding_text (struct frame *f, ptrdiff_t left,
ptrdiff_t right)
{
specpdl_ref count;
ptrdiff_t start, end, a, b, a1, b1, lstart, rstart;
struct window *w;
Lisp_Object text;
/* If F's old selected window is no longer live, fail. */
if (!WINDOW_LIVE_P (f->old_selected_window))
return;
count = SPECPDL_INDEX ();
record_unwind_protect (restore_selected_window,
selected_window);
/* Temporarily switch to F's selected window at the time of the last
redisplay. */
select_window (f->old_selected_window, Qt);
/* Figure out where to start deleting from. */
a = get_mark ();
if (a != -1 && a != PT)
lstart = rstart = max (a, PT);
else
lstart = rstart = PT;
/* Avoid the composing text. This behavior is identical to how
Android's BaseInputConnection actually implements avoiding the
composing span. */
if (MARKERP (f->conversion.compose_region_start))
{
a = marker_position (f->conversion.compose_region_start);
b = marker_position (f->conversion.compose_region_end);
a1 = min (a, b);
b1 = max (a, b);
lstart = min (lstart, min (PT, a1));
rstart = max (rstart, max (PT, b1));
}
if (lstart == rstart)
{
start = max (BEGV, lstart - left);
end = min (ZV, rstart + right);
text = del_range_1 (start, end, false, true);
record_buffer_change (start, start, text);
}
else
{
/* Don't record a deletion if the text which was deleted lies
after point. */
start = rstart;
end = min (ZV, rstart + right);
text = del_range_1 (start, end, false, true);
record_buffer_change (start, start, Qnil);
/* Now delete what must be deleted on the left. */
start = max (BEGV, lstart - left);
end = lstart;
text = del_range_1 (start, end, false, true);
record_buffer_change (start, start, text);
}
/* if the mark is now equal to start, deactivate it. */
if (get_mark () == PT)
call0 (Qdeactivate_mark);
/* Update the ephemeral last point. */
w = XWINDOW (selected_window);
w->ephemeral_last_point = PT;
unbind_to (count, Qnil);
}
/* Update the interface with F's new point and mark. If a batch edit
is in progress, schedule the update for when it finishes
instead. */
static void
really_request_point_update (struct frame *f)
{
/* If F's old selected window is no longer live, fail. */
if (!WINDOW_LIVE_P (f->old_selected_window))
return;
if (f->conversion.batch_edit_count > 0)
f->conversion.batch_edit_flags |= PENDING_POINT_CHANGE;
else if (text_interface && text_interface->point_changed)
text_interface->point_changed (f,
XWINDOW (f->old_selected_window),
current_buffer);
}
/* Set point in F to POSITION. If MARK is not POSITION, activate the
mark and set MARK to that as well.
If it has not changed, signal an update through the text input
interface, which is necessary for the IME to acknowledge that the
change has completed. */
static void
really_set_point_and_mark (struct frame *f, ptrdiff_t point,
ptrdiff_t mark)
{
specpdl_ref count;
struct window *w;
/* If F's old selected window is no longer live, fail. */
if (!WINDOW_LIVE_P (f->old_selected_window))
return;
count = SPECPDL_INDEX ();
record_unwind_protect (restore_selected_window,
selected_window);
/* Temporarily switch to F's selected window at the time of the last
redisplay. */
select_window (f->old_selected_window, Qt);
if (point == PT)
{
if (f->conversion.batch_edit_count > 0)
f->conversion.batch_edit_flags |= PENDING_POINT_CHANGE;
else if (text_interface && text_interface->point_changed)
text_interface->point_changed (f,
XWINDOW (f->old_selected_window),
current_buffer);
}
else
/* Set the point. */
Fgoto_char (make_fixnum (point));
if (mark == point && BVAR (current_buffer, mark_active))
call0 (Qdeactivate_mark);
else
call1 (Qpush_mark, make_fixnum (mark));
/* Update the ephemeral last point. */
w = XWINDOW (selected_window);
w->ephemeral_last_point = PT;
unbind_to (count, Qnil);
}
/* Complete the edit specified by the counter value inside *TOKEN. */
static void
complete_edit (void *token)
{
if (text_interface && text_interface->notify_conversion)
text_interface->notify_conversion (*(unsigned long *) token);
}
/* Context for complete_edit_check. */
struct complete_edit_check_context
{
/* The window. */
struct window *w;
/* Whether or not editing was successful. */
bool check;
};
/* If CONTEXT->check is false, then update W's ephemeral last point
and give it to the input method, the assumption being that an
editing operation signalled. */
static void
complete_edit_check (void *ptr)
{
struct complete_edit_check_context *context;
struct frame *f;
context = ptr;
if (!context->check)
{
/* Figure out the new position of point. */
context->w->ephemeral_last_point
= window_point (context->w);
/* See if the frame is still alive. */
f = WINDOW_XFRAME (context->w);
if (!FRAME_LIVE_P (f))
return;
if (text_interface && text_interface->point_changed)
{
if (f->conversion.batch_edit_count > 0)
f->conversion.batch_edit_flags |= PENDING_POINT_CHANGE;
else
text_interface->point_changed (f, context->w, NULL);
}
}
}
/* Process and free the text conversion ACTION. F must be the frame
on which ACTION will be performed.
Value is the window which was used, or NULL. */
static struct window *
handle_pending_conversion_events_1 (struct frame *f,
struct text_conversion_action *action)
{
Lisp_Object data;
enum text_conversion_operation operation;
struct buffer *buffer UNINIT;
struct window *w;
specpdl_ref count;
unsigned long token;
struct complete_edit_check_context context;
/* Next, process this action and free it. */
data = action->data;
operation = action->operation;
token = action->counter;
xfree (action);
/* Text conversion events can still arrive immediately after
`conversion_disabled_p' becomes true. In that case, process all
events, but don't perform any associated actions. */
if (conversion_disabled_p ())
return NULL;
/* check is a flag used by complete_edit_check to determine whether
or not the editing operation completed successfully. */
context.check = false;
/* Make sure completion is signalled. */
count = SPECPDL_INDEX ();
record_unwind_protect_ptr (complete_edit, &token);
w = NULL;
if (WINDOW_LIVE_P (f->old_selected_window))
{
w = XWINDOW (f->old_selected_window);
buffer = XBUFFER (WINDOW_BUFFER (w));
context.w = w;
/* Notify the input method of any editing failures. */
record_unwind_protect_ptr (complete_edit_check, &context);
}
switch (operation)
{
case TEXTCONV_START_BATCH_EDIT:
f->conversion.batch_edit_count++;
break;
case TEXTCONV_END_BATCH_EDIT:
if (f->conversion.batch_edit_count > 0)
f->conversion.batch_edit_count--;
if (!WINDOW_LIVE_P (f->old_selected_window))
break;
if (f->conversion.batch_edit_flags & PENDING_POINT_CHANGE)
text_interface->point_changed (f, w, buffer);
if (f->conversion.batch_edit_flags & PENDING_COMPOSE_CHANGE)
text_interface->compose_region_changed (f);
f->conversion.batch_edit_flags = 0;
break;
case TEXTCONV_COMMIT_TEXT:
really_commit_text (f, XFIXNUM (XCAR (data)), XCDR (data));
break;
case TEXTCONV_FINISH_COMPOSING_TEXT:
really_finish_composing_text (f);
break;
case TEXTCONV_SET_COMPOSING_TEXT:
really_set_composing_text (f, XFIXNUM (XCAR (data)),
XCDR (data));
break;
case TEXTCONV_SET_COMPOSING_REGION:
really_set_composing_region (f, XFIXNUM (XCAR (data)),
XFIXNUM (XCDR (data)));
break;
case TEXTCONV_SET_POINT_AND_MARK:
really_set_point_and_mark (f, XFIXNUM (XCAR (data)),
XFIXNUM (XCDR (data)));
break;
case TEXTCONV_DELETE_SURROUNDING_TEXT:
really_delete_surrounding_text (f, XFIXNUM (XCAR (data)),
XFIXNUM (XCDR (data)));
break;
case TEXTCONV_REQUEST_POINT_UPDATE:
really_request_point_update (f);
break;
}
/* Signal success. */
context.check = true;
unbind_to (count, Qnil);
return w;
}
/* Decrement the variable pointed to by *PTR. */
static void
decrement_inside (void *ptr)
{
int *i;
i = ptr;
(*i)--;
}
/* Process any outstanding text conversion events.
This may run Lisp or signal. */
void
handle_pending_conversion_events (void)
{
struct frame *f;
Lisp_Object tail, frame;
struct text_conversion_action *action, *next;
bool handled;
static int inside;
specpdl_ref count;
ptrdiff_t last_point;
struct window *w;
handled = false;
/* Reset Vtext_conversion_edits. Do not do this if called
reentrantly. */
if (!inside)
Vtext_conversion_edits = Qnil;
inside++;
last_point = -1;
w = NULL;
count = SPECPDL_INDEX ();
record_unwind_protect_ptr (decrement_inside, &inside);
FOR_EACH_FRAME (tail, frame)
{
f = XFRAME (frame);
/* Test if F has any outstanding conversion events. Then
process them in bottom to up order. */
while (true)
{
/* Update the input method if handled &&
w->ephemeral_last_point != last_point. */
if (w && (last_point != w->ephemeral_last_point))
{
if (handled
&& last_point != -1
&& text_interface
&& text_interface->point_changed)
{
if (f->conversion.batch_edit_count > 0)
f->conversion.batch_edit_flags |= PENDING_POINT_CHANGE;
else
text_interface->point_changed (f, NULL, NULL);
}
last_point = w->ephemeral_last_point;
}
/* Reload action. This needs to be reentrant as buffer
modification functions can call `read-char'. */
action = f->conversion.actions;
/* If there are no more actions, break. */
if (!action)
break;
/* Unlink this action. */
next = action->next;
f->conversion.actions = next;
/* Handle and free the action. */
w = handle_pending_conversion_events_1 (f, action);
handled = true;
}
}
unbind_to (count, Qnil);
}
/* Start a ``batch edit'' in F. During a batch edit, point_changed
will not be called until the batch edit ends.
Process the actual operation in the event loop in keyboard.c; then,
call `notify_conversion' in the text conversion interface with
COUNTER. */
void
start_batch_edit (struct frame *f, unsigned long counter)
{
struct text_conversion_action *action, **last;
action = xmalloc (sizeof *action);
action->operation = TEXTCONV_START_BATCH_EDIT;
action->data = Qnil;
action->next = NULL;
action->counter = counter;
for (last = &f->conversion.actions; *last; last = &(*last)->next)
;;
*last = action;
input_pending = true;
}
/* End a ``batch edit''. It is ok to call this function even if a
batch edit has not yet started, in which case it does nothing.
COUNTER means the same as in `start_batch_edit'. */
void
end_batch_edit (struct frame *f, unsigned long counter)
{
struct text_conversion_action *action, **last;
action = xmalloc (sizeof *action);
action->operation = TEXTCONV_END_BATCH_EDIT;
action->data = Qnil;
action->next = NULL;
action->counter = counter;
for (last = &f->conversion.actions; *last; last = &(*last)->next)
;;
*last = action;
input_pending = true;
}
/* Insert the specified STRING into F's current buffer's composition
region, and set point to POSITION relative to STRING.
COUNTER means the same as in `start_batch_edit'. */
void
commit_text (struct frame *f, Lisp_Object string,
ptrdiff_t position, unsigned long counter)
{
struct text_conversion_action *action, **last;
action = xmalloc (sizeof *action);
action->operation = TEXTCONV_COMMIT_TEXT;
action->data = Fcons (make_fixnum (position), string);
action->next = NULL;
action->counter = counter;
for (last = &f->conversion.actions; *last; last = &(*last)->next)
;;
*last = action;
input_pending = true;
}
/* Remove the composition region and its overlay from F's current
buffer. Leave the text being composed intact.
COUNTER means the same as in `start_batch_edit'. */
void
finish_composing_text (struct frame *f, unsigned long counter)
{
struct text_conversion_action *action, **last;
action = xmalloc (sizeof *action);
action->operation = TEXTCONV_FINISH_COMPOSING_TEXT;
action->data = Qnil;
action->next = NULL;
action->counter = counter;
for (last = &f->conversion.actions; *last; last = &(*last)->next)
;;
*last = action;
input_pending = true;
}
/* Insert the given STRING and make it the currently active
composition.
If there is currently no composing region, then the new value of
point is used as the composing region.
Then, the composing region is replaced with the text in the
specified string.
Finally, move point to new_point, which is relative to either the
start or the end of OBJECT depending on whether or not it is less
than zero.
COUNTER means the same as in `start_batch_edit'. */
void
set_composing_text (struct frame *f, Lisp_Object object,
ptrdiff_t new_point, unsigned long counter)
{
struct text_conversion_action *action, **last;
action = xmalloc (sizeof *action);
action->operation = TEXTCONV_SET_COMPOSING_TEXT;
action->data = Fcons (make_fixnum (new_point),
object);
action->next = NULL;
action->counter = counter;
for (last = &f->conversion.actions; *last; last = &(*last)->next)
;;
*last = action;
input_pending = true;
}
/* Make the region between START and END the currently active
``composing region''.
The ``composing region'' is a region of text in the buffer that is
about to undergo editing by the input method. */
void
set_composing_region (struct frame *f, ptrdiff_t start,
ptrdiff_t end, unsigned long counter)
{
struct text_conversion_action *action, **last;
if (start > MOST_POSITIVE_FIXNUM)
start = MOST_POSITIVE_FIXNUM;
if (end > MOST_POSITIVE_FIXNUM)
end = MOST_POSITIVE_FIXNUM;
action = xmalloc (sizeof *action);
action->operation = TEXTCONV_SET_COMPOSING_REGION;
action->data = Fcons (make_fixnum (start),
make_fixnum (end));
action->next = NULL;
action->counter = counter;
for (last = &f->conversion.actions; *last; last = &(*last)->next)
;;
*last = action;
input_pending = true;
}
/* Move point in F's selected buffer to POINT and maybe push MARK.
COUNTER means the same as in `start_batch_edit'. */
void
textconv_set_point_and_mark (struct frame *f, ptrdiff_t point,
ptrdiff_t mark, unsigned long counter)
{
struct text_conversion_action *action, **last;
if (point > MOST_POSITIVE_FIXNUM)
point = MOST_POSITIVE_FIXNUM;
action = xmalloc (sizeof *action);
action->operation = TEXTCONV_SET_POINT_AND_MARK;
action->data = Fcons (make_fixnum (point),
make_fixnum (mark));
action->next = NULL;
action->counter = counter;
for (last = &f->conversion.actions; *last; last = &(*last)->next)
;;
*last = action;
input_pending = true;
}
/* Delete LEFT and RIGHT characters around point in F's old selected
window. */
void
delete_surrounding_text (struct frame *f, ptrdiff_t left,
ptrdiff_t right, unsigned long counter)
{
struct text_conversion_action *action, **last;
action = xmalloc (sizeof *action);
action->operation = TEXTCONV_DELETE_SURROUNDING_TEXT;
action->data = Fcons (make_fixnum (left),
make_fixnum (right));
action->next = NULL;
action->counter = counter;
for (last = &f->conversion.actions; *last; last = &(*last)->next)
;;
*last = action;
input_pending = true;
}
/* Request an immediate call to INTERFACE->point_changed with the new
details of F's region unless a batch edit is in progress. */
void
request_point_update (struct frame *f, unsigned long counter)
{
struct text_conversion_action *action, **last;
action = xmalloc (sizeof *action);
action->operation = TEXTCONV_REQUEST_POINT_UPDATE;
action->data = Qnil;
action->next = NULL;
action->counter = counter;
for (last = &f->conversion.actions; *last; last = &(*last)->next)
;;
*last = action;
input_pending = true;
}
/* Return N characters of text around point in F's old selected
window.
If N is -1, return the text between point and mark instead, given
that the mark is active.
Set *N to the actual number of characters returned, *START_RETURN
to the position of the first character returned, *OFFSET to the
offset of point within that text, *LENGTH to the actual number of
characters returned, and *BYTES to the actual number of bytes
returned.
Value is NULL upon failure, and a malloced string upon success. */
char *
get_extracted_text (struct frame *f, ptrdiff_t n,
ptrdiff_t *start_return,
ptrdiff_t *offset, ptrdiff_t *length,
ptrdiff_t *bytes)
{
specpdl_ref count;
ptrdiff_t start, end, start_byte, end_byte;
char *buffer;
if (!WINDOW_LIVE_P (f->old_selected_window))
return NULL;
/* Save the excursion, as there will be extensive changes to the
selected window. */
count = SPECPDL_INDEX ();
record_unwind_protect_excursion ();
/* Inhibit quitting. */
specbind (Qinhibit_quit, Qt);
/* Temporarily switch to F's selected window at the time of the last
redisplay. */
select_window (f->old_selected_window, Qt);
buffer = NULL;
/* Figure out the bounds of the text to return. */
if (n != -1)
{
/* Make sure n is at least 4, leaving two characters around
PT. */
n = max (4, n);
start = PT - n / 2;
end = PT + n - n / 2;
}
else
{
if (!NILP (BVAR (current_buffer, mark_active))
&& XMARKER (BVAR (current_buffer, mark))->buffer)
{
start = marker_position (BVAR (current_buffer, mark));
end = PT;
/* Sort start and end. start_byte is used to hold a
temporary value. */
if (start > end)
{
start_byte = end;
end = start;
start = start_byte;
}
}
else
goto finish;
}
start = max (start, BEGV);
end = min (end, ZV);
/* Detect overflow. */
if (!(start <= PT && PT <= end))
goto finish;
/* Convert the character positions to byte positions. */
start_byte = CHAR_TO_BYTE (start);
end_byte = CHAR_TO_BYTE (end);
/* Extract the text from the buffer. */
buffer = xmalloc (end_byte - start_byte);
copy_buffer (start, start_byte, end, end_byte,
buffer);
/* Return the offsets. */
*start_return = start;
*offset = PT - start;
*length = end - start;
*bytes = end_byte - start_byte;
finish:
unbind_to (count, Qnil);
return buffer;
}
/* Return whether or not text conversion is temporarily disabled.
`reset' should always call this to determine whether or not to
disable the input method. */
bool
conversion_disabled_p (void)
{
return suppress_conversion_count > 0;
}
/* Window system interface. These are called from the rest of
Emacs. */
/* Notice that F's selected window has been set from redisplay.
Reset F's input method state. */
void
report_selected_window_change (struct frame *f)
{
struct window *w;
reset_frame_state (f);
if (!text_interface)
return;
/* When called from window.c, F's selected window has already been
redisplayed, but w->last_point has not yet been updated. Update
it here to avoid race conditions when the IM asks for the initial
selection position immediately after. */
if (WINDOWP (f->selected_window))
{
w = XWINDOW (f->selected_window);
w->ephemeral_last_point = window_point (w);
}
text_interface->reset (f);
}
/* Notice that the point in F's selected window's current buffer has
changed.
F is the frame whose selected window was changed, W is the window
in question, and BUFFER is that window's current buffer.
Tell the text conversion interface about the change; it will likely
pass the information on to the system input method. */
void
report_point_change (struct frame *f, struct window *window,
struct buffer *buffer)
{
if (!text_interface || !text_interface->point_changed)
return;
if (f->conversion.batch_edit_count > 0)
f->conversion.batch_edit_flags |= PENDING_POINT_CHANGE;
else
text_interface->point_changed (f, window, buffer);
}
/* Temporarily disable text conversion. Must be paired with a
corresponding call to resume_text_conversion. */
void
disable_text_conversion (void)
{
Lisp_Object tail, frame;
struct frame *f;
suppress_conversion_count++;
if (!text_interface || suppress_conversion_count > 1)
return;
/* Loop through and reset the input method on each window system
frame. It should call conversion_disabled_p and then DTRT. */
FOR_EACH_FRAME (tail, frame)
{
f = XFRAME (frame);
reset_frame_state (f);
if (FRAME_WINDOW_P (f) && FRAME_VISIBLE_P (f))
text_interface->reset (f);
}
}
/* Undo the effect of the last call to `disable_text_conversion'. */
void
resume_text_conversion (void)
{
Lisp_Object tail, frame;
struct frame *f;
suppress_conversion_count--;
eassert (suppress_conversion_count >= 0);
if (!text_interface || suppress_conversion_count)
return;
/* Loop through and reset the input method on each window system
frame. It should call conversion_disabled_p and then DTRT. */
FOR_EACH_FRAME (tail, frame)
{
f = XFRAME (frame);
reset_frame_state (f);
if (FRAME_WINDOW_P (f) && FRAME_VISIBLE_P (f))
text_interface->reset (f);
}
}
/* Register INTERFACE as the text conversion interface. */
void
register_textconv_interface (struct textconv_interface *interface)
{
text_interface = interface;
}
/* Lisp interface. */
DEFUN ("set-text-conversion-style", Fset_text_conversion_style,
Sset_text_conversion_style, 1, 1, 0,
doc: /* Set the text conversion style in the current buffer.
Set `text-conversion-style' to VALUE, then force any input method
editing frame displaying this buffer to stop itself.
This can lead to a significant amount of time being taken by the input
method resetting itself, so you should not use this function lightly;
instead, set `text-conversion-style' before your buffer is displayed,
and let redisplay manage the input method appropriately. */)
(Lisp_Object value)
{
Lisp_Object tail, frame;
struct frame *f;
Lisp_Object buffer;
bset_text_conversion_style (current_buffer, value);
if (!text_interface)
return Qnil;
/* If there are any seleted windows displaying this buffer, reset
text conversion on their associated frames. */
if (buffer_window_count (current_buffer))
{
buffer = Fcurrent_buffer ();
FOR_EACH_FRAME (tail, frame)
{
f = XFRAME (frame);
if (WINDOW_LIVE_P (f->old_selected_window)
&& FRAME_WINDOW_P (f)
&& EQ (XWINDOW (f->old_selected_window)->contents,
buffer))
{
block_input ();
reset_frame_state (f);
text_interface->reset (f);
unblock_input ();
}
}
}
return Qnil;
}
void
syms_of_textconv (void)
{
DEFSYM (Qaction, "action");
DEFSYM (Qtext_conversion, "text-conversion");
DEFSYM (Qpush_mark, "push-mark");
DEFSYM (Qunderline, "underline");
DEFSYM (Qoverriding_text_conversion_style,
"overriding-text-conversion-style");
DEFVAR_LISP ("text-conversion-edits", Vtext_conversion_edits,
doc: /* List of buffers that were last edited as a result of text conversion.
This list can be used while handling a `text-conversion' event to
determine the changes which have taken place.
Each element of the list describes a single edit in a buffer, of the
form:
(BUFFER BEG END EPHEMERAL)
If an insertion or a change occured, then BEG and END are markers
which denote the bounds of the text that was changed or inserted.
If EPHEMERAL is t, then the input method will shortly make more
changes to the text, so any actions that would otherwise be taken
(such as indenting or automatically filling text) should not take
place; otherwise, it is a string describing the text which was
inserted.
If a deletion occured before point, then BEG and END are the same
object, and EPHEMERAL is the text which was deleted.
If a deletion occured after point, then BEG and END are also the same
object, but EPHEMERAL is nil.
The list contents are ordered later edits first, so you must iterate
through the list in reverse. */);
Vtext_conversion_edits = Qnil;
DEFVAR_LISP ("overriding-text-conversion-style",
Voverriding_text_conversion_style,
doc: /* Non-buffer local version of `text-conversion-style'.
If this variable is the symbol `lambda', it means to consult the
buffer local variable `text-conversion-style' to determine whether or
not to activate the input method. Otherwise, its value is used in
preference to any buffer local value of `text-conversion-style'. */);
Voverriding_text_conversion_style = Qlambda;
DEFVAR_LISP ("text-conversion-face", Vtext_conversion_face,
doc: /* Face in which to display temporary edits by an input method.
nil means to display no indication of a temporary edit. */);
Vtext_conversion_face = Qunderline;
defsubr (&Sset_text_conversion_style);
}
Reference in a new issue View git blame Copy permalink