/*

	Title: Command Functions

		A wrapper set of functions for commands which have an output variable.









	License: http://www.autohotkey.net/~Titan/license.txt

*/



Functions() {

	Return, true

}



IfBetween(ByRef var, LowerBound, UpperBound) {

	If var between %LowerBound% and %UpperBound%

		Return, true

}

IfNotBetween(ByRef var, LowerBound, UpperBound) {

	If var not between %LowerBound% and %UpperBound%

		Return, true

}

IfIn(ByRef var, MatchList) {

	If var in %MatchList%

		Return, true

}

IfNotIn(ByRef var, MatchList) {

	If var not in %MatchList%

		Return, true

}

IfContains(ByRef var, MatchList) {

	If var contains %MatchList%

		Return, true

}

IfNotContains(ByRef var, MatchList) {

	If var not contains %MatchList%

		Return, true

}

IfIs(ByRef var, type) {

	If var is %type%

		Return, true

}

IfIsNot(ByRef var, type) {

	If var is not %type%

		Return, true

}



ControlGet(Cmd, Value = "", Control = "", WinTitle = "", WinText = "", ExcludeTitle = "", ExcludeText = "") {

	ControlGet, v, %Cmd%, %Value%, %Control%, %WinTitle%, %WinText%, %ExcludeTitle%, %ExcludeText%

	Return, v

}

ControlGetFocus(WinTitle = "", WinText = "", ExcludeTitle = "", ExcludeText = "") {

	ControlGetFocus, v, %WinTitle%, %WinText%, %ExcludeTitle%, %ExcludeText%

	Return, v

}

ControlGetText(Control = "", WinTitle = "", WinText = "", ExcludeTitle = "", ExcludeText = "") {

	ControlGetText, v, %Control%, %WinTitle%, %WinText%, %ExcludeTitle%, %ExcludeText%

	Return, v

}

DriveGet(Cmd, Value = "") {

	DriveGet, v, %Cmd%, %Value%

	Return, v

}

DriveSpaceFree(Path) {

	DriveSpaceFree, v, %Path%

	Return, v

}

EnvGet(EnvVarName) {

	EnvGet, v, %EnvVarName%

	Return, v

}

FileGetAttrib(Filename = "") {

	FileGetAttrib, v, %Filename%

	Return, v

}

FileGetShortcut(LinkFile, ByRef OutTarget = "", ByRef OutDir = "", ByRef OutArgs = "", ByRef OutDescription = "", ByRef OutIcon = "", ByRef OutIconNum = "", ByRef OutRunState = "") {

	FileGetShortcut, %LinkFile%, OutTarget, OutDir, OutArgs, OutDescription, OutIcon, OutIconNum, OutRunState

}

FileGetSize(Filename = "", Units = "") {

	FileGetSize, v, %Filename%, %Units%

	Return, v

}

FileGetTime(Filename = "", WhichTime = "") {

	FileGetTime, v, %Filename%, %WhichTime%

	Return, v

}

FileGetVersion(Filename = "") {

	FileGetVersion, v, %Filename%

	Return, v

}

FileRead(Filename) {

	FileRead, v, %Filename%

	Return, v

}

FileReadLine(Filename, LineNum) {

	FileReadLine, v, %Filename%, %LineNum%

	Return, v

}

FileSelectFile(Options = "", RootDir = "", Prompt = "", Filter = "") {

	FileSelectFile, v, %Options%, %RootDir%, %Prompt%, %Filter%

	Return, v

}

FileSelectFolder(StartingFolder = "", Options = "", Prompt = "") {

	FileSelectFolder, v, %StartingFolder%, %Options%, %Prompt%

	Return, v

}

FormatTime(YYYYMMDDHH24MISS = "", Format = "") {

	FormatTime, v, %YYYYMMDDHH24MISS%, %Format%

	Return, v

}

GuiControlGet(Subcommand = "", ControlID = "", Param4 = "") {

	GuiControlGet, v, %Subcommand%, %ControlID%, %Param4%

	Return, v

}

ImageSearch(ByRef OutputVarX, ByRef OutputVarY, X1, Y1, X2, Y2, ImageFile) {

	ImageSearch, OutputVarX, OutputVarY, %X1%, %Y1%, %X2%, %Y2%, %ImageFile%

}

IniRead(Filename, Section, Key, Default = "") {

	IniRead, v, %Filename%, %Section%, %Key%, %Default%

	Return, v

}

IniWrite(Value, Filename, Section, Key)

{

	IniWrite, %Value%, %Filename%, %Section%, %Key%

}

/*

Input(Options = "", EndKeys = "", MatchList = "") {

	Input, v, %Options%, %EndKeys%, %MatchList%

	Return, v

}

*/

InputBox(Title = "", Prompt = "", HIDE = "", Width = "", Height = "", X = "", Y = "", Font = "", Timeout = "", Default = "") {

	InputBox, v, %Title%, %Prompt%, %HIDE%, %Width%, %Height%, %X%, %Y%, , %Timeout%, %Default%

	Return, v

}

MouseGetPos(ByRef OutputVarX = "", ByRef OutputVarY = "", ByRef OutputVarWin = "", ByRef OutputVarControl = "", Mode = "") {

	MouseGetPos, OutputVarX, OutputVarY, OutputVarWin, OutputVarControl, %Mode%

}

PixelGetColor(X, Y, RGB = "") {

	PixelGetColor, v, %X%, %Y%, %RGB%

	Return, v

}

