xref: /haiku/src/apps/terminal/TermConst.h (revision 21258e2674226d6aa732321b6f8494841895af5f)
1 /*
2  * Copyright 2001-2015, Haiku.
3  * Copyright (c) 2003-4 Kian Duffy <myob@users.sourceforge.net>
4  * Copyright (C) 1998,99 Kazuho Okui and Takashi Murai.
5  *
6  * Distributed under the terms of the MIT License.
7  *
8  * Authors:
9  *		Kian Duffy, myob@users.sourceforge.net
10  *		Simon South, simon@simonsouth.net
11  *		Siarzhuk Zharski, zharik@gmx.li
12  */
13 #ifndef TERMCONST_H_INCLUDED
14 #define TERMCONST_H_INCLUDED
15 
16 // Application signature (Must same in Terminal.rdef)
17 #define TERM_SIGNATURE "application/x-vnd.Haiku-Terminal"
18 #define PREFFILE_MIMETYPE "text/x-terminal-pref"
19 
20 // Signature of R5's Terminal. Needed for proper drop-in window count support
21 #define R5_TERM_SIGNATURE "application/x-vnd.Be-SHEL"
22 
23 // Name of the clipboard used for mouse copy'n'paste.
24 #define MOUSE_CLIPBOARD_NAME TERM_SIGNATURE "/mouse"
25 
26 // Message constants for menu items
27 
28 #include <SupportDefs.h>
29 
30 
31 // define to get Ctrl-Cmd-S / Ctrl-Cmd-C shortcuts
32 // to get the debug buffers snapshots and control
33 // sequences capture logging
34 #define USE_DEBUG_SNAPSHOTS
35 #ifdef USE_DEBUG_SNAPSHOTS
36 const uint32 SHORTCUT_DEBUG_SNAPSHOTS	= 'sdbs';
37 const uint32 SHORTCUT_DEBUG_CAPTURE		= 'srdc';
38 #endif
39 
40 // Menu Message
41 static const uint32 MENU_SWITCH_TERM	= 'MSWT';
42 static const uint32 MENU_NEW_TERM		= 'MNTE';
43 static const uint32 MENU_PREF_OPEN		= 'MPre';
44 static const uint32 MENU_CLEAR_ALL		= 'MCAl';
45 static const uint32 MENU_HELP			= 'Mhlp';
46 static const uint32 MENU_COMMAND_HELP	= 'Mchp';
47 static const uint32 MENU_SHOW_GPL		= 'Mgpl';
48 static const uint32 MENU_ENCODING		= 'Menc';
49 static const uint32 MENU_PAGE_SETUP		= 'Mpst';
50 static const uint32 MENU_PRINT			= 'Mpnt';
51 static const uint32 MENU_FIND_STRING	= 'Mfpr';
52 static const uint32 MENU_FIND_NEXT		= 'Mfnx';
53 static const uint32 MENU_FIND_PREVIOUS	= 'Mfbw';
54 static const uint32 MENU_SHOW_COLOR		= 'Mcol';
55 
56 static const uint32 M_GET_DEVICE_NUM	= 'Mgdn';
57 
58 
59 // Preference Message
60 static const ulong PSET__COLS							= 'pcol';
61 static const ulong PSET__ROWS							= 'prow';
62 static const ulong PSET__HFONT							= 'phfn';
63 static const ulong PSET__HFONT_SIZE						= 'phfs';
64 static const ulong PSET_FORE_COLOR						= 'pfcl';
65 static const ulong PSET_BACK_COLOR						= 'pbcl';
66 static const ulong PSET__CODING							= 'pcod';
67 
68 // Terminal Size Messages
69 static const uint32 EIGHTYTWENTYFIVE					= 'etfv';
70 static const uint32 EIGHTYFORTY							= 'efor';
71 static const uint32 ONETHREETWOTWENTYFIVE				= 'hunv';
72 static const uint32 FULLSCREEN							= 'fscr';
73 
74 static const uint32 MSG_FONT_CHANGED					= 'fntc';
75 static const uint32 MSG_SAVE_AS_DEFAULT					= 'sadf';
76 static const uint32 MSG_CHECK_CHILDREN					= 'ckch';
77 static const uint32 MSG_REMOVE_RESIZE_VIEW_IF_NEEDED	= 'rmrv';
78 static const uint32 MSG_TERMINAL_BUFFER_CHANGED			= 'bufc';
79 static const uint32 MSG_SET_TERMINAL_TITLE				= 'sett';
80 static const uint32 MSG_SET_TERMINAL_COLORS				= 'setc';
81 static const uint32 MSG_RESET_TERMINAL_COLORS			= 'rstc';
82 static const uint32 MSG_QUIT_TERMNAL					= 'qutt';
83 static const uint32 MSG_ENABLE_META_KEY					= 'emtk';
84 static const uint32 MSG_REPORT_MOUSE_EVENT				= 'mous';
85 static const uint32 MSG_SAVE_WINDOW_POSITION			= 'swps';
86 static const uint32 MSG_MOVE_TAB_LEFT					= 'mvtl';
87 static const uint32 MSG_MOVE_TAB_RIGHT					= 'mvtr';
88 static const uint32 MSG_ACTIVATE_TERM					= 'msat';
89 static const uint32 MSG_SET_CURSOR_STYLE				= 'mscs';
90 
91 
92 // Preference Read/Write Keys
93 static const char* const PREF_HALF_FONT_FAMILY = "Half Font Family";
94 static const char* const PREF_HALF_FONT_STYLE = "Half Font Style";
95 static const char* const PREF_HALF_FONT_SIZE = "Half Font Size";
96 
97 static const char* const PREF_TEXT_FORE_COLOR = "Text";
98 static const char* const PREF_TEXT_BACK_COLOR = "Background";
99 static const char* const PREF_CURSOR_FORE_COLOR = "Text under cursor";
100 static const char* const PREF_CURSOR_BACK_COLOR = "Cursor";
101 static const char* const PREF_SELECT_FORE_COLOR = "Selected text";
102 static const char* const PREF_SELECT_BACK_COLOR = "Selected background";
103 
104 static const char* const PREF_IM_FORE_COLOR = "IM foreground color";
105 static const char* const PREF_IM_BACK_COLOR = "IM background color";
106 static const char* const PREF_IM_SELECT_COLOR = "IM selection color";
107 
108 static const char* const PREF_ANSI_BLACK_COLOR = "ANSI black color";
109 static const char* const PREF_ANSI_RED_COLOR = "ANSI red color";
110 static const char* const PREF_ANSI_GREEN_COLOR = "ANSI green color";
111 static const char* const PREF_ANSI_YELLOW_COLOR = "ANSI yellow color";
112 static const char* const PREF_ANSI_BLUE_COLOR = "ANSI blue color";
113 static const char* const PREF_ANSI_MAGENTA_COLOR = "ANSI magenta color";
114 static const char* const PREF_ANSI_CYAN_COLOR = "ANSI cyan color";
115 static const char* const PREF_ANSI_WHITE_COLOR = "ANSI white color";
116 
117 static const char* const PREF_ANSI_BLACK_HCOLOR = "ANSI bright black color";
118 static const char* const PREF_ANSI_RED_HCOLOR = "ANSI bright red color";
119 static const char* const PREF_ANSI_GREEN_HCOLOR = "ANSI bright green color";
120 static const char* const PREF_ANSI_YELLOW_HCOLOR = "ANSI bright yellow color";
121 static const char* const PREF_ANSI_BLUE_HCOLOR = "ANSI bright blue color";
122 static const char* const PREF_ANSI_MAGENTA_HCOLOR = "ANSI bright magenta color";
123 static const char* const PREF_ANSI_CYAN_HCOLOR = "ANSI bright cyan color";
124 static const char* const PREF_ANSI_WHITE_HCOLOR = "ANSI bright white color";
125 
126 static const char* const PREF_HISTORY_SIZE = "History size";
127 static const char* const PREF_CURSOR_BLINKING = "Cursor blinking rate";
128 
129 static const char* const PREF_IM_AWARE = "Input method aware";
130 
131 static const char* const PREF_COLS = "Cols";
132 static const char* const PREF_ROWS = "Rows";
133 
134 static const char* const PREF_TEXT_ENCODING = "Text encoding";
135 
136 static const char* const PREF_BLINK_CURSOR = "Blinking cursor";
137 static const char* const PREF_ALLOW_BOLD = "Allow bold text";
138 static const char* const PREF_USE_OPTION_AS_META =
139 	"Use left Option as Meta key";
140 static const char* const PREF_WARN_ON_EXIT = "Warn on exit";
141 static const char* const PREF_CURSOR_STYLE = "Cursor style";
142 static const char* const PREF_EMULATE_BOLD = "Emulate bold";
143 
144 static const char* const PREF_TAB_TITLE = "Tab title";
145 static const char* const PREF_WINDOW_TITLE = "Window title";
146 
147 // shared strings
148 extern const char* const kTooTipSetTabTitlePlaceholders;
149 extern const char* const kTooTipSetWindowTitlePlaceholders;
150 extern const char* const kToolTipCommonTitlePlaceholders;
151 
152 extern const char* const kShellEscapeCharacters;
153 extern const char* const kDefaultAdditionalWordCharacters;
154 extern const char* const kURLAdditionalWordCharacters;
155 
156 
157 // Cursor style
158 enum {
159 	BLOCK_CURSOR,
160 	UNDERLINE_CURSOR,
161 	IBEAM_CURSOR
162 };
163 
164 
165 // Preference Folder and setting path
166 
167 static const int32 DEFAULT = -1;
168 
169 // Font Width
170 enum {
171 	HALF_WIDTH = 1,
172 	FULL_WIDTH = 2
173 };
174 
175 #define M_UTF8 -1
176 
177 #define TAB_WIDTH 8
178 
179 #define MIN_COLS 10
180 #define MAX_COLS 999
181 #define MIN_ROWS 10
182 #define MAX_ROWS 999
183 
184 // Insert mode flag
185 #define MODE_OVER 0
186 #define MODE_INSERT 1
187 
188 // Define TermBuffer internal code
189 #define NO_CHAR 0x00
190 #define A_CHAR 0x01
191 #define IN_STRING 0xFF
192 
193 // TermBuffer extended attribute
194 #define A_WIDTH			0x8000
195 #define BOLD			0x4000
196 #define UNDERLINE		0x2000
197 #define INVERSE			0x1000
198 #define MOUSE			0x0800
199 #define FORESET			0x0400
200 #define BACKSET			0x0200
201 #define FONT			0x0100
202 #define RESERVE			0x0080
203 #define DUMPCR			0x0040
204 #define FORECOLOR		0xFF0000
205 #define BACKCOLOR		0xFF000000
206 #define CHAR_ATTRIBUTES	0xFFFF7700
207 
208 #define IS_WIDTH(x)	(((x) & A_WIDTH)   )
209 #define IS_BOLD(x)	(((x) & BOLD)      )
210 #define IS_UNDER(x)	(((x) & UNDERLINE) )
211 #define IS_INVERSE(x)	(((x) & INVERSE)   )
212 #define IS_MOUSE(x)	(((x) & MOUSE)     )
213 #define IS_FORESET(x)	(((x) & FORESET)   )
214 #define IS_BACKSET(x)	(((x) & BACKSET)   )
215 #define IS_FONT(x)	(((x) & FONT)      )
216 #define IS_CR(x)	(((x) & DUMPCR)	   )
217 #define IS_FORECOLOR(x) (((x) & FORECOLOR) >> 16)
218 #define IS_BACKCOLOR(x) (((x) & BACKCOLOR) >> 24)
219 
220 #define FORECOLORED(x) ((x) << 16)
221 #define BACKCOLORED(x) ((x) << 24)
222 
223 
224 #endif	// TERMCONST_H_INCLUDED
225