home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / texinfo-3.7-src.tgz / tar.out / fsf / texinfo / info / info.h < prev    next >
C/C++ Source or Header  |  1996-09-28  |  4KB  |  101 lines
  1. /* info.h -- Header file which includes all of the other headers. */
  2.  
  3. /* This file is part of GNU Info, a program for reading online documentation
  4.    stored in Info format.
  5.  
  6.    Copyright (C) 1993 Free Software Foundation, Inc.
  7.  
  8.    This program is free software; you can redistribute it and/or modify
  9.    it under the terms of the GNU General Public License as published by
  10.    the Free Software Foundation; either version 2, or (at your option)
  11.    any later version.
  12.  
  13.    This program is distributed in the hope that it will be useful,
  14.    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15.    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16.    GNU General Public License for more details.
  17.  
  18.    You should have received a copy of the GNU General Public License
  19.    along with this program; if not, write to the Free Software
  20.    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  21.  
  22.    Written by Brian Fox (bfox@ai.mit.edu). */
  23.  
  24. #if !defined (_INFO_H_)
  25. #define _INFO_H_
  26.  
  27. #include <stdio.h>
  28. #include <ctype.h>
  29. #include <sys/types.h>
  30. #include <sys/stat.h>
  31. #if defined (HAVE_STRING_H)
  32. #include <string.h>
  33. #endif /* HAVE_STRING_H */
  34. #include "filesys.h"
  35. #include "display.h"
  36. #include "session.h"
  37. #include "echo_area.h"
  38. #include "doc.h"
  39. #include "footnotes.h"
  40. #include "gc.h"
  41.  
  42. /* A structure associating the nodes visited in a particular window. */
  43. typedef struct {
  44.   WINDOW *window;        /* The window that this list is attached to. */
  45.   NODE **nodes;            /* Array of nodes visited in this window. */
  46.   int *pagetops;        /* For each node in NODES, the pagetop. */
  47.   long *points;            /* For each node in NODES, the point. */
  48.   int current;            /* Index in NODES of the current node. */
  49.   int nodes_index;        /* Index where to add the next node. */
  50.   int nodes_slots;        /* Number of slots allocated to NODES. */
  51. } INFO_WINDOW;
  52.  
  53. /* Array of structures describing for each window which nodes have been
  54.    visited in that window. */
  55. extern INFO_WINDOW **info_windows;
  56.  
  57. /* For handling errors.  If you initialize the window system, you should
  58.    also set info_windows_initialized_p to non-zero.  It is used by the
  59.    info_error () function to determine how to format and output errors. */
  60. extern int info_windows_initialized_p;
  61.  
  62. /* Non-zero if an error message has been printed. */
  63. extern int info_error_was_printed;
  64.  
  65. /* Non-zero means ring terminal bell on errors. */
  66. extern int info_error_rings_bell_p;
  67.  
  68. /* Print FORMAT with ARG1 and ARG2.  If the window system was initialized,
  69.    then the message is printed in the echo area.  Otherwise, a message is
  70.    output to stderr. */
  71. extern void info_error ();
  72.  
  73. /* The version numbers of Info. */
  74. extern int info_major_version, info_minor_version, info_patch_level;
  75.  
  76. /* How to get the version string for this version of Info.  Returns
  77.    something similar to "2.11". */
  78. extern char *version_string ();
  79.  
  80. /* Error message defines. */
  81. #define CANT_FIND_NODE    "Cannot find the node \"%s\"."
  82. #define CANT_FILE_NODE    "Cannot find the node \"(%s)%s\"."
  83. #define CANT_FIND_WIND    "Cannot find a window!"
  84. #define CANT_FIND_POINT    "Point doesn't appear within this window's node!"
  85. #define CANT_KILL_LAST    "Cannot delete the last window."
  86. #define NO_MENU_NODE    "No menu in this node."
  87. #define NO_FOOT_NODE    "No footnotes in this node."
  88. #define NO_XREF_NODE    "No cross references in this node."
  89. #define NO_POINTER    "No \"%s\" pointer for this node."
  90. #define UNKNOWN_COMMAND    "Unknown Info command `%c'.  `?' for help."
  91. #define TERM_TOO_DUMB    "Terminal type \"%s\" is not smart enough to run Info."
  92. #define AT_NODE_BOTTOM    "You are already at the last page of this node."
  93. #define AT_NODE_TOP    "You are already at the first page of this node."
  94. #define ONE_WINDOW    "Only one window."
  95. #define WIN_TOO_SMALL    "Resulting window would be too small."
  96. #define CANT_MAKE_HELP    \
  97. "There isn't enough room to make a help window.  Please delete a window."
  98.  
  99. #endif /* !_INFO_H_ */
  100.  
  101.