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

/* Cursor motion calculation definitions for GNU Emacs
   Copyright (C) 1985, 1989, 2001-2011  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 3 of the License, 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.  If not, see <http://www.gnu.org/licenses/>.  */

/* 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 (int c);

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

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