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 #include <winternl.h>
  26 #ifndef RC_INVOKED
  27 #include <string.h>
  28 #include <stdlib.h>
  29 #include <stdarg.h>
  30 #include <stdio.h>
  31 #include <ctype.h>
  32 #include <wchar.h>
  33
  34 /* msdn specified max for Win XP */
  35 #define MAXSTRING 8192
  36
  37 /* Data structure to express a redirection */
  38 typedef struct _CMD_REDIRECTION
  39 {
  40     enum CMD_REDIRECTION_KIND {REDIR_READ_FROM, REDIR_WRITE_TO, REDIR_WRITE_APPEND, REDIR_WRITE_CLONE} kind;
  41     unsigned short fd;
  42     struct _CMD_REDIRECTION *next;
  43     union
  44     {
  45         unsigned short clone; /* only if kind is REDIR_WRITE_CLONE */
  46         WCHAR file[1];        /* only if kind is READ_FROM, WRITE or WRITE_APPEND */
  47     };
  48 } CMD_REDIRECTION;
  49
  50 /* Data structure to hold commands delimiters/separators */
  51
  52 typedef enum _CMD_OPERATOR
  53 {
  54     CMD_SINGLE,      /* single command          */
  55     CMD_CONCAT,      /* &                       */
  56     CMD_ONFAILURE,   /* ||                      */
  57     CMD_ONSUCCESS,   /* &&                      */
  58     CMD_PIPE,        /* Single |                */
  59     CMD_IF,          /* IF command              */
  60     CMD_FOR,         /* FOR command             */
  61 } CMD_OPERATOR;
  62
  63 /* Data structure to hold commands to be processed */
  64
  65 enum cond_operator {CMD_IF_ERRORLEVEL, CMD_IF_EXIST, CMD_IF_DEFINED,
  66                     CMD_IF_BINOP_EQUAL /* == */, CMD_IF_BINOP_LSS, CMD_IF_BINOP_LEQ, CMD_IF_BINOP_EQU,
  67                     CMD_IF_BINOP_NEQ, CMD_IF_BINOP_GEQ, CMD_IF_BINOP_GTR};
  68 typedef struct _CMD_IF_CONDITION
  69 {
  70     unsigned case_insensitive : 1,
  71              negated : 1,
  72              op;
  73     union
  74     {
  75         /* CMD_IF_ERRORLEVEL, CMD_IF_EXIST, CMD_IF_DEFINED */
  76         const WCHAR *operand;
  77         /* CMD_BINOP_EQUAL, CMD_BINOP_LSS, CMD_BINOP_LEQ, CMD_BINOP_EQU, CMD_BINOP_NEQ, CMD_BINOP_GEQ, CMD_BINOP_GTR */
  78         struct
  79         {
  80             const WCHAR *left;
  81             const WCHAR *right;
  82         };
  83     };
  84 } CMD_IF_CONDITION;
  85
  86 #define CMD_FOR_FLAG_TREE_RECURSE (1u << 0)
  87 #define CMD_FOR_FLAG_TREE_INCLUDE_FILES (1u << 1)
  88 #define CMD_FOR_FLAG_TREE_INCLUDE_DIRECTORIES (1u << 2)
  89
  90 typedef struct _CMD_FOR_CONTROL
  91 {
  92     enum for_control_operator {CMD_FOR_FILETREE, CMD_FOR_FILE_SET /* /F */,
  93                                CMD_FOR_NUMBERS /* /L */} operator;
  94     unsigned flags;               /* |-ed CMD_FOR_FLAG_* */
  95     int variable_index;
  96     const WCHAR *set;
  97     union
  98     {
  99         const WCHAR *root_dir;    /* for CMD_FOR_FILETREE */
 100         struct                    /* for CMD_FOR_FILE_SET */
 101         {
 102             WCHAR eol;
 103             BOOL use_backq;
 104             int num_lines_to_skip;
 105             const WCHAR *delims;
 106             const WCHAR *tokens;
 107         };
 108     };
 109 } CMD_FOR_CONTROL;
 110
 111 typedef struct _CMD_NODE
 112 {
 113     CMD_OPERATOR      op;            /* operator */
 114     CMD_REDIRECTION  *redirects;     /* Redirections */
 115     union
 116     {
 117         WCHAR        *command;       /* CMD_SINGLE */
 118         struct                       /* binary operator (CMD_CONCAT, ONFAILURE, ONSUCCESS, PIPE) */
 119         {
 120             struct _CMD_NODE *left;
 121             struct _CMD_NODE *right;
 122         };
 123         struct                       /* CMD_IF */
 124         {
 125             CMD_IF_CONDITION  condition;
 126             struct _CMD_NODE *then_block;
 127             struct _CMD_NODE *else_block;
 128         };
 129         struct                       /* CMD_FOR */
 130         {
 131             CMD_FOR_CONTROL   for_ctrl;
 132             struct _CMD_NODE *do_block;
 133         };
 134     };
 135 } CMD_NODE;
 136 int WCMD_for_nexttoken(int lasttoken, const WCHAR *tokenstr,
 137                        int *totalfound, BOOL *doall,
 138                        BOOL *duplicates);
 139
 140 struct _DIRECTORY_STACK;
 141 void WCMD_add_dirstowalk(struct _DIRECTORY_STACK *dirsToWalk);
 142 struct _DIRECTORY_STACK *WCMD_dir_stack_create(const WCHAR *dir, const WCHAR *file);
 143 struct _DIRECTORY_STACK *WCMD_dir_stack_free(struct _DIRECTORY_STACK *dir);
 144
 145 /* The return code:
 146  * - some of them are directly mapped to kernel32's errors
 147  * - some others are cmd.exe specific
 148  * - ABORTED if used to break out of FOR/IF blocks (to handle GOTO, EXIT commands)
 149  */
 150 typedef int RETURN_CODE;
 151 #define RETURN_CODE_SYNTAX_ERROR         255
 152 #define RETURN_CODE_CANT_LAUNCH          9009
 153 #define RETURN_CODE_ABORTED              (-999999)
 154
 155 BOOL WCMD_print_volume_information(const WCHAR *);
 156
 157 RETURN_CODE WCMD_assoc(const WCHAR *, BOOL);
 158 RETURN_CODE WCMD_batch(const WCHAR *, WCHAR *, const WCHAR *, HANDLE);
 159 RETURN_CODE WCMD_call(WCHAR *command);
 160 RETURN_CODE WCMD_choice(WCHAR *);
 161 RETURN_CODE WCMD_clear_screen(void);
 162 RETURN_CODE WCMD_color(void);
 163 RETURN_CODE WCMD_copy(WCHAR *);
 164 RETURN_CODE WCMD_create_dir(WCHAR *);
 165 RETURN_CODE WCMD_delete(WCHAR *);
 166 RETURN_CODE WCMD_directory(WCHAR *);
 167 RETURN_CODE WCMD_echo(const WCHAR *);
 168 RETURN_CODE WCMD_endlocal(void);
 169 void WCMD_enter_paged_mode(const WCHAR *);
 170 RETURN_CODE WCMD_exit(void);
 171 BOOL WCMD_get_fullpath(const WCHAR *, SIZE_T, WCHAR *, WCHAR **);
 172 RETURN_CODE WCMD_give_help(WCHAR *args);
 173 RETURN_CODE WCMD_goto(void);
 174 RETURN_CODE WCMD_label(void);
 175 void WCMD_leave_paged_mode(void);
 176 RETURN_CODE WCMD_more(WCHAR *);
 177 RETURN_CODE WCMD_move (void);
 178 WCHAR* WINAPIV WCMD_format_string (const WCHAR *format, ...);
 179 void WINAPIV WCMD_output (const WCHAR *format, ...);
 180 void WINAPIV WCMD_output_stderr (const WCHAR *format, ...);
 181 void WCMD_output_asis (const WCHAR *message);
 182 void WCMD_output_asis_stderr (const WCHAR *message);
 183 RETURN_CODE WCMD_pause(void);
 184 RETURN_CODE WCMD_popd(void);
 185 void WCMD_print_error (void);
 186 RETURN_CODE WCMD_pushd(const WCHAR *args);
 187 RETURN_CODE WCMD_remove_dir(WCHAR *command);
 188 RETURN_CODE WCMD_rename(void);
 189 RETURN_CODE WCMD_run_program (WCHAR *command, BOOL called);
 190 RETURN_CODE WCMD_setlocal(WCHAR *args);
 191 RETURN_CODE WCMD_setshow_date(void);
 192 RETURN_CODE WCMD_setshow_default(const WCHAR *args);
 193 RETURN_CODE WCMD_setshow_env(WCHAR *command);
 194 RETURN_CODE WCMD_setshow_path(const WCHAR *args);
 195 RETURN_CODE WCMD_setshow_prompt(void);
 196 RETURN_CODE WCMD_setshow_time(void);
 197 RETURN_CODE WCMD_shift(const WCHAR *args);
 198 RETURN_CODE WCMD_start(WCHAR *args);
 199 RETURN_CODE WCMD_title(const WCHAR *);
 200 RETURN_CODE WCMD_type(WCHAR *);
 201 RETURN_CODE WCMD_verify(void);
 202 RETURN_CODE WCMD_version(void);
 203 RETURN_CODE WCMD_volume(void);
 204 RETURN_CODE WCMD_mklink(WCHAR *args);
 205
 206 WCHAR *WCMD_fgets (WCHAR *buf, DWORD n, HANDLE stream);
 207 WCHAR *WCMD_parameter (WCHAR *s, int n, WCHAR **start, BOOL raw, BOOL wholecmdline);
 208 WCHAR *WCMD_parameter_with_delims (WCHAR *s, int n, WCHAR **start, BOOL raw,
 209                                    BOOL wholecmdline, const WCHAR *delims);
 210 WCHAR *WCMD_skip_leading_spaces (WCHAR *string);
 211 BOOL WCMD_keyword_ws_found(const WCHAR *keyword, const WCHAR *ptr);
 212 void WCMD_HandleTildeModifiers(WCHAR **start, BOOL atExecute);
 213
 214 WCHAR *WCMD_strip_quotes(WCHAR *cmd);
 215 WCHAR *WCMD_LoadMessage(UINT id);
 216 WCHAR *WCMD_strsubstW(WCHAR *start, const WCHAR* next, const WCHAR* insert, int len);
 217 BOOL WCMD_ReadFile(const HANDLE hIn, WCHAR *intoBuf, const DWORD maxChars, LPDWORD charsRead);
 218
 219 enum read_parse_line {RPL_SUCCESS, RPL_EOF, RPL_SYNTAXERROR};
 220 enum read_parse_line WCMD_ReadAndParseLine(const WCHAR *initialcmd, CMD_NODE **output, HANDLE readFrom);
 221 void      node_dispose_tree(CMD_NODE *cmds);
 222 RETURN_CODE node_execute(CMD_NODE *node);
 223
 224 void *xrealloc(void *, size_t) __WINE_ALLOC_SIZE(2) __WINE_DEALLOC(free);
 225
 226 static inline void *xalloc(size_t sz) __WINE_MALLOC;
 227 static inline void *xalloc(size_t sz)
 228 {
 229     return xrealloc(NULL, sz);
 230 }
 231
 232 static inline WCHAR *xstrdupW(const WCHAR *str)
 233 {
 234     WCHAR *ret = NULL;
 235
 236     if(str) {
 237         size_t size;
 238
 239         size = (lstrlenW(str)+1)*sizeof(WCHAR);
 240         ret = xalloc(size);
 241         memcpy(ret, str, size);
 242     }
 243
 244     return ret;
 245 }
 246
 247 static inline BOOL ends_with_backslash( const WCHAR *path )
 248 {
 249     return path[0] && path[lstrlenW(path) - 1] == '\\';
 250 }
 251
 252 int evaluate_if_condition(WCHAR *p, WCHAR **command, int *test, int *negate);
 253
 254 /* Data structure to hold context when executing batch files */
 255
 256 typedef struct _BATCH_CONTEXT {
 257   WCHAR *command;       /* The command which invoked the batch file */
 258   HANDLE h;             /* Handle to the open batch file */
 259   WCHAR *batchfileW;    /* Name of same */
 260   int shift_count[10];  /* Offset in terms of shifts for %0 - %9 */
 261   struct _BATCH_CONTEXT *prev_context; /* Pointer to the previous context block */
 262   BOOL  skip_rest;      /* Skip the rest of the batch program and exit */
 263   CMD_NODE *toExecute;  /* Commands left to be executed */
 264 } BATCH_CONTEXT;
 265
 266 /* Data structure to handle building lists during recursive calls */
 267
 268 struct env_stack
 269 {
 270   struct env_stack *next;
 271   union {
 272     int    stackdepth;       /* Only used for pushd and popd */
 273     WCHAR   cwd;             /* Only used for set/endlocal   */
 274   } u;
 275   WCHAR *strings;
 276   HANDLE batchhandle;        /* Used to ensure set/endlocals stay in scope */
 277   BOOL delayedsubst;         /* Is delayed substitution in effect */
 278 };
 279
 280 /* Data structure to save setlocal and pushd information */
 281
 282 typedef struct _DIRECTORY_STACK
 283 {
 284   struct _DIRECTORY_STACK *next;
 285   WCHAR  *dirName;
 286   WCHAR  *fileName;
 287 } DIRECTORY_STACK;
 288
 289 /* Data structure to for loop variables during for body execution, bearing
 290    in mind that for loops can be nested                                    */
 291 #define MAX_FOR_VARIABLES (2*26+10)
 292
 293 static inline int for_var_char_to_index(WCHAR c)
 294 {
 295     if (c >= L'a' && c <= L'z') return c - L'a';
 296     if (c >= L'A' && c <= L'Z') return c - L'A' + 26;
 297     if (c >= L'0' && c <= L'9') return c - L'0' + 2 * 26;
 298     return -1;
 299 }
 300
 301 static inline WCHAR for_var_index_to_char(int var_idx)
 302 {
 303     if (var_idx < 0 || var_idx >= MAX_FOR_VARIABLES) return L'?';
 304     if (var_idx < 26) return L'a' + var_idx;
 305     if (var_idx < 52) return L'A' + var_idx - 26;
 306     return L'0' + var_idx - 52;
 307 }
 308
 309 /* check that the range [var_idx, var_idx + var_offset] is a contiguous range */
 310 static inline BOOL for_var_index_in_range(int var_idx, int var_offset)
 311 {
 312     return for_var_char_to_index(for_var_index_to_char(var_idx) + var_offset) == var_idx + var_offset;
 313 }
 314
 315 typedef struct _FOR_CONTEXT
 316 {
 317     struct _FOR_CONTEXT *previous;
 318     WCHAR *variable[MAX_FOR_VARIABLES]; /* a-z then A-Z */
 319 } FOR_CONTEXT;
 320
 321 void WCMD_save_for_loop_context(BOOL reset);
 322 void WCMD_restore_for_loop_context(void);
 323 void WCMD_set_for_loop_variable(int var_idx, const WCHAR *value);
 324
 325 /*
 326  * Global variables quals, param1, param2 contain the current qualifiers
 327  * (uppercased and concatenated) and parameters entered, with environment
 328  * variables and batch parameters substitution already done.
 329  */
 330 extern WCHAR quals[MAXSTRING], param1[MAXSTRING], param2[MAXSTRING];
 331 extern int errorlevel;
 332 extern BATCH_CONTEXT *context;
 333 extern FOR_CONTEXT *forloopcontext;
 334 extern BOOL delayedsubst;
 335
 336 #endif /* !RC_INVOKED */
 337
 338 /*
 339  *      Serial nos of builtin commands. These constants must be in step with
 340  *      the list of strings defined in wcmd.rc, and WCMD_EXIT *must* always be
 341  *      the last one.
 342  *
 343  *      Yes it *would* be nice to use an enumeration here, but the Resource
 344  *      Compiler won't accept resource IDs from enumerations :-(
 345  */
 346
 347 #define WCMD_CALL      0
 348 #define WCMD_CD        1
 349 #define WCMD_CHDIR     2
 350 #define WCMD_CLS       3
 351 #define WCMD_COPY      4
 352 /* no longer used slot */
 353 #define WCMD_DATE      6
 354 #define WCMD_DEL       7
 355 #define WCMD_DIR       8
 356 #define WCMD_ECHO      9
 357 #define WCMD_ERASE    10
 358 #define WCMD_FOR      11
 359 #define WCMD_GOTO     12
 360 #define WCMD_HELP     13
 361 #define WCMD_IF       14
 362 #define WCMD_LABEL    15
 363 #define WCMD_MD       16
 364 #define WCMD_MKDIR    17
 365 #define WCMD_MOVE     18
 366 #define WCMD_PATH     19
 367 #define WCMD_PAUSE    20
 368 #define WCMD_PROMPT   21
 369 #define WCMD_REM      22
 370 #define WCMD_REN      23
 371 #define WCMD_RENAME   24
 372 #define WCMD_RD       25
 373 #define WCMD_RMDIR    26
 374 #define WCMD_SET      27
 375 #define WCMD_SHIFT    28
 376 #define WCMD_START    29
 377 #define WCMD_TIME     30
 378 #define WCMD_TITLE    31
 379 #define WCMD_TYPE     32
 380 #define WCMD_VERIFY   33
 381 #define WCMD_VER      34
 382 #define WCMD_VOL      35
 383
 384 #define WCMD_ENDLOCAL 36
 385 #define WCMD_SETLOCAL 37
 386 #define WCMD_PUSHD    38
 387 #define WCMD_POPD     39
 388 #define WCMD_ASSOC    40
 389 #define WCMD_COLOR    41
 390 #define WCMD_FTYPE    42
 391 #define WCMD_MORE     43
 392 #define WCMD_CHOICE   44
 393 #define WCMD_MKLINK   45
 394
 395 /* Must be last in list */
 396 #define WCMD_EXIT     46
 397
 398 /* Some standard messages */
 399 extern WCHAR anykey[];
 400 extern WCHAR version_string[];
 401
 402 /* Translated messages */
 403 #define WCMD_ALLHELP          1000
 404 #define WCMD_CONFIRM          1001
 405 #define WCMD_YES              1002
 406 #define WCMD_NO               1003
 407 #define WCMD_NOASSOC          1004
 408 #define WCMD_NOFTYPE          1005
 409 #define WCMD_OVERWRITE        1006
 410 #define WCMD_MORESTR          1007
 411 #define WCMD_TRUNCATEDLINE    1008
 412 #define WCMD_NYI              1009
 413 #define WCMD_NOARG            1010
 414 #define WCMD_SYNTAXERR        1011
 415 #define WCMD_FILENOTFOUND     1012
 416 #define WCMD_NOCMDHELP        1013
 417 #define WCMD_NOTARGET         1014
 418 #define WCMD_CURRENTDATE      1015
 419 #define WCMD_CURRENTTIME      1016
 420 #define WCMD_NEWDATE          1017
 421 #define WCMD_NEWTIME          1018
 422 #define WCMD_MISSINGENV       1019
 423 #define WCMD_READFAIL         1020
 424 #define WCMD_CALLINSCRIPT     1021
 425 #define WCMD_ALL              1022
 426 #define WCMD_DELPROMPT        1023
 427 #define WCMD_ECHOPROMPT       1024
 428 #define WCMD_VERIFYPROMPT     1025
 429 #define WCMD_VERIFYERR        1026
 430 #define WCMD_ARGERR           1027
 431 #define WCMD_VOLUMESERIALNO   1028
 432 #define WCMD_VOLUMEPROMPT     1029
 433 #define WCMD_ANYKEY           1031
 434 #define WCMD_CONSTITLE        1032
 435 #define WCMD_VERSION          1033
 436 #define WCMD_MOREPROMPT       1034
 437 #define WCMD_LINETOOLONG      1035
 438 #define WCMD_VOLUMELABEL      1036
 439 #define WCMD_VOLUMENOLABEL    1037
 440 #define WCMD_YESNO            1038
 441 #define WCMD_YESNOALL         1039
 442 #define WCMD_NO_COMMAND_FOUND 1040
 443 #define WCMD_DIVIDEBYZERO     1041
 444 #define WCMD_NOOPERAND        1042
 445 #define WCMD_NOOPERATOR       1043
 446 #define WCMD_BADPAREN         1044
 447 #define WCMD_BADHEXOCT        1045
 448 #define WCMD_FILENAMETOOLONG  1046
 449 #define WCMD_BADTOKEN         1047
 450 #define WCMD_ENDOFLINE        1048
 451 #define WCMD_ENDOFFILE        1049