[bpt/emacs.git] / src / cm.h

/* Cursor motion calculation definitions for GNU Emacs
   Copyright (C) 1985, 1989 Free Software Foundation, Inc.

This file is part of GNU Emacs.

GNU Emacs 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 2, or (at your option)
any later version.

GNU Emacs 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 GNU Emacs; see the file COPYING.  If not, write to
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */

/* Holds the minimum and maximum costs for the parametrized capabilities.  */
struct parmcap
  {
    int mincost, maxcost;
  };

/* This structure holds everything needed to do cursor motion except the pad
   character (PC) and the output speed of the terminal (ospeed), which
   termcap wants in global variables.  */

struct cm
  {
    /* Cursor position.  -1 in *both* variables means the cursor
       position is unknown, in order to force absolute cursor motion. */

    int cm_curY;			/* Current row */
    int cm_curX;			/* Current column */

    /* Capabilities from termcap */
    char *cm_up;		/* up (up) */
    char *cm_down;		/* down (do) */
    char *cm_left;		/* left (le) */
    char *cm_right;		/* right (nd) */
    char *cm_home;		/* home (ho) */
    char *cm_cr;		/* carriage return (cr) */
    char *cm_ll;		/* last line (ll) */
    char *cm_tab;		/* tab (ta) */
    char *cm_backtab;		/* backtab (bt) */
    char *cm_abs;		/* absolute (cm) */
    char *cm_habs;		/* horizontal absolute (ch) */
    char *cm_vabs;		/* vertical absolute (cv) */
#if 0
    char *cm_ds;		/* "don't send" string (ds) */
#endif
    char *cm_multiup;		/* multiple up (UP) */
    char *cm_multidown;		/* multiple down (DO) */
    char *cm_multileft;		/* multiple left (LE) */
    char *cm_multiright;	/* multiple right (RI) */
    int cm_cols;		/* number of cols on screen (co) */
    int cm_rows;		/* number of rows on screen (li) */
    int cm_tabwidth;		/* tab width (it) */
    unsigned int cm_autowrap:1;	/* autowrap flag (am) */
    unsigned int cm_magicwrap:1; /* VT-100: cursor stays in last col but
				    will cm_wrap if next char is
				    printing (xn) */
    unsigned int cm_usetabs:1;	/* if set, use tabs */
    unsigned int cm_losewrap:1;	/* if reach right margin, forget cursor
				   location */
    unsigned int cm_autolf:1;	/* \r performs a \r\n (rn) */

    /* Parametrized capabilities.  This needs to be a struct since
       the costs are accessed through pointers.  */

#if 0
    struct parmcap cc_abs;	/* absolute (cm) */
    struct parmcap cc_habs;	/* horizontal absolute (ch) */
    struct parmcap cc_vabs;	/* vertical absolute (cv) */
    struct parmcap cc_multiup;	/* multiple up (UP) */
    struct parmcap cc_multidown; /* multiple down (DO) */
    struct parmcap cc_multileft; /* multiple left (LE) */
    struct parmcap cc_multiright; /* multiple right (RI) */
#endif

    /* Costs for the non-parametrized capabilities */
    int cc_up;			/* cost for up */
    int cc_down;		/* etc. */
    int cc_left;
    int cc_right;
    int cc_home;
    int cc_cr;
    int cc_ll;
    int cc_tab;
    int cc_backtab;
    /* These are temporary, until the code is installed to use the
       struct parmcap fields above.  */
    int cc_abs;
    int cc_habs;
    int cc_vabs;
  };

extern char PC;			/* Pad character */

/* Shorthand */
#ifndef NoCMShortHand
#define curY(tty)		(tty)->Wcm->cm_curY
#define curX(tty)		(tty)->Wcm->cm_curX
#define Up(tty)			(tty)->Wcm->cm_up
#define Down(tty)		(tty)->Wcm->cm_down
#define Left(tty)		(tty)->Wcm->cm_left
#define Right(tty)		(tty)->Wcm->cm_right
#define Tab(tty)		(tty)->Wcm->cm_tab
#define BackTab(tty)		(tty)->Wcm->cm_backtab
#define TabWidth(tty)		(tty)->Wcm->cm_tabwidth
#define CR(tty)			(tty)->Wcm->cm_cr
#define Home(tty)		(tty)->Wcm->cm_home
#define LastLine(tty)		(tty)->Wcm->cm_ll
#define AbsPosition(tty)	(tty)->Wcm->cm_abs
#define ColPosition(tty)	(tty)->Wcm->cm_habs
#define RowPosition(tty)	(tty)->Wcm->cm_vabs
#define MultiUp(tty)		(tty)->Wcm->cm_multiup
#define MultiDown(tty)		(tty)->Wcm->cm_multidown
#define MultiLeft(tty)		(tty)->Wcm->cm_multileft
#define MultiRight(tty)		(tty)->Wcm->cm_multiright
#define AutoWrap(tty)		(tty)->Wcm->cm_autowrap
#define MagicWrap(tty)		(tty)->Wcm->cm_magicwrap
#define UseTabs(tty)		(tty)->Wcm->cm_usetabs
#define FrameRows(tty)		(tty)->Wcm->cm_rows
#define FrameCols(tty)		(tty)->Wcm->cm_cols

#define UpCost(tty)		(tty)->Wcm->cc_up
#define DownCost(tty)		(tty)->Wcm->cc_down
#define LeftCost(tty)		(tty)->Wcm->cc_left
#define RightCost(tty)		(tty)->Wcm->cc_right
#define HomeCost(tty)		(tty)->Wcm->cc_home
#define CRCost(tty)		(tty)->Wcm->cc_cr
#define LastLineCost(tty)	(tty)->Wcm->cc_ll
#define TabCost(tty)		(tty)->Wcm->cc_tab
#define BackTabCost(tty)	(tty)->Wcm->cc_backtab
#define AbsPositionCost(tty)	(tty)->Wcm->cc_abs
#define ColPositionCost(tty)	(tty)->Wcm->cc_habs
#define RowPositionCost(tty)	(tty)->Wcm->cc_vabs
#define MultiUpCost(tty)	(tty)->Wcm->cc_multiup
#define MultiDownCost(tty)	(tty)->Wcm->cc_multidown
#define MultiLeftCost(tty)	(tty)->Wcm->cc_multileft
#define MultiRightCost(tty)	(tty)->Wcm->cc_multiright
#endif

#define cmat(tty,row,col)	(curY(tty) = (row), curX(tty) = (col))
#define cmplus(tty,n)					            \
  {                                                                 \
    if ((curX (tty) += (n)) >= FrameCols (tty) && !MagicWrap (tty)) \
      {                                                             \
	if ((tty)->Wcm->cm_losewrap) losecursor (tty);              \
	else if (AutoWrap (tty)) curX (tty) = 0, curY (tty)++;      \
	else curX (tty)--;                                          \
      }                                                             \
  }

#define losecursor(tty)	 (curX(tty) = -1, curY(tty) = -1)

extern int cost;
extern int evalcost ();

#define emacs_tputs(tty, str, affcnt, putc) (current_tty = (tty), tputs (str, affcnt, putc))

extern struct tty_display_info *current_tty;
extern void cmcheckmagic P_ ((struct tty_display_info *));
extern int cmputc P_ ((int));
extern void cmcostinit P_ ((struct tty_display_info *));
extern void cmgoto P_ ((struct tty_display_info *, int, int));
extern void Wcm_clear P_ ((struct tty_display_info *));
extern int Wcm_init P_ ((struct tty_display_info *));

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