-
Notifications
You must be signed in to change notification settings - Fork 3
/
_state.cmd
116 lines (111 loc) · 4.35 KB
/
_state.cmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
@ECHO OFF
SETLOCAL ENABLEDELAYEDEXPANSION&::(Don't pollute the global environment with the following)
::*********************************************************************
SET $NAME=%~n0
SET $DESCRIPTION=Status part of 'Action [state]' line
SET $Author=Erik Bachmann, ClicketyClick.dk [ErikBachmann@ClicketyClick.dk]
SET $Source=%~f0
::----------------------------------------------------------------------
::@(#)NAME
::@(-) The name of the command or function, followed by a one-line description of what it does.
::@(#) %$NAME% -- %$DESCRIPTION%
::@(#)
::@(#)SYNOPSIS
::@(-) In the case of a command, a formal description of how to run it and what command line options it takes.
::@(-) For program functions, a list of the parameters the function takes and which header file contains its definition.
::@(#) %$NAME% "string"
::@(#)
::@(#)OPTIONS
::@(-) Flags, parameters, arguments (NOT the Monty Python way)
::@(#) -h Help page
::@(#)
::@ (#)
::@(#)DESCRIPTION
::@(-) A textual description of the functioning of the command or function.
::@(#) %$NAME% echos a string with the maximum length of 77 - $ActionRange to STDOUT.
::@(#) The string will by surrounded bye [ ]
::@(#) Line IS terminated by a NEWLINE!
::@(#)
::@(#) %$NAME% is usually used in combination with _action.cmd to display
::@(#) status information durring processing
::@(#)
::@(#)EXAMPLES
::@(-) Some examples of common usage.
::@(#) CALL _ACTION "Hello"
::@(#) CALL _STATE "Buddy"
::@(#) timeout /T 5 >nul
::@(#) CALL _STATUS "World"
::@(#)
::@(#)
::@(#) Will produce the line:
::@(#) Hello [Buddy ]
::@(#) and 5 sec later update the line to
::@(#) Hello [World ]
::@(#)
::@ (#)EXIT STATUS
::@(-) Exit status / errorlevel is 0 if OK, otherwise 1+.
::@(#) 0 if OK
::@(#)
::@ (#)ENVIRONMENT
::@(-) Variables affected
::@ (#)
::@ (#)
::@ (#)FILES,
::@(-) Files used, required, affected
::@ (#)
::@ (#)
::@ (#)BUGS / KNOWN PROBLEMS
::@(-) If any known
::@ (#)
::@ (#)
::@(#)REQUIRES
::@(-) Dependecies
::@(#) _Debug.cmd Setting up debug environment for batch scripts
::@(#) _GetOpt.cmd Parse command line options and create environment vars
::@(#)
::@(#)SEE ALSO
::@(-) A list of related commands or functions.
::@(#) _action.cmd
::@(#) _status.cmd
::@(#)
::@ (#)REFERENCE
::@(-) References to inspiration, clips and other documentation
::@ (#) Author:
::@ (#) URL:
::@ (#)
::@(#)
::@(#)SOURCE
::@(-) Where to find this source
::@(#) %$Source%
::@(#)
::@ (#)AUTHOR
::@(-) Who did what
::@ (#) %$AUTHOR%
::*** HISTORY **********************************************************
::SET $VERSION=YYYY-MM-DD&SET $REVISION=hh:mm:ss&SET $COMMENT=Comment/Init [00.000]
::SET $VERSION=2010-10-07&SET $REVISION=08:35:00&SET $COMMENT=Intial/ErikBachmann [00.010]
::SET $VERSION=2010-10-20&SET $REVISION=17:15:00&SET $COMMENT=Addding $Source/ErikBachmann [01.001]
::SET $VERSION=2010-12-16&SET $REVISION=15:21:00&SET $COMMENT=$StatusRange=76 - %$ActionRange% [01.002]
::SET $VERSION=2011-01-17&SET $REVISION=15:42:00&SET $COMMENT=$ActionRange=45 [01.003]
::SET $VERSION=2015-02-19&SET $REVISION=03:35:47&SET $COMMENT=Autoupdate / ErikBachmann
::SET $VERSION=2015-10-08&SET $REVISION=16:00:00&SET $COMMENT=GetOpt: Calling usage and exit on error / ErikBachmann
::SET $VERSION=2015-11-23&SET $REVISION=16:30:00&SET $COMMENT=GetOpt replaced _getopt.sub simple call. Reduces runtime to 1/3 / ErikBachmann
SET $VERSION=2016-03-14&SET $REVISION=10:00:00&SET $COMMENT=Set "%~dp0\ prefix on function calls / ErikBachmann
::**********************************************************************
::@(#)(c)%$Version:~0,4% %$Author%
::**********************************************************************
CALL "%~dp0\_DEBUG"
::CALL "%~dp0\_Getopt" %*&IF ERRORLEVEL 1 EXIT /B 1
:: Check ONLY for combinations of -h, /h, --help
CALL "%~dp0\_getopt.sub" %*&IF ERRORLEVEL 1 EXIT /B 1
::ENDLOCAL
:_Status
SET _=%~1
IF NOT DEFINED $ActionRange SET $ActionRange=45
SET /a $StatusRange=76 - %$ActionRange%
SET _=%_% !
CALL SET /P _=[%%_:~0,%$StatusRange%%% ]<nul
FOR /L %%a IN (-2,1,%$StatusRange%%) DO SET /P _=<nul
EXIT /b 0
GOTO :EOF
::*** End of File ******************************************************