Search for a File or Directory (Alternative) - Revision history

ConversionBot: Adding new author and category links.

2005-06-24T13:47:25Z

Adding new author and category links.

â† Older revision		Revision as of 13:47, 24 June 2005
Line 1:		Line 1:
	{~~\|align=right~~		{{PageAuthor\|deguix}}
	~~\|<small>Author: [[~~{~~{ns:2}}:deguix~~\|deguix~~]] ([[{{ns:3}}:deguix\|talk]], [[{{ns:-1}~~}~~:Contributions/deguix\|contrib]])</small>~~
	\|}
	~~<br style="clear:both;">~~
	== Description ==		== Description ==

Line 288:		Line 286:
	</highlight-nsis>		</highlight-nsis>

	[[~~{{ns:14}}~~:Disk, Path & File Functions]]		[[Category:Disk, Path & File Functions]]

ConversionBot: Added category links.

2005-04-30T21:28:30Z

Added category links.

â† Older revision		Revision as of 21:28, 30 April 2005
Line 287:		Line 287:
	FunctionEnd		FunctionEnd
	</highlight-nsis>		</highlight-nsis>

			[[{{ns:14}}:Disk, Path & File Functions]]

ConversionBot: Updated author links.

2005-04-30T03:03:19Z

Updated author links.

@@ Line 1: / Line 1: @@
 == Description ==
@@ Line 283: / Line 287: @@
 FunctionEnd
 </highlight-nsis>

Deguix: FA: "Page author" line.

2005-04-29T20:36:25Z

FA: "Page author" line.

â† Older revision		Revision as of 20:36, 29 April 2005
Line 1:		Line 1:
	== Description ==		== Description ==

	This function searches for a file or folder into a folder of your choice. It has options like:		This function searches for a file or folder into a folder of your choice. It has options like:
	*"Include subfolders in search" (to search for files or folders inside subfolders);		*"Include subfolders in search" (to search for files or folders inside subfolders);
Line 8:		Line 9:

	== Function Call Syntax ==		== Function Call Syntax ==

	<highlight-nsis>		<highlight-nsis>
	Push "(filename.ext\|foldername)" ;File or folder to search. Wildcards are supported.		Push "(filename.ext\|foldername)" ;File or folder to search. Wildcards are supported.
Line 20:		Line 22:

	== How to Use Callback Function ==		== How to Use Callback Function ==

	*You have to push "Stop" to stop, or anything to continue the search, if you don't push, will occur the stack corruption.		*You have to push "Stop" to stop, or anything to continue the search, if you don't push, will occur the stack corruption.
	*Do not push values on the stack without poping them later unless it's the return value.		*Do not push values on the stack without poping them later unless it's the return value.
Line 33:		Line 36:

	== Function Code ==		== Function Code ==
	<highlight-nsis>;----------------------------------------------------------------------------
			<highlight-nsis>
			;----------------------------------------------------------------------------
	; Title : Search file or directory (alternative)		; Title : Search file or directory (alternative)
	; Short Name : SearchFile		; Short Name : SearchFile
Line 276:		Line 281:
	Pop $R0		Pop $R0

	FunctionEnd</highlight-nsis>		FunctionEnd
			</highlight-nsis>

			Page author: [[User:deguix\|deguix]]

Deguix: Created page.

2005-04-09T13:51:15Z

Created page.

New page

