update.
[chise/xemacs-chise.git.1] / src / cm.h
1 /* Cursor motion calculation definitions for XEmacs
2    Copyright (C) 1985, 1989, 1992, 1993 Free Software Foundation, Inc.
3
4 This file is part of XEmacs.
5
6 XEmacs is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by the
8 Free Software Foundation; either version 2, or (at your option) any
9 later version.
10
11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with XEmacs; see the file COPYING.  If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA.  */
20
21 /* Synched up with: FSF 19.30. */
22
23 /* #### Chuck -- This file should be deleted.  I'm not deleting it yet
24    because there might be something you want out of it. */
25
26 #ifndef INCLUDED_cm_h_
27 #define INCLUDED_cm_h_
28
29 /* Holds the minimum and maximum costs for the parametrized capabilities.  */
30 struct parmcap
31   {
32     int mincost, maxcost;
33   };
34
35 /* This structure holds everything needed to do cursor motion except the pad
36    character (PC) and the output speed of the terminal (ospeed), which
37    termcap wants in global variables.  */
38
39 struct cm
40   {
41 #if 0
42     /* Cursor position.  -1 in *both* variables means the cursor
43        position is unknown, in order to force absolute cursor motion. */
44
45     int cm_curY;                        /* Current row */
46     int cm_curX;                        /* Current column */
47
48     /* Capabilities from termcap */
49     const char *cm_up;          /* up (up) */
50     const char *cm_down;        /* down (do) */
51     const char *cm_left;        /* left (le) */
52     const char *cm_right;       /* right (nd) */
53     const char *cm_home;        /* home (ho) */
54     const char *cm_cr;          /* carriage return (cr) */
55     const char *cm_ll;          /* last line (ll) */
56 #endif /* 0 */
57     const char *cm_tab;         /* tab (ta) */
58     const char *cm_backtab;     /* backtab (bt) */
59 #if 0
60     const char *cm_abs;         /* absolute (cm) */
61     const char *cm_habs;        /* horizontal absolute (ch) */
62     const char *cm_vabs;        /* vertical absolute (cv) */
63     const char *cm_ds;          /* "don't send" string (ds) */
64     const char *cm_multiup;     /* multiple up (UP) */
65     const char *cm_multidown;   /* multiple down (DO) */
66     const char *cm_multileft;   /* multiple left (LE) */
67     const char *cm_multiright;  /* multiple right (RI) */
68     int cm_cols;                /* number of cols on frame (co) */
69     int cm_rows;                /* number of rows on frame (li) */
70     int cm_tabwidth;            /* tab width (it) */
71     unsigned int cm_autowrap:1; /* autowrap flag (am) */
72     unsigned int cm_magicwrap:1; /* VT-100: cursor stays in last col but
73                                     will cm_wrap if next char is
74                                     printing (xn) */
75     unsigned int cm_usetabs:1;  /* if set, use tabs */
76     unsigned int cm_losewrap:1; /* if reach right margin, forget cursor
77                                    location */
78     unsigned int cm_autolf:1;   /* \r performs a \r\n (rn) */
79 #endif
80
81     /* Parametrized capabilities.  This needs to be a struct since
82        the costs are accessed through pointers.  */
83
84 #if 0
85     struct parmcap cc_abs;      /* absolute (cm) */
86     struct parmcap cc_habs;     /* horizontal absolute (ch) */
87     struct parmcap cc_vabs;     /* vertical absolute (cv) */
88     struct parmcap cc_multiup;  /* multiple up (UP) */
89     struct parmcap cc_multidown; /* multiple down (DO) */
90     struct parmcap cc_multileft; /* multiple left (LE) */
91     struct parmcap cc_multiright; /* multiple right (RI) */
92 #endif
93
94 #if 0
95     /* Costs for the non-parametrized capabilities */
96     int cc_up;                  /* cost for up */
97     int cc_down;                /* etc. */
98     int cc_left;
99     int cc_right;
100     int cc_home;
101     int cc_cr;
102     int cc_ll;
103     int cc_tab;
104     int cc_backtab;
105     /* These are temporary, until the code is installed to use the
106        struct parmcap fields above.  */
107     int cc_abs;
108     int cc_habs;
109     int cc_vabs;
110 #endif
111   };
112
113 #if 0
114 extern struct cm Wcm;           /* Terminal capabilities */
115 extern char PC;                 /* Pad character */
116
117 /* Shorthand */
118 #ifndef NoCMShortHand
119 #define curY            Wcm.cm_curY
120 #define curX            Wcm.cm_curX
121 #define Up              Wcm.cm_up
122 #define Down            Wcm.cm_down
123 #define Left            Wcm.cm_left
124 #define Right           Wcm.cm_right
125 #define Tab             Wcm.cm_tab
126 #define BackTab         Wcm.cm_backtab
127 #define TabWidth        Wcm.cm_tabwidth
128 #define CR              Wcm.cm_cr
129 #define Home            Wcm.cm_home
130 #define LastLine        Wcm.cm_ll
131 #define AbsPosition     Wcm.cm_abs
132 #define ColPosition     Wcm.cm_habs
133 #define RowPosition     Wcm.cm_vabs
134 #define MultiUp         Wcm.cm_multiup
135 #define MultiDown       Wcm.cm_multidown
136 #define MultiLeft       Wcm.cm_multileft
137 #define MultiRight      Wcm.cm_multiright
138 #define AutoWrap        Wcm.cm_autowrap
139 #define MagicWrap       Wcm.cm_magicwrap
140 #define UseTabs         Wcm.cm_usetabs
141 #define FrameRows       Wcm.cm_rows
142 #define FrameCols       Wcm.cm_cols
143
144 #define UpCost          Wcm.cc_up
145 #define DownCost        Wcm.cc_down
146 #define LeftCost        Wcm.cc_left
147 #define RightCost       Wcm.cc_right
148 #define HomeCost        Wcm.cc_home
149 #define CRCost          Wcm.cc_cr
150 #define LastLineCost    Wcm.cc_ll
151 #define TabCost         Wcm.cc_tab
152 #define BackTabCost     Wcm.cc_backtab
153 #define AbsPositionCost Wcm.cc_abs
154 #define ColPositionCost Wcm.cc_habs
155 #define RowPositionCost Wcm.cc_vabs
156 #define MultiUpCost     Wcm.cc_multiup
157 #define MultiDownCost   Wcm.cc_multidown
158 #define MultiLeftCost   Wcm.cc_multileft
159 #define MultiRightCost  Wcm.cc_multiright
160 #endif
161 #endif /* 0 */
162
163 #define cmat(row,col)   (curY = (row), curX = (col))
164 #define cmplus(n)                                       \
165   {                                                     \
166     if ((curX += (n)) >= FrameCols && !MagicWrap)       \
167       {                                                 \
168         if (Wcm.cm_losewrap) losecursor ();             \
169         else if (AutoWrap) curX = 0, curY++;            \
170         else curX--;                                    \
171       }                                                 \
172   }
173
174 #define losecursor()    (curX = -1, curY = -1)
175
176 extern int cost;
177 void cmputc (int c);
178 void cmcheckmagic (void);
179 void cm_cost_init (struct console *c);
180 void cmgoto (int, int);
181 void Wcm_clear (void);
182 int Wcm_init (void);
183
184 #endif /* INCLUDED_cm_h_ */