ReactOS 0.4.16-dev-334-g4d9f67c
batch.h File Reference
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  _BATCH_CONTEXT
 
struct  _FOR_CONTEXT
 

Macros

#define MSCMD_BATCH_ECHO
 
#define BATCH_BUFFSIZE   8192
 

Typedefs

typedef enum _BATCH_TYPE BATCH_TYPE
 
typedef struct _BATCH_CONTEXT BATCH_CONTEXT
 
typedef struct _BATCH_CONTEXTPBATCH_CONTEXT
 
typedef struct _FOR_CONTEXT FOR_CONTEXT
 
typedef struct _FOR_CONTEXTPFOR_CONTEXT
 

Enumerations

enum  _BATCH_TYPE { NONE , BAT_TYPE , CMD_TYPE }
 

Functions

BOOL FindArg (IN TCHAR Char, OUT PCTSTR *ArgPtr, OUT BOOL *IsParam0)
 
VOID ExitBatch (VOID)
 
VOID ExitAllBatches (VOID)
 
INT Batch (LPTSTR, LPTSTR, LPTSTR, PARSED_COMMAND *)
 
BOOL BatchGetString (LPTSTR lpBuffer, INT nBufferLength)
 
LPTSTR ReadBatchLine (VOID)
 
VOID AddBatchRedirection (REDIRECTION **)
 

Variables

BATCH_TYPE BatType
 
PBATCH_CONTEXT bc
 
PFOR_CONTEXT fc
 
BOOL bBcEcho
 
BOOL bEcho
 
TCHAR textline [BATCH_BUFFSIZE]
 

Macro Definition Documentation

◆ BATCH_BUFFSIZE

#define BATCH_BUFFSIZE   8192

Definition at line 68 of file batch.h.

◆ MSCMD_BATCH_ECHO

#define MSCMD_BATCH_ECHO

Definition at line 24 of file batch.h.

Typedef Documentation

◆ BATCH_CONTEXT

◆ BATCH_TYPE

◆ FOR_CONTEXT

◆ PBATCH_CONTEXT

◆ PFOR_CONTEXT

Enumeration Type Documentation

◆ _BATCH_TYPE

Enumerator
NONE 
BAT_TYPE 
CMD_TYPE 

Definition at line 15 of file batch.h.

