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 /* Data structure to hold commands to be processed */
35 typedef enum _CMDdelimiters {
36 CMD_NONE, /* End of line or single & */
37 CMD_ONFAILURE, /* || */
38 CMD_ONSUCCESS, /* && */
39 CMD_PIPE /* Single | */
42 typedef struct _CMD_LIST {
43 WCHAR *command; /* Command string to execute */
44 WCHAR *redirects; /* Redirects in place */
45 struct _CMD_LIST *nextcommand; /* Next command string to execute */
46 CMD_DELIMITERS prevDelim; /* Previous delimiter */
47 int bracketDepth;/* How deep bracketing have we got to */
48 WCHAR pipeFile[MAX_PATH]; /* Where to get input from for pipes */
51 void WCMD_assoc (const WCHAR *, BOOL);
52 void WCMD_batch (WCHAR *, WCHAR *, int, WCHAR *, HANDLE);
53 void WCMD_call (WCHAR *command);
54 void WCMD_change_tty (void);
55 void WCMD_choice (const WCHAR *);
56 void WCMD_clear_screen (void);
57 void WCMD_color (void);
58 void WCMD_copy (void);
59 void WCMD_create_dir (WCHAR *);
60 BOOL WCMD_delete (WCHAR *);
61 void WCMD_directory (WCHAR *);
62 void WCMD_echo (const WCHAR *);
63 void WCMD_endlocal (void);
64 void WCMD_enter_paged_mode(const WCHAR *);
65 void WCMD_exit (CMD_LIST **cmdList);
66 void WCMD_for (WCHAR *, CMD_LIST **cmdList);
67 void WCMD_give_help (const WCHAR *command);
68 void WCMD_goto (CMD_LIST **cmdList);
69 void WCMD_if (WCHAR *, CMD_LIST **cmdList);
70 void WCMD_leave_paged_mode(void);
71 void WCMD_more (WCHAR *);
72 void WCMD_move (void);
73 void WCMD_output (const WCHAR *format, ...);
74 void WCMD_output_asis (const WCHAR *message);
75 void WCMD_pause (void);
76 void WCMD_popd (void);
77 void WCMD_print_error (void);
78 void WCMD_pushd (WCHAR *);
79 void WCMD_remove_dir (WCHAR *command);
80 void WCMD_rename (void);
81 void WCMD_run_program (WCHAR *command, int called);
82 void WCMD_setlocal (const WCHAR *command);
83 void WCMD_setshow_attrib (void);
84 void WCMD_setshow_date (void);
85 void WCMD_setshow_default (const WCHAR *command);
86 void WCMD_setshow_env (WCHAR *command);
87 void WCMD_setshow_path (const WCHAR *command);
88 void WCMD_setshow_prompt (void);
89 void WCMD_setshow_time (void);
90 void WCMD_shift (const WCHAR *command);
91 void WCMD_title (const WCHAR *);
92 void WCMD_type (WCHAR *);
93 void WCMD_verify (const WCHAR *command);
94 void WCMD_version (void);
95 int WCMD_volume (int mode, const WCHAR *command);
97 WCHAR *WCMD_fgets (WCHAR *s, int n, HANDLE stream);
98 WCHAR *WCMD_parameter (WCHAR *s, int n, WCHAR **where);
99 WCHAR *WCMD_skip_leading_spaces (WCHAR *string);
100 BOOL WCMD_keyword_ws_found(const WCHAR *keyword, int len, const WCHAR *ptr);
101 void WCMD_HandleTildaModifiers(WCHAR **start, const WCHAR *forVariable, const WCHAR *forValue, BOOL justFors);
103 void WCMD_splitpath(const WCHAR* path, WCHAR* drv, WCHAR* dir, WCHAR* name, WCHAR* ext);
104 void WCMD_opt_s_strip_quotes(WCHAR *cmd);
105 WCHAR *WCMD_LoadMessage(UINT id);
106 WCHAR *WCMD_strdupW(const WCHAR *input);
107 void WCMD_strsubstW(WCHAR *start, const WCHAR* next, const WCHAR* insert, int len);
108 BOOL WCMD_ReadFile(const HANDLE hIn, WCHAR *intoBuf, const DWORD maxChars,
109 LPDWORD charsRead, const LPOVERLAPPED unused);
111 WCHAR *WCMD_ReadAndParseLine(const WCHAR *initialcmd, CMD_LIST **output, HANDLE readFrom);
112 CMD_LIST *WCMD_process_commands(CMD_LIST *thisCmd, BOOL oneBracket,
113 const WCHAR *var, const WCHAR *val);
114 void WCMD_free_commands(CMD_LIST *cmds);
115 void WCMD_execute (const WCHAR *orig_command, const WCHAR *redirects,
116 const WCHAR *parameter, const WCHAR *substitution,
119 /* Data structure to hold context when executing batch files */
122 WCHAR *command; /* The command which invoked the batch file */
123 HANDLE h; /* Handle to the open batch file */
124 WCHAR *batchfileW; /* Name of same */
125 int shift_count[10]; /* Offset in terms of shifts for %0 - %9 */
126 void *prev_context; /* Pointer to the previous context block */
127 BOOL skip_rest; /* Skip the rest of the batch program and exit */
128 CMD_LIST *toExecute; /* Commands left to be executed */
131 /* Data structure to save setlocal and pushd information */
135 struct env_stack *next;
137 int stackdepth; /* Only used for pushd and popd */
138 WCHAR cwd; /* Only used for set/endlocal */
143 /* Data structure to handle building lists during recursive calls */
145 typedef struct _DIRECTORY_STACK
147 struct _DIRECTORY_STACK *next;
152 #endif /* !RC_INVOKED */
155 * Serial nos of builtin commands. These constants must be in step with
156 * the list of strings defined in wcmd.rc, and WCMD_EXIT *must* always be
159 * Yes it *would* be nice to use an enumeration here, but the Resource
160 * Compiler won't accept resource IDs from enumerations :-(
163 #define WCMD_ATTRIB 0
174 #define WCMD_ERASE 11
179 #define WCMD_LABEL 16
181 #define WCMD_MKDIR 18
184 #define WCMD_PAUSE 21
185 #define WCMD_PROMPT 22
188 #define WCMD_RENAME 25
190 #define WCMD_RMDIR 27
192 #define WCMD_SHIFT 29
194 #define WCMD_TITLE 31
196 #define WCMD_VERIFY 33
200 #define WCMD_ENDLOCAL 36
201 #define WCMD_SETLOCAL 37
202 #define WCMD_PUSHD 38
204 #define WCMD_ASSOC 40
205 #define WCMD_COLOR 41
206 #define WCMD_FTYPE 42
208 #define WCMD_CHOICE 44
210 /* Must be last in list */
213 /* Some standard messages */
214 extern const WCHAR newline[];
215 extern WCHAR anykey[];
216 extern WCHAR version_string[];
218 /* Translated messages */
219 #define WCMD_ALLHELP 1000
220 #define WCMD_CONFIRM 1001
221 #define WCMD_YES 1002
223 #define WCMD_NOASSOC 1004
224 #define WCMD_NOFTYPE 1005
225 #define WCMD_OVERWRITE 1006
226 #define WCMD_MORESTR 1007
227 #define WCMD_TRUNCATEDLINE 1008
228 #define WCMD_NYI 1009
229 #define WCMD_NOARG 1010
230 #define WCMD_SYNTAXERR 1011
231 #define WCMD_FILENOTFOUND 1012
232 #define WCMD_NOCMDHELP 1013
233 #define WCMD_NOTARGET 1014
234 #define WCMD_CURRENTDATE 1015
235 #define WCMD_CURRENTTIME 1016
236 #define WCMD_NEWDATE 1017
237 #define WCMD_NEWTIME 1018
238 #define WCMD_MISSINGENV 1019
239 #define WCMD_READFAIL 1020
240 #define WCMD_CALLINSCRIPT 1021
241 #define WCMD_ALL 1022
242 #define WCMD_DELPROMPT 1023
243 #define WCMD_ECHOPROMPT 1024
244 #define WCMD_VERIFYPROMPT 1025
245 #define WCMD_VERIFYERR 1026
246 #define WCMD_ARGERR 1027
247 #define WCMD_VOLUMEDETAIL 1028
248 #define WCMD_VOLUMEPROMPT 1029
249 #define WCMD_NOPATH 1030
250 #define WCMD_ANYKEY 1031
251 #define WCMD_CONSTITLE 1032
252 #define WCMD_VERSION 1033
253 #define WCMD_MOREPROMPT 1034
254 #define WCMD_LINETOOLONG 1035
256 /* msdn specified max for Win XP */
257 #define MAXSTRING 8192