== Description ==
This function searches for a file or folder into a folder of your choice. It has options like:
*"Include subfolders in search" (to search for files or folders inside subfolders);
*"Enter folders with "."" (If disabled: search gets 1.7x faster. Else it remains as Windows');
*"Custom callback function" (function called when a file or folder is found).

Based on contributions by [[user:Afrow UK|Afrow UK]], [[user:Sunjammer|Sunjammer]] and [[user:Kichik|Kichik]].

== Function Call Syntax ==
<highlight-nsis>
Push "(filename.ext|foldername)" ;File or folder to search. Wildcards are supported.
Push "Path" ;Path where to search for the file or folder.
Push $0
GetFunctionAddress $0 "CallbackFunction" ;Custom callback function name
Exch $0
Push "(0|1)" ;Include subfolders in search. (0 = false, 1 = true)
Push "(0|1)" ;Enter subfolders with ".". This only works if "Include subfolders in search" is set to 1 (true). (0 = false, 1 = true)
Call SearchFile
</highlight-nsis>

== How to Use Callback Function ==
*You have to push "Stop" to stop, or anything to continue the search, if you don't push, will occur the stack corruption.
*Do not push values on the stack without poping them later unless it's the return value.
*You can use any variables, but the $R0 - $R7 have function results that can be used or changed:
**$R0 ;Directory being searched at that time.
**$R1 ;File or folder to search (same as 1st push).
**$R2 ;Reserved.
**$R3 ;File or folder found without path.
**$R4 ;File or folder found with path (same as $R0/$R3).
**$R5 ;Function address provided by "GetFunctionAddress".
**$R6 ;"Include subfolders in search" option.
**$R7 ;"Enter subfolders with "."" option.

== Function Code ==
<highlight-nsis>;----------------------------------------------------------------------------
; Title : Search file or directory (alternative)
; Short Name : SearchFile
; Last Changed : 22/Feb/2005
; Code Type : Function
; Code Sub-Type : One-way Input, Callback Dependant
;----------------------------------------------------------------------------
; Description : Searches for a file or folder into a folder of your
; choice.
;----------------------------------------------------------------------------
; Function Call : Push "(filename.ext|foldername)"
; File or folder to search. Wildcards are supported.
;
; Push "Path"
; Path where to search for the file or folder.
;
; Push $0
;
; GetFunctionAddress $0 "CallbackFunction"
; Custom callback function name where the search is
; returned to.
;
; Exch $0
;
; Push "(1|0)"
; Include subfolders in search. (0= false, 1= true)
;
; Push "(1|0)"
; Enter subfolders with ".". This only works if
; "Include subfolders in search" is set to 1 (true).
; (0= false, 1= true)
;
; Call SearchFile
;----------------------------------------------------------------------------
; Callback Variables: $R0 ;Directory being searched at that time.
; $R1 ;File or folder to search (same as 1st push).
; $R2 ;Reserved.
; $R3 ;File or folder found without path.
; $R4 ;File or folder found with path (same as $R0/$R3).
; $R5 ;Function address provided by "GetFunctionAddress".
; $R6 ;"Include subfolders in search" option.
; $R7 ;"Enter subfolders with "."" option.
;----------------------------------------------------------------------------
; Author : Diego Pedroso
; Author Reg. Name : deguix
;----------------------------------------------------------------------------

Function SearchFile

Exch 4
Exch
Exch 3
Exch $R0 ; directory in which to search
Exch 4
Exch
Exch $R1 ; file or folder name to search in
Exch 3
Exch 2
Exch $R2
Exch 2
Exch $R3
Exch
Push $R4
Exch
Push $R5
Exch
Push $R6
Exch
Exch $R7 ;search folders with "."

StrCpy $R5 $R2 ;$R5 = custom function name
StrCpy $R6 $R3 ;$R6 = include subfolders

StrCpy $R2 ""
StrCpy $R3 ""

# Remove \ from end (if any) from the file name or folder name to search
StrCpy $R2 $R1 1 -1
StrCmp $R2 \ 0 +2
StrCpy $R1 $R1 -1

# Detect if the search path have backslash to add the backslash
StrCpy $R2 $R0 1 -1
StrCmp $R2 \ +2
StrCpy $R0 "$R0\"

# File (or Folder) Search
##############

# Get first file or folder name

FindFirst $R2 $R3 "$R0$R1"

FindNextFile:

# This loop, search for files or folders with the same conditions.

StrCmp $R3 "" NoFiles
StrCpy $R4 "$R0$R3"

# Preparing variables for the Callback function

Push $R7
Push $R6
Push $R5
Push $R4
Push $R3
Push $R2
Push $R1
Push $R0

# Call the Callback function

Call $R5

# Returning variables

Push $R8
Exch
Pop $R8

Exch
Pop $R0
Exch
Pop $R1
Exch
Pop $R2
Exch
Pop $R3
Exch
Pop $R4
Exch
Pop $R5
Exch
Pop $R6
Exch
Pop $R7

StrCmp $R8 "Stop" 0 +3
Pop $R8
Goto Done

Pop $R8

# Detect if have another file

FindNext $R2 $R3
Goto FindNextFile ;and loop!

# If don't have any more files or folders with the condictions

NoFiles:

FindClose $R2

# Search in Subfolders
#############

# If you don't want to search in subfolders...

StrCmp $R6 0 NoSubfolders 0

# SEARCH FOLDERS WITH DOT

# Find the first folder with dot

StrCmp $R7 1 0 EndWithDot

FindFirst $R2 $R3 "$R0*.*"
StrCmp $R3 "" NoSubfolders
StrCmp $R3 "." FindNextSubfolderWithDot 0
StrCmp $R3 ".." FindNextSubfolderWithDot 0
IfFileExists "$R0$R3\*.*" RecallingOfFunction 0

# Now, detect the next folder with dot

FindNextSubfolderWithDot:

FindNext $R2 $R3
StrCmp $R3 "" NoSubfolders
StrCmp $R3 "." FindNextSubfolder 0
StrCmp $R3 ".." FindNextSubfolder 0
IfFileExists "$R0$R3\*.*" RecallingOfFunction FindNextSubfolderWithDot

EndWithDot:

# SEARCH FOLDERS WITHOUT DOT

# Skip ., and .. (C:\ don't have .., so have to detect if is :\)

FindFirst $R2 $R3 "$R0*."

Push $R6

StrCpy $R6 $R0 "" 1
StrCmp $R6 ":\" +2

FindNext $R2 $R3

Pop $R6

# Now detect the "really" subfolders, and loop

FindNextSubfolder:

FindNext $R2 $R3
StrCmp $R3 "" NoSubfolders
IfFileExists "$R0$R3\" FindNextSubfolder

# Now Recall the function (making a LOOP)!

RecallingOfFunction:

Push $R1
Push "$R0$R3\"
Push "$R5"
Push "$R6"
Push "$R7"
Call SearchFile

# Now, find the next Subfolder

Goto FindNextSubfolder

# If don't exist more subfolders...

NoSubfolders:

FindClose $R2

# Returning Values to User

Done:

Pop $R7
Pop $R6
Pop $R5
Pop $R4
Pop $R3
Pop $R2
Pop $R1
Pop $R0

FunctionEnd</highlight-nsis>