programs/cmd/wcmd.h

   1 /*
   2  * CMD - Wine-compatible command line interface.
   3  *
   4  * Copyright (C) 1999 D A Pickles
   5  * Copyright (C) 2007 J Edmeades
   6  *
   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.
  11  *
  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.
  16  *
  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
  20  */
  21
  22 #define IDI_ICON1       1
  23 #include <windows.h>
  24 #include <windef.h>
  25 #ifndef RC_INVOKED
  26 #include <string.h>
  27 #include <stdlib.h>
  28 #include <stdarg.h>
  29 #include <stdio.h>
  30 #include <ctype.h>
  31 #include <wine/unicode.h>
  32
  33 /* msdn specified max for Win XP */
  34 #define MAXSTRING 8192
  35
  36 /* Data structure to hold commands delimitors/separators */
  37
  38 typedef enum _CMDdelimiters {
  39   CMD_NONE,        /* End of line or single & */
  40   CMD_ONFAILURE,   /* ||                      */
  41   CMD_ONSUCCESS,   /* &&                      */
  42   CMD_PIPE         /* Single |                */
  43 } CMD_DELIMITERS;
  44
  45 /* Data structure to hold commands to be processed */
  46
  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 */
  54 } CMD_LIST;
  55
  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);
 104
 105 static inline BOOL WCMD_is_console_handle(HANDLE h)
 106 {
 107     return (((DWORD_PTR)h) & 3) == 3;
 108 }
 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 atExecute);
 116
 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 void WCMD_strsubstW(WCHAR *start, const WCHAR* next, const WCHAR* insert, int len);
 121 BOOL WCMD_ReadFile(const HANDLE hIn, WCHAR *intoBuf, const DWORD maxChars, LPDWORD charsRead);
 122
 123 WCHAR    *WCMD_ReadAndParseLine(const WCHAR *initialcmd, CMD_LIST **output, HANDLE readFrom);
 124 CMD_LIST *WCMD_process_commands(CMD_LIST *thisCmd, BOOL oneBracket, BOOL retrycall);
 125 void      WCMD_free_commands(CMD_LIST *cmds);
 126 void      WCMD_execute (const WCHAR *orig_command, const WCHAR *redirects,
 127                         CMD_LIST **cmdList, BOOL retrycall);
 128
 129 void *heap_alloc(size_t);
 130
 131 static inline BOOL heap_free(void *mem)
 132 {
 133     return HeapFree(GetProcessHeap(), 0, mem);
 134 }
 135
 136 static inline WCHAR *heap_strdupW(const WCHAR *str)
 137 {
 138     WCHAR *ret = NULL;
 139
 140     if(str) {
 141         size_t size;
 142
 143         size = (strlenW(str)+1)*sizeof(WCHAR);
 144         ret = heap_alloc(size);
 145         memcpy(ret, str, size);
 146     }
 147
 148     return ret;
 149 }
 150
 151 /* Data structure to hold context when executing batch files */
 152
 153 typedef struct _BATCH_CONTEXT {
 154   WCHAR *command;       /* The command which invoked the batch file */
 155   HANDLE h;             /* Handle to the open batch file */
 156   WCHAR *batchfileW;    /* Name of same */
 157   int shift_count[10];  /* Offset in terms of shifts for %0 - %9 */
 158   struct _BATCH_CONTEXT *prev_context; /* Pointer to the previous context block */
 159   BOOL  skip_rest;      /* Skip the rest of the batch program and exit */
 160   CMD_LIST *toExecute;  /* Commands left to be executed */
 161 } BATCH_CONTEXT;
 162
 163 /* Data structure to handle building lists during recursive calls */
 164
 165 struct env_stack
 166 {
 167   struct env_stack *next;
 168   union {
 169     int    stackdepth;       /* Only used for pushd and popd */
 170     WCHAR   cwd;             /* Only used for set/endlocal   */
 171   } u;
 172   WCHAR *strings;
 173   HANDLE batchhandle;        /* Used to ensure set/endlocals stay in scope */
 174   BOOL delayedsubst;         /* Is delayed substitution in effect */
 175 };
 176
 177 /* Data structure to save setlocal and pushd information */
 178
 179 typedef struct _DIRECTORY_STACK
 180 {
 181   struct _DIRECTORY_STACK *next;
 182   WCHAR  *dirName;
 183   WCHAR  *fileName;
 184 } DIRECTORY_STACK;
 185
 186 /* Data structure to for loop variables during for body execution, bearing
 187    in mind that for loops can be nested                                    */
 188 #define MAX_FOR_VARIABLES 52
 189 #define FOR_VAR_IDX(c) (((c)>='a'&&(c)<='z')?((c)-'a'):\
 190                         ((c)>='A'&&(c)<='Z')?(26+(c)-'A'):-1)
 191
 192 typedef struct _FOR_CONTEXT {
 193   WCHAR *variable[MAX_FOR_VARIABLES];   /* a-z then A-Z */
 194 } FOR_CONTEXT;
 195
 196 /*
 197  * Global variables quals, param1, param2 contain the current qualifiers
 198  * (uppercased and concatenated) and parameters entered, with environment
 199  * variables and batch parameters substitution already done.
 200  */
 201 extern WCHAR quals[MAX_PATH], param1[MAXSTRING], param2[MAXSTRING];
 202 extern DWORD errorlevel;
 203 extern BATCH_CONTEXT *context;
 204 extern FOR_CONTEXT forloopcontext;
 205 extern BOOL delayedsubst;
 206
 207 #endif /* !RC_INVOKED */
 208
 209 /*
 210  *      Serial nos of builtin commands. These constants must be in step with
 211  *      the list of strings defined in wcmd.rc, and WCMD_EXIT *must* always be
 212  *      the last one.
 213  *
 214  *      Yes it *would* be nice to use an enumeration here, but the Resource
 215  *      Compiler won't accept resource IDs from enumerations :-(
 216  */
 217
 218 #define WCMD_CALL      0
 219 #define WCMD_CD        1
 220 #define WCMD_CHDIR     2
 221 #define WCMD_CLS       3
 222 #define WCMD_COPY      4
 223 #define WCMD_CTTY      5
 224 #define WCMD_DATE      6
 225 #define WCMD_DEL       7
 226 #define WCMD_DIR       8
 227 #define WCMD_ECHO      9
 228 #define WCMD_ERASE    10
 229 #define WCMD_FOR      11
 230 #define WCMD_GOTO     12
 231 #define WCMD_HELP     13
 232 #define WCMD_IF       14
 233 #define WCMD_LABEL    15
 234 #define WCMD_MD       16
 235 #define WCMD_MKDIR    17
 236 #define WCMD_MOVE     18
 237 #define WCMD_PATH     19
 238 #define WCMD_PAUSE    20
 239 #define WCMD_PROMPT   21
 240 #define WCMD_REM      22
 241 #define WCMD_REN      23
 242 #define WCMD_RENAME   24
 243 #define WCMD_RD       25
 244 #define WCMD_RMDIR    26
 245 #define WCMD_SET      27
 246 #define WCMD_SHIFT    28
 247 #define WCMD_START    29
 248 #define WCMD_TIME     30
 249 #define WCMD_TITLE    31
 250 #define WCMD_TYPE     32
 251 #define WCMD_VERIFY   33
 252 #define WCMD_VER      34
 253 #define WCMD_VOL      35
 254
 255 #define WCMD_ENDLOCAL 36
 256 #define WCMD_SETLOCAL 37
 257 #define WCMD_PUSHD    38
 258 #define WCMD_POPD     39
 259 #define WCMD_ASSOC    40
 260 #define WCMD_COLOR    41
 261 #define WCMD_FTYPE    42
 262 #define WCMD_MORE     43
 263 #define WCMD_CHOICE   44
 264
 265 /* Must be last in list */
 266 #define WCMD_EXIT     45
 267
 268 /* Some standard messages */
 269 extern const WCHAR newlineW[];
 270 extern const WCHAR spaceW[];
 271 extern const WCHAR nullW[];
 272 extern const WCHAR dotW[];
 273 extern const WCHAR dotdotW[];
 274 extern const WCHAR starW[];
 275 extern const WCHAR slashW[];
 276 extern const WCHAR equalW[];
 277 extern WCHAR anykey[];
 278 extern WCHAR version_string[];
 279
 280 /* Translated messages */
 281 #define WCMD_ALLHELP          1000
 282 #define WCMD_CONFIRM          1001
 283 #define WCMD_YES              1002
 284 #define WCMD_NO               1003
 285 #define WCMD_NOASSOC          1004
 286 #define WCMD_NOFTYPE          1005
 287 #define WCMD_OVERWRITE        1006
 288 #define WCMD_MORESTR          1007
 289 #define WCMD_TRUNCATEDLINE    1008
 290 #define WCMD_NYI              1009
 291 #define WCMD_NOARG            1010
 292 #define WCMD_SYNTAXERR        1011
 293 #define WCMD_FILENOTFOUND     1012
 294 #define WCMD_NOCMDHELP        1013
 295 #define WCMD_NOTARGET         1014
 296 #define WCMD_CURRENTDATE      1015
 297 #define WCMD_CURRENTTIME      1016
 298 #define WCMD_NEWDATE          1017
 299 #define WCMD_NEWTIME          1018
 300 #define WCMD_MISSINGENV       1019
 301 #define WCMD_READFAIL         1020
 302 #define WCMD_CALLINSCRIPT     1021
 303 #define WCMD_ALL              1022
 304 #define WCMD_DELPROMPT        1023
 305 #define WCMD_ECHOPROMPT       1024
 306 #define WCMD_VERIFYPROMPT     1025
 307 #define WCMD_VERIFYERR        1026
 308 #define WCMD_ARGERR           1027
 309 #define WCMD_VOLUMESERIALNO   1028
 310 #define WCMD_VOLUMEPROMPT     1029
 311 #define WCMD_NOPATH           1030
 312 #define WCMD_ANYKEY           1031
 313 #define WCMD_CONSTITLE        1032
 314 #define WCMD_VERSION          1033
 315 #define WCMD_MOREPROMPT       1034
 316 #define WCMD_LINETOOLONG      1035
 317 #define WCMD_VOLUMELABEL      1036
 318 #define WCMD_VOLUMENOLABEL    1037
 319 #define WCMD_YESNO            1038
 320 #define WCMD_YESNOALL         1039
 321 #define WCMD_NO_COMMAND_FOUND 1040
 322 #define WCMD_DIVIDEBYZERO     1041
 323 #define WCMD_NOOPERAND        1042
 324 #define WCMD_NOOPERATOR       1043
 325 #define WCMD_BADPAREN         1044
 326 #define WCMD_BADHEXOCT        1045