2 * CMD - Wine-compatible command line interface.
4 * Copyright (C) 1999 D A Pickles
5 * Copyright (C) 2007 J Edmeades
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * This library 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 GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
31 #include <wine/unicode.h>
33 /* msdn specified max for Win XP */
34 #define MAXSTRING 8192
36 /* Data structure to hold commands delimitors/separators */
38 typedef enum _CMDdelimiters {
39 CMD_NONE, /* End of line or single & */
40 CMD_ONFAILURE, /* || */
41 CMD_ONSUCCESS, /* && */
42 CMD_PIPE /* Single | */
45 /* Data structure to hold commands to be processed */
47 typedef struct _CMD_LIST {
48 WCHAR *command; /* Command string to execute */
49 WCHAR *redirects; /* Redirects in place */
50 struct _CMD_LIST *nextcommand; /* Next command string to execute */
51 CMD_DELIMITERS prevDelim; /* Previous delimiter */
52 int bracketDepth;/* How deep bracketing have we got to */
53 WCHAR pipeFile[MAX_PATH]; /* Where to get input from for pipes */
56 void WCMD_assoc (const WCHAR *, BOOL);
57 void WCMD_batch (WCHAR *, WCHAR *, BOOL, WCHAR *, HANDLE);
58 void WCMD_call (WCHAR *command);
59 void WCMD_change_tty (void);
60 void WCMD_choice (const WCHAR *);
61 void WCMD_clear_screen (void);
62 void WCMD_color (void);
63 void WCMD_copy (WCHAR *);
64 void WCMD_create_dir (WCHAR *);
65 BOOL WCMD_delete (WCHAR *);
66 void WCMD_directory (WCHAR *);
67 void WCMD_echo (const WCHAR *);
68 void WCMD_endlocal (void);
69 void WCMD_enter_paged_mode(const WCHAR *);
70 void WCMD_exit (CMD_LIST **cmdList);
71 void WCMD_for (WCHAR *, CMD_LIST **cmdList);
72 void WCMD_give_help (const WCHAR *args);
73 void WCMD_goto (CMD_LIST **cmdList);
74 void WCMD_if (WCHAR *, CMD_LIST **cmdList);
75 void WCMD_leave_paged_mode(void);
76 void WCMD_more (WCHAR *);
77 void WCMD_move (void);
78 WCHAR* CDECL WCMD_format_string (const WCHAR *format, ...);
79 void CDECL WCMD_output (const WCHAR *format, ...);
80 void CDECL WCMD_output_stderr (const WCHAR *format, ...);
81 void WCMD_output_asis (const WCHAR *message);
82 void WCMD_output_asis_stderr (const WCHAR *message);
83 void WCMD_pause (void);
84 void WCMD_popd (void);
85 void WCMD_print_error (void);
86 void WCMD_pushd (const WCHAR *args);
87 void WCMD_remove_dir (WCHAR *command);
88 void WCMD_rename (void);
89 void WCMD_run_program (WCHAR *command, BOOL called);
90 void WCMD_setlocal (const WCHAR *args);
91 void WCMD_setshow_date (void);
92 void WCMD_setshow_default (const WCHAR *args);
93 void WCMD_setshow_env (WCHAR *command);
94 void WCMD_setshow_path (const WCHAR *args);
95 void WCMD_setshow_prompt (void);
96 void WCMD_setshow_time (void);
97 void WCMD_shift (const WCHAR *args);
98 void WCMD_start (const WCHAR *args);
99 void WCMD_title (const WCHAR *);
100 void WCMD_type (WCHAR *);
101 void WCMD_verify (const WCHAR *args);
102 void WCMD_version (void);
103 int WCMD_volume (BOOL set_label, const WCHAR *args);
105 static inline BOOL WCMD_is_console_handle(HANDLE h)
107 return (((DWORD_PTR)h) & 3) == 3;
109 WCHAR *WCMD_fgets (WCHAR *buf, DWORD n, HANDLE stream);
110 WCHAR *WCMD_parameter (WCHAR *s, int n, WCHAR **start, BOOL raw, BOOL wholecmdline);
111 WCHAR *WCMD_parameter_with_delims (WCHAR *s, int n, WCHAR **start, BOOL raw,
112 BOOL wholecmdline, const WCHAR *delims);
113 WCHAR *WCMD_skip_leading_spaces (WCHAR *string);
114 BOOL WCMD_keyword_ws_found(const WCHAR *keyword, int len, const WCHAR *ptr);
115 void WCMD_HandleTildaModifiers(WCHAR **start, BOOL justFors);
117 void WCMD_splitpath(const WCHAR* path, WCHAR* drv, WCHAR* dir, WCHAR* name, WCHAR* ext);
118 void WCMD_strip_quotes(WCHAR *cmd);
119 WCHAR *WCMD_LoadMessage(UINT id);
120 WCHAR *WCMD_strdupW(const WCHAR *input);
121 void WCMD_strsubstW(WCHAR *start, const WCHAR* next, const WCHAR* insert, int len);
122 BOOL WCMD_ReadFile(const HANDLE hIn, WCHAR *intoBuf, const DWORD maxChars, LPDWORD charsRead);
124 WCHAR *WCMD_ReadAndParseLine(const WCHAR *initialcmd, CMD_LIST **output, HANDLE readFrom);
125 CMD_LIST *WCMD_process_commands(CMD_LIST *thisCmd, BOOL oneBracket, BOOL retrycall);
126 void WCMD_free_commands(CMD_LIST *cmds);
127 void WCMD_execute (const WCHAR *orig_command, const WCHAR *redirects,
128 CMD_LIST **cmdList, BOOL retrycall);
130 /* Data structure to hold context when executing batch files */
132 typedef struct _BATCH_CONTEXT {
133 WCHAR *command; /* The command which invoked the batch file */
134 HANDLE h; /* Handle to the open batch file */
135 WCHAR *batchfileW; /* Name of same */
136 int shift_count[10]; /* Offset in terms of shifts for %0 - %9 */
137 struct _BATCH_CONTEXT *prev_context; /* Pointer to the previous context block */
138 BOOL skip_rest; /* Skip the rest of the batch program and exit */
139 CMD_LIST *toExecute; /* Commands left to be executed */
142 /* Data structure to handle building lists during recursive calls */
146 struct env_stack *next;
148 int stackdepth; /* Only used for pushd and popd */
149 WCHAR cwd; /* Only used for set/endlocal */
152 HANDLE batchhandle; /* Used to ensure set/endlocals stay in scope */
155 /* Data structure to save setlocal and pushd information */
157 typedef struct _DIRECTORY_STACK
159 struct _DIRECTORY_STACK *next;
164 /* Data structure to for loop variables during for body execution, bearing
165 in mind that for loops can be nested */
166 #define MAX_FOR_VARIABLES 52
167 #define FOR_VAR_IDX(c) (((c)>='a'&&(c)<='z')?((c)-'a'):\
168 ((c)>='A'&&(c)<='Z')?(26+(c)-'A'):-1)
170 typedef struct _FOR_CONTEXT {
171 WCHAR *variable[MAX_FOR_VARIABLES]; /* a-z then A-Z */
175 * Global variables quals, param1, param2 contain the current qualifiers
176 * (uppercased and concatenated) and parameters entered, with environment
177 * variables and batch parameters substitution already done.
179 extern WCHAR quals[MAX_PATH], param1[MAXSTRING], param2[MAXSTRING];
180 extern DWORD errorlevel;
181 extern BATCH_CONTEXT *context;
182 extern FOR_CONTEXT forloopcontext;
184 #endif /* !RC_INVOKED */
187 * Serial nos of builtin commands. These constants must be in step with
188 * the list of strings defined in wcmd.rc, and WCMD_EXIT *must* always be
191 * Yes it *would* be nice to use an enumeration here, but the Resource
192 * Compiler won't accept resource IDs from enumerations :-(
205 #define WCMD_ERASE 10
210 #define WCMD_LABEL 15
212 #define WCMD_MKDIR 17
215 #define WCMD_PAUSE 20
216 #define WCMD_PROMPT 21
219 #define WCMD_RENAME 24
221 #define WCMD_RMDIR 26
223 #define WCMD_SHIFT 28
224 #define WCMD_START 29
226 #define WCMD_TITLE 31
228 #define WCMD_VERIFY 33
232 #define WCMD_ENDLOCAL 36
233 #define WCMD_SETLOCAL 37
234 #define WCMD_PUSHD 38
236 #define WCMD_ASSOC 40
237 #define WCMD_COLOR 41
238 #define WCMD_FTYPE 42
240 #define WCMD_CHOICE 44
242 /* Must be last in list */
245 /* Some standard messages */
246 extern const WCHAR newlineW[];
247 extern const WCHAR spaceW[];
248 extern const WCHAR nullW[];
249 extern const WCHAR dotW[];
250 extern const WCHAR dotdotW[];
251 extern const WCHAR starW[];
252 extern const WCHAR slashW[];
253 extern const WCHAR equalW[];
254 extern WCHAR anykey[];
255 extern WCHAR version_string[];
257 /* Translated messages */
258 #define WCMD_ALLHELP 1000
259 #define WCMD_CONFIRM 1001
260 #define WCMD_YES 1002
262 #define WCMD_NOASSOC 1004
263 #define WCMD_NOFTYPE 1005
264 #define WCMD_OVERWRITE 1006
265 #define WCMD_MORESTR 1007
266 #define WCMD_TRUNCATEDLINE 1008
267 #define WCMD_NYI 1009
268 #define WCMD_NOARG 1010
269 #define WCMD_SYNTAXERR 1011
270 #define WCMD_FILENOTFOUND 1012
271 #define WCMD_NOCMDHELP 1013
272 #define WCMD_NOTARGET 1014
273 #define WCMD_CURRENTDATE 1015
274 #define WCMD_CURRENTTIME 1016
275 #define WCMD_NEWDATE 1017
276 #define WCMD_NEWTIME 1018
277 #define WCMD_MISSINGENV 1019
278 #define WCMD_READFAIL 1020
279 #define WCMD_CALLINSCRIPT 1021
280 #define WCMD_ALL 1022
281 #define WCMD_DELPROMPT 1023
282 #define WCMD_ECHOPROMPT 1024
283 #define WCMD_VERIFYPROMPT 1025
284 #define WCMD_VERIFYERR 1026
285 #define WCMD_ARGERR 1027
286 #define WCMD_VOLUMESERIALNO 1028
287 #define WCMD_VOLUMEPROMPT 1029
288 #define WCMD_NOPATH 1030
289 #define WCMD_ANYKEY 1031
290 #define WCMD_CONSTITLE 1032
291 #define WCMD_VERSION 1033
292 #define WCMD_MOREPROMPT 1034
293 #define WCMD_LINETOOLONG 1035
294 #define WCMD_VOLUMELABEL 1036
295 #define WCMD_VOLUMENOLABEL 1037
296 #define WCMD_YESNO 1038
297 #define WCMD_YESNOALL 1039
298 #define WCMD_NO_COMMAND_FOUND 1040