/* Window creation, deletion and examination for XEmacs. Copyright (C) 1985-1987, 1992-1995 Free Software Foundation, Inc. Copyright (C) 1994, 1995 Board of Trustees, University of Illinois. Copyright (C) 1995, 1996, 2002, 2010 Ben Wing. Copyright (C) 1996 Chuck Thompson. This file is part of XEmacs. XEmacs 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. XEmacs 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 XEmacs. If not, see . */ /* Synched up with: FSF 19.30. */ /* Beginning to diverge significantly. */ /* Authorship: Based on code from pre-release FSF 19, c. 1991. Significantly reworked by Chuck Thompson, 1993-1996. window mirror stuff added by Chuck Thompson c. 1993. various cleanup by Ben Wing c. 1995 (window slots, window init code, memory usage, synch. up to FSF 19.30, other). Unknown work by Andy Piper. new window-width/height fns. by Ben Wing, Mar 2000. */ /* This file has been Mule-ized. */ #include #include "lisp.h" #include "buffer.h" #include "commands.h" #include "device-impl.h" #include "elhash.h" #include "faces.h" #include "frame-impl.h" #include "glyphs.h" #include "gutter.h" #include "fontcolor.h" #include "redisplay.h" #include "window-impl.h" Lisp_Object Qwindowp, Qwindow_live_p; Lisp_Object Qdisplay_buffer; #ifdef MEMORY_USAGE_STATS Lisp_Object Qface_cache, Qglyph_cache, Qline_start_cache, Qredisplay_structs; #ifdef HAVE_SCROLLBARS Lisp_Object Qscrollbar_instances; #endif #endif extern int allow_deletion_of_last_visible_frame; EXFUN (Fnext_window, 4); static int window_pixel_width_to_char_width (struct window *w, int pixel_width, int include_margins_p); static int window_char_width_to_pixel_width (struct window *w, int char_width, int include_margins_p); static int window_pixel_height_to_char_height (struct window *w, int pixel_height, int include_gutters_p); static int window_char_height_to_pixel_height (struct window *w, int char_height, int include_gutters_p); static void change_window_height (Lisp_Object window, int delta, Lisp_Object horizontalp, int inpixels); /* Thickness of shadow border around 3d modelines. */ Lisp_Object Vmodeline_shadow_thickness; /* Whether vertical dividers are draggable and displayed */ Lisp_Object Vvertical_divider_always_visible_p; /* Whether a modeline should be displayed. */ Lisp_Object Vhas_modeline_p; /* Thickness of shadow border around vertical dividers. */ Lisp_Object Vvertical_divider_shadow_thickness; /* Divider surface width (not counting 3-d borders) */ Lisp_Object Vvertical_divider_line_width; /* Spacing between outer edge of divider border and window edge */ Lisp_Object Vvertical_divider_spacing; /* How much to scroll by per-line. */ Lisp_Object Vwindow_pixel_scroll_increment; /* Scroll if point lands on the bottom line and that line is partially clipped. */ int scroll_on_clipped_lines; /* The minibuffer window of the selected frame. Note that you cannot test for minibufferness of an arbitrary window by comparing against this; but you can test for minibufferness of the selected window. */ Lisp_Object minibuf_window; /* Non-nil means it is the window for C-M-v to scroll when the minibuffer is selected. */ Lisp_Object Vminibuffer_scroll_window; /* Non-nil means this is the buffer whose window C-M-v should scroll. */ Lisp_Object Vother_window_scroll_buffer; /* Non-nil means it's the function to call to display temp buffers. */ Lisp_Object Vtemp_buffer_show_function; /* If a window gets smaller than either of these, it is removed. */ Fixnum window_min_height; Fixnum window_min_width; /* Number of lines of continuity in scrolling by screenfuls. */ Fixnum next_screen_context_lines; Lisp_Object Qcurrent_window_configuration, Qset_window_configuration; Lisp_Object Qtruncate_partial_width_windows; #define SET_LAST_MODIFIED(w, cache_too) \ do { \ (w)->last_modified[CURRENT_DISP] = Qzero; \ (w)->last_modified[DESIRED_DISP] = Qzero; \ (w)->last_modified[CMOTION_DISP] = Qzero; \ if (cache_too) \ (w)->line_cache_last_updated = Qzero; \ } while (0) #define SET_LAST_FACECHANGE(w) \ do { \ (w)->last_facechange[CURRENT_DISP] = Qzero; \ (w)->last_facechange[DESIRED_DISP] = Qzero; \ (w)->last_facechange[CMOTION_DISP] = Qzero; \ } while (0) static const struct memory_description int_description_1[] = { { XD_END } }; static const struct sized_memory_description int_description = { sizeof (int), int_description_1 }; static const struct memory_description int_dynarr_description_1[] = { XD_DYNARR_DESC (int_dynarr, &int_description), { XD_END } }; static const struct sized_memory_description int_dynarr_description = { sizeof (int_dynarr), int_dynarr_description_1 }; static const struct memory_description face_cachel_description_1[] = { { XD_BLOCK_PTR, offsetof (face_cachel, merged_faces), 1, { &int_dynarr_description } }, { XD_LISP_OBJECT, offsetof (face_cachel, face) }, { XD_LISP_OBJECT, offsetof (face_cachel, foreground) }, { XD_LISP_OBJECT, offsetof (face_cachel, background) }, { XD_LISP_OBJECT_ARRAY, offsetof (face_cachel, font), NUM_LEADING_BYTES }, { XD_LISP_OBJECT, offsetof (face_cachel, display_table) }, { XD_LISP_OBJECT, offsetof (face_cachel, background_pixmap) }, { XD_END } }; #ifdef NEW_GC DEFINE_DUMPABLE_INTERNAL_LISP_OBJECT ("face-cachel", face_cachel, 0, face_cachel_description_1, Lisp_Face_Cachel); #endif /* NEW_GC */ static const struct sized_memory_description face_cachel_description = { sizeof (face_cachel), face_cachel_description_1 }; static const struct memory_description face_cachel_dynarr_description_1[] = { #ifdef NEW_GC XD_LISP_DYNARR_DESC (face_cachel_dynarr, &face_cachel_description), #else /* not NEW_GC */ XD_DYNARR_DESC (face_cachel_dynarr, &face_cachel_description), #endif /* not NEW_GC */ { XD_END } }; #ifdef NEW_GC DEFINE_DUMPABLE_INTERNAL_LISP_OBJECT ("face-cachel-dynarr", face_cachel_dynarr, 0, face_cachel_dynarr_description_1, face_cachel_dynarr); #else /* not NEW_GC */ static const struct sized_memory_description face_cachel_dynarr_description = { sizeof (face_cachel_dynarr), face_cachel_dynarr_description_1 }; #endif /* not NEW_GC */ static const struct memory_description glyph_cachel_description_1[] = { { XD_LISP_OBJECT, offsetof (glyph_cachel, glyph) }, { XD_END } }; #ifdef NEW_GC DEFINE_DUMPABLE_INTERNAL_LISP_OBJECT ("glyph-cachel", glyph_cachel, 0, glyph_cachel_description_1, Lisp_Glyph_Cachel); #endif /* NEW_GC */ static const struct sized_memory_description glyph_cachel_description = { sizeof (glyph_cachel), glyph_cachel_description_1 }; static const struct memory_description glyph_cachel_dynarr_description_1[] = { #ifdef NEW_GC XD_LISP_DYNARR_DESC (glyph_cachel_dynarr, &glyph_cachel_description), #else /* not NEW_GC */ XD_DYNARR_DESC (glyph_cachel_dynarr, &glyph_cachel_description), #endif /* not NEW_GC */ { XD_END } }; #ifdef NEW_GC DEFINE_DUMPABLE_INTERNAL_LISP_OBJECT ("glyph-cachel-dynarr", glyph_cachel_dynarr, 0, glyph_cachel_dynarr_description_1, glyph_cachel_dynarr); #else /* not NEW_GC */ static const struct sized_memory_description glyph_cachel_dynarr_description = { sizeof (glyph_cachel_dynarr), glyph_cachel_dynarr_description_1 }; #endif /* not NEW_GC */ static const struct memory_description line_start_cache_description_1[] = { { XD_END } }; static const struct sized_memory_description line_start_cache_description = { sizeof (line_start_cache), line_start_cache_description_1 }; static const struct memory_description line_start_cache_dynarr_description_1[] = { XD_DYNARR_DESC (line_start_cache_dynarr, &line_start_cache_description), { XD_END } }; static const struct sized_memory_description line_start_cache_dynarr_description = { sizeof (line_start_cache_dynarr), line_start_cache_dynarr_description_1 }; static const struct memory_description window_description [] = { #define WINDOW_SLOT(slot) { XD_LISP_OBJECT, offsetof (struct window, slot) }, #define WINDOW_SLOT_ARRAY(slot, size) \ { XD_LISP_OBJECT_ARRAY, offsetof (struct window, slot), size }, #include "winslots.h" #ifdef NEW_GC { XD_LISP_OBJECT, offsetof (struct window, face_cachels) }, { XD_LISP_OBJECT, offsetof (struct window, glyph_cachels) }, #else /* not NEW_GC */ { XD_BLOCK_PTR, offsetof (struct window, face_cachels), 1, { &face_cachel_dynarr_description } }, { XD_BLOCK_PTR, offsetof (struct window, glyph_cachels), 1, { &glyph_cachel_dynarr_description } }, #endif /* not NEW_GC */ { XD_BLOCK_PTR, offsetof (struct window, line_start_cache), 1, { &line_start_cache_dynarr_description }, XD_FLAG_NO_KKCC }, { XD_END } }; static Lisp_Object mark_window (Lisp_Object obj) { struct window *window = XWINDOW (obj); mark_face_cachels (window->face_cachels); mark_glyph_cachels (window->glyph_cachels); #define WINDOW_SLOT(slot) mark_object (window->slot); #include "winslots.h" return Qnil; } static void print_window (Lisp_Object obj, Lisp_Object printcharfun, int UNUSED (escapeflag)) { Lisp_Object buf; if (print_readably) printing_unreadable_lisp_object (obj, 0); write_ascstring (printcharfun, "#name; write_fmt_string_lisp (printcharfun, " on %S", 1, name); } write_fmt_string (printcharfun, " 0x%x>", LISP_OBJECT_UID (obj)); } static void finalize_window (Lisp_Object obj) { struct window *w = XWINDOW (obj); if (w->line_start_cache) { Dynarr_free (w->line_start_cache); w->line_start_cache = 0; } if (w->face_cachels) { int i; for (i = 0; i < Dynarr_length (w->face_cachels); i++) { struct face_cachel *cachel = Dynarr_atp (w->face_cachels, i); if (cachel->merged_faces) { Dynarr_free (cachel->merged_faces); cachel->merged_faces = 0; } } Dynarr_free (w->face_cachels); w->face_cachels = 0; } if (w->glyph_cachels) { Dynarr_free (w->glyph_cachels); w->glyph_cachels = 0; } } /* These caches map buffers to markers. They are key-weak so that entries remain around as long as the buffers do. */ static Lisp_Object make_saved_buffer_point_cache (void) { return make_lisp_hash_table (20, HASH_TABLE_KEY_WEAK, Qeq); } DEFINE_NODUMP_LISP_OBJECT ("window", window, mark_window, print_window, finalize_window, 0, 0, window_description, struct window); #define INIT_DISP_VARIABLE(field, initialization) \ p->field[CURRENT_DISP] = initialization; \ p->field[DESIRED_DISP] = initialization; \ p->field[CMOTION_DISP] = initialization; /* We have an implicit assertion that the first two elements (default and modeline faces) are always present in the face_element_cache. Normally redisplay ensures this. However, it is possible for a window to get created and functions which reference these values called before redisplay works with the window for the first time. All callers of allocate_window should therefore call reset_face_cachels on the created window. We can't do it here because the window must have its frame pointer set or reset_face_cachels will fail. A similar requirement holds for reset_glyph_cachels. We *could* do that here (there's no reference to the frame pointer in that function), but we may as well have the same discipline. */ Lisp_Object allocate_window (void) { Lisp_Object obj = ALLOC_NORMAL_LISP_OBJECT (window); struct window *p = XWINDOW (obj); #define WINDOW_SLOT(slot) p->slot = Qnil; #include "winslots.h" INIT_DISP_VARIABLE (start, Fmake_marker ()); INIT_DISP_VARIABLE (pointm, Fmake_marker ()); p->sb_point = Fmake_marker (); p->saved_point_cache = make_saved_buffer_point_cache (); p->saved_last_window_start_cache = make_saved_buffer_point_cache (); p->use_time = Qzero; INIT_DISP_VARIABLE (last_modified, Qzero); INIT_DISP_VARIABLE (last_point, Fmake_marker ()); INIT_DISP_VARIABLE (last_start, Fmake_marker ()); INIT_DISP_VARIABLE (last_facechange, Qzero); #ifdef NEW_GC p->face_cachels = Dynarr_lisp_new (face_cachel, &lrecord_face_cachel_dynarr, &lrecord_face_cachel); p->glyph_cachels = Dynarr_lisp_new (glyph_cachel, &lrecord_glyph_cachel_dynarr, &lrecord_glyph_cachel); #else /* not NEW_GC */ p->face_cachels = Dynarr_new (face_cachel); p->glyph_cachels = Dynarr_new (glyph_cachel); #endif /* not NEW_GC */ p->line_start_cache = Dynarr_new (line_start_cache); p->subwindow_instance_cache = make_image_instance_cache_hash_table (); p->line_cache_last_updated = Qzero; p->windows_changed = 1; p->shadow_thickness_changed = 1; return obj; } #undef INIT_DISP_VARIABLE /************************************************************************/ /* Window mirror structure */ /************************************************************************/ /* * The redisplay structures used to be stored with each window. While * they are logically something associated with frames they can't be * stored there with a redisplay which handles variable height lines. * Lines in horizontally split windows might not line up. So they get * stored with the windows. * * The problem with this is window configurations. When restoring a * window configuration it now becomes problematic to do an * incremental redisplay. The solution is to store the redisplay * structures with the frame as they should be but laid out in the * same manner as the window structure. Thus is born the window * mirror. * * It also becomes a convenient place to stick scrollbar instances * since they extrapolate out to having the same problem described for * the display structures. */ /* NOTE: The window-mirror structure formerly was not a Lisp object, and marking was handled specially. I've gotten recurring crashes, however, using the mouse wheel under Windows, where either the window mirror accessed through a scrollbar instance, or the frame pointed to by that window mirror, gets garbaged. Things are tricky under windows because the scrollbar instances are stored in HWND-specific data. Furthermore, we have scrollbar-instance caches to complicate things. Both of these make it very difficult (for me at least, not being intimately familiar with the redisplay code) to track exactly when and where a particular window mirror or scrollbar instance has pointers to it, or whether a window mirror might have a dead frame or buffer in it (i.e. not necessarily gc-protected by being on a global list). By far the safest thing, then, is to make both structures Lisp objects and not explicitly xfree() them. This should make no practical difference in memory usage because neither structure is created very often (only when windows are created or deleted). --ben */ static const struct memory_description window_mirror_description [] = { { XD_LISP_OBJECT, offsetof (struct window_mirror, frame) }, { XD_LISP_OBJECT, offsetof (struct window_mirror, next) }, { XD_LISP_OBJECT, offsetof (struct window_mirror, hchild) }, { XD_LISP_OBJECT, offsetof (struct window_mirror, vchild) }, { XD_BLOCK_PTR, offsetof (struct window_mirror, current_display_lines), 1, { &display_line_dynarr_description } }, { XD_BLOCK_PTR, offsetof (struct window_mirror, desired_display_lines), 1, { &display_line_dynarr_description } }, { XD_LISP_OBJECT, offsetof (struct window_mirror, buffer) }, #ifdef HAVE_SCROLLBARS { XD_LISP_OBJECT, offsetof (struct window_mirror, scrollbar_vertical_instance) }, { XD_LISP_OBJECT, offsetof (struct window_mirror, scrollbar_horizontal_instance) }, #endif /* HAVE_SCROLLBARS */ { XD_END } }; static Lisp_Object mark_window_mirror (Lisp_Object obj) { struct window_mirror *mir = XWINDOW_MIRROR (obj); if (mir->current_display_lines) mark_redisplay_structs (mir->current_display_lines); if (mir->desired_display_lines) mark_redisplay_structs (mir->desired_display_lines); if (mir->hchild) mark_object (wrap_window_mirror (mir->hchild)); if (mir->vchild) mark_object (wrap_window_mirror (mir->vchild)); if (mir->frame) mark_object (wrap_frame (mir->frame)); if (mir->buffer) mark_object (wrap_buffer (mir->buffer)); #ifdef HAVE_SCROLLBARS if (mir->scrollbar_vertical_instance) mark_object (wrap_scrollbar_instance (mir->scrollbar_vertical_instance)); if (mir->scrollbar_horizontal_instance) mark_object (wrap_scrollbar_instance (mir->scrollbar_horizontal_instance)); #endif /* HAVE_SCROLLBARS */ if (mir->next) return wrap_window_mirror (mir->next); else return Qnil; } DEFINE_NODUMP_INTERNAL_LISP_OBJECT ("window-mirror", window_mirror, mark_window_mirror, window_mirror_description, struct window_mirror); /* Create a new window mirror structure and associated redisplay structs. */ static struct window_mirror * new_window_mirror (struct frame *f) { Lisp_Object obj = ALLOC_NORMAL_LISP_OBJECT (window_mirror); struct window_mirror *t = XWINDOW_MIRROR (obj); t->frame = f; t->current_display_lines = Dynarr_new (display_line); t->desired_display_lines = Dynarr_new (display_line); return t; } /* Synchronize the mirror structure with a given window structure. This is normally called from update_frame_window_mirror with a starting window of f->root_window. */ static struct window_mirror * update_mirror_internal (Lisp_Object win, struct window_mirror *mir) { if (NILP (win)) { if (mir) { free_window_mirror (mir); mir = NULL; } return mir; } else if (!mir) mir = new_window_mirror (XFRAME (XWINDOW (win)->frame)); mir->next = update_mirror_internal (XWINDOW (win)->next, mir->next); mir->hchild = update_mirror_internal (XWINDOW (win)->hchild, mir->hchild); mir->vchild = update_mirror_internal (XWINDOW (win)->vchild, mir->vchild); /* * If the redisplay structs are not empty and the mirror has * children, then this mirror structure was formerly being used for * display but is no longer. Reset its current display structs so * that redisplay doesn't accidentally think they are accurate if it * is later used for display purposes once again. Also, mark the * scrollbar instance as not active. */ if (mir->vchild || mir->hchild) { /* The redisplay structures are big. Leaving them around in non-leaf windows can add up to a lot of wasted space. So don't do it. */ free_display_structs (mir); mir->current_display_lines = Dynarr_new (display_line); mir->desired_display_lines = Dynarr_new (display_line); #ifdef HAVE_SCROLLBARS update_window_scrollbars (XWINDOW (win), mir, 0, 0); #endif mir->buffer = NULL; } return mir; } /* Given a window mirror, determine which real window it contains the redisplay structures for. */ static Lisp_Object real_window_internal (Lisp_Object win, struct window_mirror *rmir, struct window_mirror *mir) { for (; !NILP (win) && rmir ; win = XWINDOW (win)->next, rmir = rmir->next) { if (mir == rmir) return win; if (!NILP (XWINDOW (win)->vchild)) { Lisp_Object retval = real_window_internal (XWINDOW (win)->vchild, rmir->vchild, mir); if (!NILP (retval)) return retval; } if (!NILP (XWINDOW (win)->hchild)) { Lisp_Object retval = real_window_internal (XWINDOW (win)->hchild, rmir->hchild, mir); if (!NILP (retval)) return retval; } } return Qnil; } /* Given a real window, find the mirror structure which contains its redisplay structures. */ static struct window_mirror * find_window_mirror_internal (Lisp_Object win, struct window_mirror *rmir, struct window *w) { for (; !NILP (win) && rmir; win = XWINDOW (win)->next, rmir = rmir->next) { if (w == XWINDOW (win)) return rmir; if (!NILP (XWINDOW (win)->vchild)) { struct window_mirror *retval = find_window_mirror_internal (XWINDOW (win)->vchild, rmir->vchild, w); if (retval) return retval; } if (!NILP (XWINDOW (win)->hchild)) { struct window_mirror *retval = find_window_mirror_internal (XWINDOW (win)->hchild, rmir->hchild, w); if (retval) return retval; } } return 0; } /* Update the mirror structure for the given frame. */ void update_frame_window_mirror (struct frame *f) { f->root_mirror = wrap_window_mirror (update_mirror_internal (f->root_window, NILP (f->root_mirror) ? 0 : XWINDOW_MIRROR (f->root_mirror))); f->mirror_dirty = 0; } /* Free a given mirror structure along with all of its children as well as their associated display structures. */ void free_window_mirror (struct window_mirror *mir) { while (mir) { if (mir->hchild) free_window_mirror (mir->hchild); if (mir->vchild) free_window_mirror (mir->vchild); #ifdef HAVE_SCROLLBARS release_window_mirror_scrollbars (mir); #endif free_display_structs (mir); mir = mir->next; /* not worth calling free_normal_lisp_object() -- window mirrors are not created that frequently and it's dangerous. we don't know for sure that there aren't other pointers around -- e.g. in a scrollbar instance. */ } } /* Given a mirror structure, return the window it mirrors. Calls real_window_internal to do most of the work. */ Lisp_Object real_window (struct window_mirror *mir, int no_abort) { Lisp_Object retval = real_window_internal (mir->frame->root_window, XWINDOW_MIRROR (mir->frame->root_mirror), mir); assert (!NILP (retval) || no_abort); return retval; } /* Given a real window, return its mirror structure. Calls find_window_mirror_internal to do all of the work. */ struct window_mirror * find_window_mirror (struct window *w) { struct frame *f = XFRAME (w->frame); if (f->mirror_dirty) update_frame_window_mirror (f); return find_window_mirror_internal (f->root_window, XWINDOW_MIRROR (f->root_mirror), w); } /* Given a real window, return its mirror structure, if it exists. Don't do any updating. */ static struct window_mirror * find_window_mirror_maybe (struct window *w) { struct frame *f = XFRAME (w->frame); if (!WINDOW_MIRRORP (f->root_mirror)) return 0; return find_window_mirror_internal (f->root_window, XWINDOW_MIRROR (f->root_mirror), w); } /***************************************************************************** find_window_by_pixel_pos Given a pixel position relative to a frame, find the window at that position. ****************************************************************************/ struct window * find_window_by_pixel_pos (int pix_x, int pix_y, Lisp_Object win) { if (NILP (win)) return 0; for (; !NILP (win); win = XWINDOW (win)->next) { struct window *w; if (!NILP (XWINDOW (win)->vchild)) { w = find_window_by_pixel_pos (pix_x, pix_y, XWINDOW (win)->vchild); if (w) return w; } if (!NILP (XWINDOW (win)->hchild)) { w = find_window_by_pixel_pos (pix_x, pix_y, XWINDOW (win)->hchild); if (w) return w; } w = XWINDOW (win); if (pix_x >= WINDOW_LEFT (w) && pix_x <= WINDOW_RIGHT (w) && pix_y >= WINDOW_TOP (w) && pix_y <= WINDOW_BOTTOM (w)) return w; } return NULL; } /* Return a pointer to the display structures for the given window. */ display_line_dynarr * window_display_lines (struct window *w, int which) { struct window_mirror *t; t = find_window_mirror (w); assert (t); if (which == CURRENT_DISP) return t->current_display_lines; else if (which == DESIRED_DISP) return t->desired_display_lines; else if (which == CMOTION_DISP) /* The CMOTION_DISP display lines are global. */ return cmotion_display_lines; else ABORT (); return 0; /* shut up compiler */ } struct buffer * window_display_buffer (struct window *w) { struct window_mirror *t; t = find_window_mirror (w); assert (t); return t->buffer; } void set_window_display_buffer (struct window *w, struct buffer *b) { struct window_mirror *t; t = find_window_mirror (w); assert (t); t->buffer = b; } /* Determining a window's position based solely on its pixel positioning doesn't work. Instead, we do it the intelligent way, by checking its positioning in the window hierarchy. */ int window_is_leftmost (struct window *w) { Lisp_Object parent, current_ancestor, window; window = wrap_window (w); parent = XWINDOW (window)->parent; current_ancestor = window; while (!NILP (parent)) { if (!NILP (XWINDOW (parent)->hchild) && !EQ (XWINDOW (parent)->hchild, current_ancestor)) return 0; current_ancestor = parent; parent = XWINDOW (parent)->parent; } return 1; } int window_is_rightmost (struct window *w) { Lisp_Object parent, current_ancestor, window; window = wrap_window (w); parent = XWINDOW (window)->parent; current_ancestor = window; while (!NILP (parent)) { if (!NILP (XWINDOW (parent)->hchild) && !NILP (XWINDOW (current_ancestor)->next)) return 0; current_ancestor = parent; parent = XWINDOW (parent)->parent; } return 1; } static int window_full_width_p (struct window *w) { return window_is_leftmost (w) && window_is_rightmost (w); } int window_is_highest (struct window *w) { Lisp_Object parent, current_ancestor, window; window = wrap_window (w); parent = XWINDOW (window)->parent; current_ancestor = window; while (!NILP (parent)) { if (!NILP (XWINDOW (parent)->vchild) && !EQ (XWINDOW (parent)->vchild, current_ancestor)) return 0; current_ancestor = parent; parent = XWINDOW (parent)->parent; } /* This is really to catch the minibuffer but we make it generic in case we ever change things around to let the minibuffer be on top. */ if (NILP (XWINDOW (current_ancestor)->prev)) return 1; else return 0; } int window_is_lowest (struct window *w) { Lisp_Object parent, current_ancestor, window; window = wrap_window (w); parent = XWINDOW (window)->parent; current_ancestor = window; while (!NILP (parent)) { if (!NILP (XWINDOW (parent)->vchild) && !NILP (XWINDOW (current_ancestor)->next)) return 0; current_ancestor = parent; parent = XWINDOW (parent)->parent; } return 1; } #if 0 /* not currently used */ static int window_full_height_p (struct window *w) { return window_is_highest (w) && window_is_lowest (w); } #endif int window_truncation_on (struct window *w) { /* Minibuffer windows are never truncated. #### is this the right way ? */ if (MINI_WINDOW_P (w)) return 0; /* Horizontally scrolled windows are truncated. */ if (w->hscroll) return 1; /* If truncate_partial_width_windows is true and the window is not the full width of the frame it is truncated. */ if (!NILP (symbol_value_in_buffer (Qtruncate_partial_width_windows, w->buffer)) && !(window_is_leftmost (w) && window_is_rightmost (w))) return 1; /* If the window's buffer's value of truncate_lines is non-nil, then the window is truncated. */ if (!NILP (XBUFFER (w->buffer)->truncate_lines)) return 1; return 0; } DEFUN ("window-truncated-p", Fwindow_truncated_p, 0, 1, 0, /* Returns non-nil if text in the window is truncated. */ (window)) { struct window *w = decode_window (window); return window_truncation_on (w) ? Qt : Qnil; } static int have_undivided_common_edge (struct window *w_right, void *closure) { struct window *w_left = (struct window *) closure; return (WINDOW_RIGHT (w_left) == WINDOW_LEFT (w_right) && WINDOW_TOP (w_left) < WINDOW_BOTTOM (w_right) && WINDOW_TOP (w_right) < WINDOW_BOTTOM (w_left) #ifdef HAVE_SCROLLBARS && (NILP (w_right->scrollbar_on_left_p) || NILP (w_right->vertical_scrollbar_visible_p) || ZEROP (w_right->scrollbar_width)) #endif ); } static int window_needs_vertical_divider_1 (struct window *w) { /* Never if we're on the right */ if (window_is_rightmost (w)) return 0; /* Always if draggable */ if (!NILP (w->vertical_divider_always_visible_p)) return 1; #ifdef HAVE_SCROLLBARS /* Our right scrollbar is enough to separate us at the right */ if (NILP (w->scrollbar_on_left_p) && !NILP (w->vertical_scrollbar_visible_p) && !ZEROP (w->scrollbar_width)) return 0; #endif /* Ok. to determine whether we need a divider on the left, we must check that our right neighbor windows have scrollbars on their left sides. We must check all such windows which have common left edge with our window's right edge. */ return map_windows (XFRAME (WINDOW_FRAME (w)), have_undivided_common_edge, (void*)w); } int window_needs_vertical_divider (struct window *w) { if (!w->need_vertical_divider_valid_p) { w->need_vertical_divider_p = window_needs_vertical_divider_1 (w); w->need_vertical_divider_valid_p = 1; } return w->need_vertical_divider_p; } /* Called from invalidate_vertical_divider_cache_in_frame */ int invalidate_vertical_divider_cache_in_window (struct window *w, void *UNUSED (unused)) { w->need_vertical_divider_valid_p = 0; return 0; } /* Calculate width of vertical divider, including its shadows and spacing. The returned value is effectively the distance between adjacent window edges. This function does not check whether a window needs a vertical divider, so the returned value is a "theoretical" one */ int window_divider_width (struct window *w) { /* the shadow thickness can be negative. This means that the divider will have a depressed look */ if (FRAME_WIN_P (XFRAME (WINDOW_FRAME (w)))) return XFIXNUM (w->vertical_divider_line_width) + 2 * XFIXNUM (w->vertical_divider_spacing) + 2 * abs (XFIXNUM (w->vertical_divider_shadow_thickness)); else return XFIXNUM (w->vertical_divider_line_width) == 0 ? 0 : 1; } int window_scrollbar_width (struct window * USED_IF_SCROLLBARS (w)) { #ifdef HAVE_SCROLLBARS if (!WINDOW_WIN_P (w) || MINI_WINDOW_P (w) || NILP (w->buffer) || NILP (w->vertical_scrollbar_visible_p)) /* #### when does NILP (w->buffer) happen? */ return 0; return XFIXNUM (w->scrollbar_width); #else return 0; #endif /* HAVE_SCROLLBARS */ } /* Horizontal scrollbars are only active on windows with truncation turned on. */ int window_scrollbar_height (struct window * USED_IF_SCROLLBARS (w)) { #ifdef HAVE_SCROLLBARS if (!WINDOW_WIN_P (w) || MINI_WINDOW_P (w) || NILP (w->buffer) || NILP (w->horizontal_scrollbar_visible_p) || !window_truncation_on (w)) return 0; return XFIXNUM (w->scrollbar_height); #else return 0; #endif /* HAVE_SCROLLBARS */ } int window_modeline_height (struct window *w) { struct frame *f = XFRAME (w->frame); int modeline_height; if (MINI_WINDOW_P (w) || NILP (w->buffer)) { modeline_height = 0; } else if (!WINDOW_HAS_MODELINE_P (w)) { if (window_scrollbar_height (w)) modeline_height = 0; else { modeline_height = FRAMEMETH (f, divider_height, ()); if (!EQ (Qzero, w->modeline_shadow_thickness) && FRAME_WIN_P (f)) modeline_height += (2 * MODELINE_SHADOW_THICKNESS (w)); } } else { if (noninteractive) modeline_height = 0; else { display_line_dynarr *dla; /* We don't force a regeneration of the modeline here. Instead it is now a precondition that any function calling this should make sure that one of these structures is up-to-date. In practice this only affects two internal redisplay functions, regenerate_window and regenerate_window_point_center. */ /* We check DESIRED_DISP because if it is valid it is more up-to-date than CURRENT_DISP. For calls to this outside of redisplay it doesn't matter which structure we check since there is a redisplay condition that these structures be identical outside of redisplay. */ dla = window_display_lines (w, DESIRED_DISP); if (dla && Dynarr_length (dla) && Dynarr_begin (dla)->modeline) modeline_height = (Dynarr_begin (dla)->ascent + Dynarr_begin (dla)->descent); else { dla = window_display_lines (w, CURRENT_DISP); if (dla && Dynarr_length (dla) && Dynarr_begin (dla)->modeline) modeline_height = (Dynarr_begin (dla)->ascent + Dynarr_begin (dla)->descent); else /* This should be an abort except I'm not yet 100% confident that it won't ever get hit (though I haven't been able to trigger it). It is extremely unlikely to cause any noticeable problem and even if it does it will be a minor display glitch. */ /* #### Bullshit alert. It does get hit and it causes noticeable glitches. real_current_modeline_height is a kludge to fix this for 19.14. */ modeline_height = real_current_modeline_height (w); } if (!EQ (Qzero, w->modeline_shadow_thickness) && FRAME_WIN_P (f)) modeline_height += (2 * MODELINE_SHADOW_THICKNESS (w)); } } return modeline_height; } /***************************************************************************** margin_width_internal For a given window, return the width in pixels of the specified margin. ****************************************************************************/ static int margin_width_internal (struct window *w, int left_margin) { int window_cwidth = window_char_width (w, 1); int margin_cwidth; int font_width; Lisp_Object window; /* We might be getting called on a non-leaf. */ if (NILP (w->buffer)) return 0; /* The minibuffer never has margins. */ if (MINI_WINDOW_P (w)) return 0; window = wrap_window (w); margin_cwidth = (left_margin ? XFIXNUM (w->left_margin_width) : XFIXNUM (w->right_margin_width)); default_face_width_and_height (window, &font_width, 0); /* The left margin takes precedence over the right margin so we subtract its width from the space available for the right margin. */ if (!left_margin) window_cwidth -= XFIXNUM (w->left_margin_width); /* The margin cannot be wider than the window is. We allow the value to be bigger since it is possible for the user to enlarge the window such that the left margin value would no longer be too big, but we won't return a value that is larger. */ if (margin_cwidth > window_cwidth) margin_cwidth = window_cwidth; /* At the user level the margin is always specified in characters. Internally however it is manipulated in terms of pixels. */ return margin_cwidth * font_width; } int window_left_margin_width (struct window *w) { return margin_width_internal (w, 1); } int window_right_margin_width (struct window *w) { return margin_width_internal (w, 0); } /***************************************************************************** Window Gutters The gutters of a window are those areas in the boundary defined by w->pixel_top, w->pixel_left, w->pixel_height and w->pixel_width which do not contain text. Items which may be in the gutters include scrollbars, toolbars and modelines. The margin areas are not included. This is an exception made because redisplay special cases the handling of those areas in many places in such a way that including them in the gutter area would make life difficult. The size functions refer to height for the bottom and top gutters and width for the left and right gutters. The starting position functions refer to the Y coord for bottom and top gutters and the X coord for left and right gutters. All starting positions are relative to the frame, not the window. ****************************************************************************/ static int window_top_window_gutter_height (struct window *w) { if (!NILP (w->hchild) || !NILP (w->vchild)) return 0; #ifdef HAVE_SCROLLBARS if (!NILP (w->scrollbar_on_top_p)) return window_scrollbar_height (w); else #endif return 0; } int window_top_gutter_height (struct window *w) { return window_top_window_gutter_height (w); } static int window_bottom_window_gutter_height (struct window *w) { int gutter; if (!NILP (w->hchild) || !NILP (w->vchild)) return 0; gutter = window_modeline_height (w); #ifdef HAVE_SCROLLBARS if (NILP (w->scrollbar_on_top_p)) return window_scrollbar_height (w) + gutter; else #endif return gutter; } int window_bottom_gutter_height (struct window *w) { return window_bottom_window_gutter_height (w); } static int window_left_window_gutter_width (struct window *w, int USED_IF_SCROLLBARS (modeline)) { if (!NILP (w->hchild) || !NILP (w->vchild)) return 0; #ifdef HAVE_SCROLLBARS if (!modeline && !NILP (w->scrollbar_on_left_p)) return window_scrollbar_width (w); #endif return 0; } int window_left_gutter_width (struct window *w, int modeline) { return window_left_window_gutter_width (w, modeline); } static int window_right_window_gutter_width (struct window *w, int USED_IF_SCROLLBARS (modeline)) { int gutter = 0; if (!NILP (w->hchild) || !NILP (w->vchild)) return 0; #ifdef HAVE_SCROLLBARS if (!modeline && NILP (w->scrollbar_on_left_p)) gutter += window_scrollbar_width (w); #endif if (window_needs_vertical_divider (w)) gutter += window_divider_width (w); return gutter; } int window_right_gutter_width (struct window *w, int modeline) { return window_right_window_gutter_width (w, modeline); } static int window_pixel_height (struct window* w) { return WINDOW_HEIGHT (w); } DEFUN ("windowp", Fwindowp, 1, 1, 0, /* Return t if OBJECT is a window. */ (object)) { return WINDOWP (object) ? Qt : Qnil; } DEFUN ("window-live-p", Fwindow_live_p, 1, 1, 0, /* Return t if OBJECT is a window which is currently visible. */ (object)) { return WINDOWP (object) && WINDOW_LIVE_P (XWINDOW (object)) ? Qt : Qnil; } DEFUN ("selected-window", Fselected_window, 0, 1, 0, /* Return the window that the cursor now appears in and commands apply to. If the optional argument CON-DEV-OR-FRAME is specified and is a frame, return the selected window used by that frame. If CON-DEV-OR-FRAME is a device, then the selected frame on that device will be used. If CON-DEV-OR-FRAME is a console, the selected frame on that console's selected device will be used. Otherwise, the selected frame is used. */ (con_dev_or_frame)) { if (NILP (con_dev_or_frame) && NILP (Fselected_device (Qnil))) return Qnil; /* happens at startup */ { struct frame *f = decode_frame_or_selected (con_dev_or_frame); return FRAME_SELECTED_WINDOW (f); } } DEFUN ("last-nonminibuf-window", Flast_nonminibuf_window, 0, 1, 0, /* Return the last selected window that is not a minibuffer window. If the optional argument CON-DEV-OR-FRAME is specified and is a frame, return the last non-minibuffer window used by that frame. If CON-DEV-OR-FRAME is a device, then the selected frame on that device will be used. If CON-DEV-OR-FRAME is a console, the selected frame on that console's selected device will be used. Otherwise, the selected frame is used. */ (con_dev_or_frame)) { if (NILP (con_dev_or_frame) && NILP (Fselected_device (Qnil))) return Qnil; /* happens at startup */ { struct frame *f = decode_frame_or_selected (con_dev_or_frame); return FRAME_LAST_NONMINIBUF_WINDOW (f); } } DEFUN ("minibuffer-window", Fminibuffer_window, 0, 1, 0, /* Return the window used now for minibuffers. If the optional argument CON-DEV-OR-FRAME is specified and is a frame, return the minibuffer window used by that frame. If CON-DEV-OR-FRAME is a device, then the selected frame on that device will be used. If CON-DEV-OR-FRAME is a console, the selected frame on that console's selected device will be used. Otherwise, the selected frame is used. */ (con_dev_or_frame)) { return FRAME_MINIBUF_WINDOW (decode_frame_or_selected (con_dev_or_frame)); } DEFUN ("window-minibuffer-p", Fwindow_minibuffer_p, 0, 1, 0, /* Return non-nil if WINDOW is a minibuffer window. */ (window)) { return MINI_WINDOW_P (decode_window (window)) ? Qt : Qnil; } DEFUN ("window-first-hchild", Fwindow_first_hchild, 1, 1, 0, /* Return the first horizontal child of WINDOW, or nil. */ (window)) { return decode_window (window)->hchild; } DEFUN ("window-first-vchild", Fwindow_first_vchild, 1, 1, 0, /* Return the first vertical child of WINDOW, or nil. */ (window)) { return decode_window (window)->vchild; } DEFUN ("window-next-child", Fwindow_next_child, 1, 1, 0, /* Return the next window on the same level as WINDOW, or nil. */ (window)) { return decode_window (window)->next; } DEFUN ("window-previous-child", Fwindow_previous_child, 1, 1, 0, /* Return the previous window on the same level as WINDOW, or nil. */ (window)) { return decode_window (window)->prev; } DEFUN ("window-parent", Fwindow_parent, 1, 1, 0, /* Return the parent of WINDOW, or nil. */ (window)) { return decode_window (window)->parent; } DEFUN ("window-lowest-p", Fwindow_lowest_p, 1, 1, 0, /* Return non-nil if WINDOW is along the bottom of its frame. */ (window)) { return window_is_lowest (decode_window (window)) ? Qt : Qnil; } DEFUN ("window-highest-p", Fwindow_highest_p, 1, 1, 0, /* Return non-nil if WINDOW is along the top of its frame. */ (window)) { return window_is_highest (decode_window (window)) ? Qt : Qnil; } DEFUN ("window-leftmost-p", Fwindow_leftmost_p, 1, 1, 0, /* Return non-nil if WINDOW is along the left edge of its frame. */ (window)) { return window_is_leftmost (decode_window (window)) ? Qt : Qnil; } DEFUN ("window-rightmost-p", Fwindow_rightmost_p, 1, 1, 0, /* Return non-nil if WINDOW is along the right edge of its frame. */ (window)) { return window_is_rightmost (decode_window (window)) ? Qt : Qnil; } DEFUN ("pos-visible-in-window-p", Fpos_visible_in_window_p, 0, 3, 0, /* Returns t if position POS is currently on the frame in WINDOW. Returns nil if that position is scrolled vertically out of view. If a character is only partially visible, nil is returned, unless the optional argument PARTIALLY is non-nil. POS defaults to point in WINDOW's buffer; WINDOW, to the selected window. */ (pos, window, partially)) { struct window *w = decode_window (window); Charbpos top = marker_position (w->start[CURRENT_DISP]); Charbpos posint; struct buffer *buf = XBUFFER (w->buffer); if (NILP (pos)) posint = BUF_PT (buf); else { CHECK_FIXNUM_COERCE_MARKER (pos); posint = XFIXNUM (pos); } if (posint < top || posint > BUF_ZV (buf)) return Qnil; /* w->start can be out of range. If it is, do something reasonable. */ if (top < BUF_BEGV (buf) || top > BUF_ZV (buf)) return Qnil; return point_would_be_visible (w, top, posint, !NILP (partially)) ? Qt : Qnil; } struct window * decode_window (Lisp_Object window) { if (NILP (window)) return XWINDOW (Fselected_window (Qnil)); CHECK_LIVE_WINDOW (window); return XWINDOW (window); } int window_live_p (struct window *w) { return WINDOW_LIVE_P (w); } Lisp_Object window_frame (struct window *w) { return WINDOW_FRAME (w); } Lisp_Object window_buffer (struct window *w) { return WINDOW_BUFFER (w); } DEFUN ("window-buffer", Fwindow_buffer, 0, 1, 0, /* Return the buffer that WINDOW is displaying. */ (window)) { return decode_window (window)->buffer; } DEFUN ("window-frame", Fwindow_frame, 0, 1, 0, /* Return the frame that window WINDOW is on. */ (window)) { return decode_window (window)->frame; } DEFUN ("window-height", Fwindow_height, 0, 1, 0, /* Return the number of default lines in WINDOW. This actually works by dividing the window's pixel height (including the modeline and horizontal scrollbar, if any) by the height of the default font; therefore, the number of displayed lines will probably be different. Use `window-height' to get consistent results in geometry calculations. Use `window-displayed-height' to get the actual number of lines currently displayed in a window. The names are somewhat confusing; here's a table to help out: width height ------------------------------------------------------------------------- w/o gutters (rows/columns) window-width window-text-area-height (pixels) window-text-area-pixel-width window-text-area-pixel-height with gutters (rows/columns) window-full-width window-height (pixels) window-pixel-width window-pixel-height actually displayed (rows/columns) ---- window-displayed-height (pixels) ---- window-displayed-text-pixel-height */ (window)) { return make_fixnum (window_char_height (decode_window (window), 1)); } DEFUN ("window-displayed-height", Fwindow_displayed_height, 0, 1, 0, /* Return the number of lines currently displayed in WINDOW. This counts the actual number of lines displayed in WINDOW \(as opposed to `window-height'). The modeline and horizontal scrollbar do not count as lines. If there is some blank space between the end of the buffer and the end of the window, this function pretends that there are lines of text in the default font there. */ (window)) { return make_fixnum (window_displayed_height (decode_window (window))); } DEFUN ("window-pixel-height", Fwindow_pixel_height, 0, 1, 0, /* Return the height of WINDOW in pixels. Defaults to current window. This includes the window's modeline and horizontal scrollbar (if any). */ (window)) { return make_fixnum (window_pixel_height (decode_window (window))); } DEFUN ("window-text-area-height", Fwindow_text_area_height, 0, 1, 0, /* Return the number of default lines in the text area of WINDOW. This actually works by dividing the window's text area pixel height (i.e. excluding the modeline and horizontal scrollbar, if any) by the height of the default font; therefore, the number of displayed lines will probably be different. See also `window-height' and `window-displayed-height'. */ (window)) { return make_fixnum (window_char_height (decode_window (window), 0)); } DEFUN ("window-text-area-pixel-height", Fwindow_text_area_pixel_height, 0, 1, 0, /* Return the height in pixels of the text-displaying portion of WINDOW. Unlike `window-pixel-height', the space occupied by the modeline and horizontal scrollbar, if any, is not counted. */ (window)) { struct window *w = decode_window (window); return make_fixnum (WINDOW_TEXT_HEIGHT (w)); } DEFUN ("window-displayed-text-pixel-height", Fwindow_displayed_text_pixel_height, 0, 2, 0, /* Return the height in pixels of the text displayed in WINDOW. Unlike `window-text-area-pixel-height', any blank space below the end of the buffer is not included. If optional argument NOCLIPPED is non-nil, do not include space occupied by clipped lines. */ (window, noclipped)) { struct window *w; Charbpos start, eobuf; int defheight; int hlimit, height, prev_height = -1; int line; int elt, nelt, i; int needed; line_start_cache_dynarr *cache; if (NILP (window)) window = Fselected_window (Qnil); CHECK_LIVE_WINDOW (window); w = XWINDOW (window); start = marker_position (w->start[CURRENT_DISP]); hlimit = WINDOW_TEXT_HEIGHT (w); eobuf = BUF_ZV (XBUFFER (w->buffer)); default_face_width_and_height (window, NULL, &defheight); /* guess lines needed in line start cache + a few extra */ needed = (hlimit + defheight-1) / defheight + 3; while (1) { elt = point_in_line_start_cache (w, start, needed); assert (elt >= 0); /* in the cache */ cache = w->line_start_cache; nelt = Dynarr_length (cache); height = 0; for (i = elt; i < nelt; i++) { line = Dynarr_atp (cache, i)->height; if (height + line > hlimit) return make_fixnum (!NILP (noclipped) ? height : hlimit); height += line; if (height == hlimit || Dynarr_atp (cache, i)->end >= eobuf) return make_fixnum (height); } /* get here => need more cache lines. try again. */ assert(height > prev_height); /* progress? */ prev_height = height; needed += ((hlimit - height)*(nelt - elt) + height-1)/height + 3; } RETURN_NOT_REACHED(make_fixnum (0)); /* shut up compiler */ } DEFUN ("window-width", Fwindow_width, 0, 1, 0, /* Return the number of display columns in WINDOW. This is the width that is usable columns available for text in WINDOW, and does not include vertical scrollbars, dividers, or the like. See also `window-full-width' and `window-height'. */ (window)) { return make_fixnum (window_char_width (decode_window (window), 0)); } DEFUN ("window-full-width", Fwindow_full_width, 0, 1, 0, /* Return the total number of columns in WINDOW. This is like `window-width' but includes vertical scrollbars, dividers, etc. */ (window)) { return make_fixnum (window_char_width (decode_window (window), 1)); } DEFUN ("window-pixel-width", Fwindow_pixel_width, 0, 1, 0, /* Return the width of WINDOW in pixels. Defaults to current window. */ (window)) { return make_fixnum (decode_window (window)->pixel_width); } DEFUN ("window-text-area-pixel-width", Fwindow_text_area_pixel_width, 0, 1, 0, /* Return the width in pixels of the text-displaying portion of WINDOW. Unlike `window-pixel-width', the space occupied by the vertical scrollbar or divider, if any, is not counted. */ (window)) { struct window *w = decode_window (window); return make_fixnum (WINDOW_TEXT_WIDTH (w)); } DEFUN ("window-hscroll", Fwindow_hscroll, 0, 1, 0, /* Return the number of columns by which WINDOW is scrolled from left margin. */ (window)) { return make_fixnum (decode_window (window)->hscroll); } DEFUN ("modeline-hscroll", Fmodeline_hscroll, 0, 1, 0, /* Return the horizontal scrolling amount of WINDOW's modeline. If the window has no modeline, return nil. */ (window)) { struct window *w = decode_window (window); return (WINDOW_HAS_MODELINE_P (w)) ? make_fixnum ((int) w->modeline_hscroll) : Qnil; } DEFUN ("set-modeline-hscroll", Fset_modeline_hscroll, 2, 2, 0, /* Set the horizontal scrolling amount of WINDOW's modeline to NCOL. If NCOL is negative, it will silently be forced to 0. If the window has no modeline, return nil. Otherwise, return the actual value that was set. */ (window, ncol)) { struct window *w = decode_window (window); if (WINDOW_HAS_MODELINE_P (w)) { Charcount ncols; CHECK_FIXNUM (ncol); ncols = (XFIXNUM (ncol) <= 0) ? 0 : (Charcount) XFIXNUM (ncol); if (ncols != w->modeline_hscroll) { MARK_MODELINE_CHANGED; w->modeline_hscroll = ncols; } return make_fixnum ((int) ncols); } return Qnil; } DEFUN ("set-window-hscroll", Fset_window_hscroll, 2, 2, 0, /* Set number of columns WINDOW is scrolled from left margin to NCOL. NCOL should be zero or positive. */ (window, ncol)) { struct window *w; int ncols; CHECK_FIXNUM (ncol); ncols = XFIXNUM (ncol); if (ncols < 0) ncols = 0; w = decode_window (window); if (w->hscroll != ncols) MARK_CLIP_CHANGED; /* FSF marks differently but we aren't FSF. */ w->hscroll = ncols; return ncol; } DEFUN ("window-pixel-edges", Fwindow_pixel_edges, 0, 1, 0, /* Return a list of the pixel edge coordinates of WINDOW. The returned list is of the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at the top left corner of WINDOW's frame. The frame toolbars, menubars and gutters are considered to be outside of this area, while the scrollbars are considered to be inside. */ (window)) { struct window *w = decode_window (window); struct frame *f = XFRAME (w->frame); int left = w->pixel_left - FRAME_PANED_LEFT_EDGE (f); int top = w->pixel_top - FRAME_PANED_TOP_EDGE (f); return list4 (make_fixnum (left), make_fixnum (top), make_fixnum (left + w->pixel_width), make_fixnum (top + w->pixel_height)); } DEFUN ("window-text-area-pixel-edges", Fwindow_text_area_pixel_edges, 0, 1, 0, /* Return a list of the pixel edge coordinates of the text area of WINDOW. The returned list is of the form (LEFT TOP RIGHT BOTTOM), all relative to 0, 0 at the top left corner of the total area allocated to the window, which includes the scrollbars. */ (window)) { struct window *w = decode_window (window); int left = window_left_gutter_width (w, /* modeline = */ 0); int top = window_top_gutter_height (w); int right = WINDOW_WIDTH (w) - window_right_gutter_width (w, 0); int bottom = WINDOW_HEIGHT (w) - window_bottom_gutter_height (w); return list4 (make_fixnum (left), make_fixnum (top), make_fixnum (right), make_fixnum (bottom)); } DEFUN ("window-point", Fwindow_point, 0, 1, 0, /* Return current value of point in WINDOW. For a non-selected window, this is the value point would have if that window were selected. Note that, when WINDOW is the selected window and its buffer is also currently selected, the value returned is the same as (point). It would be more strictly correct to return the `top-level' value of point, outside of any save-excursion forms. But that value is hard to find. */ (window)) { struct window *w = decode_window (window); /* The special check for current buffer is necessary for this function to work as defined when called within an excursion. */ if (w == XWINDOW (Fselected_window (XFRAME (w->frame)->device)) && current_buffer == XBUFFER (w->buffer)) return Fpoint (Qnil); return Fmarker_position (w->pointm[CURRENT_DISP]); } DEFUN ("window-start", Fwindow_start, 0, 1, 0, /* Return position at which display currently starts in WINDOW. This is updated by redisplay or by calling `set-window-start'. */ (window)) { return Fmarker_position (decode_window (window)->start[CURRENT_DISP]); } DEFUN ("window-end", Fwindow_end, 0, 2, 0, /* Return position at which display currently ends in WINDOW. This is updated by redisplay, when it runs to completion. Simply changing the buffer text or setting `window-start' does not update this value. WINDOW defaults to the selected window. If optional arg GUARANTEE is non-nil, the return value is guaranteed to be the same value as this function would return at the end of the next full redisplay assuming nothing else changes in the meantime. This function is potentially much slower with this flag set. */ (window, guarantee)) { struct window *w = decode_window (window); if (NILP (guarantee)) { Lisp_Object buf; buf = w->buffer; CHECK_BUFFER (buf); return make_fixnum (BUF_Z (XBUFFER (buf)) - w->window_end_pos[CURRENT_DISP]); } else { Charbpos startp = marker_position (w->start[CURRENT_DISP]); return make_fixnum (end_of_last_line (w, startp)); } } DEFUN ("window-last-line-visible-height", Fwindow_last_line_visible_height, 0, 1, 0, /* Return pixel height of visible part of last window line if it is clipped. If the last line is not clipped, return nil. */ (window)) { struct window *w = decode_window (window); display_line_dynarr *dla = window_display_lines (w, CURRENT_DISP); int num_lines = Dynarr_length (dla); struct display_line *dl; /* No lines - no clipped lines */ if (num_lines == 0 || (num_lines == 1 && Dynarr_begin (dla)->modeline)) return Qnil; dl = Dynarr_atp (dla, num_lines - 1); if (dl->clip == 0) return Qnil; return make_fixnum (dl->ascent + dl->descent - dl->clip); } DEFUN ("set-window-point", Fset_window_point, 2, 2, 0, /* Make point value in WINDOW be at position POS in WINDOW's buffer. If WINDOW is the selected window, and window's buffer is the current buffer, this actually changes the buffer's point instead of the window's point. (The equivalence of the selected window's point with its buffer's point is maintained throughout XEmacs. However, enforcing the additional restriction on the current buffer is "bug compatible" with FSF and is perhaps more logical.) */ (window, pos)) { struct window *w = decode_window (window); CHECK_FIXNUM_COERCE_MARKER (pos); /* Don't dereference selected-window because there may not be one -- e.g. at startup */ if (EQ (wrap_window (w), Fselected_window (Qnil)) && EQ (w->buffer, Fcurrent_buffer ())) Fgoto_char (pos, Qnil); else set_marker_restricted (w->pointm[CURRENT_DISP], pos, w->buffer); MARK_POINT_CHANGED; return pos; } DEFUN ("set-window-start", Fset_window_start, 2, 3, 0, /* Make display in WINDOW start at position POS in WINDOW's buffer. Optional third arg NOFORCE non-nil inhibits next redisplay from overriding motion of point in order to display at this exact start. */ (window, pos, noforce)) { struct window *w = decode_window (window); CHECK_FIXNUM_COERCE_MARKER (pos); set_marker_restricted (w->start[CURRENT_DISP], pos, w->buffer); /* this is not right, but much easier than doing what is right. */ /* w->start_at_line_beg = 0; */ /* WTF is the above supposed to mean? GE */ w->start_at_line_beg = beginning_of_line_p (XBUFFER (w->buffer), marker_position (w->start[CURRENT_DISP])); if (NILP (noforce)) w->force_start = 1; w->redo_modeline = 1; SET_LAST_MODIFIED (w, 0); SET_LAST_FACECHANGE (w); MARK_WINDOWS_CHANGED (w); return pos; } DEFUN ("window-dedicated-p", Fwindow_dedicated_p, 1, 1, 0, /* Return WINDOW's dedicated object, usually t or nil. See also `set-window-dedicated-p'. */ (window)) { return decode_window (window)->dedicated; } DEFUN ("set-window-dedicated-p", Fset_window_dedicated_p, 2, 2, 0, /* Control whether WINDOW is dedicated to the buffer it displays. If it is dedicated, Emacs will not automatically change which buffer appears in it. The second argument is the new value for the dedication flag; non-nil means yes. */ (window, arg)) { struct window *w = decode_window (window); w->dedicated = NILP (arg) ? Qnil : Qt; return w->dedicated; } /* FSFmacs has window-display-table here. We have display table as a specifier. */ /* Record info on buffer window w is displaying when it is about to cease to display that buffer. */ static void unshow_buffer (struct window *w) { Lisp_Object buf = w->buffer; struct buffer *b = XBUFFER (buf); assert (b == XMARKER (w->pointm[CURRENT_DISP])->buffer); /* FSF disables this check, so I'll do it too. I hope it won't break things. --ben */ #if 0 if (w == XWINDOW (Fselected_window (Qnil)) || ! EQ (buf, XWINDOW (Fselected_window (Qnil))->buffer)) /* Do this except when the selected window's buffer is being removed from some other window. */ #endif /* last_window_start records the start position that this buffer had in the last window to be disconnected from it. Now that this statement is unconditional, it is possible for the buffer to be displayed in the selected window, while last_window_start reflects another window which was recently showing the same buffer. Some people might say that might be a good thing. Let's see. */ XBUFFER (buf)->last_window_start = marker_position (w->start[CURRENT_DISP]); /* Point in the selected window's buffer is actually stored in that buffer, and the window's pointm isn't used. So don't clobber point in that buffer. */ if (! EQ (buf, XWINDOW (Fselected_window (Qnil))->buffer)) BUF_SET_PT (b, charbpos_clip_to_bounds (BUF_BEGV (b), marker_position (w->pointm[CURRENT_DISP]), BUF_ZV (b))); { Lisp_Object marker = Fgethash (buf, w->saved_point_cache, Qnil); int selected = EQ (wrap_window (w), Fselected_window (Qnil)); if (NILP (marker)) { marker = Fmake_marker (); Fputhash (buf, marker, w->saved_point_cache); } Fset_marker (marker, selected ? make_fixnum (BUF_PT (b)) : w->pointm[CURRENT_DISP], buf); marker = Fgethash (buf, w->saved_last_window_start_cache, Qnil); if (NILP (marker)) { marker = Fmake_marker (); Fputhash (buf, marker, w->saved_last_window_start_cache); } Fset_marker (marker, w->start[CURRENT_DISP], buf); } } /* Put REPLACEMENT into the window structure in place of OLD. */ static void replace_window (Lisp_Object old, Lisp_Object replacement) { Lisp_Object tem; struct window *o = XWINDOW (old), *p = XWINDOW (replacement); /* If OLD is its frame's root_window, then replacement is the new root_window for that frame. */ if (EQ (old, FRAME_ROOT_WINDOW (XFRAME (o->frame)))) FRAME_ROOT_WINDOW (XFRAME (o->frame)) = replacement; WINDOW_LEFT (p) = WINDOW_LEFT (o); WINDOW_TOP (p) = WINDOW_TOP (o); WINDOW_WIDTH (p) = WINDOW_WIDTH (o); WINDOW_HEIGHT (p) = WINDOW_HEIGHT (o); p->next = tem = o->next; if (!NILP (tem)) XWINDOW (tem)->prev = replacement; p->prev = tem = o->prev; if (!NILP (tem)) XWINDOW (tem)->next = replacement; p->parent = tem = o->parent; if (!NILP (tem)) { if (EQ (XWINDOW (tem)->vchild, old)) XWINDOW (tem)->vchild = replacement; if (EQ (XWINDOW (tem)->hchild, old)) XWINDOW (tem)->hchild = replacement; } /* #### Here, if replacement is a vertical combination and so is its new parent, we should make replacement's children be children of that parent instead. */ ERROR_CHECK_SUBWINDOW_CACHE (p); } static void window_unmap_subwindows (struct window* w) { assert (!NILP (w->subwindow_instance_cache)); elisp_maphash (unmap_subwindow_instance_cache_mapper, w->subwindow_instance_cache, (void*)1); } /* we're deleting W; set the structure of W to indicate this. */ static void mark_window_as_deleted (struct window *w) { /* The window instance cache is going away now, so need to get the cachels reset by redisplay. */ MARK_FRAME_SUBWINDOWS_CHANGED (XFRAME (WINDOW_FRAME (w))); /* The cache is going away. If we leave unmapping to reset_subwindow_cachels then we get in a situation where the domain (the window) has been deleted but we still need access to its attributes in order to unmap windows properly. Since the subwindows are going to get GC'd anyway as a result of the domain going away, it is safer to just unmap them all while we know the domain is still valid. */ ERROR_CHECK_SUBWINDOW_CACHE (w); window_unmap_subwindows (w); /* Free the extra data structures attached to windows immediately so they don't sit around consuming excess space. They will be reinitialized by the window-configuration code as necessary. */ finalize_window (wrap_window (w)); /* Nobody should be accessing anything in this object any more, and making them Qnil allows for better GC'ing in case a pointer to the dead window continues to hang around. Zero all other structs in case someone tries to access something through them. (So, in point of fact, we zero out all of the "saved" slots, which are obviously restored from the window config, plus the slots which were already zeroed.) As an example of why setting the values to Qnil is good, here is an old comment: In the loop (while t (split-window) (delete-window)) we end up with a tree of deleted windows which are all connected through the `next' slot. This might not seem so bad, as they're deleted, and will presumably be GCed - but if even *one* of those windows is still being pointed to, by the user, or by a window configuration, then *all* of those windows stick around. */ #define WINDOW_SLOT(slot) #define WINDOW_SAVED_SLOT(slot, compare) w->slot = Qnil; #include "winslots.h" w->next = Qnil; w->prev = Qnil; w->hchild = Qnil; w->vchild = Qnil; w->parent = Qnil; w->subwindow_instance_cache = Qnil; w->dead = 1; note_object_deleted (wrap_window (w)); } /* Check if window contains pwindow. */ static int contains_window (Lisp_Object window, Lisp_Object pwindow) { while (!NILP (pwindow)) { if (EQ (window, pwindow)) return 1; pwindow = XWINDOW (pwindow)->parent; } return 0; } DEFUN ("delete-window", Fdelete_window, 0, 2, "", /* Remove WINDOW from the display. Default is selected window. If window is the only one on its frame, the frame is deleted as well. Normally, you cannot delete the last non-minibuffer-only frame (you must use `save-buffers-kill-emacs' or `kill-emacs'). However, if optional second argument FORCE is non-nil, you can delete the last frame. (This will automatically call `save-buffers-kill-emacs'.) */ (window, force)) { /* This function can GC if this is the only window in the frame */ struct window *w; Lisp_Object parent; struct window *par; Lisp_Object frame; struct frame *f; struct device *d; /* Note: this function is called by other C code on non-leaf windows. */ /* Do the equivalent of decode_window() but don't error out on deleted window; it's OK to delete an already-deleted window. */ if (NILP (window)) window = Fselected_window (Qnil); else CHECK_WINDOW (window); w = XWINDOW (window); /* It's okay to delete an already-deleted window. */ if (! WINDOW_LIVE_P (w)) return Qnil; check_allowed_operation (OPERATION_DELETE_OBJECT, window, Qnil); frame = WINDOW_FRAME (w); f = XFRAME (frame); d = XDEVICE (FRAME_DEVICE (f)); if (TOP_LEVEL_WINDOW_P (w)) { if (NILP (memq_no_quit (frame, DEVICE_FRAME_LIST (d)))) /* this frame isn't fully initialized yet; don't blow up. */ return Qnil; if (MINI_WINDOW_P (XWINDOW (window))) signal_error (Qinvalid_operation, "Attempt to delete the minibuffer window", Qunbound); /* It has been suggested that it's a good thing for C-x 0 to have this behavior, but not such a good idea for #'delete-window to have it. Maybe C-x 0 should be bound to something else, or maybe frame deletion should only happen when this is called interactively. */ delete_frame_internal (f, !NILP (force), 0, 0); return Qnil; } /* At this point, we know the window has a parent. */ parent = w->parent; par = XWINDOW (parent); MARK_FRAME_WINDOWS_STRUCTURE_CHANGED (f); /* It's quite likely that deleting a window will result in subwindows needing to be deleted also (since they are cached per-window). So we mark them as changed, so that the cachels will get reset by redisplay and thus deleted subwindows can get GC'd. */ MARK_FRAME_SUBWINDOWS_CHANGED (f); /* Are we trying to delete any frame's selected window? Note that we could be dealing with a non-leaf window where the selected window is one of our children. So, we check by scanning all the ancestors of the frame's selected window and comparing each one with WINDOW. */ if (contains_window (window, FRAME_SELECTED_WINDOW (f))) { Lisp_Object alternative; alternative = Fnext_window (window, Qlambda, Qnil, Qnil); /* #### */ /* If we're about to delete the selected window on the selected frame, then we should use Fselect_window to select the new window. On the other hand, if we're about to delete the selected window on any other frame, we shouldn't do anything but set the frame's selected_window slot. */ if (EQ (frame, Fselected_frame (Qnil))) Fselect_window (alternative, Qnil); else set_frame_selected_window (f, alternative); } /* Some display parameters (gutter display specifically) depend on FRAME_LAST_NONMINIBUF (f) to be set to a live window. Ensure that. */ if (contains_window (window, FRAME_LAST_NONMINIBUF_WINDOW (f))) f->last_nonminibuf_window = Fnext_window (window, Qlambda, Qnil, Qnil); /* w->buffer is nil in a non-leaf window; in this case, get rid of the markers we maintain that point into that buffer. */ if (!NILP (w->buffer)) { unshow_buffer (w); unchain_marker (w->pointm[CURRENT_DISP]); unchain_marker (w->pointm[DESIRED_DISP]); unchain_marker (w->pointm[CMOTION_DISP]); unchain_marker (w->start[CURRENT_DISP]); unchain_marker (w->start[DESIRED_DISP]); unchain_marker (w->start[CMOTION_DISP]); unchain_marker (w->sb_point); w->buffer = Qnil; } /* close up the hole in the sibling list */ if (!NILP (w->next)) XWINDOW (w->next)->prev = w->prev; if (!NILP (w->prev)) XWINDOW (w->prev)->next = w->next; if (EQ (window, par->hchild)) par->hchild = w->next; if (EQ (window, par->vchild)) par->vchild = w->next; /* Find one of our siblings to give our space to. */ { Lisp_Object sib = w->prev; if (NILP (sib)) { /* If w gives its space to its next sibling, that sibling needs to have its top/left side pulled back to where w's is. set_window_{height,width} will re-position the sibling's children. */ sib = w->next; WINDOW_TOP (XWINDOW (sib)) = WINDOW_TOP (w); WINDOW_LEFT (XWINDOW (sib)) = WINDOW_LEFT (w); } /* Stretch that sibling. */ if (!NILP (par->vchild)) set_window_pixheight (sib, (WINDOW_HEIGHT (XWINDOW (sib)) + WINDOW_HEIGHT (w)), 1); if (!NILP (par->hchild)) set_window_pixwidth (sib, (WINDOW_WIDTH (XWINDOW (sib)) + WINDOW_WIDTH (w)), 1); } /* If parent now has only one child, put the child into the parent's place. */ { Lisp_Object parchild = par->hchild; if (NILP (parchild)) parchild = par->vchild; if (NILP (XWINDOW (parchild)->next)) { replace_window (parent, parchild); mark_window_as_deleted (XWINDOW (parent)); } } /* Since we may be deleting combination windows, we must make sure that not only W but all its children have been marked as deleted. */ if (!NILP (w->hchild)) delete_all_subwindows (XWINDOW (w->hchild)); else if (!NILP (w->vchild)) delete_all_subwindows (XWINDOW (w->vchild)); /* Warning: mark_window_as_deleted calls window_unmap_subwindows and therefore redisplay, so it requires the mirror structure to be correct. We must dirty the mirror before it is called. */ f->mirror_dirty = 1; mark_window_as_deleted (w); return Qnil; } DEFUN ("next-window", Fnext_window, 0, 4, 0, /* Return the next window after WINDOW in the canonical ordering of windows. If omitted, WINDOW defaults to the selected window. Optional second arg MINIBUF t means count the minibuffer window even if not active. MINIBUF nil or omitted means count the minibuffer iff it is active. MINIBUF neither t nor nil means not to count the minibuffer even if it is active. Several frames may share a single minibuffer; if the minibuffer counts, all windows on all frames that share that minibuffer count too. Therefore, `next-window' can be used to iterate through the set of windows even when the minibuffer is on another frame. If the minibuffer does not count, only windows from WINDOW's frame count. By default, only the windows in the selected frame are considered. The optional argument WHICH-FRAMES changes this behavior: WHICH-FRAMES = `visible' means search windows on all visible frames. WHICH-FRAMES = 0 means search windows on all visible and iconified frames. WHICH-FRAMES = t means search windows on all frames including invisible frames. WHICH-FRAMES = a frame means search only windows on that frame. Anything else means restrict to the selected frame. The optional fourth argument WHICH-DEVICES further clarifies on which devices to search for frames as specified by WHICH-FRAMES. This value is only meaningful if WHICH-FRAMES is non-nil. If nil or omitted, search all devices on the selected console. If a device, only search that device. If a console, search all devices on that console. If a device type, search all devices of that type. If `window-system', search all window-system devices. Any other non-nil value means search all devices. If you use consistent values for MINIBUF, WHICH-FRAMES, and WHICH-DEVICES, you can use `next-window' to iterate through the entire cycle of acceptable windows, eventually ending up back at the window you started with. `previous-window' traverses the same cycle, in the reverse order. */ (window, minibuf, which_frames, which_devices)) { Lisp_Object tem; Lisp_Object start_window; if (NILP (window)) window = Fselected_window (Qnil); else CHECK_LIVE_WINDOW (window); start_window = window; /* minibuf == nil may or may not include minibuffers. Decide if it does. */ if (NILP (minibuf)) minibuf = (minibuf_level ? minibuf_window : Qlambda); else if (! EQ (minibuf, Qt)) minibuf = Qlambda; /* Now `minibuf' is one of: t => count all minibuffer windows lambda => count none of them or a specific minibuffer window (the active one) to count. */ /* which_frames == nil doesn't specify which frames to include. */ if (NILP (which_frames)) which_frames = (! EQ (minibuf, Qlambda) ? (FRAME_MINIBUF_WINDOW (XFRAME (WINDOW_FRAME (XWINDOW (window))))) : Qnil); else if (EQ (which_frames, Qvisible)) ; else if (ZEROP (which_frames)) ; else if (FRAMEP (which_frames) && ! EQ (which_frames, Fwindow_frame (window))) /* If which_frames is a frame and window arg isn't on that frame, just return the first window on the frame. */ return frame_first_window (XFRAME (which_frames)); else if (! EQ (which_frames, Qt)) which_frames = Qnil; /* Now `which_frames' is one of: t => search all frames nil => search just the current frame visible => search just visible frames 0 => search visible and iconified frames a window => search the frame that window belongs to. */ /* Do this loop at least once, to get the next window, and perhaps again, if we hit the minibuffer and that is not acceptable. */ do { /* Find a window that actually has a next one. This loop climbs up the tree. */ while (tem = XWINDOW (window)->next, NILP (tem)) if (tem = XWINDOW (window)->parent, !NILP (tem)) window = tem; else /* window must be minibuffer window now */ { /* We've reached the end of this frame. Which other frames are acceptable? */ tem = WINDOW_FRAME (XWINDOW (window)); if (! NILP (which_frames)) { Lisp_Object tem1 = tem; tem = next_frame (tem, which_frames, which_devices); /* In the case where the minibuffer is active, and we include its frame as well as the selected one, next_frame may get stuck in that frame. If that happens, go back to the selected frame so we can complete the cycle. */ if (EQ (tem, tem1)) tem = wrap_frame (selected_frame ()); } tem = FRAME_ROOT_WINDOW (XFRAME (tem)); break; } window = tem; /* If we're in a combination window, find its first child and recurse on that. Otherwise, we've found the window we want. */ while (1) { if (!NILP (XWINDOW (window)->hchild)) window = XWINDOW (window)->hchild; else if (!NILP (XWINDOW (window)->vchild)) window = XWINDOW (window)->vchild; else break; } } /* Which windows are acceptable? Exit the loop and accept this window if this isn't a minibuffer window, or we're accepting all minibuffer windows, or this is the active minibuffer and we are accepting that one, or we've come all the way around and we're back at the original window. */ while (MINI_WINDOW_P (XWINDOW (window)) && ! EQ (minibuf, Qt) && ! EQ (minibuf, window) && ! EQ (window, start_window)); return window; } DEFUN ("previous-window", Fprevious_window, 0, 4, 0, /* Return the window preceding WINDOW in the canonical ordering of windows. If omitted, WINDOW defaults to the selected window. Optional second arg MINIBUF t means count the minibuffer window even if not active. MINIBUF nil or omitted means count the minibuffer iff it is active. MINIBUF neither t nor nil means not to count the minibuffer even if it is active. Several frames may share a single minibuffer; if the minibuffer counts, all windows on all frames that share that minibuffer count too. Therefore, `previous-window' can be used to iterate through the set of windows even when the minibuffer is on another frame. If the minibuffer does not count, only windows from WINDOW's frame count. By default, only the windows in the selected frame are considered. The optional argument WHICH-FRAMES changes this behavior: WHICH-FRAMES = `visible' means search windows on all visible frames. WHICH-FRAMES = 0 means search windows on all visible and iconified frames. WHICH-FRAMES = t means search windows on all frames including invisible frames. WHICH-FRAMES = a frame means search only windows on that frame. Anything else means restrict to the selected frame. The optional fourth argument WHICH-DEVICES further clarifies on which devices to search for frames as specified by WHICH-FRAMES. This value is only meaningful if WHICH-FRAMES is non-nil. If nil or omitted, search all devices on the selected console. If a device, only search that device. If a console, search all devices on that console. If a device type, search all devices of that type. If `window-system', search all window-system devices. Any other non-nil value means search all devices. If you use consistent values for MINIBUF, WHICH-FRAMES, and WHICH-DEVICES, you can use `previous-window' to iterate through the entire cycle of acceptable windows, eventually ending up back at the window you started with. `next-window' traverses the same cycle, in the reverse order. */ (window, minibuf, which_frames, devices)) { Lisp_Object tem; Lisp_Object start_window; if (NILP (window)) window = Fselected_window (Qnil); else CHECK_LIVE_WINDOW (window); start_window = window; /* minibuf == nil may or may not include minibuffers. Decide if it does. */ if (NILP (minibuf)) minibuf = (minibuf_level ? minibuf_window : Qlambda); else if (! EQ (minibuf, Qt)) minibuf = Qlambda; /* Now `minibuf' is one of: t => count all minibuffer windows lambda => count none of them or a specific minibuffer window (the active one) to count. */ /* which_frames == nil doesn't specify which frames to include. Decide which frames it includes. */ if (NILP (which_frames)) which_frames = (! EQ (minibuf, Qlambda) ? (FRAME_MINIBUF_WINDOW (XFRAME (WINDOW_FRAME (XWINDOW (window))))) : Qnil); else if (EQ (which_frames, Qvisible)) ; else if (ZEROP (which_frames)) ; else if (FRAMEP (which_frames) && ! EQ (which_frames, Fwindow_frame (window))) /* If which_frames is a frame and window arg isn't on that frame, just return the first window on the frame. */ return frame_first_window (XFRAME (which_frames)); else if (! EQ (which_frames, Qt)) which_frames = Qnil; /* Now `which_frames' is one of: t => search all frames nil => search just the current frame visible => search just visible frames 0 => search visible and iconified frames a window => search the frame that window belongs to. */ /* Do this loop at least once, to get the next window, and perhaps again, if we hit the minibuffer and that is not acceptable. */ do { /* Find a window that actually has a next one. This loop climbs up the tree. */ while (tem = XWINDOW (window)->prev, NILP (tem)) if (tem = XWINDOW (window)->parent, !NILP (tem)) window = tem; else /* window must be minibuffer window now */ { /* We have found the top window on the frame. Which frames are acceptable? */ tem = WINDOW_FRAME (XWINDOW (window)); if (! NILP (which_frames)) /* It's actually important that we use previous_frame here, rather than next_frame. All the windows acceptable according to the given parameters should form a ring; Fnext_window and Fprevious_window should go back and forth around the ring. If we use next_frame here, then Fnext_window and Fprevious_window take different paths through the set of acceptable windows. window_loop assumes that these `ring' requirement are met. */ { Lisp_Object tem1 = tem; tem = previous_frame (tem, which_frames, devices); /* In the case where the minibuffer is active, and we include its frame as well as the selected one, next_frame may get stuck in that frame. If that happens, go back to the selected frame so we can complete the cycle. */ if (EQ (tem, tem1)) tem = wrap_frame (selected_frame ()); } /* If this frame has a minibuffer, find that window first, because it is conceptually the last window in that frame. */ if (FRAME_HAS_MINIBUF_P (XFRAME (tem))) tem = FRAME_MINIBUF_WINDOW (XFRAME (tem)); else tem = FRAME_ROOT_WINDOW (XFRAME (tem)); break; } window = tem; /* If we're in a combination window, find its first child and recurse on that. Otherwise, we've found the window we want. */ while (1) { if (!NILP (XWINDOW (window)->hchild)) window = XWINDOW (window)->hchild; else if (!NILP (XWINDOW (window)->vchild)) window = XWINDOW (window)->vchild; else break; while (tem = XWINDOW (window)->next, !NILP (tem)) window = tem; } } /* Which windows are acceptable? Exit the loop and accept this window if this isn't a minibuffer window, or we're accepting all minibuffer windows, or this is the active minibuffer and we are accepting that one, or we've come all the way around and we're back at the original window. */ while (MINI_WINDOW_P (XWINDOW (window)) && ! EQ (minibuf, Qt) && ! EQ (minibuf, window) && ! EQ (window, start_window)); return window; } DEFUN ("next-vertical-window", Fnext_vertical_window, 0, 1, 0, /* Return the next window which is vertically after WINDOW. */ (window)) { Lisp_Object root; struct window *w = decode_window (window); window = wrap_window (w); if (MINI_WINDOW_P (XWINDOW (window))) return Qnil; root = FRAME_ROOT_WINDOW (XFRAME (WINDOW_FRAME (XWINDOW (window)))); if (EQ (window, root)) { while (1) if (!NILP (XWINDOW (window)->hchild)) window = XWINDOW (window)->hchild; else if (!NILP (XWINDOW (window)->vchild)) window = XWINDOW (window)->vchild; else return window; } do { if (!NILP (XWINDOW (window)->parent) && !NILP (XWINDOW (XWINDOW (window)->parent)->vchild)) { if (!NILP (XWINDOW (window)->next)) return XWINDOW (window)->next; else window = XWINDOW (window)->parent; } else window = XWINDOW (window)->parent; } while (!EQ (window, root)); while (1) if (!NILP (XWINDOW (window)->hchild)) window = XWINDOW (window)->hchild; else if (!NILP (XWINDOW (window)->vchild)) window = XWINDOW (window)->vchild; else return window; } DEFUN ("other-window", Fother_window, 1, 3, "p", /* Select the COUNT'th different window on this frame. All windows on current frame are arranged in a cyclic order. This command selects the window COUNT steps away in that order. A negative COUNT moves in the opposite order. By default, only the windows in the selected frame are considered. The optional argument WHICH-FRAMES changes this behavior: WHICH-FRAMES = `visible' means search windows on all visible frames. WHICH-FRAMES = 0 means search windows on all visible and iconified frames. WHICH-FRAMES = t means search windows on all frames including invisible frames. WHICH-FRAMES = a frame means search only windows on that frame. Anything else means restrict to the selected frame. The optional argument WHICH-DEVICES further clarifies on which devices to search for frames as specified by WHICH-FRAMES. This value is only meaningful if WHICH-FRAMES is non-nil. If nil or omitted, search all devices on the selected console. If a device, only search that device. If a console, search all devices on that console. If a device type, search all devices of that type. If `window-system', search all window-system devices. Any other non-nil value means search all devices. */ (count, which_frames, which_devices)) { int i; Lisp_Object w; CHECK_FIXNUM (count); w = Fselected_window (Qnil); i = XFIXNUM (count); while (i > 0) { w = Fnext_window (w, Qnil, which_frames, which_devices); i--; } while (i < 0) { w = Fprevious_window (w, Qnil, which_frames, which_devices); i++; } Fselect_window (w, Qnil); return Qnil; } /* Look at all windows, performing an operation specified by TYPE with argument OBJ. If FRAMES is Qt, look at all frames, if Qnil, look at just the selected frame. If FRAMES is a frame, just look at windows on that frame. If MINI is non-zero, perform the operation on minibuffer windows too. */ enum window_loop { WINDOW_LOOP_UNUSED, GET_BUFFER_WINDOW, /* Arg is buffer */ GET_LRU_WINDOW, /* Arg is t for full-width windows only */ DELETE_OTHER_WINDOWS, /* Arg is window not to delete */ DELETE_BUFFER_WINDOWS, /* Arg is buffer */ GET_LARGEST_WINDOW, GET_BUFFER_WINDOW_COUNT, /* Arg is buffer */ GET_BUFFER_MRU_WINDOW /* Arg is buffer */ }; static Lisp_Object window_loop (enum window_loop type, Lisp_Object obj, int mini, Lisp_Object which_frames, int dedicated_too, Lisp_Object which_devices) { /* This function can GC if type == DELETE_BUFFER_WINDOWS */ Lisp_Object w; Lisp_Object best_window = Qnil; Lisp_Object next_window; Lisp_Object last_window; struct frame *frame; Lisp_Object frame_arg = Qt; int count = 0; /* for GET_BUFFER_WINDOW_COUNT */ /* #### I think the change of "precomputing" last_window and next_window * #### catch the lossage this is meant(?) to punt on... */ int lose_lose = 0; Lisp_Object devcons, concons; /* If we're only looping through windows on a particular frame, FRAME points to that frame. If we're looping through windows on all frames, FRAME is 0. */ if (FRAMEP (which_frames)) frame = XFRAME (which_frames); else if (NILP (which_frames)) frame = selected_frame (); else frame = 0; /* FRAME_ARG is Qlambda to stick to one frame, Qvisible to consider all visible frames, or Qt otherwise. */ if (frame) frame_arg = Qlambda; else if (ZEROP (which_frames)) frame_arg = which_frames; else if (EQ (which_frames, Qvisible)) frame_arg = which_frames; DEVICE_LOOP_NO_BREAK (devcons, concons) { Lisp_Object device = XCAR (devcons); Lisp_Object the_frame; if (frame) the_frame = wrap_frame (frame); else the_frame = DEVICE_SELECTED_FRAME (XDEVICE (device)); if (NILP (the_frame)) continue; if (!device_matches_device_spec (device, NILP (which_devices) ? FRAME_CONSOLE (XFRAME (the_frame)) : which_devices)) continue; /* Pick a window to start with. */ if (WINDOWP (obj)) w = obj; else w = FRAME_SELECTED_WINDOW (XFRAME (the_frame)); /* Figure out the last window we're going to mess with. Since Fnext_window, given the same options, is guaranteed to go in a ring, we can just use Fprevious_window to find the last one. We can't just wait until we hit the first window again, because it might be deleted. */ last_window = Fprevious_window (w, mini ? Qt : Qnil, frame_arg, device); best_window = Qnil; for (;;) { struct window *p = XWINDOW (w); /* Pick the next window now, since some operations will delete the current window. */ next_window = Fnext_window (w, mini ? Qt : Qnil, frame_arg, device); /* #### Still needed ?? */ /* Given the outstanding quality of the rest of this code, I feel no shame about putting this piece of shit in. */ if (++lose_lose >= 500) { /* Call to ABORT() added by Darryl Okahata (16 Nov. 2001), at Ben's request, to catch any remaining bugs. If you find that XEmacs is aborting here, and you need to be up and running ASAP, it should be safe to comment out the following ABORT(), as long as you leave the "break;" alone. */ ABORT(); break; /* <--- KEEP THIS HERE! Do not delete! */ } /* Note that we do not pay attention here to whether the frame is visible, since Fnext_window skips non-visible frames if that is desired, under the control of frame_arg. */ if (! MINI_WINDOW_P (p) || (mini && minibuf_level > 0)) switch (type) { case GET_BUFFER_WINDOW: { if (XBUFFER (p->buffer) == XBUFFER (obj)) return w; break; } case GET_BUFFER_WINDOW_COUNT: { if (XBUFFER (p->buffer) == XBUFFER (obj)) count++; break; } case GET_LRU_WINDOW: { /* t as arg means consider only full-width windows */ if (!NILP (obj) && !window_full_width_p (p)) break; /* Ignore dedicated windows and minibuffers. */ if (MINI_WINDOW_P (p) || (dedicated_too ? 0 : !NILP (p->dedicated))) break; if (NILP (best_window) || (XFIXNUM (XWINDOW (best_window)->use_time) > XFIXNUM (p->use_time))) best_window = w; break; } case GET_BUFFER_MRU_WINDOW: { /* #### what about the first check in GET_LRU_WINDOW? */ /* Ignore dedicated windows and minibuffers. */ if (MINI_WINDOW_P (p) || (dedicated_too ? 0 : !NILP (p->dedicated))) break; if (XBUFFER (p->buffer) == XBUFFER (obj)) { if (NILP (best_window) || (XFIXNUM (XWINDOW (best_window)->use_time) < XFIXNUM (p->use_time))) best_window = w; } break; } case DELETE_OTHER_WINDOWS: { /* Don't delete the last window on a frame; this can happen when the minibuffer is selected, and would cause the frame to be deleted. */ if (p != XWINDOW (obj) && !TOP_LEVEL_WINDOW_P (XWINDOW (w))) Fdelete_window (w, Qnil); break; } case DELETE_BUFFER_WINDOWS: { if (EQ (p->buffer, obj)) { struct frame *f = XFRAME (WINDOW_FRAME (p)); /* If this window is dedicated, and in a frame of its own, kill the frame. */ if (EQ (w, FRAME_ROOT_WINDOW (f)) && !NILP (p->dedicated) && (allow_deletion_of_last_visible_frame || other_visible_frames (f))) { /* Skip the other windows on this frame. There might be one, the minibuffer! */ if (! EQ (w, last_window)) while (f == XFRAME (WINDOW_FRAME (XWINDOW (next_window)))) { /* As we go, check for the end of the loop. We mustn't start going around a second time. */ if (EQ (next_window, last_window)) { last_window = w; break; } next_window = Fnext_window (next_window, mini ? Qt : Qnil, frame_arg, Qt); } /* Now we can safely delete the frame. */ Fdelete_frame (WINDOW_FRAME (p), Qnil); } else /* If we're deleting the buffer displayed in the only window on the frame, find a new buffer to display there. */ if (NILP (p->parent)) { Lisp_Object new_buffer; new_buffer = Fother_buffer (obj, Qnil, Qnil); if (NILP (new_buffer)) new_buffer = Fget_buffer_create (QSscratch); Fset_window_buffer (w, new_buffer, Qnil); if (EQ (w, Fselected_window (Qnil))) Fset_buffer (p->buffer); } else Fdelete_window (w, Qnil); } break; } case GET_LARGEST_WINDOW: { /* Ignore dedicated windows and minibuffers. */ if (MINI_WINDOW_P (p) || (dedicated_too ? 0 : !NILP (p->dedicated))) break; { /* write the check as follows to avoid tripping error_check_window() --ben */ struct window *b = NILP (best_window) ? 0 : XWINDOW (best_window); if (NILP (best_window) || ((WINDOW_HEIGHT (p) * WINDOW_WIDTH (p)) > (WINDOW_HEIGHT (b) * WINDOW_WIDTH (b)))) best_window = w; } break; } default: ABORT (); } if (EQ (w, last_window)) break; w = next_window; } } return type == GET_BUFFER_WINDOW_COUNT ? make_fixnum (count) : best_window; } #if 0 /* not currently used */ int buffer_window_count (struct buffer *b, struct frame *f) { Lisp_Object buffer, frame; frame = wrap_frame (f); buffer = wrap_buffer (b); return XFIXNUM (window_loop (GET_BUFFER_WINDOW_COUNT, buffer, 0, frame, 1, Qnil)); } int buffer_window_mru (struct window *w) { Lisp_Object window = window_loop (GET_BUFFER_MRU_WINDOW, w->buffer, 0, w->frame, 1, Qnil); if (NILP (window)) return 0; else if (XWINDOW (window) == w) return 1; else return 0; } #endif DEFUN ("get-lru-window", Fget_lru_window, 0, 2, 0, /* Return the window least recently selected or used for display. By default, only the windows in the selected frame are considered. The optional argument WHICH-FRAMES changes this behavior: If optional argument WHICH-FRAMES is `visible', search all visible frames. If WHICH-FRAMES is 0, search all visible and iconified frames. If WHICH-FRAMES is t, search all frames. If WHICH-FRAMES is nil, search only the selected frame. If WHICH-FRAMES is a frame, search only that frame. The optional argument WHICH-DEVICES further clarifies on which devices to search for frames as specified by WHICH-FRAMES. This value is only meaningful if WHICH-FRAMES is non-nil. If nil or omitted, search all devices on the selected console. If a device, only search that device. If a console, search all devices on that console. If a device type, search all devices of that type. If `window-system', search all devices on window-system consoles. Any other non-nil value means search all devices. */ (which_frames, which_devices)) { Lisp_Object w; /* First try for a non-dedicated window that is full-width */ w = window_loop (GET_LRU_WINDOW, Qt, 0, which_frames, 0, which_devices); if (!NILP (w) && !EQ (w, Fselected_window (Qnil))) return w; /* Then try for any non-dedicated window */ w = window_loop (GET_LRU_WINDOW, Qnil, 0, which_frames, 0, which_devices); if (!NILP (w) && !EQ (w, Fselected_window (Qnil))) return w; #if 0 /* FSFmacs never returns a dedicated window here. If we do, it makes `display-buffer' not work right. #### All of this shit is so disgusting and awful that it needs to be rethought from scratch. */ /* then try for a dedicated window that is full-width */ w = window_loop (GET_LRU_WINDOW, Qt, 0, which_frames, 1, which_devices); if (!NILP (w) && !EQ (w, Fselected_window (Qnil))) return w; /* If none of them, then all windows, dedicated or not. */ w = window_loop (GET_LRU_WINDOW, Qnil, 0, which_frames, 1, which_devices); /* At this point we damn well better have found something. */ assert (!NILP (w)); #endif return w; } DEFUN ("get-largest-window", Fget_largest_window, 0, 2, 0, /* Return the window largest in area. By default, only the windows in the selected frame are considered. The optional argument WHICH-FRAMES changes this behavior: If optional argument WHICH-FRAMES is `visible', search all visible frames. If WHICH-FRAMES is 0, search all visible and iconified frames. If WHICH-FRAMES is t, search all frames. If WHICH-FRAMES is nil, search only the selected frame. If WHICH-FRAMES is a frame, search only that frame. The optional argument WHICH-DEVICES further clarifies on which devices to search for frames as specified by WHICH-FRAMES. This value is only meaningful if WHICH-FRAMES is non-nil. If nil or omitted, search all devices on the selected console. If a device, only search that device. If a console, search all devices on that console. If a device type, search all devices of that type. If `window-system', search all devices on window-system consoles. Any other non-nil value means search all devices. */ (which_frames, which_devices)) { /* Don't search dedicated windows because FSFmacs doesn't. This stuff is all black magic so don't try to apply common sense to it. */ return window_loop (GET_LARGEST_WINDOW, Qnil, 0, which_frames, 0, which_devices); } DEFUN ("get-buffer-window", Fget_buffer_window, 1, 3, 0, /* Return a window currently displaying BUFFER, or nil if none. By default, only the windows in the selected frame are considered. The optional argument WHICH-FRAMES changes this behavior: If optional argument WHICH-FRAMES is `visible', search all visible frames. If WHICH-FRAMES is 0, search all visible and iconified frames. If WHICH-FRAMES is t, search all frames. If WHICH-FRAMES is nil, search only the selected frame. If WHICH-FRAMES is a frame, search only that frame. The optional argument WHICH-DEVICES further clarifies on which devices to search for frames as specified by WHICH-FRAMES. This value is only meaningful if WHICH-FRAMES is non-nil. If nil or omitted, search all devices on the selected console. If a device, only search that device. If a console, search all devices on that console. If a device type, search all devices of that type. If `window-system', search all devices on window-system consoles. Any other non-nil value means search all devices. */ (buffer, which_frames, which_devices)) { buffer = Fget_buffer (buffer); if (BUFFERP (buffer)) /* Search dedicated windows too. (Doesn't matter here anyway.) */ return window_loop (GET_BUFFER_WINDOW, buffer, 1, which_frames, 1, which_devices); else return Qnil; } /* These functions used to be `buffer-left-margin-pixel-width', etc. but there is no sensible way to implement those functions, since you can't in general derive a window from a buffer. */ DEFUN ("window-left-margin-pixel-width", Fwindow_left_margin_pixel_width, 0, 1, 0, /* Return the width in pixels of the left outside margin of window WINDOW. If WINDOW is nil, the selected window is assumed. */ (window)) { return make_fixnum (window_left_margin_width (decode_window (window))); } DEFUN ("window-right-margin-pixel-width", Fwindow_right_margin_pixel_width, 0, 1, 0, /* Return the width in pixels of the right outside margin of window WINDOW. If WINDOW is nil, the selected window is assumed. */ (window)) { return make_fixnum (window_right_margin_width (decode_window (window))); } DEFUN ("delete-other-windows", Fdelete_other_windows, 0, 1, "", /* Make WINDOW (or the selected window) fill its frame. Only the frame WINDOW is on is affected. This function tries to reduce display jumps by keeping the text previously visible in WINDOW in the same place on the frame. Doing this depends on the value of (window-start WINDOW), so if calling this function in a program gives strange scrolling, make sure the window-start value is reasonable when this function is called. */ (window)) { struct window *w = decode_window (window); struct buffer *b; Charbpos start_pos; int old_top = WINDOW_TOP (w); if (NILP (WINDOW_BUFFER (w))) invalid_operation ("Can't delete other windows of combination", window); window = wrap_window (w); b = XBUFFER (WINDOW_BUFFER (w)); if (MINI_WINDOW_P (w) && old_top > 0) invalid_operation ("Can't expand minibuffer to full frame", Qunbound); /* Ignore dedicated windows. */ window_loop (DELETE_OTHER_WINDOWS, window, 0, w->frame, 0, Qnil); start_pos = marker_position (w->start[CURRENT_DISP]); /* Try to minimize scrolling, by setting the window start to the point which will cause the text at the old window start to be at the same place on the frame. But don't try to do this if the window start is outside the visible portion (as might happen when the display is not current, due to typeahead). */ if (start_pos >= BUF_BEGV (b) && start_pos <= BUF_ZV (b) && !MINI_WINDOW_P (w)) { Charbpos new_start = start_with_line_at_pixpos (w, start_pos, old_top); if (new_start >= BUF_BEGV (b) && new_start <= BUF_ZV (b)) { Fset_marker (w->start[CURRENT_DISP], make_fixnum (new_start), w->buffer); w->start_at_line_beg = beginning_of_line_p (b, new_start); } /* We need to do this, so that the window-scroll-functions get called. */ w->force_start = 1; } return Qnil; } DEFUN ("delete-windows-on", Fdelete_windows_on, 1, 3, "bDelete windows on (buffer): ", /* Delete all windows showing BUFFER. Optional second argument WHICH-FRAMES controls which frames are affected. If nil or omitted, delete all windows showing BUFFER in any frame. If t, delete only windows showing BUFFER in the selected frame. If `visible', delete all windows showing BUFFER in any visible frame. If a frame, delete only windows showing BUFFER in that frame. Warning: WHICH-FRAMES has the same meaning as with `next-window', except that the meanings of nil and t are reversed. The optional third argument WHICH-DEVICES further clarifies on which devices to search for frames as specified by WHICH-FRAMES. This value is only meaningful if WHICH-FRAMES is not t. If nil or omitted, search only the selected console. If a device, only search that device. If a console, search all devices on that console. If a device type, search all devices of that type. If `window-system', search all devices on a window system. Any other non-nil value means search all devices. */ (buffer, which_frames, which_devices)) { /* This function can GC */ buffer = Fget_buffer (buffer); CHECK_BUFFER (buffer); /* WHICH-FRAMES values t and nil mean the opposite of what window_loop expects. */ if (EQ (which_frames, Qnil)) which_frames = Qt; else if (EQ (which_frames, Qt)) which_frames = Qnil; /* Ignore dedicated windows. */ window_loop (DELETE_BUFFER_WINDOWS, buffer, 0, which_frames, 0, which_devices); return Qnil; } static Lisp_Object list_windows (struct window *w, Lisp_Object value) { for (;;) { if (!NILP (w->hchild)) value = list_windows (XWINDOW (w->hchild), value); else if (!NILP (w->vchild)) value = list_windows (XWINDOW (w->vchild), value); else { Lisp_Object window = wrap_window (w); value = Fcons (window, value); } if (NILP (w->next)) break; w = XWINDOW (w->next); } return value; } static Lisp_Object list_all_windows (Lisp_Object frame_spec, Lisp_Object device_spec) { Lisp_Object devcons, concons; Lisp_Object retval = Qnil; DEVICE_LOOP_NO_BREAK (devcons, concons) { Lisp_Object frame_list, the_window; Lisp_Object device, tail; device = XCAR (devcons); frame_list = DEVICE_FRAME_LIST (XDEVICE (device)); LIST_LOOP (tail, frame_list) { if ((NILP (frame_spec) && !EQ (XCAR (tail), DEVICE_SELECTED_FRAME (XDEVICE (device)))) || (EQ (frame_spec, Qvisible) && !FRAME_VISIBLE_P (XFRAME (XCAR (tail)))) || (FRAMEP (frame_spec) && !EQ (frame_spec, XCAR (tail))) || (!NILP (frame_spec) && !device_matches_device_spec (device, NILP (device_spec) ? Vselected_console : device_spec))) continue; the_window = FRAME_ROOT_WINDOW (XFRAME (XCAR (tail))); retval = list_windows (XWINDOW (the_window), retval); } } return Fnreverse (retval); } DEFUN ("replace-buffer-in-windows", Freplace_buffer_in_windows, 1, 3, "bReplace buffer in windows: ", /* Replace BUFFER with some other buffer in all windows showing it. Optional second argument WHICH-FRAMES controls which frames are affected. If nil or omitted, all frames are affected. If t, only the selected frame is affected. If `visible', all visible frames are affected. If a frame, only that frame is affected. Warning: WHICH-FRAMES has the same meaning as with `next-window', except that the meanings of nil and t are reversed. The optional third argument WHICH-DEVICES further clarifies on which devices to search for frames as specified by WHICH-FRAMES. This value is only meaningful if WHICH-FRAMES is not t. If nil or omitted, search only the selected console. If a device, only search that device. If a console, search all devices on that console. If a device type, search all devices of that type. If `window-system', search all devices on a window system. Any other non-nil value means search all devices. */ (buffer, which_frames, which_devices)) { /* This function can GC */ Lisp_Object window_list; Lisp_Object tail; struct gcpro gcpro1, gcpro2; if (EQ (which_frames, Qnil)) which_frames = Qt; else if (EQ (which_frames, Qt)) which_frames = Qnil; window_list = list_all_windows (which_frames, which_devices); buffer = Fget_buffer (buffer); CHECK_BUFFER (buffer); GCPRO2 (window_list, buffer); LIST_LOOP (tail, window_list) { Lisp_Object window = XCAR (tail); if (!MINI_WINDOW_P (XWINDOW (window)) && EQ (XWINDOW (window)->buffer, buffer)) { Lisp_Object another_buffer = Fother_buffer (buffer, Qnil, Qnil); Lisp_Object frame = WINDOW_FRAME (XWINDOW (window)); if (NILP (another_buffer)) another_buffer = Fget_buffer_create (QSscratch); if (!NILP (XWINDOW (window)->dedicated) && EQ (window, FRAME_ROOT_WINDOW (XFRAME (frame))) && (allow_deletion_of_last_visible_frame || other_visible_frames (XFRAME (frame)))) { delete_frame_internal (XFRAME (frame), 0, 0, 0); /* GC */ } else { Fset_window_buffer (window, another_buffer, Qnil); if (EQ (window, Fselected_window (Qnil))) Fset_buffer (XWINDOW (window)->buffer); } } } UNGCPRO; return Qnil; } /* The smallest acceptable dimensions for a window. Anything smaller might crash Emacs. */ #define MIN_SAFE_WINDOW_WIDTH (2) #define MIN_SAFE_WINDOW_HEIGHT (2) /* Make sure that window_min_height and window_min_width are not too small; if they are, set them to safe minima. */ static void check_min_window_sizes (void) { /* Smaller values might permit a crash. */ if (window_min_width < MIN_SAFE_WINDOW_WIDTH) window_min_width = MIN_SAFE_WINDOW_WIDTH; if (window_min_height < MIN_SAFE_WINDOW_HEIGHT) window_min_height = MIN_SAFE_WINDOW_HEIGHT; } static int frame_min_height (struct frame *frame) { /* For height, we have to see whether the frame has a minibuffer, and whether it wants a modeline. */ return (FRAME_MINIBUF_ONLY_P (frame) ? MIN_SAFE_WINDOW_HEIGHT - 1 : (! FRAME_HAS_MINIBUF_P (frame)) ? MIN_SAFE_WINDOW_HEIGHT : 2 * MIN_SAFE_WINDOW_HEIGHT - 1); } /* Return non-zero if both frame sizes are less than or equal to minimal allowed values. ROWS and COLS are in characters */ static int frame_size_valid_p (struct frame *frame, int cols, int rows) { return (rows >= frame_min_height (frame) && cols >= MIN_SAFE_WINDOW_WIDTH); } /* Return non-zero if both frame sizes are less than or equal to minimal allowed values. WIDTH and HEIGHT are in pixels */ int frame_pixsize_valid_p (struct frame *frame, int width, int height) { int rows, cols; pixel_to_char_size (frame, width, height, &cols, &rows); return frame_size_valid_p (frame, cols, rows); } /* If *ROWS or *COLS are too small a size for FRAME, set them to the minimum allowable size. */ void check_frame_size (struct frame *frame, int *cols, int *rows) { int min_height = frame_min_height (frame); int min_pixwidth, min_pixheight; int min_geomwidth, min_geomheight; /* There is no char_to_frame_unit_size(). This can be done with frame_conversion_internal(), but that's currently static, and we can do it fine with two steps, as follows. */ char_to_pixel_size (frame, MIN_SAFE_WINDOW_WIDTH, min_height, &min_pixwidth, &min_pixheight); pixel_to_frame_unit_size (frame, min_pixwidth, min_pixheight, &min_geomwidth, &min_geomheight); if (*rows < min_geomheight) *rows = min_geomheight; if (*cols < min_geomwidth) *cols = min_geomwidth; } /* Normally the window is deleted if it gets too small. nodelete nonzero means do not do this. (The caller should check later and do so if appropriate) */ static void set_window_pixsize (Lisp_Object window, int new_pixsize, int nodelete, int set_height) { struct window *w = XWINDOW (window); struct frame *f = XFRAME (w->frame); struct window *c; int old_pixsize = (set_height ? WINDOW_HEIGHT (w) : WINDOW_WIDTH (w)); Lisp_Object child, minor_kid, major_kid; int minsize; int line_size; int defheight, defwidth; default_face_width_and_height (window, &defwidth, &defheight); line_size = (set_height ? defheight : defwidth); check_min_window_sizes (); minsize = (set_height ? window_min_height : window_min_width); minsize *= line_size; if (!nodelete && !TOP_LEVEL_WINDOW_P (w) && (new_pixsize + window_modeline_height (w)) < minsize) { Fdelete_window (window, Qnil); return; } SET_LAST_MODIFIED (w, 0); SET_LAST_FACECHANGE (w); MARK_FRAME_WINDOWS_STRUCTURE_CHANGED (f); /* multiple windows affected */ if (set_height) { WINDOW_HEIGHT (w) = new_pixsize; major_kid = w->vchild; minor_kid = w->hchild; } else { WINDOW_WIDTH (w) = new_pixsize; major_kid = w->hchild; minor_kid = w->vchild; } if (!NILP (minor_kid)) { for (child = minor_kid; !NILP (child); child = XWINDOW (child)->next) { if (set_height) WINDOW_TOP (XWINDOW (child)) = WINDOW_TOP (w); else WINDOW_LEFT (XWINDOW (child)) = WINDOW_LEFT (w); set_window_pixsize (child, new_pixsize, nodelete, set_height); } } else if (!NILP (major_kid)) { int last_pos, last_old_pos, pos, old_pos, first; int pixel_adj_left = new_pixsize - old_pixsize; int div_val = old_pixsize << 1; /* * Previously we bailed out here if there was no size change. * (pixel_adj_left == 0) But this broke toolbar updates. If a * toolbar appears or disappears, windows may not change size, * but their top and left coordinates need to be updated. * * So we don't bail until after the loop below. */ last_pos = first = (set_height ? WINDOW_TOP (w) : WINDOW_LEFT (w)); last_old_pos = 0; for (child = major_kid; !NILP (child); child = c->next) { c = XWINDOW (child); if (set_height) { old_pos = last_old_pos + WINDOW_HEIGHT (c); WINDOW_TOP (c) = last_pos; } else { old_pos = last_old_pos + WINDOW_WIDTH (c); WINDOW_LEFT (c) = last_pos; } pos = (((old_pos * new_pixsize) << 1) + old_pixsize) / div_val; /* All but the last window should have a height which is a multiple of the default line height. */ if (!NILP (c->next)) { /* * Round up when we're shrinking, down when we're growing * to make sure that pairs of grow / shrink meant to * cancel out actually do cancel out. */ if (pixel_adj_left < 0) pos = ((pos + line_size -1) / line_size) * line_size; else pos = (pos / line_size) * line_size; } /* Avoid confusion: don't delete child if it becomes too small */ set_window_pixsize (child, pos + first - last_pos, 1, set_height); last_pos = pos + first; last_old_pos = old_pos; } /* Sometimes we may get called with our old size. In that case we don't need to do anything else. */ if (!pixel_adj_left) return; /* Now delete any children that became too small. */ if (!nodelete) for (child = major_kid; !NILP (child); child = XWINDOW (child)->next) { if (set_height) set_window_pixheight (child, WINDOW_HEIGHT (XWINDOW (child)), 0); else set_window_pixwidth (child, WINDOW_WIDTH (XWINDOW (child)), 0); } } } /* Set the height of WINDOW and all its inferiors. */ void set_window_pixheight (Lisp_Object window, int new_pixheight, int nodelete) { set_window_pixsize (window, new_pixheight, nodelete, 1); } /* Recursively set width of WINDOW and its inferiors. */ void set_window_pixwidth (Lisp_Object window, int new_pixwidth, int nodelete) { set_window_pixsize (window, new_pixwidth, nodelete, 0); } static int window_select_count; DEFUN ("set-window-buffer", Fset_window_buffer, 2, 3, 0, /* Make WINDOW display BUFFER as its contents. BUFFER can be a buffer or buffer name. With non-nil optional argument NORECORD, do not modify the global or per-frame buffer ordering. */ (window, buffer, norecord)) { Lisp_Object tem; struct window *w = decode_window (window); int old_buffer_local_face_property = 0; buffer = Fget_buffer (buffer); CHECK_BUFFER (buffer); if (!BUFFER_LIVE_P (XBUFFER (buffer))) invalid_operation ("Attempt to display deleted buffer", Qunbound); tem = w->buffer; if (NILP (tem)) invalid_operation ("Window is deleted", Qunbound); else if (EQ (tem, buffer)) return Qnil; else if (! EQ (tem, Qt)) /* w->buffer is t when the window is first being set up. */ { if (!NILP (w->dedicated) && !EQ (tem, buffer)) signal_error (Qinvalid_operation, "Window is dedicated to buffer", tem); old_buffer_local_face_property = XBUFFER (w->buffer)->buffer_local_face_property; unshow_buffer (w); } w->buffer = buffer; w->window_end_pos[CURRENT_DISP] = 0; w->hscroll = 0; w->modeline_hscroll = 0; #if 0 /* pre point caches */ Fset_marker (w->pointm[CURRENT_DISP], make_fixnum (BUF_PT (XBUFFER (buffer))), buffer); set_marker_restricted (w->start[CURRENT_DISP], make_fixnum (XBUFFER (buffer)->last_window_start), buffer); #else { Lisp_Object marker = Fgethash (buffer, w->saved_point_cache, Qnil); Lisp_Object newpoint = !NILP (marker) ? make_fixnum (marker_position (marker)) : make_fixnum (BUF_PT (XBUFFER (buffer))); /* Previously, we had in here set-window-point, which did one of the following two, but not both. However, that could result in pointm being in a different buffer from the window's buffer! Probably not a travesty since it always occurred when the window was selected, meaning its value of point was ignored in favor of the buffer's; but it tripped an assert() in unshow_buffer(). */ set_marker_restricted (w->pointm[CURRENT_DISP], newpoint, buffer); if (EQ (wrap_window (w), Fselected_window (Qnil))) Fgoto_char (newpoint, buffer); /* this will automatically clip to accessible */ marker = Fgethash (buffer, w->saved_last_window_start_cache, Qnil); set_marker_restricted (w->start[CURRENT_DISP], !NILP (marker) ? make_fixnum (marker_position (marker)) : make_fixnum (XBUFFER (buffer)->last_window_start), buffer); } #endif Fset_marker (w->sb_point, w->start[CURRENT_DISP], buffer); /* set start_at_line_beg correctly. GE */ w->start_at_line_beg = beginning_of_line_p (XBUFFER (buffer), marker_position (w->start[CURRENT_DISP])); w->force_start = 0; /* XEmacs fix */ SET_LAST_MODIFIED (w, 1); SET_LAST_FACECHANGE (w); MARK_WINDOWS_CHANGED (w); { int new_buffer_local_face_property = XBUFFER (w->buffer)->buffer_local_face_property; if (new_buffer_local_face_property || new_buffer_local_face_property != old_buffer_local_face_property) MARK_WINDOW_FACES_CHANGED (w); } recompute_all_cached_specifiers_in_window (w); if (EQ (window, Fselected_window (Qnil))) { if (NILP (norecord)) Frecord_buffer (buffer); Fset_buffer (buffer); } if (NILP (XBUFFER (buffer)->display_count)) XBUFFER (buffer)->display_count = make_fixnum (1); else XBUFFER (buffer)->display_count = make_fixnum (1 + XFIXNUM (XBUFFER (buffer)->display_count)); XBUFFER (buffer)->display_time = Fcurrent_time(); return Qnil; } DEFUN ("select-window", Fselect_window, 1, 2, 0, /* Select WINDOW. Most editing will apply to WINDOW's buffer. The main editor command loop selects the buffer of the selected window before each command. With non-nil optional argument NORECORD, do not modify the global or per-frame buffer ordering. */ (window, norecord)) { struct window *w; Lisp_Object old_selected_window = Fselected_window (Qnil); CHECK_LIVE_WINDOW (window); w = XWINDOW (window); /* we have already caught dead-window errors */ if (!NILP (w->hchild) || !NILP (w->vchild)) invalid_operation ("Trying to select non-leaf window", Qunbound); w->use_time = make_fixnum (++window_select_count); if (EQ (window, old_selected_window)) return window; /* deselect the old window, if it exists (it might not exist if the selected device has no frames, which occurs at startup) */ if (!NILP (old_selected_window)) { struct window *ow = XWINDOW (old_selected_window); Fset_marker (ow->pointm[CURRENT_DISP], make_fixnum (BUF_PT (XBUFFER (ow->buffer))), ow->buffer); MARK_WINDOWS_CHANGED (ow); } /* now select the window's frame */ set_frame_selected_window (XFRAME (WINDOW_FRAME (w)), window); select_frame_1 (WINDOW_FRAME (w)); /* also select the window's buffer */ if (NILP (norecord)) Frecord_buffer (w->buffer); Fset_buffer (w->buffer); /* Go to the point recorded in the window. This is important when the buffer is in more than one window. It also matters when redisplay_window has altered point after scrolling, because it makes the change only in the window. */ { Charbpos new_point = marker_position (w->pointm[CURRENT_DISP]); if (new_point < BUF_BEGV (current_buffer)) new_point = BUF_BEGV (current_buffer); else if (new_point > BUF_ZV (current_buffer)) new_point = BUF_ZV (current_buffer); BUF_SET_PT (current_buffer, new_point); } MARK_WINDOWS_CHANGED (w); return window; } Lisp_Object display_buffer (Lisp_Object buffer, Lisp_Object not_this_window_p, Lisp_Object override_frame) { return call3 (Qdisplay_buffer, buffer, not_this_window_p, override_frame); } void temp_output_buffer_show (Lisp_Object buf, Lisp_Object same_frame) { /* This function can GC */ Lisp_Object window; struct window *w; struct buffer *b = XBUFFER (buf); BUF_SAVE_MODIFF (XBUFFER (buf)) = BUF_MODIFF (b); widen_buffer (b, 0); BUF_SET_PT (b, BUF_BEG (b)); if (!NILP (Vtemp_buffer_show_function)) call1 (Vtemp_buffer_show_function, buf); else { window = display_buffer (buf, Qnil, same_frame); if (!EQ (XWINDOW (window)->frame, Fselected_frame (Qnil))) Fmake_frame_visible (WINDOW_FRAME (XWINDOW (window))); Vminibuffer_scroll_window = window; w = XWINDOW (window); w->hscroll = 0; w->modeline_hscroll = 0; set_marker_restricted (w->start[CURRENT_DISP], make_fixnum (1), buf); set_marker_restricted (w->pointm[CURRENT_DISP], make_fixnum (1), buf); set_marker_restricted (w->sb_point, make_fixnum (1), buf); } } static void make_dummy_parent (Lisp_Object window) { struct window *o = XWINDOW (window); Lisp_Object obj = ALLOC_NORMAL_LISP_OBJECT (window); struct window *p = XWINDOW (obj); copy_lisp_object (obj, window); /* Don't copy the pointers to the line start cache or the face instances. */ p->line_start_cache = Dynarr_new (line_start_cache); #ifdef NEW_GC p->face_cachels = Dynarr_lisp_new (face_cachel, &lrecord_face_cachel_dynarr, &lrecord_face_cachel); p->glyph_cachels = Dynarr_lisp_new (glyph_cachel, &lrecord_glyph_cachel_dynarr, &lrecord_glyph_cachel); #else /* not NEW_GC */ p->face_cachels = Dynarr_new (face_cachel); p->glyph_cachels = Dynarr_new (glyph_cachel); #endif /* not NEW_GC */ p->subwindow_instance_cache = make_image_instance_cache_hash_table (); /* Put new into window structure in place of window */ replace_window (window, obj); o->next = Qnil; o->prev = Qnil; o->vchild = Qnil; o->hchild = Qnil; o->parent = obj; p->start[CURRENT_DISP] = Qnil; p->start[DESIRED_DISP] = Qnil; p->start[CMOTION_DISP] = Qnil; p->pointm[CURRENT_DISP] = Qnil; p->pointm[DESIRED_DISP] = Qnil; p->pointm[CMOTION_DISP] = Qnil; p->sb_point = Qnil; p->saved_point_cache = make_saved_buffer_point_cache (); p->saved_last_window_start_cache = make_saved_buffer_point_cache (); p->buffer = Qnil; } DEFUN ("split-window", Fsplit_window, 0, 3, "", /* Split WINDOW, putting SIZE lines in the first of the pair. WINDOW defaults to the selected one and SIZE to half its size. If optional third arg HORFLAG is non-nil, split side by side and put SIZE columns in the first of the pair. The newly created window is returned. */ (window, size, horflag)) { Lisp_Object new_; struct window *o, *p; struct frame *f; int csize; int psize; if (NILP (window)) window = Fselected_window (Qnil); else CHECK_LIVE_WINDOW (window); o = XWINDOW (window); f = XFRAME (WINDOW_FRAME (o)); if (NILP (size)) { if (!NILP (horflag)) /* In the new scheme, we are symmetric with respect to separators so there is no need to do weird things here. */ { psize = (WINDOW_WIDTH (o) + window_divider_width (o)) >> 1; csize = window_pixel_width_to_char_width (o, psize, 0); } else { psize = WINDOW_HEIGHT (o) >> 1; csize = window_pixel_height_to_char_height (o, psize, 1); } } else { CHECK_FIXNUM (size); csize = XFIXNUM (size); if (!NILP (horflag)) psize = window_char_width_to_pixel_width (o, csize, 0); else psize = window_char_height_to_pixel_height (o, csize, 1); } if (MINI_WINDOW_P (o)) invalid_operation ("Attempt to split minibuffer window", Qunbound); else if (FRAME_NO_SPLIT_P (XFRAME (WINDOW_FRAME (o)))) invalid_operation ("Attempt to split unsplittable frame", Qunbound); check_min_window_sizes (); if (NILP (horflag)) { if (csize < window_min_height) signal_error (Qinvalid_operation, "Window height too small (after splitting)", make_fixnum (csize)); if (csize + window_min_height > window_char_height (o, 1)) signal_error (Qinvalid_operation, "Window height too small (after splitting)", make_fixnum (window_char_height (o, 1) - csize)); if (NILP (o->parent) || NILP (XWINDOW (o->parent)->vchild)) { make_dummy_parent (window); #if 0 /* #### I can't understand why you have to reset face cachels here. This can cause crash so let's disable it and see the difference. See redisplay-tests.el --yh */ reset_face_cachels (XWINDOW (window)); #endif new_ = o->parent; XWINDOW (new_)->vchild = window; XFRAME (o->frame)->mirror_dirty = 1; } } else { if (csize < window_min_width) signal_error (Qinvalid_operation, "Window width too small (after splitting)", make_fixnum (csize)); if (csize + window_min_width > window_char_width (o, 0)) signal_error (Qinvalid_operation, "Window width too small (after splitting)", make_fixnum (window_char_width (o, 0) - csize)); if (NILP (o->parent) || NILP (XWINDOW (o->parent)->hchild)) { make_dummy_parent (window); #if 0 /* #### See above. */ reset_face_cachels (XWINDOW (window)); #endif new_ = o->parent; XWINDOW (new_)->hchild = window; XFRAME (o->frame)->mirror_dirty = 1; } } /* Now we know that window's parent is a vertical combination if we are dividing vertically, or a horizontal combination if we are making side-by-side windows */ MARK_FRAME_WINDOWS_STRUCTURE_CHANGED (f); new_ = allocate_window (); p = XWINDOW (new_); p->frame = o->frame; p->next = o->next; if (!NILP (p->next)) XWINDOW (p->next)->prev = new_; p->prev = window; o->next = new_; p->parent = o->parent; p->buffer = Qt; reset_face_cachels (p); reset_glyph_cachels (p); /* Apportion the available frame space among the two new windows */ if (!NILP (horflag)) { WINDOW_HEIGHT (p) = WINDOW_HEIGHT (o); WINDOW_TOP (p) = WINDOW_TOP (o); WINDOW_WIDTH (p) = WINDOW_WIDTH (o) - psize; WINDOW_WIDTH (o) = psize; WINDOW_LEFT (p) = WINDOW_LEFT (o) + psize; } else { WINDOW_LEFT (p) = WINDOW_LEFT (o); WINDOW_WIDTH (p) = WINDOW_WIDTH (o); WINDOW_HEIGHT (p) = WINDOW_HEIGHT (o) - psize; WINDOW_HEIGHT (o) = psize; WINDOW_TOP (p) = WINDOW_TOP (o) + psize; } XFRAME (p->frame)->mirror_dirty = 1; note_object_created (new_); /* do this last (after the window is completely initialized and the mirror-dirty flag is set) so that specifier recomputation caused as a result of this will work properly and not abort. */ Fset_window_buffer (new_, o->buffer, Qt); return new_; } DEFUN ("enlarge-window", Fenlarge_window, 1, 3, "_p", /* Make the selected window COUNT lines taller. From program, optional second arg HORIZONTALP non-nil means grow sideways COUNT columns, and optional third arg WINDOW specifies the window to change instead of the selected window. */ (count, horizontalp, window)) { CHECK_FIXNUM (count); change_window_height (window, XFIXNUM (count), horizontalp, /* inpixels */ 0); return Qnil; } DEFUN ("enlarge-window-pixels", Fenlarge_window_pixels, 1, 3, "_p", /* Make the selected window COUNT pixels taller. From program, optional second arg HORIZONTALP non-nil means grow sideways COUNT pixels, and optional third arg WINDOW specifies the window to change instead of the selected window. */ (count, horizontalp, window)) { CHECK_FIXNUM (count); change_window_height (window, XFIXNUM (count), horizontalp, /* inpixels */ 1); return Qnil; } DEFUN ("shrink-window", Fshrink_window, 1, 3, "_p", /* Make the selected window COUNT lines shorter. From program, optional second arg HORIZONTALP non-nil means shrink sideways COUNT columns, and optional third arg WINDOW specifies the window to change instead of the selected window. */ (count, horizontalp, window)) { CHECK_FIXNUM (count); change_window_height (window, -XFIXNUM (count), horizontalp, /* inpixels */ 0); return Qnil; } DEFUN ("shrink-window-pixels", Fshrink_window_pixels, 1, 3, "_p", /* Make the selected window COUNT pixels smaller. From program, optional second arg HORIZONTALP non-nil means shrink sideways COUNT pixels, and optional third arg WINDOW specifies the window to change instead of the selected window. */ (count, horizontalp, window)) { CHECK_FIXNUM (count); change_window_height (window, -XFIXNUM (count), horizontalp, /* inpixels */ 1); return Qnil; } static int window_pixel_height_to_char_height (struct window *w, int pixel_height, int include_gutters_p) { int avail_height; int defheight, defwidth; int char_height = 0; Lisp_Object window = wrap_window (w); avail_height = (pixel_height - (include_gutters_p ? 0 : window_top_window_gutter_height (w) + window_bottom_window_gutter_height (w))); default_face_width_and_height (window, &defwidth, &defheight); if (defheight) char_height = avail_height / defheight; /* It's the calling function's responsibility to check these values and make sure they're not out of range. #### We need to go through the calling functions and actually do this. */ return max (0, char_height); } static int window_char_height_to_pixel_height (struct window *w, int char_height, int include_gutters_p) { int avail_height; int defheight, defwidth; int pixel_height; Lisp_Object window = wrap_window (w); default_face_width_and_height (window, &defwidth, &defheight); avail_height = char_height * defheight; pixel_height = (avail_height + (include_gutters_p ? 0 : window_top_window_gutter_height (w) + window_bottom_window_gutter_height (w))); /* It's the calling function's responsibility to check these values and make sure they're not out of range. #### We need to go through the calling functions and actually do this. */ return max (0, pixel_height); } /* Return number of default lines of text can fit in the window W. If INCLUDE_GUTTERS_P is 1, include "gutter" space (modeline plus horizontal scrollbar) in the space that is used for the calculation. This doesn't include space used by the frame gutters. */ int window_char_height (struct window *w, int include_gutters_p) { return window_pixel_height_to_char_height (w, window_pixel_height (w), include_gutters_p); } /* * Return number of lines currently displayed in window w. If * end-of-buffer is displayed then the area below end-of-buffer is assume * to be blank lines of default height. * Does not include the modeline. */ int window_displayed_height (struct window *w) { struct buffer *b = XBUFFER (w->buffer); display_line_dynarr *dla = window_display_lines (w, CURRENT_DISP); int num_lines; Charcount end_pos = (BUF_Z (b) - w->window_end_pos[CURRENT_DISP] > BUF_ZV (b) ? -1 : w->window_end_pos[CURRENT_DISP]); if (!Dynarr_length (dla)) return window_char_height (w, 0); num_lines = Dynarr_length (dla); /* #### Document and assert somewhere that w->window_end_pos == -1 indicates that end-of-buffer is being displayed. */ if (end_pos == -1) { struct display_line *dl = Dynarr_begin (dla); int ypos1 = dl->ypos + dl->descent; int ypos2 = WINDOW_TEXT_BOTTOM (w); Lisp_Object window; int defheight, defwidth; window = wrap_window (w); if (dl->modeline) { num_lines--; if (Dynarr_length (dla) == 1) ypos1 = WINDOW_TEXT_TOP (w); else { dl = Dynarr_atp (dla, Dynarr_length (dla) - 1); /* If this line is clipped then we know that there is no blank room between eob and the modeline. If we are scrolling on clipped lines just know off the clipped line and return .*/ if (scroll_on_clipped_lines && dl->clip) return num_lines - 1; ypos1 = dl->ypos + dl->descent - dl->clip; } } default_face_width_and_height (window, &defwidth, &defheight); /* #### This probably needs to know about the clipping area once a final definition is decided on. */ if (defheight) num_lines += ((ypos2 - ypos1) / defheight); } else { if (num_lines > 1 && Dynarr_begin (dla)->modeline) num_lines--; if (scroll_on_clipped_lines && Dynarr_atp (dla, Dynarr_length (dla) - 1)->clip) num_lines--; } return num_lines; } static int window_pixel_width (Lisp_Object window) { return WINDOW_WIDTH (XWINDOW (window)); } /* Calculate the pixel of a window, optionally including margin space but no vertical gutters. */ static int window_pixel_width_to_char_width (struct window *w, int pixel_width, int include_margins_p) { int avail_width; int char_width = 0; int defheight, defwidth; Lisp_Object window = wrap_window (w); avail_width = (pixel_width - window_left_gutter_width (w, 0) - window_right_gutter_width (w, 0) - (include_margins_p ? 0 : window_left_margin_width (w)) - (include_margins_p ? 0 : window_right_margin_width (w))); default_face_width_and_height (window, &defwidth, &defheight); if (defwidth) char_width = (avail_width / defwidth); /* It's the calling function's responsibility to check these values and make sure they're not out of range. #### We need to go through the calling functions and actually do this. */ return max (0, char_width); } static int window_char_width_to_pixel_width (struct window *w, int char_width, int include_margins_p) { int avail_width; int pixel_width; int defheight, defwidth; Lisp_Object window = wrap_window (w); default_face_width_and_height (window, &defwidth, &defheight); avail_width = char_width * defwidth; pixel_width = (avail_width + window_left_window_gutter_width (w, 0) + window_right_window_gutter_width (w, 0) + (include_margins_p ? 0 : window_left_margin_width (w)) + (include_margins_p ? 0 : window_right_margin_width (w))); /* It's the calling function's responsibility to check these values and make sure they're not out of range. #### We need to go through the calling functions and actually do this. */ return max (0, pixel_width); } /* This returns the usable space which doesn't include space needed by scrollbars or divider lines. */ int window_char_width (struct window *w, int include_margins_p) { return window_pixel_width_to_char_width (w, WINDOW_WIDTH (w), include_margins_p); } #define MINSIZE(w) \ (widthflag \ ? window_min_width * defwidth \ : (defheight * (MINI_WINDOW_P (XWINDOW (w)) ? 1 : window_min_height))) #define CURBEG(w) \ *(widthflag ? (int *) &WINDOW_LEFT (w) : (int *) &WINDOW_TOP (w)) #define CURSIZE(w) \ *(widthflag ? (int *) &WINDOW_WIDTH (w) : (int *) &WINDOW_HEIGHT (w)) #define CURCHARSIZE(w) \ (widthflag ? window_char_width (w, 0) : window_char_height (w, 1)) #define MINCHARSIZE(window) \ (widthflag ? window_min_width : MINI_WINDOW_P (XWINDOW (window)) \ ? 1 : window_min_height) static int window_pixheight (Lisp_Object w) { return window_pixel_height (XWINDOW (w)); } /* Unlike set_window_pixheight, this function also changes the heights of the siblings so as to keep everything consistent. */ static void change_window_height (Lisp_Object window, int delta, Lisp_Object horizontalp, int inpixels) { struct window *win = decode_window (window); int widthflag = !NILP (horizontalp); Lisp_Object parent; struct window *w; struct frame *f; int *sizep; int (*sizefun) (Lisp_Object) = (widthflag ? window_pixel_width : window_pixheight); void (*setsizefun) (Lisp_Object, int, int) = (widthflag ? set_window_pixwidth : set_window_pixheight); int dim; int defheight, defwidth; if (delta == 0) return; check_min_window_sizes (); window = wrap_window (win); f = XFRAME (win->frame); if (EQ (window, FRAME_ROOT_WINDOW (f))) invalid_operation ("Won't change only window", Qunbound); default_face_width_and_height (window, &defwidth, &defheight); while (1) { w = XWINDOW (window); parent = w->parent; if (NILP (parent)) { if (widthflag) { int new_pixsize; sizep = &CURSIZE (w); dim = CURCHARSIZE (w); new_pixsize = inpixels?(*sizep + delta):(dim+delta); set_window_pixsize (window, new_pixsize, 0, 0); return; } break; } if (widthflag ? !NILP (XWINDOW (parent)->hchild) : !NILP (XWINDOW (parent)->vchild)) break; window = parent; } sizep = &CURSIZE (w); dim = CURCHARSIZE (w); if ((inpixels && (*sizep + delta) < MINSIZE (window)) || (!inpixels && (dim + delta) < MINCHARSIZE (window))) { if (MINI_WINDOW_P (XWINDOW (window))) return; else if (!NILP (parent)) { Fdelete_window (window, Qnil); return; } } if (!inpixels) delta *= (widthflag ? defwidth : defheight); { int maxdelta; maxdelta = ((!NILP (parent)) ? (*sizefun) (parent) - *sizep : ((!NILP (w->next)) ? (*sizefun) (w->next) - MINSIZE (w->next) : ((!NILP (w->prev)) ? (*sizefun) (w->prev) - MINSIZE (w->prev) /* This is a frame with only one window, a minibuffer-only or a minibufferless frame. */ : (delta = 0)))); if (delta > maxdelta) /* This case traps trying to make the minibuffer the full frame, or make the only window aside from the minibuffer the full frame. */ delta = maxdelta; if (delta == 0) return; #if 0 /* FSFmacs */ /* #### Chuck: is this correct? */ if (*sizep + delta < MINSIZE (window)) { Fdelete_window (window); return; } #endif } if (!NILP (w->next) && (*sizefun) (w->next) - delta >= (int) MINSIZE (w->next)) { CURBEG (XWINDOW (w->next)) += delta; (*setsizefun) (w->next, (*sizefun) (w->next) - delta, 0); (*setsizefun) (window, *sizep + delta, 0); } else if (!NILP (w->prev) && (*sizefun) (w->prev) - delta >= (int) MINSIZE (w->prev)) { (*setsizefun) (w->prev, (*sizefun) (w->prev) - delta, 0); CURBEG (w) -= delta; (*setsizefun) (window, *sizep + delta, 0); } else { int delta1; int opht = (*sizefun) (parent); /* If trying to grow this window to or beyond size of the parent, make delta1 so big that, on shrinking back down, all the siblings end up with less than one line and are deleted. */ if (opht <= *sizep + delta) delta1 = opht * opht * 2; /* Otherwise, make delta1 just right so that if we add delta1 lines to this window and to the parent, and then shrink the parent back to its original size, the new proportional size of this window will increase by delta. */ else delta1 = (delta * opht * 100) / ((opht - *sizep - delta) * 100); /* Add delta1 lines or columns to this window, and to the parent, keeping things consistent while not affecting siblings. */ CURSIZE (XWINDOW (parent)) = opht + delta1; (*setsizefun) (window, *sizep + delta1, 0); /* Squeeze out delta1 lines or columns from our parent, shrinking this window and siblings proportionately. This brings parent back to correct size. Delta1 was calculated so this makes this window the desired size, taking it all out of the siblings. */ (*setsizefun) (parent, opht, 0); } SET_LAST_MODIFIED (w, 0); SET_LAST_FACECHANGE (w); MARK_FRAME_WINDOWS_STRUCTURE_CHANGED (f); /* overkill maybe, but better to be correct */ MARK_FRAME_GUTTERS_CHANGED (f); } #undef MINSIZE #undef CURBEG #undef CURSIZE #undef CURCHARSIZE #undef MINCHARSIZE /* Scroll contents of window WINDOW up COUNT lines. If COUNT < (top line height / average line height) then we just adjust the top clip. */ void window_scroll (Lisp_Object window, Lisp_Object count, int direction, Error_Behavior errb) { struct window *w = XWINDOW (window); struct buffer *b = XBUFFER (w->buffer); int selected = EQ (window, Fselected_window (Qnil)); int value = 0; Lisp_Object point, tem; display_line_dynarr *dla; int fheight, fwidth, modeline = 0; struct display_line* dl; if (selected) point = make_fixnum (BUF_PT (b)); else { Charbpos pos = marker_position (w->pointm[CURRENT_DISP]); if (pos < BUF_BEGV (b)) pos = BUF_BEGV (b); else if (pos > BUF_ZV (b)) pos = BUF_ZV (b); point = make_fixnum (pos); } /* Always set force_start so that redisplay_window will run the window-scroll-functions. */ w->force_start = 1; /* #### When the fuck does this happen? I'm so glad that history has completely documented the behavior of the scrolling functions under all circumstances. */ tem = Fpos_visible_in_window_p (point, window, Qnil); if (NILP (tem)) { Fvertical_motion (make_fixnum (-window_char_height (w, 0) / 2), window, Qnil); Fset_marker (w->start[CURRENT_DISP], point, w->buffer); w->start_at_line_beg = beginning_of_line_p (b, XFIXNUM (point)); WINDOW_TEXT_TOP_CLIP (w) = 0; MARK_WINDOWS_CHANGED (w); } if (!NILP (count)) { if (EQ (count, Qminus)) direction *= -1; else { count = Fprefix_numeric_value (count); value = XFIXNUM (count) * direction; if (!value) return; /* someone just made a pointless call */ } } /* If the user didn't specify how far to scroll then we have to figure it out by ourselves. */ if (NILP (count) || EQ (count, Qminus)) { /* Going forwards is easy. If that is what we are doing then just set value and the section which handles the user specifying a positive value will work. */ if (direction == 1) { value = window_displayed_height (w) - next_screen_context_lines; value = (value < 1 ? 1 : value); } /* Going backwards is hard. We can't use the same loop used if the user specified a negative value because we care about next_screen_context_lines. In a variable height world you don't know how many lines above you can actually be displayed and still have the context lines appear. So we leave value set to 0 and add a separate section to deal with this. */ } if (direction == 1 && !value) { return; } /* Determine parameters to test for partial line scrolling with. */ dla = window_display_lines (w, CURRENT_DISP); if (FIXNUMP (Vwindow_pixel_scroll_increment)) fheight = XFIXNUM (Vwindow_pixel_scroll_increment); else if (!NILP (Vwindow_pixel_scroll_increment)) default_face_width_and_height (window, &fwidth, &fheight); if (Dynarr_length (dla) >= 1) modeline = Dynarr_begin (dla)->modeline; dl = Dynarr_atp (dla, modeline); if (value > 0) { /* Go for partial display line scrolling. This just means bumping the clip by a reasonable amount and redisplaying, everything else remains unchanged. */ if (!NILP (Vwindow_pixel_scroll_increment) && Dynarr_length (dla) >= (1 + modeline) && (dl->ascent - dl->top_clip) > fheight * value) { WINDOW_TEXT_TOP_CLIP (w) += value * fheight; MARK_WINDOWS_CHANGED (w); } else { int vtarget; Charbpos startp, old_start; if (WINDOW_TEXT_TOP_CLIP (w)) { WINDOW_TEXT_TOP_CLIP (w) = 0; MARK_WINDOWS_CHANGED (w); } old_start = marker_position (w->start[CURRENT_DISP]); startp = vmotion (w, old_start, value, &vtarget); if (vtarget < value && (w->window_end_pos[CURRENT_DISP] == -1 || (BUF_Z (b) - w->window_end_pos[CURRENT_DISP] > BUF_ZV (b)))) { maybe_signal_error_1 (Qend_of_buffer, Qnil, Qwindow, errb); return; } else { set_marker_restricted (w->start[CURRENT_DISP], make_fixnum (startp), w->buffer); w->force_start = 1; w->start_at_line_beg = beginning_of_line_p (b, startp); MARK_WINDOWS_CHANGED (w); if (!point_would_be_visible (w, startp, XFIXNUM (point), 0)) Fset_window_point (wrap_window (w), make_fixnum (startp)); } } } else if (value < 0) { /* Go for partial display line scrolling. This just means bumping the clip by a reasonable amount and redisplaying, everything else remains unchanged. */ if (!NILP (Vwindow_pixel_scroll_increment) && Dynarr_length (dla) >= (1 + modeline) && (dl->ascent - dl->top_clip) - fheight * value < (dl->ascent + dl->descent - dl->clip) && WINDOW_TEXT_TOP_CLIP (w) + value * fheight > 0) { WINDOW_TEXT_TOP_CLIP (w) += value * fheight; MARK_WINDOWS_CHANGED (w); } else { int vtarget; Charbpos startp, old_start; if (WINDOW_TEXT_TOP_CLIP (w)) { WINDOW_TEXT_TOP_CLIP (w) = 0; MARK_WINDOWS_CHANGED (w); } old_start = marker_position (w->start[CURRENT_DISP]); startp = vmotion (w, old_start, value, &vtarget); if (vtarget > value && marker_position (w->start[CURRENT_DISP]) == BUF_BEGV (b)) { maybe_signal_error_1 (Qbeginning_of_buffer, Qnil, Qwindow, errb); return; } else { set_marker_restricted (w->start[CURRENT_DISP], make_fixnum (startp), w->buffer); w->force_start = 1; w->start_at_line_beg = beginning_of_line_p (b, startp); MARK_WINDOWS_CHANGED (w); /* #### Scroll back by less than a line. This code was originally for scrolling over large pixmaps and it loses when a line being *exposed* at the top of the window is bigger than the current one. However, for pixel based scrolling in general we can guess that the line we are going to display is probably the same size as the one we are on. In that instance we can have a reasonable stab at a suitable top clip. Fixing this properly is hard (and probably slow) as we would have to call redisplay to figure out the exposed line size. */ if (!NILP (Vwindow_pixel_scroll_increment) && Dynarr_length (dla) >= (1 + modeline) && dl->ascent + fheight * value > 0) { WINDOW_TEXT_TOP_CLIP (w) = (dl->ascent + fheight * value); } if (!point_would_be_visible (w, startp, XFIXNUM (point), 0)) { Charbpos new_point; if (MINI_WINDOW_P (w)) new_point = startp; else new_point = start_of_last_line (w, startp); Fset_window_point (wrap_window (w), make_fixnum (new_point)); } } } } else /* value == 0 && direction == -1 */ { if (WINDOW_TEXT_TOP_CLIP (w)) { WINDOW_TEXT_TOP_CLIP (w) = 0; MARK_WINDOWS_CHANGED (w); } if (marker_position (w->start[CURRENT_DISP]) == BUF_BEGV (b)) { maybe_signal_error_1 (Qbeginning_of_buffer, Qnil, Qwindow, errb); return; } else { int vtarget; int movement = next_screen_context_lines - 1; Charbpos old_startp = marker_position (w->start[CURRENT_DISP]); Charbpos bottom = vmotion (w, old_startp, movement, &vtarget); Charbpos startp = start_with_point_on_display_line (w, bottom, -1 - (movement - vtarget)); if (startp >= old_startp) startp = vmotion (w, old_startp, -1, NULL); set_marker_restricted (w->start[CURRENT_DISP], make_fixnum (startp), w->buffer); w->force_start = 1; w->start_at_line_beg = beginning_of_line_p (b, startp); MARK_WINDOWS_CHANGED (w); if (!point_would_be_visible (w, startp, XFIXNUM (point), 0)) { Charbpos new_point = start_of_last_line (w, startp); Fset_window_point (wrap_window (w), make_fixnum (new_point)); } } } } DEFUN ("scroll-up", Fscroll_up, 0, 1, "_P", /* Scroll text of current window up COUNT lines; or near full screen if no arg. A near full screen is `next-screen-context-lines' less than a full screen. Negative COUNT means scroll downward. When calling from a program, supply an integer as argument or nil. On attempt to scroll past end of buffer, `end-of-buffer' is signaled. On attempt to scroll past beginning of buffer, `beginning-of-buffer' is signaled. The characters that are moved over may be added to the current selection \(i.e. active region) if the Shift key is held down, a motion key is used to invoke this command, and `shifted-motion-keys-select-region' is t; see the documentation for this variable for more details. */ (count)) { window_scroll (Fselected_window (Qnil), count, 1, ERROR_ME); return Qnil; } DEFUN ("scroll-down", Fscroll_down, 0, 1, "_P", /* Scroll text of current window down COUNT lines; or near full screen if no arg. A near full screen is `next-screen-context-lines' less than a full screen. Negative COUNT means scroll upward. When calling from a program, supply a number as argument or nil. On attempt to scroll past end of buffer, `end-of-buffer' is signaled. On attempt to scroll past beginning of buffer, `beginning-of-buffer' is signaled. The characters that are moved over may be added to the current selection \(i.e. active region) if the Shift key is held down, a motion key is used to invoke this command, and `shifted-motion-keys-select-region' is t; see the documentation for this variable for more details. */ (count)) { window_scroll (Fselected_window (Qnil), count, -1, ERROR_ME); return Qnil; } DEFUN ("other-window-for-scrolling", Fother_window_for_scrolling, 0, 0, 0, /* Return the other window for "other window scroll" commands. If in the minibuffer, `minibuffer-scroll-window' if non-nil specifies the window. If `other-window-scroll-buffer' is non-nil, a window showing that buffer is used. */ ()) { Lisp_Object window; Lisp_Object selected_window = Fselected_window (Qnil); if (MINI_WINDOW_P (XWINDOW (selected_window)) && !NILP (Vminibuffer_scroll_window)) window = Vminibuffer_scroll_window; /* If buffer is specified, scroll that buffer. */ else if (!NILP (Vother_window_scroll_buffer)) { window = Fget_buffer_window (Vother_window_scroll_buffer, Qnil, Qnil); if (NILP (window)) window = display_buffer (Vother_window_scroll_buffer, Qt, Qnil); } else { /* Nothing specified; look for a neighboring window on the same frame. */ window = Fnext_window (selected_window, Qnil, Qnil, Qnil); if (EQ (window, selected_window)) /* That didn't get us anywhere; look for a window on another visible frame. */ do window = Fnext_window (window, Qnil, Qt, Qnil); while (! FRAME_VISIBLE_P (XFRAME (WINDOW_FRAME (XWINDOW (window)))) && ! EQ (window, selected_window)); } CHECK_LIVE_WINDOW (window); if (EQ (window, selected_window)) invalid_operation ("There is no other window", Qunbound); return window; } DEFUN ("scroll-other-window", Fscroll_other_window, 0, 1, "_P", /* Scroll next window upward COUNT lines; or near full frame if no arg. The next window is the one below the current one; or the one at the top if the current one is at the bottom. Negative COUNT means scroll downward. When calling from a program, supply a number as argument or nil. If in the minibuffer, `minibuffer-scroll-window' if non-nil specifies the window to scroll. If `other-window-scroll-buffer' is non-nil, scroll the window showing that buffer, popping the buffer up if necessary. */ (count)) { window_scroll (Fother_window_for_scrolling (), count, 1, ERROR_ME); return Qnil; } DEFUN ("scroll-left", Fscroll_left, 0, 1, "_P", /* Scroll selected window display COUNT columns left. Default for COUNT is window width minus 2. The characters that are moved over may be added to the current selection \(i.e. active region) if the Shift key is held down, a motion key is used to invoke this command, and `shifted-motion-keys-select-region' is t; see the documentation for this variable for more details. */ (count)) { Lisp_Object window = Fselected_window (Qnil); struct window *w = XWINDOW (window); int n = (NILP (count) ? window_char_width (w, 0) - 2 : XFIXNUM (Fprefix_numeric_value (count))); return Fset_window_hscroll (window, make_fixnum (w->hscroll + n)); } DEFUN ("scroll-right", Fscroll_right, 0, 1, "_P", /* Scroll selected window display COUNT columns right. Default for COUNT is window width minus 2. The characters that are moved over may be added to the current selection \(i.e. active region) if the Shift key is held down, a motion key is used to invoke this command, and `shifted-motion-keys-select-region' is t; see the documentation for this variable for more details. */ (count)) { Lisp_Object window = Fselected_window (Qnil); struct window *w = XWINDOW (window); int n = (NILP (count) ? window_char_width (w, 0) - 2 : XFIXNUM (Fprefix_numeric_value (count))); return Fset_window_hscroll (window, make_fixnum (w->hscroll - n)); } DEFUN ("center-to-window-line", Fcenter_to_window_line, 0, 2, "_P", /* Center point in WINDOW. With N, put point on line N. The desired position of point is always relative to the window. If WINDOW is nil, the selected window is used. */ (n, window)) { struct window *w = decode_window (window); struct buffer *b = XBUFFER (w->buffer); Charbpos opoint = BUF_PT (b); Charbpos startp; if (NILP (n)) startp = start_with_line_at_pixpos (w, opoint, window_half_pixpos (w)); else { n = Fprefix_numeric_value (n); CHECK_FIXNUM (n); startp = start_with_point_on_display_line (w, opoint, XFIXNUM (n)); } Fset_marker (w->start[CURRENT_DISP], make_fixnum (startp), w->buffer); w->start_at_line_beg = beginning_of_line_p (b, startp); w->force_start = 1; MARK_WINDOWS_CHANGED (w); return Qnil; } DEFUN ("move-to-window-line", Fmove_to_window_line, 1, 2, "_P", /* Position point relative to WINDOW. With no argument, position text at center of window. An argument specifies window line; zero means top of window, negative means relative to bottom of window. If WINDOW is nil, the selected window is used. */ (arg, window)) { struct window *w; struct buffer *b; int height; Charbpos start, new_point; int selected; /* Don't use decode_window() because we need the new value of WINDOW. */ if (NILP (window)) window = Fselected_window (Qnil); else CHECK_LIVE_WINDOW (window); w = XWINDOW (window); b = XBUFFER (w->buffer); height = window_displayed_height (w); selected = EQ (window, Fselected_window (w->frame)); if (NILP (arg)) { int retval; if (XFIXNUM (w->last_modified[CURRENT_DISP]) >= BUF_MODIFF (b) && XFIXNUM (w->last_facechange[CURRENT_DISP]) >= BUF_FACECHANGE (b)) { new_point = point_at_center (w, CURRENT_DISP, 0, 0); /* #### Here we are checking the selected window of the frame instead of the selected window period. Elsewhere we check the selected window of the device. What a mess! */ if (selected) BUF_SET_PT (b, new_point); else Fset_window_point (window, make_fixnum (new_point)); retval = line_at_center (w, CURRENT_DISP, 0, 0); } else { start = marker_position (w->start[CURRENT_DISP]); if (start < BUF_BEGV (b)) start = BUF_BEGV (b); else if (start > BUF_ZV (b)) start = BUF_ZV (b); if (selected) new_point = BUF_PT (b); else new_point = marker_position (w->pointm[CURRENT_DISP]); new_point = point_at_center (w, CMOTION_DISP, start, BUF_PT (b)); if (selected) BUF_SET_PT (b, new_point); else Fset_window_point (window, make_fixnum (new_point)); retval = line_at_center (w, CMOTION_DISP, start, BUF_PT (b)); } return make_fixnum (retval); } else { /* #### Is this going to work right when at eob? */ arg = Fprefix_numeric_value (arg); if (XFIXNUM (arg) < 0) arg = make_fixnum (XFIXNUM (arg) + height); } start = marker_position (w->start[CURRENT_DISP]); if (start < BUF_BEGV (b) || start > BUF_ZV (b)) { if (selected) new_point = BUF_PT (b); else new_point = marker_position (w->pointm[CURRENT_DISP]); new_point = vmotion (XWINDOW (window), new_point, -height / 2, 0); if (selected) BUF_SET_PT (b, new_point); else Fset_window_point (window, make_fixnum (new_point)); Fset_marker (w->start[CURRENT_DISP], make_fixnum (new_point), w->buffer); w->start_at_line_beg = beginning_of_line_p (b, new_point); w->force_start = 1; } else { if (selected) BUF_SET_PT (b, start); else Fset_window_point (window, make_fixnum (start)); } if (selected) return Fvertical_motion (arg, window, Qnil); else { int vpos; new_point = vmotion (XWINDOW (window), marker_position (w->pointm[CURRENT_DISP]), XFIXNUM (arg), &vpos); Fset_window_point (window, make_fixnum (new_point)); return make_fixnum (vpos); } } static int map_windows_1 (Lisp_Object window, int (*mapfun) (struct window *w, void *closure), void *closure) { for (; !NILP (window); window = XWINDOW (window)->next) { int retval; struct window *w = XWINDOW (window); if (!NILP (w->vchild)) retval = map_windows_1 (w->vchild, mapfun, closure); else if (!NILP (w->hchild)) retval = map_windows_1 (w->hchild, mapfun, closure); else retval = (mapfun) (w, closure); if (retval) return retval; } return 0; } /* Map MAPFUN over the windows in F. CLOSURE is passed to each invocation of MAPFUN. If any invocation of MAPFUN returns non-zero, the mapping is halted. Otherwise, map_windows() maps over all windows in F. If F is null, map over all frames on all devices and consoles. If MAPFUN creates or deletes windows, the behavior is undefined. */ int map_windows (struct frame *f, int (*mapfun) (struct window *w, void *closure), void *closure) { if (f) return map_windows_1 (FRAME_ROOT_WINDOW (f), mapfun, closure); else { Lisp_Object frmcons, devcons, concons; FRAME_LOOP_NO_BREAK(frmcons, devcons, concons) { int v = map_windows_1 (FRAME_ROOT_WINDOW (XFRAME (XCAR (frmcons))), mapfun, closure); if (v) return v; } } return 0; } static void modeline_shadow_thickness_changed (Lisp_Object UNUSED (specifier), struct window *w, Lisp_Object UNUSED (oldval)) { w->shadow_thickness_changed = 1; MARK_WINDOWS_CHANGED (w); } static void vertical_divider_changed_in_window (Lisp_Object UNUSED (specifier), struct window *w, Lisp_Object UNUSED (oldval)) { MARK_WINDOWS_CHANGED (w); MARK_FRAME_WINDOWS_STRUCTURE_CHANGED (XFRAME (WINDOW_FRAME (w))); } /* also used in scrollbar.c */ void some_window_value_changed (Lisp_Object UNUSED (specifier), struct window *w, Lisp_Object UNUSED (oldval)) { MARK_WINDOWS_CHANGED (w); } #ifdef MEMORY_USAGE_STATS struct window_mirror_stats { struct usage_stats u; /* Ancillary non-lisp */ Bytecount redisplay_structs; #ifdef HAVE_SCROLLBARS /* Ancillary Lisp */ Bytecount scrollbar; #endif }; struct window_stats { struct usage_stats u; /* Ancillary non-Lisp */ Bytecount line_start; /* The next two: ancillary non-Lisp under old-GC, ancillary Lisp under NEW_GC */ Bytecount face; Bytecount glyph; /* The next two are copied out of the window mirror, which is an ancillary Lisp structure; the first is non-Lisp, the second Lisp, but from our perspective, they are both counted as Lisp */ Bytecount redisplay_structs; #ifdef HAVE_SCROLLBARS Bytecount scrollbar; #endif /* Remaining memory associated with window mirror (ancillary Lisp) */ Bytecount window_mirror; }; static void compute_window_mirror_usage (struct window_mirror *mir, struct window_mirror_stats *stats) { stats->redisplay_structs = compute_display_line_dynarr_usage (mir->current_display_lines, &stats->u) + compute_display_line_dynarr_usage (mir->desired_display_lines, &stats->u); #ifdef HAVE_SCROLLBARS stats->scrollbar = compute_all_scrollbar_instance_usage (mir->scrollbar_vertical_instance) + compute_all_scrollbar_instance_usage (mir->scrollbar_horizontal_instance); #endif /* HAVE_SCROLLBARS */ } static void window_mirror_memory_usage (Lisp_Object window_mirror, struct generic_usage_stats *gustats) { struct window_mirror_stats *stats = (struct window_mirror_stats *) gustats; compute_window_mirror_usage (XWINDOW_MIRROR (window_mirror), stats); } static void compute_window_usage (struct window *w, struct window_stats *stats, struct usage_stats *ustats) { stats->line_start = compute_line_start_cache_dynarr_usage (w->line_start_cache, ustats); stats->face = compute_face_cachel_usage (w->face_cachels, ustats); stats->glyph = compute_glyph_cachel_usage (w->glyph_cachels, ustats); { struct window_mirror *wm; wm = find_window_mirror_maybe (w); if (wm) { struct generic_usage_stats gustats; struct window_mirror_stats *wmstats; Bytecount total; total = lisp_object_memory_usage_full (wrap_window_mirror (wm), NULL, NULL, NULL, &gustats); wmstats = (struct window_mirror_stats *) &gustats; stats->redisplay_structs = wmstats->redisplay_structs; total -= stats->redisplay_structs; #ifdef HAVE_SCROLLBARS stats->scrollbar = wmstats->scrollbar; total -= stats->scrollbar; #endif stats->window_mirror = total; } } } static void window_memory_usage (Lisp_Object window, struct generic_usage_stats *gustats) { struct window_stats *stats = (struct window_stats *) gustats; compute_window_usage (XWINDOW (window), stats, &stats->u); } #endif /* MEMORY_USAGE_STATS */ /* Mark all subwindows of a window as deleted. The argument W is actually the subwindow tree of the window in question. */ void delete_all_subwindows (struct window *w) { if (!NILP (w->next)) delete_all_subwindows (XWINDOW (w->next)); if (!NILP (w->vchild)) delete_all_subwindows (XWINDOW (w->vchild)); if (!NILP (w->hchild)) delete_all_subwindows (XWINDOW (w->hchild)); mark_window_as_deleted (w); } static int get_current_pixel_pos (Lisp_Object window, Lisp_Object pos, struct window **w, struct rune **rb, struct display_line **dl) { display_line_dynarr *dla; struct display_block *db = NULL; int x, y; *rb = NULL; *dl = NULL; *w = decode_window (window); dla = window_display_lines (*w, CURRENT_DISP); x = (*w)->last_point_x[CURRENT_DISP]; y = (*w)->last_point_y[CURRENT_DISP]; if (MINI_WINDOW_P (*w)) return 0; if (y<0 || x<0 || y >= Dynarr_length (dla) || !NILP (pos)) { int first_line, i; Charbpos point; if (NILP (pos)) pos = Fwindow_point (window); CHECK_FIXNUM (pos); point = XFIXNUM (pos); if (Dynarr_length (dla) && Dynarr_begin (dla)->modeline) first_line = 1; else first_line = 0; for (i = first_line; i < Dynarr_length (dla); i++) { *dl = Dynarr_atp (dla, i); /* find the vertical location first */ if (point >= (*dl)->charpos && point <= (*dl)->end_charpos) { db = get_display_block_from_line (*dl, TEXT); for (i = 0; i < Dynarr_length (db->runes); i++) { *rb = Dynarr_atp (db->runes, i); if (point <= (*rb)->charpos) goto found_charpos; } return 0; } } return 0; found_charpos: ; } else { /* optimized case */ *dl = Dynarr_atp (dla, y); db = get_display_block_from_line (*dl, TEXT); if (x >= Dynarr_length (db->runes)) return 0; *rb = Dynarr_atp (db->runes, x); } return 1; } DEFUN ("current-pixel-column", Fcurrent_pixel_column, 0, 2, 0, /* Return the horizontal pixel position of point POS in window. Beginning of line is column 0. If WINDOW is nil, the current window is assumed. If POS is nil, point is assumed. Note that POS must be visible for a non-nil result to be returned. This is calculated using the redisplay display tables; because of this, the returned value will only be correct if the redisplay tables are up-to-date. Use \"(sit-for 0)\" to insure that they are; however, if WINDOW is part of a new frame, use the following instead: (while (not (frame-visible-p frame)) (sleep-for .5)) */ (window, pos)) { struct window* w; struct display_line *dl; struct rune* rb; if (!get_current_pixel_pos(window, pos, &w, &rb, &dl)) return Qnil; return make_fixnum (rb->xpos - WINDOW_LEFT (w)); } DEFUN ("current-pixel-row", Fcurrent_pixel_row, 0, 2, 0, /* Return the vertical pixel position of point POS in window. Top of window is row 0. If WINDOW is nil, the current window is assumed. If POS is nil, point is assumed. Note that POS must be visible for a non-nil result to be returned. This is calculated using the redisplay display tables; because of this, the returned value will only be correct if the redisplay tables are up-to-date. Use \"(sit-for 0)\" to insure that they are; however, if WINDOW is part of a new frame, use the following instead: (while (not (frame-visible-p frame)) (sleep-for .5)) */ (window, pos)) { struct window* w; struct display_line *dl; struct rune* rb; if (!get_current_pixel_pos(window, pos, &w, &rb, &dl)) return Qnil; return make_fixnum (dl->ypos - dl->ascent - WINDOW_TOP (w)); } #ifdef DEBUG_XEMACS /* This is short and simple in elisp, but... it was written to debug problems purely on the C side. That is where we need to call it so here it is. */ static void debug_print_window (Lisp_Object window, int level) { int i; Lisp_Object child = Fwindow_first_vchild (window); if (NILP (child)) child = Fwindow_first_hchild (window); for (i = level; i > 0; i--) stderr_out ("\t"); stderr_out ("#buffer; if (!NILP (buffer) && BUFFERP (buffer)) stderr_out (" on %s", XSTRING_DATA (XBUFFER (buffer)->name)); } stderr_out (" 0x%x>", LISP_OBJECT_UID (window)); while (!NILP (child)) { debug_print_window (child, level + 1); child = Fwindow_next_child (child); } } void debug_print_windows (struct frame *f); void debug_print_windows (struct frame *f) { debug_print_window (f->root_window, 0); putc ('\n', stderr); } #endif /* DEBUG_XEMACS */ /************************************************************************/ /* initialization */ /************************************************************************/ void window_objects_create (void) { #ifdef MEMORY_USAGE_STATS OBJECT_HAS_METHOD (window, memory_usage); OBJECT_HAS_METHOD (window_mirror, memory_usage); #endif } void syms_of_window (void) { INIT_LISP_OBJECT (window); INIT_LISP_OBJECT (window_mirror); #ifdef NEW_GC INIT_LISP_OBJECT (face_cachel); INIT_LISP_OBJECT (face_cachel_dynarr); INIT_LISP_OBJECT (glyph_cachel); INIT_LISP_OBJECT (glyph_cachel_dynarr); #endif /* NEW_GC */ DEFSYMBOL (Qwindowp); DEFSYMBOL (Qwindow_live_p); DEFSYMBOL (Qdisplay_buffer); #ifdef MEMORY_USAGE_STATS DEFSYMBOL (Qface_cache); DEFSYMBOL (Qglyph_cache); DEFSYMBOL (Qline_start_cache); #ifdef HAVE_SCROLLBARS DEFSYMBOL (Qscrollbar_instances); #endif DEFSYMBOL (Qredisplay_structs); #endif DEFSYMBOL (Qtruncate_partial_width_windows); DEFSYMBOL (Qcurrent_window_configuration); DEFSYMBOL (Qset_window_configuration); DEFSUBR (Fselected_window); DEFSUBR (Flast_nonminibuf_window); DEFSUBR (Fminibuffer_window); DEFSUBR (Fwindow_minibuffer_p); DEFSUBR (Fwindowp); DEFSUBR (Fwindow_live_p); DEFSUBR (Fwindow_first_hchild); DEFSUBR (Fwindow_first_vchild); DEFSUBR (Fwindow_next_child); DEFSUBR (Fwindow_previous_child); DEFSUBR (Fwindow_parent); DEFSUBR (Fwindow_lowest_p); DEFSUBR (Fwindow_truncated_p); DEFSUBR (Fwindow_highest_p); DEFSUBR (Fwindow_leftmost_p); DEFSUBR (Fwindow_rightmost_p); DEFSUBR (Fpos_visible_in_window_p); DEFSUBR (Fwindow_buffer); DEFSUBR (Fwindow_frame); DEFSUBR (Fwindow_height); DEFSUBR (Fwindow_displayed_height); DEFSUBR (Fwindow_width); DEFSUBR (Fwindow_full_width); DEFSUBR (Fwindow_pixel_height); DEFSUBR (Fwindow_pixel_width); DEFSUBR (Fwindow_text_area_height); DEFSUBR (Fwindow_text_area_pixel_height); DEFSUBR (Fwindow_displayed_text_pixel_height); DEFSUBR (Fwindow_text_area_pixel_width); DEFSUBR (Fwindow_hscroll); DEFSUBR (Fset_window_hscroll); DEFSUBR (Fmodeline_hscroll); DEFSUBR (Fset_modeline_hscroll); DEFSUBR (Fwindow_pixel_edges); DEFSUBR (Fwindow_text_area_pixel_edges); DEFSUBR (Fwindow_point); DEFSUBR (Fwindow_start); DEFSUBR (Fwindow_end); DEFSUBR (Fwindow_last_line_visible_height); DEFSUBR (Fset_window_point); DEFSUBR (Fset_window_start); DEFSUBR (Fwindow_dedicated_p); DEFSUBR (Fset_window_dedicated_p); DEFSUBR (Fnext_window); DEFSUBR (Fprevious_window); DEFSUBR (Fnext_vertical_window); DEFSUBR (Fother_window); DEFSUBR (Fget_lru_window); DEFSUBR (Fget_largest_window); DEFSUBR (Fget_buffer_window); DEFSUBR (Fwindow_left_margin_pixel_width); DEFSUBR (Fwindow_right_margin_pixel_width); DEFSUBR (Fdelete_other_windows); DEFSUBR (Fdelete_windows_on); DEFSUBR (Freplace_buffer_in_windows); DEFSUBR (Fdelete_window); DEFSUBR (Fset_window_buffer); DEFSUBR (Fselect_window); DEFSUBR (Fsplit_window); DEFSUBR (Fenlarge_window); DEFSUBR (Fenlarge_window_pixels); DEFSUBR (Fshrink_window); DEFSUBR (Fshrink_window_pixels); DEFSUBR (Fscroll_up); DEFSUBR (Fscroll_down); DEFSUBR (Fscroll_left); DEFSUBR (Fscroll_right); DEFSUBR (Fother_window_for_scrolling); DEFSUBR (Fscroll_other_window); DEFSUBR (Fcenter_to_window_line); DEFSUBR (Fmove_to_window_line); DEFSUBR (Fcurrent_pixel_column); DEFSUBR (Fcurrent_pixel_row); } void reinit_vars_of_window (void) { /* Make sure all windows get marked */ minibuf_window = Qnil; staticpro_nodump (&minibuf_window); } void vars_of_window (void) { #ifdef MEMORY_USAGE_STATS Lisp_Object l; l = listu (Qline_start_cache, #ifdef NEW_GC Qt, #endif Qface_cache, Qglyph_cache, #ifndef NEW_GC Qt, #endif Qredisplay_structs, #ifdef HAVE_SCROLLBARS Qscrollbar_instances, #endif intern ("window-mirror"), Qunbound); OBJECT_HAS_PROPERTY (window, memusage_stats_list, l); l = listu (Qredisplay_structs, #ifdef HAVE_SCROLLBARS Qt, Qscrollbar_instances, #endif Qunbound); OBJECT_HAS_PROPERTY (window_mirror, memusage_stats_list, l); #endif /* MEMORY_USAGE_STATS */ DEFVAR_BOOL ("scroll-on-clipped-lines", &scroll_on_clipped_lines /* *Non-nil means to scroll if point lands on a line which is clipped. */ ); scroll_on_clipped_lines = 1; DEFVAR_LISP ("temp-buffer-show-function", &Vtemp_buffer_show_function /* Non-nil means call as function to display a help buffer. The function is called with one argument, the buffer to be displayed. Used by `with-output-to-temp-buffer'. If this function is used, then it must do the entire job of showing the buffer; `temp-buffer-show-hook' is not run unless this function runs it. \(`temp-buffer-show-hook' is obsolete. Do not use in new code.) */ ); Vtemp_buffer_show_function = Qnil; DEFVAR_LISP ("minibuffer-scroll-window", &Vminibuffer_scroll_window /* Non-nil means it is the window that \\\\[scroll-other-window] in minibuffer should scroll. */ ); Vminibuffer_scroll_window = Qnil; DEFVAR_LISP ("other-window-scroll-buffer", &Vother_window_scroll_buffer /* If non-nil, this is a buffer and \\[scroll-other-window] should scroll its window. */ ); Vother_window_scroll_buffer = Qnil; DEFVAR_LISP ("window-pixel-scroll-increment", &Vwindow_pixel_scroll_increment /* *Number of pixels to scroll by per requested line. If nil then normal line scrolling occurs regardless of line height. If t then scrolling is done in increments equal to the height of the default face. */ ); Vwindow_pixel_scroll_increment = Qt; DEFVAR_INT ("next-screen-context-lines", &next_screen_context_lines /* *Number of lines of continuity when scrolling by screenfuls. */ ); next_screen_context_lines = 2; DEFVAR_INT ("window-min-height", &window_min_height /* *Delete any window less than this tall (including its modeline). */ ); window_min_height = 4; DEFVAR_INT ("window-min-width", &window_min_width /* *Delete any window less than this wide. */ ); window_min_width = 10; } void specifier_vars_of_window (void) { DEFVAR_SPECIFIER ("modeline-shadow-thickness", &Vmodeline_shadow_thickness /* *How thick to draw 3D shadows around modelines. If this is set to 0, modelines will be the traditional 2D. Sizes above 10 will be accepted but the maximum thickness that will be drawn is 10. This is a specifier; use `set-specifier' to change it. */ ); Vmodeline_shadow_thickness = Fmake_specifier (Qinteger); /* The initial value for modeline-shadow-thickness is 2, but if the user removes all specifications we provide a fallback value of 0, which is probably what was expected. */ set_specifier_fallback (Vmodeline_shadow_thickness, list1 (Fcons (Qnil, Qzero))); Fadd_spec_to_specifier (Vmodeline_shadow_thickness, make_fixnum (2), Qnil, Qnil, Qnil); set_specifier_caching (Vmodeline_shadow_thickness, offsetof (struct window, modeline_shadow_thickness), modeline_shadow_thickness_changed, 0, 0, 0); DEFVAR_SPECIFIER ("has-modeline-p", &Vhas_modeline_p /* *Whether the modeline should be displayed. This is a specifier; use `set-specifier' to change it. */ ); Vhas_modeline_p = Fmake_specifier (Qboolean); set_specifier_fallback (Vhas_modeline_p, list1 (Fcons (Qnil, Qt))); set_specifier_caching (Vhas_modeline_p, offsetof (struct window, has_modeline_p), /* #### It's strange that we need a special flag to indicate that the shadow-thickness has changed, but not one to indicate that the modeline has been turned off or on. */ some_window_value_changed, 0, 0, 0); DEFVAR_SPECIFIER ("vertical-divider-always-visible-p", &Vvertical_divider_always_visible_p /* *Should XEmacs always display vertical dividers between windows. When this is non-nil, vertical dividers are always shown, and are draggable. When it is nil, vertical dividers are shown only when there are no scrollbars in between windows, and are not draggable. This is a specifier; use `set-specifier' to change it. */ ); Vvertical_divider_always_visible_p = Fmake_specifier (Qboolean); set_specifier_fallback (Vvertical_divider_always_visible_p, list1 (Fcons (Qnil, Qt))); set_specifier_caching (Vvertical_divider_always_visible_p, offsetof (struct window, vertical_divider_always_visible_p), vertical_divider_changed_in_window, 0, 0, 0); DEFVAR_SPECIFIER ("vertical-divider-shadow-thickness", &Vvertical_divider_shadow_thickness /* *How thick to draw 3D shadows around vertical dividers. This is a specifier; use `set-specifier' to change it. */ ); Vvertical_divider_shadow_thickness = Fmake_specifier (Qinteger); set_specifier_fallback (Vvertical_divider_shadow_thickness, list1 (Fcons (Qnil, Qzero))); Fadd_spec_to_specifier (Vvertical_divider_shadow_thickness, make_fixnum (2), Qnil, Qnil, Qnil); set_specifier_caching (Vvertical_divider_shadow_thickness, offsetof (struct window, vertical_divider_shadow_thickness), vertical_divider_changed_in_window, 0, 0, 0); DEFVAR_SPECIFIER ("vertical-divider-line-width", &Vvertical_divider_line_width /* *The width of the vertical dividers, not including shadows. For TTY windows, divider line is always one character wide. When instance of this specifier is zero in a TTY window, no divider is drawn at all between windows. When non-zero, a one character wide divider is displayed. This is a specifier; use `set-specifier' to change it. */ ); Vvertical_divider_line_width = Fmake_specifier (Qnatnum); { Lisp_Object fb = Qnil; #ifdef HAVE_TTY fb = Fcons (Fcons (list1 (Qtty), make_fixnum (1)), fb); #endif #ifdef HAVE_GTK fb = Fcons (Fcons (list1 (Qgtk), make_fixnum (3)), fb); #endif #ifdef HAVE_X_WINDOWS fb = Fcons (Fcons (list1 (Qx), make_fixnum (3)), fb); #endif #ifdef HAVE_MS_WINDOWS /* #### This should be made magic and made to obey system settings */ fb = Fcons (Fcons (list1 (Qmswindows), make_fixnum (3)), fb); #endif set_specifier_fallback (Vvertical_divider_line_width, fb); } set_specifier_caching (Vvertical_divider_line_width, offsetof (struct window, vertical_divider_line_width), vertical_divider_changed_in_window, 0, 0, 0); DEFVAR_SPECIFIER ("vertical-divider-spacing", &Vvertical_divider_spacing /* *How much space to leave around the vertical dividers. In TTY windows, spacing is always zero, and the value of this specifier is ignored. This is a specifier; use `set-specifier' to change it. */ ); Vvertical_divider_spacing = Fmake_specifier (Qnatnum); { Lisp_Object fb = Qnil; #ifdef HAVE_TTY fb = Fcons (Fcons (list1 (Qtty), Qzero), fb); #endif #ifdef HAVE_X_WINDOWS /* #### 3D dividers look great on MS Windows with spacing = 0. Should not the same value be the fallback under X? - kkm */ fb = Fcons (Fcons (list1 (Qx), make_fixnum (2)), fb); #endif #ifdef HAVE_GTK fb = Fcons (Fcons (list1 (Qgtk), Qzero), fb); #endif #ifdef HAVE_MS_WINDOWS fb = Fcons (Fcons (list1 (Qmswindows), Qzero), fb); #endif set_specifier_fallback (Vvertical_divider_spacing, fb); } set_specifier_caching (Vvertical_divider_spacing, offsetof (struct window, vertical_divider_spacing), vertical_divider_changed_in_window, 0, 0, 0); }