2 * WCMD - Wine-compatible command line interface - built-in functions.
4 * Copyright (C) 1999 D A Pickles
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 * On entry to each function, global variables quals, param1, param2 contain
24 * the qualifiers (uppercased and concatenated) and parameters entered, with
25 * environment-variable and batch parameter substitution already done.
30 * - No support for pipes, shell parameters
31 * - Lots of functionality missing from builtins
32 * - Messages etc need international support
37 void WCMD_execute (char *orig_command, char *parameter, char *substitution);
41 struct env_stack *next;
45 struct env_stack *saved_environment;
47 extern HINSTANCE hinst;
48 extern char *inbuilt[];
49 extern int echo_mode, verify_mode;
50 extern char quals[MAX_PATH], param1[MAX_PATH], param2[MAX_PATH];
51 extern BATCH_CONTEXT *context;
52 extern DWORD errorlevel;
56 /****************************************************************************
59 * Clear the terminal screen.
62 void WCMD_clear_screen (void) {
64 /* Emulate by filling the screen from the top left to bottom right with
65 spaces, then moving the cursor to the top left afterwards */
66 CONSOLE_SCREEN_BUFFER_INFO consoleInfo;
67 HANDLE hStdOut = GetStdHandle(STD_OUTPUT_HANDLE);
69 if (GetConsoleScreenBufferInfo(hStdOut, &consoleInfo))
74 screenSize = consoleInfo.dwSize.X * (consoleInfo.dwSize.Y + 1);
78 FillConsoleOutputCharacter(hStdOut, ' ', screenSize, topLeft, &screenSize);
79 SetConsoleCursorPosition(hStdOut, topLeft);
83 /****************************************************************************
86 * Change the default i/o device (ie redirect STDin/STDout).
89 void WCMD_change_tty (void) {
95 /****************************************************************************
98 * Copy a file or wildcarded set.
99 * FIXME: No wildcard support
102 void WCMD_copy (void) {
108 static const char *overwrite = "Overwrite file (Y/N)?";
109 char string[8], outpath[MAX_PATH], inpath[MAX_PATH], *infile;
111 if ((strchr(param1,'*') != NULL) && (strchr(param1,'%') != NULL)) {
112 WCMD_output ("Wildcards not yet supported\n");
116 /* If no destination supplied, assume current directory */
117 if (param2[0] == 0x00) {
121 GetFullPathName (param2, sizeof(outpath), outpath, NULL);
122 hff = FindFirstFile (outpath, &fd);
123 if (hff != INVALID_HANDLE_VALUE) {
124 if (fd.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) {
125 GetFullPathName (param1, sizeof(inpath), inpath, &infile);
126 strcat (outpath, "\\");
127 strcat (outpath, infile);
132 force = (strstr (quals, "/Y") != NULL);
134 hff = FindFirstFile (outpath, &fd);
135 if (hff != INVALID_HANDLE_VALUE) {
137 WCMD_output (overwrite);
138 ReadFile (GetStdHandle(STD_INPUT_HANDLE), string, sizeof(string), &count, NULL);
139 if (toupper(string[0]) == 'Y') force = TRUE;
144 status = CopyFile (param1, outpath, FALSE);
145 if (!status) WCMD_print_error ();
149 /****************************************************************************
152 * Create a directory.
155 void WCMD_create_dir (void) {
157 if (!CreateDirectory (param1, NULL)) WCMD_print_error ();
160 /****************************************************************************
163 * Delete a file or wildcarded set.
167 void WCMD_delete (int recurse) {
171 char fpath[MAX_PATH];
174 hff = FindFirstFile (param1, &fd);
175 if (hff == INVALID_HANDLE_VALUE) {
176 WCMD_output ("%s :File Not Found\n",param1);
179 if ((strchr(param1,'*') == NULL) && (strchr(param1,'?') == NULL)
180 && (!recurse) && (fd.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)) {
181 strcat (param1, "\\*");
186 if ((strchr(param1,'*') != NULL) || (strchr(param1,'?') != NULL)) {
187 strcpy (fpath, param1);
189 p = strrchr (fpath, '\\');
192 strcat (fpath, fd.cFileName);
194 else strcpy (fpath, fd.cFileName);
195 if (!(fd.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)) {
196 if (!DeleteFile (fpath)) WCMD_print_error ();
198 } while (FindNextFile(hff, &fd) != 0);
202 if (!DeleteFile (param1)) WCMD_print_error ();
207 /****************************************************************************
210 * Echo input to the screen (or not). We don't try to emulate the bugs
211 * in DOS (try typing "ECHO ON AGAIN" for an example).
214 void WCMD_echo (const char *command) {
216 static const char *eon = "Echo is ON\n", *eoff = "Echo is OFF\n";
219 if ((command[0] == '.') && (command[1] == 0)) {
220 WCMD_output (newline);
225 count = strlen(command);
227 if (echo_mode) WCMD_output (eon);
228 else WCMD_output (eoff);
231 if (lstrcmpi(command, "ON") == 0) {
235 if (lstrcmpi(command, "OFF") == 0) {
239 WCMD_output_asis (command);
240 WCMD_output (newline);
244 /**************************************************************************
247 * Batch file loop processing.
248 * FIXME: We don't exhaustively check syntax. Any command which works in MessDOS
249 * will probably work here, but the reverse is not necessarily the case...
252 void WCMD_for (char *p) {
257 char set[MAX_PATH], param[MAX_PATH];
260 if (lstrcmpi (WCMD_parameter (p, 1, NULL), "in")
261 || lstrcmpi (WCMD_parameter (p, 3, NULL), "do")
262 || (param1[0] != '%')) {
263 WCMD_output ("Syntax error\n");
266 lstrcpyn (set, WCMD_parameter (p, 2, NULL), sizeof(set));
267 WCMD_parameter (p, 4, &cmd);
268 lstrcpy (param, param1);
271 * If the parameter within the set has a wildcard then search for matching files
272 * otherwise do a literal substitution.
276 while (*(item = WCMD_parameter (set, i, NULL))) {
277 if (strpbrk (item, "*?")) {
278 hff = FindFirstFile (item, &fd);
279 if (hff == INVALID_HANDLE_VALUE) {
283 WCMD_execute (cmd, param, fd.cFileName);
284 } while (FindNextFile(hff, &fd) != 0);
288 WCMD_execute (cmd, param, item);
294 /*****************************************************************************
297 * Execute a command after substituting variable text for the supplied parameter
300 void WCMD_execute (char *orig_cmd, char *param, char *subst) {
302 char *new_cmd, *p, *s, *dup;
305 size = lstrlen (orig_cmd);
306 new_cmd = (char *) LocalAlloc (LMEM_FIXED | LMEM_ZEROINIT, size);
307 dup = s = strdup (orig_cmd);
309 while ((p = strstr (s, param))) {
311 size += lstrlen (subst);
312 new_cmd = (char *) LocalReAlloc ((HANDLE)new_cmd, size, 0);
314 strcat (new_cmd, subst);
315 s = p + lstrlen (param);
318 WCMD_process_command (new_cmd);
320 LocalFree ((HANDLE)new_cmd);
324 /**************************************************************************
327 * Simple on-line help. Help text is stored in the resource file.
330 void WCMD_give_help (char *command) {
335 command = WCMD_strtrim_leading_spaces(command);
336 if (lstrlen(command) == 0) {
337 LoadString (hinst, 1000, buffer, sizeof(buffer));
338 WCMD_output_asis (buffer);
341 for (i=0; i<=WCMD_EXIT; i++) {
342 if (CompareString (LOCALE_USER_DEFAULT, NORM_IGNORECASE | SORT_STRINGSORT,
343 param1, -1, inbuilt[i], -1) == 2) {
344 LoadString (hinst, i, buffer, sizeof(buffer));
345 WCMD_output_asis (buffer);
349 WCMD_output ("No help available for %s\n", param1);
354 /****************************************************************************
357 * Batch file jump instruction. Not the most efficient algorithm ;-)
358 * Prints error message if the specified label cannot be found - the file pointer is
359 * then at EOF, effectively stopping the batch file.
360 * FIXME: DOS is supposed to allow labels with spaces - we don't.
363 void WCMD_goto (void) {
365 char string[MAX_PATH];
367 if (context != NULL) {
368 SetFilePointer (context -> h, 0, NULL, FILE_BEGIN);
369 while (WCMD_fgets (string, sizeof(string), context -> h)) {
370 if ((string[0] == ':') && (strcmp (&string[1], param1) == 0)) return;
372 WCMD_output ("Target to GOTO not found\n");
378 /****************************************************************************
381 * Batch file conditional.
382 * FIXME: Much more syntax checking needed!
385 void WCMD_if (char *p) {
387 int negate = 0, test = 0;
388 char condition[MAX_PATH], *command, *s;
390 if (!lstrcmpi (param1, "not")) {
392 lstrcpy (condition, param2);
395 lstrcpy (condition, param1);
397 if (!lstrcmpi (condition, "errorlevel")) {
398 if (errorlevel >= atoi(WCMD_parameter (p, 1+negate, NULL))) test = 1;
400 WCMD_parameter (p, 2+negate, &command);
402 else if (!lstrcmpi (condition, "exist")) {
403 if (GetFileAttributesA(WCMD_parameter (p, 1+negate, NULL)) != INVALID_FILE_ATTRIBUTES) {
406 WCMD_parameter (p, 2+negate, &command);
408 else if ((s = strstr (p, "=="))) {
410 if (!lstrcmpi (condition, WCMD_parameter (s, 0, NULL))) test = 1;
411 WCMD_parameter (s, 1, &command);
414 WCMD_output ("Syntax error\n");
417 if (test != negate) {
418 command = strdup (command);
419 WCMD_process_command (command);
424 /****************************************************************************
427 * Move a file, directory tree or wildcarded set of files.
428 * FIXME: Needs input and output files to be fully specified.
431 void WCMD_move (void) {
434 char outpath[MAX_PATH], inpath[MAX_PATH], *infile;
438 if ((strchr(param1,'*') != NULL) || (strchr(param1,'%') != NULL)) {
439 WCMD_output ("Wildcards not yet supported\n");
443 /* If no destination supplied, assume current directory */
444 if (param2[0] == 0x00) {
448 /* If 2nd parm is directory, then use original filename */
449 GetFullPathName (param2, sizeof(outpath), outpath, NULL);
450 hff = FindFirstFile (outpath, &fd);
451 if (hff != INVALID_HANDLE_VALUE) {
452 if (fd.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY) {
453 GetFullPathName (param1, sizeof(inpath), inpath, &infile);
454 strcat (outpath, "\\");
455 strcat (outpath, infile);
460 status = MoveFile (param1, outpath);
461 if (!status) WCMD_print_error ();
464 /****************************************************************************
467 * Wait for keyboard input.
470 void WCMD_pause (void) {
475 WCMD_output (anykey);
476 ReadFile (GetStdHandle(STD_INPUT_HANDLE), string, sizeof(string), &count, NULL);
479 /****************************************************************************
482 * Delete a directory.
485 void WCMD_remove_dir (void) {
487 if (!RemoveDirectory (param1)) WCMD_print_error ();
490 /****************************************************************************
494 * FIXME: Needs input and output files to be fully specified.
497 void WCMD_rename (void) {
501 if ((strchr(param1,'*') != NULL) || (strchr(param1,'%') != NULL)) {
502 WCMD_output ("Wildcards not yet supported\n");
505 status = MoveFile (param1, param2);
506 if (!status) WCMD_print_error ();
509 /*****************************************************************************
512 * Make a copy of the environment.
514 static WCHAR *WCMD_dupenv( const WCHAR *env )
524 len += (lstrlenW(&env[len]) + 1);
526 env_copy = LocalAlloc (LMEM_FIXED, (len+1) * sizeof (WCHAR) );
529 WCMD_output ("out of memory\n");
532 memcpy (env_copy, env, len*sizeof (WCHAR));
538 /*****************************************************************************
541 * setlocal pushes the environment onto a stack
542 * Save the environment as unicode so we don't screw anything up.
544 void WCMD_setlocal (const char *s) {
546 struct env_stack *env_copy;
548 /* DISABLEEXTENSIONS ignored */
550 env_copy = LocalAlloc (LMEM_FIXED, sizeof (struct env_stack));
553 WCMD_output ("out of memory\n");
557 env = GetEnvironmentStringsW ();
559 env_copy->strings = WCMD_dupenv (env);
560 if (env_copy->strings)
562 env_copy->next = saved_environment;
563 saved_environment = env_copy;
566 LocalFree (env_copy);
568 FreeEnvironmentStringsW (env);
571 /*****************************************************************************
574 static inline WCHAR *WCMD_strchrW(WCHAR *str, WCHAR ch)
585 /*****************************************************************************
588 * endlocal pops the environment off a stack
590 void WCMD_endlocal (void) {
591 WCHAR *env, *old, *p;
592 struct env_stack *temp;
595 if (!saved_environment)
598 /* pop the old environment from the stack */
599 temp = saved_environment;
600 saved_environment = temp->next;
602 /* delete the current environment, totally */
603 env = GetEnvironmentStringsW ();
604 old = WCMD_dupenv (GetEnvironmentStringsW ());
607 n = lstrlenW(&old[len]) + 1;
608 p = WCMD_strchrW(&old[len], '=');
612 SetEnvironmentVariableW (&old[len], NULL);
617 FreeEnvironmentStringsW (env);
619 /* restore old environment */
623 n = lstrlenW(&env[len]) + 1;
624 p = WCMD_strchrW(&env[len], '=');
628 SetEnvironmentVariableW (&env[len], p);
636 /*****************************************************************************
637 * WCMD_setshow_attrib
639 * Display and optionally sets DOS attributes on a file or directory
641 * FIXME: Wine currently uses the Unix stat() function to get file attributes.
642 * As a result only the Readonly flag is correctly reported, the Archive bit
643 * is always set and the rest are not implemented. We do the Right Thing anyway.
645 * FIXME: No SET functionality.
649 void WCMD_setshow_attrib (void) {
654 char flags[9] = {" "};
656 if (param1[0] == '-') {
661 if (lstrlen(param1) == 0) {
662 GetCurrentDirectory (sizeof(param1), param1);
663 strcat (param1, "\\*");
666 hff = FindFirstFile (param1, &fd);
667 if (hff == INVALID_HANDLE_VALUE) {
668 WCMD_output ("%s: File Not Found\n",param1);
672 if (!(fd.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)) {
673 if (fd.dwFileAttributes & FILE_ATTRIBUTE_HIDDEN) {
676 if (fd.dwFileAttributes & FILE_ATTRIBUTE_SYSTEM) {
679 if (fd.dwFileAttributes & FILE_ATTRIBUTE_ARCHIVE) {
682 if (fd.dwFileAttributes & FILE_ATTRIBUTE_READONLY) {
685 if (fd.dwFileAttributes & FILE_ATTRIBUTE_TEMPORARY) {
688 if (fd.dwFileAttributes & FILE_ATTRIBUTE_COMPRESSED) {
691 WCMD_output ("%s %s\n", flags, fd.cFileName);
692 for (count=0; count < 8; count++) flags[count] = ' ';
694 } while (FindNextFile(hff, &fd) != 0);
699 /*****************************************************************************
700 * WCMD_setshow_default
702 * Set/Show the current default directory
705 void WCMD_setshow_default (void) {
710 if (strlen(param1) == 0) {
711 GetCurrentDirectory (sizeof(string), string);
712 strcat (string, "\n");
713 WCMD_output (string);
716 status = SetCurrentDirectory (param1);
725 /****************************************************************************
728 * Set/Show the system date
729 * FIXME: Can't change date yet
732 void WCMD_setshow_date (void) {
734 char curdate[64], buffer[64];
737 if (lstrlen(param1) == 0) {
738 if (GetDateFormat (LOCALE_USER_DEFAULT, 0, NULL, NULL,
739 curdate, sizeof(curdate))) {
740 WCMD_output ("Current Date is %s\nEnter new date: ", curdate);
741 ReadFile (GetStdHandle(STD_INPUT_HANDLE), buffer, sizeof(buffer), &count, NULL);
746 else WCMD_print_error ();
753 /****************************************************************************
756 static int WCMD_compare( const void *a, const void *b )
759 const char * const *str_a = a, * const *str_b = b;
760 r = CompareString( LOCALE_USER_DEFAULT, NORM_IGNORECASE | SORT_STRINGSORT,
761 *str_a, -1, *str_b, -1 );
762 if( r == CSTR_LESS_THAN ) return -1;
763 if( r == CSTR_GREATER_THAN ) return 1;
767 /****************************************************************************
768 * WCMD_setshow_sortenv
770 * sort variables into order for display
772 static void WCMD_setshow_sortenv(const char *s)
774 UINT count=0, len=0, i;
777 /* count the number of strings, and the total length */
779 len += (lstrlen(&s[len]) + 1);
783 /* add the strings to an array */
784 str = LocalAlloc (LMEM_FIXED | LMEM_ZEROINIT, count * sizeof (char*) );
788 for( i=1; i<count; i++ )
789 str[i] = str[i-1] + lstrlen(str[i-1]) + 1;
792 qsort( str, count, sizeof (char*), WCMD_compare );
795 for( i=0; i<count; i++ )
796 WCMD_output("%s\n", str[i] );
801 /****************************************************************************
804 * Set/Show the environment variables
807 void WCMD_setshow_env (char *s) {
814 if (strlen(param1) == 0) {
815 env = GetEnvironmentStrings ();
816 WCMD_setshow_sortenv( env );
822 /* FIXME: Emulate Win98 for now, ie "SET C" looks ONLY for an
823 environment variable C, whereas on NT it shows ALL variables
826 status = GetEnvironmentVariable(s, buffer, sizeof(buffer));
828 WCMD_output("%s=%s\n", s, buffer);
830 WCMD_output ("Environment variable %s not defined\n", s);
836 if (strlen(p) == 0) p = 0x00;
837 status = SetEnvironmentVariable (s, p);
838 if (!status) WCMD_print_error();
840 /* WCMD_output (newline); @JED*/
843 /****************************************************************************
846 * Set/Show the path environment variable
849 void WCMD_setshow_path (char *command) {
854 if (strlen(param1) == 0) {
855 status = GetEnvironmentVariable ("PATH", string, sizeof(string));
857 WCMD_output ("PATH=%s\n", string);
860 WCMD_output ("PATH not found\n");
864 status = SetEnvironmentVariable ("PATH", command);
865 if (!status) WCMD_print_error();
869 /****************************************************************************
870 * WCMD_setshow_prompt
872 * Set or show the command prompt.
875 void WCMD_setshow_prompt (void) {
879 if (strlen(param1) == 0) {
880 SetEnvironmentVariable ("PROMPT", NULL);
884 while ((*s == '=') || (*s == ' ')) s++;
885 if (strlen(s) == 0) {
886 SetEnvironmentVariable ("PROMPT", NULL);
888 else SetEnvironmentVariable ("PROMPT", s);
892 /****************************************************************************
895 * Set/Show the system time
896 * FIXME: Can't change time yet
899 void WCMD_setshow_time (void) {
901 char curtime[64], buffer[64];
905 if (strlen(param1) == 0) {
907 if (GetTimeFormat (LOCALE_USER_DEFAULT, 0, &st, NULL,
908 curtime, sizeof(curtime))) {
909 WCMD_output ("Current Time is %s\nEnter new time: ", curtime);
910 ReadFile (GetStdHandle(STD_INPUT_HANDLE), buffer, sizeof(buffer), &count, NULL);
915 else WCMD_print_error ();
922 /****************************************************************************
925 * Shift batch parameters.
928 void WCMD_shift (void) {
930 if (context != NULL) context -> shift_count++;
934 /****************************************************************************
937 * Set the console title
939 void WCMD_title (char *command) {
940 SetConsoleTitle(command);
943 /****************************************************************************
946 * Copy a file to standard output.
949 void WCMD_type (void) {
955 h = CreateFile (param1, GENERIC_READ, FILE_SHARE_READ, NULL, OPEN_EXISTING,
956 FILE_ATTRIBUTE_NORMAL, NULL);
957 if (h == INVALID_HANDLE_VALUE) {
961 while (ReadFile (h, buffer, sizeof(buffer), &count, NULL)) {
962 if (count == 0) break; /* ReadFile reports success on EOF! */
964 WCMD_output_asis (buffer);
969 /****************************************************************************
972 * Display verify flag.
973 * FIXME: We don't actually do anything with the verify flag other than toggle
977 void WCMD_verify (char *command) {
979 static const char *von = "Verify is ON\n", *voff = "Verify is OFF\n";
982 count = strlen(command);
984 if (verify_mode) WCMD_output (von);
985 else WCMD_output (voff);
988 if (lstrcmpi(command, "ON") == 0) {
992 else if (lstrcmpi(command, "OFF") == 0) {
996 else WCMD_output ("Verify must be ON or OFF\n");
999 /****************************************************************************
1002 * Display version info.
1005 void WCMD_version (void) {
1007 WCMD_output (version_string);
1011 /****************************************************************************
1014 * Display volume info and/or set volume label. Returns 0 if error.
1017 int WCMD_volume (int mode, char *path) {
1019 DWORD count, serial;
1020 char string[MAX_PATH], label[MAX_PATH], curdir[MAX_PATH];
1023 if (lstrlen(path) == 0) {
1024 status = GetCurrentDirectory (sizeof(curdir), curdir);
1026 WCMD_print_error ();
1029 status = GetVolumeInformation (NULL, label, sizeof(label), &serial, NULL,
1033 if ((path[1] != ':') || (lstrlen(path) != 2)) {
1034 WCMD_output_asis("Syntax Error\n\n");
1037 wsprintf (curdir, "%s\\", path);
1038 status = GetVolumeInformation (curdir, label, sizeof(label), &serial, NULL,
1042 WCMD_print_error ();
1045 WCMD_output ("Volume in drive %c is %s\nVolume Serial Number is %04x-%04x\n\n",
1046 curdir[0], label, HIWORD(serial), LOWORD(serial));
1048 WCMD_output ("Volume label (11 characters, ENTER for none)?");
1049 ReadFile (GetStdHandle(STD_INPUT_HANDLE), string, sizeof(string), &count, NULL);
1051 string[count-1] = '\0'; /* ReadFile output is not null-terminated! */
1052 if (string[count-2] == '\r') string[count-2] = '\0'; /* Under Windoze we get CRLF! */
1054 if (lstrlen(path) != 0) {
1055 if (!SetVolumeLabel (curdir, string)) WCMD_print_error ();
1058 if (!SetVolumeLabel (NULL, string)) WCMD_print_error ();