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

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