PixelSearch(ByRef OutputVarX, ByRef OutputVarY, X1, Y1, X2, Y2, ColorID, Variation = "", Mode = "") {

	PixelSearch, OutputVarX, OutputVarY, %X1%, %Y1%, %X2%, %Y2%, %ColorID%, %Variation%, %Mode%

}

Random(Min = "", Max = "") {

	Random, v, %Min%, %Max%

	Return, v

}

RegRead(RootKey, SubKey, ValueName = "") {

	RegRead, v, %RootKey%, %SubKey%, %ValueName%

	Return, v

}

RunWait(Target, WorkingDir = "", Mode = "") {

	RunWait, %Target%, %WorkingDir%, %Mode%, v

	Return v

}

SoundGet(ComponentType = "", ControlType = "", DeviceNumber = "") {

	SoundGet, v, %ComponentType%, %ControlType%, %DeviceNumber%

	Return, v

}

SoundGetWaveVolume(DeviceNumber = "") {

	SoundGetWaveVolume, v, %DeviceNumber%

	Return, v

}

StatusBarGetText(Part = "", WinTitle = "", WinText = "", ExcludeTitle = "", ExcludeText = "") {

	StatusBarGetText, v, %Part%, %WinTitle%, %WinText%, %ExcludeTitle%, %ExcludeText%

	Return, v

}

SplitPath(ByRef InputVar, ByRef OutFileName = "", ByRef OutDir = "", ByRef OutExtension = "", ByRef OutNameNoExt = "", ByRef OutDrive = "") {

	SplitPath, InputVar, OutFileName, OutDir, OutExtension, OutNameNoExt, OutDrive

}

StringGetPos(ByRef InputVar, SearchText, Mode = "", Offset = "") {

	StringGetPos, v, InputVar, %SearchText%, %Mode%, %Offset%

	Return, v

}

StringLeft(ByRef InputVar, Count) {

	StringLeft, v, InputVar, %Count%

	Return, v

}

StringLen(ByRef InputVar) {

	StringLen, v, InputVar

	Return, v

}

StringLower(ByRef InputVar, T = "") {

	StringLower, v, InputVar, %T%

	Return, v

}

StringMid(ByRef InputVar, StartChar, Count , L = "") {

	StringMid, v, InputVar, %StartChar%, %Count%, %L%

	Return, v

}

StringReplace(InputVar, SearchText, ReplaceText = "", All = "") {

	StringReplace, v, InputVar, %SearchText%, %ReplaceText%, %All%

	Return, v

}

StringRight(ByRef InputVar, Count) {

	StringRight, v, InputVar, %Count%

	Return, v

}

StringTrimLeft(ByRef InputVar, Count) {

	StringTrimLeft, v, InputVar, %Count%

	Return, v

}

StringTrimRight(ByRef InputVar, Count) {

	StringTrimRight, v, InputVar, %Count%

	Return, v

}

StringUpper(ByRef InputVar, T = "") {

	StringUpper, v, InputVar, %T%

	Return, v

}

SysGet(Subcommand, Param3 = "") {

	SysGet, v, %Subcommand%, %Param3%

	Return, v

}

Transform(Cmd, Value1, Value2 = "") {

	Transform, v, %Cmd%, %Value1%, %Value2%

	Return, v

}

WinGet(Cmd = "", WinTitle = "", WinText = "", ExcludeTitle = "", ExcludeText = "") {

	WinGet, v, %Cmd%, %WinTitle%, %WinText%, %ExcludeTitle%, %ExcludeText%

	Return, v

}

WinGetActiveTitle() {

	WinGetActiveTitle, v

	Return, v

}

WinGetClass(WinTitle = "", WinText = "", ExcludeTitle = "", ExcludeText = "") {

	WinGetClass, v, %WinTitle%, %WinText%, %ExcludeTitle%, %ExcludeText%

	Return, v

}

WinGetText(WinTitle = "", WinText = "", ExcludeTitle = "", ExcludeText = "") {

	WinGetText, v, %WinTitle%, %WinText%, %ExcludeTitle%, %ExcludeText%

	Return, v

}

WinGetTitle(WinTitle = "", WinText = "", ExcludeTitle = "", ExcludeText = "") {

	WinGetTitle, v, %WinTitle%, %WinText%, %ExcludeTitle%, %ExcludeText%

	Return, v

}

WinMaximize(WinTitle = "", WinText = "", ExcludeTitle = "", ExcludeText = "") {

	WinGet, style, style, %WinTitle%, %WinText%, %ExcludeTitle%, %ExcludeText%

	if(style & 0x10000)

		WinMaximize, %WinTitle%, %WinText%, %ExcludeTitle%, %ExcludeText%

}

WinMinimize(WinTitle = "", WinText = "", ExcludeTitle = "", ExcludeText = "") {

	WinGet, style, style, %WinTitle%, %WinText%, %ExcludeTitle%, %ExcludeText%

	outputdebug % "style " style " minimize " style & 0x20000

	if(style & 0x20000)

		WinMinimize, %WinTitle%, %WinText%, %ExcludeTitle%, %ExcludeText%

}

;System modal messagebox (Options can't be considered due to msgbox parsing

MsgBox2(Title, Text, Timeout="")

{	

	if(title = "")

		title := "7plus"

	Msgbox, 0x1000, %Title%, %Text%, %Timeout%

}

MsgBox(Text)

{

	MsgBox, %Text%

}