PIX_TYPE foreground_pixel;
};
-#define FRAME_INTERNAL_BORDER_WIDTH(f) 0
-
#endif /* ! HAVE_X_WINDOWS */
/* Cost of deleting n lines on this frame */
int *delete_n_lines_cost;
- /* Size of this frame, in units of characters. */
- EMACS_INT height;
- EMACS_INT width;
- EMACS_INT window_width;
- EMACS_INT window_height;
+ /* Size of this frame, excluding fringes, scroll bars etc.,
+ in units of canonical characters. */
+ EMACS_INT text_lines, text_cols;
+
+ /* Total size of this frame (i.e. its native window), in units of
+ canonical characters. */
+ EMACS_INT total_lines, total_cols;
+
+ /* New text height and width for pending size change.
+ 0 if no change pending. */
+ int new_text_lines, new_text_cols;
+
+ /* Pixel position of the frame window (x and y offsets in root window). */
+ int left_pos, top_pos;
+
+ /* Size of the frame window in pixels. */
+ int pixel_height, pixel_width;
+
+ /* These many pixels are the difference between the outer window (i.e. the
+ left and top of the window manager decoration) and FRAME_X_WINDOW. */
+ int x_pixels_diff, y_pixels_diff;
+
+ /* This is the gravity value for the specified window position. */
+ int win_gravity;
+
+ /* The geometry flags for this window. */
+ int size_hint_flags;
- /* New height and width for pending size change. 0 if no change pending. */
- int new_height, new_width;
+ /* Border width of the frame window as known by the (X) window system. */
+ int border_width;
+
+ /* Width of the internal border. This is a line of background color
+ just inside the window's border. When the frame is selected,
+ a highlighting is displayed inside the internal border. */
+ int internal_border_width;
+
+ /* Canonical X unit. Width of default font, in pixels. */
+ int column_width;
+
+ /* Canonical Y unit. Height of a line, in pixels. */
+ int line_height;
/* The output method says how the contents of this frame
are displayed. It could be using termcap, or using an X window. */
}
output_data;
+ /* Total width of fringes reserved for drawing truncation bitmaps,
+ continuation bitmaps and alike. The width is in canonical char
+ units of the frame. This must currently be the case because window
+ sizes aren't pixel values. If it weren't the case, we wouldn't be
+ able to split windows horizontally nicely. */
+ int fringe_cols;
+
+ /* The extra width (in pixels) currently allotted for fringes. */
+ int left_fringe_width, right_fringe_width;
+
#ifdef MULTI_KBOARD
/* A pointer to the kboard structure associated with this frame.
For termcap frames, this points to initial_kboard. For X frames,
struct kboard *kboard;
#endif
+ /* See FULLSCREEN_ enum below */
+ int want_fullscreen;
+
/* Number of lines of menu bar. */
int menu_bar_lines;
for lines beyond a certain vpos. This is the vpos. */
int scroll_bottom_vpos;
- /* Width of the scroll bar, in pixels and in characters.
- scroll_bar_cols tracks scroll_bar_pixel_width if the latter is positive;
- a zero value in scroll_bar_pixel_width means to compute the actual width
- on the fly, using scroll_bar_cols and the current font width. */
- int scroll_bar_pixel_width;
- int scroll_bar_cols;
+ /* Configured width of the scroll bar, in pixels and in characters.
+ config_scroll_bar_cols tracks config_scroll_bar_width if the
+ latter is positive; a zero value in config_scroll_bar_width means
+ to compute the actual width on the fly, using config_scroll_bar_cols
+ and the current font width. */
+ int config_scroll_bar_width;
+ int config_scroll_bar_cols;
+
+ /* The size of the extra width currently allotted for vertical
+ scroll bars in this frame, in pixels. */
+ int scroll_bar_actual_width;
/* The baud rate that was used to calculate costs for this frame. */
int cost_calculation_baud_rate;
/* Nonzero if frame F contains a minibuffer window.
(If this is 0, F must use some other minibuffer window.) */
#define FRAME_HAS_MINIBUF_P(f) ((f)->has_minibuffer)
-#define FRAME_HEIGHT(f) (f)->height
-/* Width of frame F, measured in character columns,
+/* Pixel height of frame F, including non-toolkit menu bar and
+ non-toolkit tool bar lines. */
+#define FRAME_PIXEL_HEIGHT(f) ((f)->pixel_height)
+
+/* Pixel width of frame F. */
+#define FRAME_PIXEL_WIDTH(f) ((f)->pixel_width)
+
+/* Height of frame F, measured in canonical lines, including
+ non-toolkit menu bar and non-toolkit tool bar lines. */
+#define FRAME_LINES(f) (f)->text_lines
+
+/* Width of frame F, measured in canonical character columns,
not including scroll bars if any. */
-#define FRAME_WIDTH(f) (f)->width
+#define FRAME_COLS(f) (f)->text_cols
/* Number of lines of frame F used for menu bar.
This is relevant on terminal frames and on
X Windows when not using the X toolkit.
- These lines are counted in FRAME_HEIGHT. */
+ These lines are counted in FRAME_LINES. */
#define FRAME_MENU_BAR_LINES(f) (f)->menu_bar_lines
/* Nonzero if this frame should display a tool bar
but not yet really put into effect. This can be true temporarily
when an X event comes in at a bad time. */
#define FRAME_WINDOW_SIZES_CHANGED(f) (f)->window_sizes_changed
-/* When a size change is pending, these are the requested new sizes. */
-#define FRAME_NEW_HEIGHT(f) (f)->new_height
-#define FRAME_NEW_WIDTH(f) (f)->new_width
/* The minibuffer window of frame F, if it has one; otherwise nil. */
#define FRAME_MINIBUF_WINDOW(f) (f)->minibuffer_window
/* Width that a scroll bar in frame F should have, if there is one.
Measured in pixels.
If scroll bars are turned off, this is still nonzero. */
-#define FRAME_SCROLL_BAR_PIXEL_WIDTH(f) ((f)->scroll_bar_pixel_width)
+#define FRAME_CONFIG_SCROLL_BAR_WIDTH(f) ((f)->config_scroll_bar_width)
/* Width that a scroll bar in frame F should have, if there is one.
Measured in columns (characters).
If scroll bars are turned off, this is still nonzero. */
-#define FRAME_SCROLL_BAR_COLS(f) ((f)->scroll_bar_cols)
+#define FRAME_CONFIG_SCROLL_BAR_COLS(f) ((f)->config_scroll_bar_cols)
/* Width of a scroll bar in frame F, measured in columns (characters),
but only if scroll bars are on the left. If scroll bars are on
the right in this frame, or there are no scroll bars, value is 0. */
-#define FRAME_LEFT_SCROLL_BAR_WIDTH(f) \
+#define FRAME_LEFT_SCROLL_BAR_COLS(f) \
(FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
- ? FRAME_SCROLL_BAR_COLS (f) \
+ ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
: 0)
+/* Width of a left scroll bar in frame F, measured in pixels */
+
+#define FRAME_LEFT_SCROLL_BAR_AREA_WIDTH(f) \
+ (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_LEFT (f) \
+ ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
+ : 0)
+
/* Width of a scroll bar in frame F, measured in columns (characters),
but only if scroll bars are on the right. If scroll bars are on
the left in this frame, or there are no scroll bars, value is 0. */
-#define FRAME_RIGHT_SCROLL_BAR_WIDTH(f) \
+#define FRAME_RIGHT_SCROLL_BAR_COLS(f) \
(FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \
- ? FRAME_SCROLL_BAR_COLS (f) \
+ ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
: 0)
-/* Width of a scroll bar in frame F, measured in columns (characters). */
-#define FRAME_SCROLL_BAR_WIDTH(f) \
- (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
- ? FRAME_SCROLL_BAR_COLS (f) \
+/* Width of a right scroll bar area in frame F, measured in pixels */
+
+#define FRAME_RIGHT_SCROLL_BAR_AREA_WIDTH(f) \
+ (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (f) \
+ ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
+ : 0)
+
+/* Actual width of a scroll bar in frame F, measured in columns. */
+
+#define FRAME_SCROLL_BAR_COLS(f) \
+ (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
+ ? FRAME_CONFIG_SCROLL_BAR_COLS (f) \
: 0)
+/* Actual width of a scroll bar area in frame F, measured in pixels. */
+
+#define FRAME_SCROLL_BAR_AREA_WIDTH(f) \
+ (FRAME_HAS_VERTICAL_SCROLL_BARS (f) \
+ ? (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)) \
+ : 0)
+
/* Total width of frame F, in columns (characters),
including the width used by scroll bars if any. */
-#define FRAME_WINDOW_WIDTH(f) ((f)->window_width)
+
+#define FRAME_TOTAL_COLS(f) ((f)->total_cols)
/* Set the width of frame F to VAL.
VAL is the width of a full-frame window,
- not including scroll bars. */
-#define SET_FRAME_WIDTH(f, val) \
- ((f)->width = (val), \
- (f)->window_width = FRAME_WINDOW_WIDTH_ARG (f, (f)->width))
+ not including scroll bars and fringes. */
+
+#define SET_FRAME_COLS(f, val) \
+ (FRAME_COLS (f) = (val), \
+ (f)->total_cols = FRAME_TOTAL_COLS_ARG (f, FRAME_COLS (f)))
/* Given a value WIDTH for frame F's nominal width,
- return the value that FRAME_WINDOW_WIDTH should have. */
-#define FRAME_WINDOW_WIDTH_ARG(f, width) \
+ return the value that FRAME_TOTAL_COLS should have. */
+
+#define FRAME_TOTAL_COLS_ARG(f, width) \
((width) \
- + FRAME_SCROLL_BAR_WIDTH (f) \
+ + FRAME_SCROLL_BAR_COLS (f) \
+ FRAME_FRINGE_COLS (f))
/* Maximum + 1 legitimate value for FRAME_CURSOR_X. */
+
#define FRAME_CURSOR_X_LIMIT(f) \
- (FRAME_WIDTH (f) + FRAME_LEFT_SCROLL_BAR_WIDTH (f))
+ (FRAME_COLS (f) + FRAME_LEFT_SCROLL_BAR_COLS (f))
/* Nonzero if frame F has scroll bars. */
+
#define FRAME_SCROLL_BARS(f) ((f)->scroll_bars)
#define FRAME_CONDEMNED_SCROLL_BARS(f) ((f)->condemned_scroll_bars)
width of the frame by 4 because multi-byte form may require at most
4-byte for a character. */
-#define FRAME_MESSAGE_BUF_SIZE(f) (((int) (f)->width) * 4)
+#define FRAME_MESSAGE_BUF_SIZE(f) (((int) FRAME_COLS (f)) * 4)
/* Emacs's redisplay code could become confused if a frame's
visibility changes at arbitrary times. For example, if a frame is
enum text_cursor_kinds get_specified_cursor_type P_ ((Lisp_Object, int *));
enum text_cursor_kinds get_window_cursor_type P_ ((struct window *, int *, int *));
\f
-/* Device-independent scroll bar stuff. */
-
-/* Return the starting column (zero-based) of the vertical scroll bar
- for window W. The column before this one is the last column we can
- use for text. If the window touches the right edge of the frame,
- we have extra space allocated for it. Otherwise, the scroll bar
- takes over the window's rightmost columns. */
-
-#define WINDOW_VERTICAL_SCROLL_BAR_COLUMN(w) \
- (FRAME_HAS_VERTICAL_SCROLL_BARS_ON_RIGHT (XFRAME (WINDOW_FRAME (w))) ? \
- (((XINT ((w)->left) + XINT ((w)->width)) \
- < FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) \
- ? (XINT ((w)->left) + XINT ((w)->width) \
- - FRAME_SCROLL_BAR_COLS (XFRAME (WINDOW_FRAME (w)))) \
- : FRAME_WIDTH (XFRAME (WINDOW_FRAME (w)))) \
- : XINT ((w)->left))
-
-/* Return the height in lines of the vertical scroll bar in w. If the
- window has a mode line, don't make the scroll bar extend that far. */
-
-#define WINDOW_VERTICAL_SCROLL_BAR_HEIGHT(w) (window_internal_height (w))
-
/* The currently selected frame. */
extern Lisp_Object selected_frame;
Display-related Macros
***********************************************************************/
-/* Canonical y-unit on frame F. This value currently equals the line
- height of the frame. Terminal specific header files are expected
- to define the macro FRAME_LINE_HEIGHT. */
+/* Canonical y-unit on frame F.
+ This value currently equals the line height of the frame (which is
+ the height of the default font of F). */
+
+#define FRAME_LINE_HEIGHT(F) ((F)->line_height)
-#define CANON_Y_UNIT(F) \
- (FRAME_WINDOW_P (F) ? FRAME_LINE_HEIGHT (F) : 1)
+/* Canonical x-unit on frame F.
+ This value currently equals the width of the default font of F. */
-/* Canonical x-unit on frame F. This is currently equal to the width
- of the default font of F. Terminal specific headers are expected
- to define the macro FRAME_DEFAULT_FONT_WIDTH. */
+#define FRAME_COLUMN_WIDTH(F) ((F)->column_width)
-#define CANON_X_UNIT(F) \
- (FRAME_WINDOW_P (F) ? FRAME_DEFAULT_FONT_WIDTH (F) : 1)
/* Pixel width of areas used to display truncation marks, continuation
marks, overlay arrows. This is 0 for terminal frames. */
#ifdef HAVE_WINDOW_SYSTEM
-#define FRAME_FRINGE_COLS(F) \
- (FRAME_WINDOW_P (F) ? FRAME_X_FRINGE_COLS (F) : 0)
-#define FRAME_FRINGE_WIDTH(F) \
- (FRAME_WINDOW_P (F) ? FRAME_X_FRINGE_WIDTH (F) : 0)
-#define FRAME_LEFT_FRINGE_WIDTH(F) \
- (FRAME_WINDOW_P (F) ? FRAME_X_LEFT_FRINGE_WIDTH (F) : 0)
-#define FRAME_RIGHT_FRINGE_WIDTH(F) \
- (FRAME_WINDOW_P (F) ? FRAME_X_RIGHT_FRINGE_WIDTH (F) : 0)
+/* Total width of fringes reserved for drawing truncation bitmaps,
+ continuation bitmaps and alike. The width is in canonical char
+ units of the frame. This must currently be the case because window
+ sizes aren't pixel values. If it weren't the case, we wouldn't be
+ able to split windows horizontally nicely. */
+
+#define FRAME_FRINGE_COLS(F) ((F)->fringe_cols)
+
+/* Pixel-width of the left and right fringe. */
+
+#define FRAME_LEFT_FRINGE_WIDTH(F) ((F)->left_fringe_width)
+#define FRAME_RIGHT_FRINGE_WIDTH(F) ((F)->right_fringe_width)
+
+/* Total width of fringes in pixels. */
+
+#define FRAME_TOTAL_FRINGE_WIDTH(F) \
+ (FRAME_LEFT_FRINGE_WIDTH (F) + FRAME_RIGHT_FRINGE_WIDTH (F))
+
+
+/* Pixel-width of internal border lines */
+
+#define FRAME_INTERNAL_BORDER_WIDTH(F) ((F)->internal_border_width)
#else /* not HAVE_WINDOW_SYSTEM */
-#define FRAME_FRINGE_WIDTH(F) 0
#define FRAME_FRINGE_COLS(F) 0
+#define FRAME_TOTAL_FRINGE_WIDTH(F) 0
#define FRAME_LEFT_FRINGE_WIDTH(F) 0
#define FRAME_RIGHT_FRINGE_WIDTH(F) 0
+#define FRAME_INTERNAL_BORDER_WIDTH(F) 0
#endif /* not HAVE_WINDOW_SYSTEM */
Conversion between canonical units and pixels
***********************************************************************/
-/* Canonical x-values are fractions of CANON_X_UNIT, canonical y-unit
- are fractions of CANON_Y_UNIT of a frame. Both are represented as
- Lisp numbers, i.e. integers or floats. */
+/* Canonical x-values are fractions of FRAME_COLUMN_WIDTH, canonical
+ y-unit are fractions of FRAME_LINE_HEIGHT of a frame. Both are
+ represented as Lisp numbers, i.e. integers or floats. */
/* Convert canonical value X to pixels. F is the frame whose
canonical char width is to be used. X must be a Lisp integer or
float. Value is a C integer. */
-#define PIXEL_X_FROM_CANON_X(F, X) \
+#define FRAME_PIXEL_X_FROM_CANON_X(F, X) \
(INTEGERP (X) \
- ? XINT (X) * CANON_X_UNIT (F) \
- : (int) (XFLOAT_DATA (X) * CANON_X_UNIT (F)))
+ ? XINT (X) * FRAME_COLUMN_WIDTH (F) \
+ : (int) (XFLOAT_DATA (X) * FRAME_COLUMN_WIDTH (F)))
/* Convert canonical value Y to pixels. F is the frame whose
canonical character height is to be used. X must be a Lisp integer
or float. Value is a C integer. */
-#define PIXEL_Y_FROM_CANON_Y(F, Y) \
+#define FRAME_PIXEL_Y_FROM_CANON_Y(F, Y) \
(INTEGERP (Y) \
- ? XINT (Y) * CANON_Y_UNIT (F) \
- : (int) (XFLOAT_DATA (Y) * CANON_Y_UNIT (F)))
+ ? XINT (Y) * FRAME_LINE_HEIGHT (F) \
+ : (int) (XFLOAT_DATA (Y) * FRAME_LINE_HEIGHT (F)))
/* Convert pixel-value X to canonical units. F is the frame whose
canonical character width is to be used. X is a C integer. Result
is a Lisp float if X is not a multiple of the canon width,
otherwise it's a Lisp integer. */
-#define CANON_X_FROM_PIXEL_X(F, X) \
- ((X) % CANON_X_UNIT (F) != 0 \
- ? make_float ((double) (X) / CANON_X_UNIT (F)) \
- : make_number ((X) / CANON_X_UNIT (F)))
+#define FRAME_CANON_X_FROM_PIXEL_X(F, X) \
+ ((X) % FRAME_COLUMN_WIDTH (F) != 0 \
+ ? make_float ((double) (X) / FRAME_COLUMN_WIDTH (F)) \
+ : make_number ((X) / FRAME_COLUMN_WIDTH (F)))
/* Convert pixel-value Y to canonical units. F is the frame whose
canonical character height is to be used. Y is a C integer.
Result is a Lisp float if Y is not a multiple of the canon width,
otherwise it's a Lisp integer. */
-#define CANON_Y_FROM_PIXEL_Y(F, Y) \
- ((Y) % CANON_Y_UNIT (F) \
- ? make_float ((double) (Y) / CANON_Y_UNIT (F)) \
- : make_number ((Y) / CANON_Y_UNIT (F)))
+#define FRAME_CANON_Y_FROM_PIXEL_Y(F, Y) \
+ ((Y) % FRAME_LINE_HEIGHT (F) \
+ ? make_float ((double) (Y) / FRAME_LINE_HEIGHT (F)) \
+ : make_number ((Y) / FRAME_LINE_HEIGHT (F)))
+
+
+\f
+/* Manipulating pixel sizes and character sizes.
+ Knowledge of which factors affect the overall size of the window should
+ be hidden in these macros, if that's possible.
+
+ Return the upper/left pixel position of the character cell on frame F
+ at ROW/COL. */
+
+#define FRAME_LINE_TO_PIXEL_Y(f, row) \
+ (FRAME_INTERNAL_BORDER_WIDTH (f) \
+ + (row) * FRAME_LINE_HEIGHT (f))
+
+#define FRAME_COL_TO_PIXEL_X(f, col) \
+ (FRAME_INTERNAL_BORDER_WIDTH (f) \
+ + (col) * FRAME_COLUMN_WIDTH (f))
+
+/* Return the pixel width/height of frame F if it has
+ COLS columns/LINES rows. */
+
+#define FRAME_TEXT_COLS_TO_PIXEL_WIDTH(f, cols) \
+ (FRAME_COL_TO_PIXEL_X (f, cols) \
+ + (f)->scroll_bar_actual_width \
+ + FRAME_TOTAL_FRINGE_WIDTH (f) \
+ + FRAME_INTERNAL_BORDER_WIDTH (f))
+
+#define FRAME_TEXT_LINES_TO_PIXEL_HEIGHT(f, lines) \
+ (FRAME_LINE_TO_PIXEL_Y (f, lines) \
+ + FRAME_INTERNAL_BORDER_WIDTH (f))
+
+
+/* Return the row/column (zero-based) of the character cell containing
+ the pixel on FRAME at Y/X. */
+
+#define FRAME_PIXEL_Y_TO_LINE(f, y) \
+ (((y) - FRAME_INTERNAL_BORDER_WIDTH (f)) \
+ / FRAME_LINE_HEIGHT (f))
+
+#define FRAME_PIXEL_X_TO_COL(f, x) \
+ (((x) - FRAME_INTERNAL_BORDER_WIDTH (f)) \
+ / FRAME_COLUMN_WIDTH (f))
+
+/* How many columns/rows of text can we fit in WIDTH/HEIGHT pixels on
+ frame F? */
+
+#define FRAME_PIXEL_WIDTH_TO_TEXT_COLS(f, width) \
+ (FRAME_PIXEL_X_TO_COL (f, ((width) \
+ - FRAME_INTERNAL_BORDER_WIDTH (f) \
+ - FRAME_TOTAL_FRINGE_WIDTH (f) \
+ - (f)->scroll_bar_actual_width)))
+
+#define FRAME_PIXEL_HEIGHT_TO_TEXT_LINES(f, height) \
+ (FRAME_PIXEL_Y_TO_LINE (f, ((height) \
+ - FRAME_INTERNAL_BORDER_WIDTH (f))))
/***********************************************************************
projects / emacs.git / commitdiff