Class: Recls::FileSearch

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/recls/recls.rb,
lib/recls/file_search.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(search_root, patterns, options = {}) ⇒ FileSearch

Initialises a FileSearch instance, which acts as an Enumerable of Recls::Entry

Signature

  • Parameters:

    • search_root

      (String, Recls::Entry) The root directory of

    the search. May be +nil+, in which case the current directory
is assumed
    • patterns

      (String, Array) The pattern(s) for which to

    search. May be +nil+, in which case +Recls::WILDCARDS_ALL+ is
assumed
    • options

      (Hash, Integer) Combination of flags (with

    behaviour as described below for the +flags+ option), or an
options hash

  • Options:

    • flags

      (Integer) Combination of flags - FILES,

    DIRECTORIES, RECURSIVE, etc. If the value modulo TYPEMASK is 0,
then FILES is assumed

Return

An instance of the class



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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/recls/file_search.rb', line 73

def initialize(search_root, patterns, options={})

	# for backwards compatibility, we allow for options to
	# be a number

	flags	=	0

	case options
	when ::NilClass

		options	=	{ flags: 0 }
	when ::Integer

		flags	=	options
		options	=	{ flags: flags }
	when ::Hash

		flags	=	options[:flags] || 0
	else

		raise ArgumentError, "options parameter must a #{::Hash}, nil, or an integer specifying flags - an instance of #{options.class} given"
	end


	if not search_root

		search_root = '.'
	else

		search_root = search_root.to_s
	end
	search_root = '.' if search_root.empty?
	search_root = File.expand_path(search_root) if '~' == search_root[0]

	case	patterns
	when	NilClass

		patterns = []
	when	String

		patterns = patterns.split(/[|#{Recls::Ximpl::OS::PATH_SEPARATOR}]/)
	when	Array
	else

		patterns = patterns.to_a
	end

	patterns = [ Recls::WILDCARDS_ALL ] if patterns.empty?

	if(0 == (Recls::TYPEMASK & flags))

		flags |= Recls::FILES
	end

	# now de-dup the patterns, to avoid duplicates in search
	patterns		=	patterns.flatten
	patterns		=	patterns.uniq

	@search_root	=	search_root
	@patterns		=	patterns
	@flags			=	flags
end

Instance Attribute Details

#flags ⇒ Object (readonly)

Returns the value of attribute flags.



138
139
140
 
# File 'lib/recls/file_search.rb', line 138

def flags
  @flags
end

#patterns ⇒ Object (readonly) Also known as: pattern

Returns the value of attribute patterns.



137
138
139
 
# File 'lib/recls/file_search.rb', line 137

def patterns
  @patterns
end

#search_root ⇒ Object (readonly) Also known as: searchRoot

Returns the value of attribute search_root.



136
137
138
 
# File 'lib/recls/file_search.rb', line 136

def search_root
  @search_root
end

Instance Method Details

#each(&blk) ⇒ Object 



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/recls/file_search.rb', line 140

def each(&blk)

	search_root = @search_root
	search_root = Recls::Ximpl::absolute_path search_root

	search_root = search_root.gsub(/\\/, '/') if Recls::Ximpl::OS::OS_IS_WINDOWS

	# set the (type part of the) flags to zero if we want
	# everything, to facilitate later optimisation

	flags = @flags

	if(Recls::Ximpl::OS::OS_IS_WINDOWS)

		mask = (Recls::FILES | Recls::DIRECTORIES)
	else

		mask = (Recls::FILES | Recls::DIRECTORIES | Recls::LINKS | Recls::DEVICES)
	end

	if(mask == (mask & flags))

		flags = flags & ~Recls::TYPEMASK
	end

	patterns = @patterns

	patterns = patterns.map do |pattern|

		pattern = pattern.gsub(/\./, '\\.')
		pattern = pattern.gsub(/\?/, '.')
		pattern = pattern.gsub(/\*/, '.*')
		pattern
	end

	search_dir	=	search_root
	search_root	=	Recls::Ximpl::Util.append_trailing_slash search_root

	FileSearch::search_directory_(search_root, search_dir, patterns, flags, &blk)
end