16{
17 NONE,
18 BAT_TYPE, /* Old-style DOS batch file */
19 CMD_TYPE /* New-style NT OS/2 batch file */
@ BAT_TYPE
Definition: batch.h:18
@ CMD_TYPE
Definition: batch.h:19
@ NONE
Definition: batch.h:17
enum _BATCH_TYPE BATCH_TYPE

Function Documentation

◆ AddBatchRedirection()

VOID AddBatchRedirection ( REDIRECTION **  RedirList)

Definition at line 501 of file batch.c.

502{
504
505 /* Prepend the list to the batch context's list */
506 ListEnd = RedirList;
507 while (*ListEnd)
508 ListEnd = &(*ListEnd)->Next;
509 *ListEnd = bc->RedirList;
510 bc->RedirList = *RedirList;
511
512 /* Null out the pointer so that the list will not be cleared prematurely.
513 * These redirections should persist until the batch file exits. */
514 *RedirList = NULL;
515}
PBATCH_CONTEXT bc
Definition: batch.c:67
#define NULL
Definition: types.h:112
REDIRECTION * RedirList
Definition: batch.h:40
_Inout_ __drv_aliasesMem PSLIST_ENTRY _Inout_ PSLIST_ENTRY ListEnd
Definition: exfuncs.h:1224

Referenced by Batch().

◆ Batch()

INT Batch ( LPTSTR  fullname,
LPTSTR  firstword,
LPTSTR  param,
PARSED_COMMAND Cmd 
)

Definition at line 299 of file batch.c.

300{
301 INT ret = 0;
302 INT i;
303 HANDLE hFile = NULL;
304 BOOLEAN bSameFn = FALSE;
305 BOOLEAN bTopLevel;
306 BATCH_CONTEXT new;
307 PFOR_CONTEXT saved_fc;
308
309 SetLastError(0);
310 if (bc && bc->mem)
311 {
312 TCHAR fpname[MAX_PATH];
313 GetFullPathName(fullname, ARRAYSIZE(fpname), fpname, NULL);
314 if (_tcsicmp(bc->BatchFilePath, fpname) == 0)
315 bSameFn = TRUE;
316 }
317 TRACE("Batch(\'%s\', \'%s\', \'%s\') bSameFn = %d\n",
318 debugstr_aw(fullname), debugstr_aw(firstword), debugstr_aw(param), bSameFn);
319
320 if (!bSameFn)
321 {
325
327 {
329 return 1;
330 }
331 }
332
333 /*
334 * Remember whether this is a top-level batch context, i.e. if there is
335 * no batch context existing prior (bc == NULL originally), and we are
336 * going to create one below.
337 */
338 bTopLevel = !bc;
339
340 if (bc && Cmd == bc->current)
341 {
342 /* Then we are transferring to another batch */
343 if (!bSameFn)
344 ClearBatch();
345 AddBatchRedirection(&Cmd->Redirections);
346 }
347 else
348 {
349 struct _SETLOCAL *setlocal = NULL;
350
351 if (Cmd == NULL)
352 {
353 /* This is a CALL. CALL will set errorlevel to our return value, so
354 * in order to keep the value of errorlevel unchanged in the case
355 * of calling an empty batch file, we must return that same value. */
357 }
358 else if (bc)
359 {
360 /* If a batch file runs another batch file as part of a compound command
361 * (e.g. "x.bat & somethingelse") then the first file gets terminated. */
362
363 /* Get its SETLOCAL stack so it can be migrated to the new context */
364 setlocal = bc->setlocal;
365 bc->setlocal = NULL;
366 ExitBatch();
367 }
368
369 /* Create a new context. This function will not
370 * return until this context has been exited */
371 new.prev = bc;
372 /* copy some fields in the new structure if it is the same file */
373 if (bSameFn)
374 {
375 new.mem = bc->mem;
376 new.memsize = bc->memsize;
377 new.mempos = 0;
378 new.memfree = FALSE; /* don't free this, being used before this */
379 }
380 bc = &new;
381 bc->RedirList = NULL;
382 bc->setlocal = setlocal;
383 }
384
386
387 /* If a new batch file, load it into memory and close the file */
388 if (!bSameFn)
389 {
392 }
393
394 bc->mempos = 0; /* Go to the beginning of the batch file */
395#ifndef MSCMD_BATCH_ECHO
396 bc->bEcho = bEcho; /* Preserve echo across batch calls */
397#endif
398 for (i = 0; i < 10; i++)
399 bc->shiftlevel[i] = i;
400
401 /* Parse the batch parameters */
402 if (!BatchParams(firstword, param, &bc->raw_params, &bc->params))
403 return 1;
404
405 /* If we are calling from inside a FOR, hide the FOR variables */
406 saved_fc = fc;
407 fc = NULL;
408
409 /* Perform top-level batch initialization */
410 if (bTopLevel)
411 {
412 /* Default the top-level batch context type
413 * to .BAT, unless this is a .CMD file */
414 PTCHAR dotext = _tcsrchr(bc->BatchFilePath, _T('.'));
415 BatType = (dotext && (!_tcsicmp(dotext, _T(".cmd")))) ? CMD_TYPE : BAT_TYPE;
416
417#ifdef MSCMD_BATCH_ECHO
418 bBcEcho = bEcho;
419#endif
420 }
421
422 /* If this is a "CALL :label args ...", call a subroutine of
423 * the current batch file, only if extensions are enabled. */
424 if (bEnableExtensions && (*firstword == _T(':')))
425 {
426 LPTSTR expLabel;
427
428 /* Position at the place of the parent file (which is the same as the caller) */
429 bc->mempos = (bc->prev ? bc->prev->mempos : 0);
430
431 /*
432 * Jump to the label. Strip the label's colon; as a side-effect
433 * this will forbid "CALL :EOF"; however "CALL ::EOF" will work!
434 */
435 bc->current = Cmd;
436 ++firstword;
437
438 /* Expand the label only! (simulate a GOTO command as in Windows' CMD) */
439 expLabel = DoDelayedExpansion(firstword);
440 ret = cmd_goto(expLabel ? expLabel : firstword);
441 if (expLabel)
442 cmd_free(expLabel);
443 }
444
445 /* If we have created a new context, don't return
446 * until this batch file has completed. */
447 while (bc == &new && !bExit)
448 {
450 if (!Cmd)
451 {
452 if (!bParseError)
453 continue;
454
455 /* Echo the pre-parsed batch file line on error */
456 if (bEcho && !bDisableBatchEcho)
457 {
458 if (!bIgnoreEcho)
459 ConOutChar(_T('\n'));
460 PrintPrompt();
462 ConOutChar(_T('\n'));
463 }
464 /* Stop all execution */
466 ret = 1;
467 break;
468 }
469
470 /* JPP 19980807 */
471 /* Echo the command and execute it */
472 bc->current = Cmd;
475 }
476 if (bExit)
477 {
478 /* Stop all execution */
480 }
481
482 /* Perform top-level batch cleanup */
483 if (!bc || bTopLevel)
484 {
485 /* Reset the top-level batch context type */
486 BatType = NONE;
487
488#ifdef MSCMD_BATCH_ECHO
489 bEcho = bBcEcho;
490#endif
491 }
492
493 /* Restore the FOR variables */
494 fc = saved_fc;
495
496 /* Always return the last command's return code */
497 TRACE("Batch: returns %d\n", ret);
498 return ret;
499}
unsigned char BOOLEAN
VOID AddBatchRedirection(REDIRECTION **RedirList)
Definition: batch.c:501
static void BatchFile2Mem(HANDLE hBatchFile)
Definition: batch.c:270
BOOL bBcEcho
Definition: batch.c:70
BATCH_TYPE BatType
Definition: batch.c:66
VOID ExitBatch(VOID)
Definition: batch.c:222
BOOL bEcho
Definition: batch.c:73
static VOID ClearBatch(VOID)
Definition: batch.c:198
static BOOL BatchParams(IN PCTSTR Arg0, IN PCTSTR Args, OUT PTSTR *RawParams, OUT PTSTR *ParamList)
Definition: batch.c:119
VOID ExitAllBatches(VOID)
Definition: batch.c:261
INT nErrorLevel
Definition: cmd.c:158
BOOL bDisableBatchEcho
Definition: cmd.c:160
BOOL bExit
Definition: cmd.c:152
INT ExecuteCommandWithEcho(IN PARSED_COMMAND *Cmd)
Definition: cmd.c:868
PTSTR DoDelayedExpansion(IN PCTSTR Line)
Definition: cmd.c:1640
BOOL bIgnoreEcho
Definition: cmd.c:155
PARSED_COMMAND * ParseCommand(IN PCTSTR Line)
Definition: parser.c:1461
BOOL bParseError
Definition: parser.c:90
VOID PrintPrompt(VOID)
Definition: prompt.c:134
TCHAR ParseLine[CMDLINE_LENGTH]
Definition: parser.c:92
INT cmd_goto(LPTSTR)
Definition: goto.c:36
VOID FreeCommand(IN OUT PARSED_COMMAND *Cmd)
Definition: parser.c:527
#define ConErrResPuts(uID)
Definition: console.h:38
#define ConOutPuts(szStr)
Definition: console.h:29
#define debugstr_aw
Definition: precomp.h:44
#define STRING_BATCH_ERROR
Definition: resource.h:30
PFOR_CONTEXT fc
Definition: for.c:57
#define cmd_free(ptr)
Definition: cmddbg.h:31
#define TRUE
Definition: types.h:120
#define FALSE
Definition: types.h:117
#define ARRAYSIZE(array)
Definition: filtermapper.c:47
#define CloseHandle
Definition: compat.h:739
#define OPEN_EXISTING
Definition: compat.h:775
#define SetLastError(x)
Definition: compat.h:752
#define INVALID_HANDLE_VALUE
Definition: compat.h:731
#define GENERIC_READ
Definition: compat.h:135
#define MAX_PATH
Definition: compat.h:34
#define FILE_ATTRIBUTE_NORMAL
Definition: compat.h:137
#define FILE_SHARE_READ
Definition: compat.h:136
GLfloat param
Definition: glext.h:5796
GLsizei GLenum const GLvoid GLsizei GLenum GLbyte GLbyte GLbyte GLdouble GLdouble GLdouble GLfloat GLfloat GLfloat GLint GLint GLint GLshort GLshort GLshort GLubyte GLubyte GLubyte GLuint GLuint GLuint GLushort GLushort GLushort GLbyte GLbyte GLbyte GLbyte GLdouble GLdouble GLdouble GLdouble GLfloat GLfloat GLfloat GLfloat GLint GLint GLint GLint GLshort GLshort GLshort GLshort GLubyte GLubyte GLubyte GLubyte GLuint GLuint GLuint GLuint GLushort GLushort GLushort GLushort GLboolean const GLdouble const GLfloat const GLint const GLshort const GLbyte const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLdouble const GLfloat const GLfloat const GLint const GLint const GLshort const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort const GLdouble const GLfloat const GLint const GLshort GLenum GLenum GLenum GLfloat GLenum GLint GLenum GLenum GLenum GLfloat GLenum GLenum GLint GLenum GLfloat GLenum GLint GLint GLushort GLenum GLenum GLfloat GLenum GLenum GLint GLfloat const GLubyte GLenum GLenum GLenum const GLfloat GLenum GLenum const GLint GLenum GLint GLint GLsizei GLsizei GLint GLenum GLenum const GLvoid GLenum GLenum const GLfloat GLenum GLenum const GLint GLenum GLenum const GLdouble GLenum GLenum const GLfloat GLenum GLenum const GLint GLsizei GLuint GLfloat GLuint GLbitfield GLfloat GLint GLuint GLboolean GLenum GLfloat GLenum GLbitfield GLenum GLfloat GLfloat GLint GLint const GLfloat GLenum GLfloat GLfloat GLint GLint GLfloat GLfloat GLint GLint const GLfloat GLint GLfloat GLfloat GLint GLfloat GLfloat GLint GLfloat GLfloat const GLdouble const GLfloat const GLdouble const GLfloat GLint i
Definition: glfuncs.h:248
if(dx< 0)
Definition: linetemp.h:194
#define _tcsrchr
Definition: utility.h:116
#define FILE_FLAG_SEQUENTIAL_SCAN
Definition: disk.h:43
const char * fullname
Definition: shader.c:1766
BOOL bEnableExtensions
Definition: more.c:53
_In_ HANDLE hFile
Definition: mswsock.h:90
#define FILE_SHARE_WRITE
Definition: nt_native.h:681
#define FILE_SHARE_DELETE
Definition: nt_native.h:682
char * PTCHAR
Definition: ntbasedef.h:484
#define NONE
Definition: ntddpar.h:94
VOID ConOutChar(TCHAR c)
Definition: util.c:233
@ Cmd
Definition: sacdrv.h:278
#define TRACE(s)
Definition: solgame.cpp:4
DWORD memsize
Definition: batch.h:30
char * mem
Definition: batch.h:29
struct _BATCH_CONTEXT * prev
Definition: batch.h:28
struct _SETLOCAL * setlocal
Definition: batch.h:42
LPTSTR params
Definition: batch.h:34
TCHAR BatchFilePath[MAX_PATH]
Definition: batch.h:33
LPTSTR raw_params
Definition: batch.h:35
INT shiftlevel[10]
Definition: batch.h:36
PARSED_COMMAND * current
Definition: batch.h:41
DWORD mempos
Definition: batch.h:31
int32_t INT
Definition: typedefs.h:58
#define _T(x)
Definition: vfdio.h:22
int ret
#define CreateFile
Definition: winbase.h:3774
#define GetFullPathName
Definition: winbase.h:3846
char TCHAR
Definition: xmlstorage.h:189
CHAR * LPTSTR
Definition: xmlstorage.h:192
#define _tcsicmp
Definition: xmlstorage.h:205

◆ BatchGetString()

BOOL BatchGetString ( LPTSTR  lpBuffer,
INT  nBufferLength 
)

Definition at line 521 of file batch.c.

522{
523 INT len = 0;
524
525 /* read all chars from memory until a '\n' is encountered */
526 if (bc->mem)
527 {
528 for (; ((bc->mempos + len) < bc->memsize && len < (nBufferLength-1)); len++)
529 {
530#ifndef _UNICODE
531 lpBuffer[len] = bc->mem[bc->mempos + len];
532#endif
533 if (bc->mem[bc->mempos + len] == '\n')
534 {
535 len++;
536 break;
537 }
538 }
539#ifdef _UNICODE
541 lpBuffer[nBufferLength] = L'\0';
542 lpBuffer[len] = '\0';
543#endif
544 bc->mempos += len;
545 }
546
547 return len != 0;
548}
UINT OutputCodePage
Definition: console.c:26
static TAGREF LPCWSTR LPDWORD LPVOID lpBuffer
Definition: db.cpp:175
#define MultiByteToWideChar
Definition: compat.h:110
GLenum GLsizei len
Definition: glext.h:6722
#define L(x)
Definition: ntvdm.h:50
_In_ LPCSTR _In_opt_ LPCSTR _In_ DWORD nBufferLength
Definition: winbase.h:3098

Referenced by cmd_goto(), and ReadBatchLine().

◆ ExitAllBatches()

VOID ExitAllBatches ( VOID  )

Definition at line 261 of file batch.c.

262{
263 while (bc)
264 ExitBatch();
265}

Referenced by Batch(), and ReadBatchLine().

◆ ExitBatch()

VOID ExitBatch ( VOID  )

Definition at line 222 of file batch.c.

223{
224 ClearBatch();
225
226 TRACE("ExitBatch\n");
227
230
231#ifndef MSCMD_BATCH_ECHO
232 /* Preserve echo state across batch calls */
233 bEcho = bc->bEcho;
234#endif
235
236 while (bc->setlocal)
237 cmd_endlocal(_T(""));
238
239 bc = bc->prev;
240
241#if 0
242 /* Do not process any more parts of a compound command */
243 bc->current = NULL;
244#endif
245
246 /* If there is no more batch contexts, notify the signal handler */
247 if (!bc)
248 {
250 BatType = NONE;
251
252#ifdef MSCMD_BATCH_ECHO
253 bEcho = bBcEcho;
254#endif
255 }
256}
BOOL CheckCtrlBreak(INT)
Definition: misc.c:146
INT cmd_endlocal(LPTSTR)
Definition: setlocal.c:110
#define BREAK_OUTOFBATCH
Definition: cmd.h:35
VOID FreeRedirection(REDIRECTION *)
Definition: redir.c:153
VOID UndoRedirection(REDIRECTION *, REDIRECTION *End)
Definition: redir.c:142

Referenced by Batch(), cmd_goto(), ExitAllBatches(), and ReadBatchLine().

◆ FindArg()

BOOL FindArg ( IN TCHAR  Char,
OUT PCTSTR ArgPtr,
OUT BOOL IsParam0 
)

Definition at line 84 of file batch.c.

88{
89 PCTSTR pp;
90 INT n = Char - _T('0');
91
92 TRACE("FindArg: (%d)\n", n);
93
94 *ArgPtr = NULL;
95
96 if (n < 0 || n > 9)
97 return FALSE;
98
99 n = bc->shiftlevel[n];
100 *IsParam0 = (n == 0);
101 pp = bc->params;
102
103 /* Step up the strings till we reach
104 * the end or the one we want. */
105 while (*pp && n--)
106 pp += _tcslen(pp) + 1;
107
108 *ArgPtr = pp;
109 return TRUE;
110}
GLdouble n
Definition: glext.h:7729
LPCSTR PCTSTR
Definition: ntbasedef.h:496
#define _tcslen
Definition: xmlstorage.h:198

Referenced by GetBatchVar().

◆ ReadBatchLine()

LPTSTR ReadBatchLine ( VOID  )

Definition at line 558 of file batch.c.

559{
560 TRACE("ReadBatchLine()\n");
561
562 /* User halt */
564 {
566 return NULL;
567 }
568
570 {
571 TRACE("ReadBatchLine(): Reached EOF!\n");
572 /* End of file */
573 ExitBatch();
574 return NULL;
575 }
576
577 TRACE("ReadBatchLine(): textline: \'%s\'\n", debugstr_aw(textline));
578
579#if 1
580 //
581 // FIXME: This is redundant, but keep it for the moment until we correctly
582 // hande the end-of-file situation here, in ReadLine() and in the parser.
583 // (In an EOF, the previous BatchGetString() call will return FALSE but
584 // we want not to run the ExitBatch() at first, but wait later to do it.)
585 //
586 if (textline[_tcslen(textline) - 1] != _T('\n'))
587 _tcscat(textline, _T("\n"));
588#endif
589
590 return textline;
591}
TCHAR textline[BATCH_BUFFSIZE]
Definition: batch.c:76
BOOL BatchGetString(LPTSTR lpBuffer, INT nBufferLength)
Definition: batch.c:521
#define BREAK_BATCHFILE
Definition: cmd.h:34
#define _tcscat
Definition: tchar.h:622

Referenced by ReadLine().

Variable Documentation

◆ BatType

BATCH_TYPE BatType
extern

Definition at line 66 of file batch.c.

Referenced by Batch(), cmd_path(), cmd_prompt(), cmd_set(), CommandAssoc(), and ExitBatch().

◆ bBcEcho

BOOL bBcEcho
extern

Definition at line 70 of file batch.c.

Referenced by Batch(), and ExitBatch().

◆ bc

◆ bEcho

BOOL bEcho
extern

Definition at line 73 of file batch.c.

Referenced by Batch(), CommandEcho(), ExecuteCommandWithEcho(), ExitBatch(), ReadFromConsole(), and ReadLine().

◆ fc

◆ textline

TCHAR textline[BATCH_BUFFSIZE]
extern

Definition at line 76 of file batch.c.

Referenced by cmd_goto(), and ReadBatchLine().