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