contrib/texinfo/info/display.h

   1 /* display.h -- How the display in Info is done.
   2    $Id: display.h,v 1.8 2008/06/09 22:51:20 gray Exp $
   3
   4    This file is part of GNU Info, a program for reading online documentation
   5    stored in Info format.
   6
   7    Copyright (C) 1993, 1997, 2004, 2007 Free Software Foundation, Inc.
   8
   9    This program is free software: you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation, either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21
  22    Written by Brian Fox (bfox@ai.mit.edu). */
  23
  24 #ifndef INFO_DISPLAY_H
  25 #define INFO_DISPLAY_H
  26
  27 #include "info-utils.h"
  28 #include "terminal.h"
  29
  30 typedef struct {
  31   char *text;                   /* Text of the line as it appears. */
  32   int textlen;                  /* Printable Length of TEXT. */
  33   int inverse;                  /* Non-zero means this line is inverse. */
  34 } DISPLAY_LINE;
  35
  36 /* An array of display lines which tell us what is currently visible on
  37    the display.  */
  38 extern DISPLAY_LINE **the_display;
  39
  40 /* Non-zero means do no output. */
  41 extern int display_inhibited;
  42
  43 /* Non-zero if we didn't completely redisplay a window. */
  44 extern int display_was_interrupted_p;
  45
  46 /* Initialize THE_DISPLAY to WIDTH and HEIGHT, with nothing in it. */
  47 extern void display_initialize_display (int width, int height);
  48
  49 /* Clear all of the lines in DISPLAY making the screen blank. */
  50 extern void display_clear_display (DISPLAY_LINE **display);
  51
  52 /* Update the windows pointed to by WINDOWS in THE_DISPLAY.  This actually
  53    writes the text on the screen. */
  54 extern void display_update_display (WINDOW *window);
  55
  56 /* Display WIN on THE_DISPLAY.  Unlike display_update_display (), this
  57    function only does one window. */
  58 extern void display_update_one_window (WINDOW *win);
  59
  60 /* Move the screen cursor to directly over the current character in WINDOW. */
  61 extern void display_cursor_at_point (WINDOW *window);
  62
  63 /* Scroll the region of the_display starting at START, ending at END, and
  64    moving the lines AMOUNT lines.  If AMOUNT is less than zero, the lines
  65    are moved up in the screen, otherwise down.  Actually, it is possible
  66    for no scrolling to take place in the case that the terminal doesn't
  67    support it.  This doesn't matter to us. */
  68 extern void display_scroll_display (int start, int end, int amount);
  69
  70 /* Try to scroll lines in WINDOW.  OLD_PAGETOP is the pagetop of WINDOW before
  71    having had its line starts recalculated.  OLD_STARTS is the list of line
  72    starts that used to appear in this window.  OLD_COUNT is the number of lines
  73    that appear in the OLD_STARTS array. */
  74 extern void display_scroll_line_starts (WINDOW *window, int old_pagetop,
  75     char **old_starts, int old_count);
  76
  77 void handle_tag (char *tag);
  78
  79 #endif /* not INFO_DISPLAY_H */