Class: Build::Graph::Walker

Inherits:
Object
  • Object
show all
Defined in:
lib/build/graph/walker.rb

Overview

A walker walks over a graph and applies a task to each node.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(controller, &task) ⇒ Walker

Returns a new instance of Walker.



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
 
# File 'lib/build/graph/walker.rb', line 29

def initialize(controller, &task)
	@controller = controller
	@task = task
	
	# The number of nodes we have touched:
	@count = 0
	
	@outputs = {}
	@dirty = Set.new

	# Generate a list of dirty outputs, possibly a subset, if the build graph might generate additional nodes:
	@controller.nodes.each do |key, node|
		# For a given child, a list of any parents waiting on it.
		if node.dirty?
			@dirty << node
			
			@outputs[node] = []
			
			node.outputs.each do |output|
				@outputs[output] = []
			end
		end
	end

	@parents = {}

	# Failed output paths:
	@failed = Set.new
	
	# The number of failed nodes:
	@failures = 0
end

Instance Attribute Details

#controller ⇒ Object (readonly)

Returns the value of attribute controller.



62
63
64
 
# File 'lib/build/graph/walker.rb', line 62

def controller
  @controller
end

#count ⇒ Object

Returns the value of attribute count.



67
68
69
 
# File 'lib/build/graph/walker.rb', line 67

def count
  @count
end

#dirty ⇒ Object (readonly)

Returns the value of attribute dirty.



68
69
70
 
# File 'lib/build/graph/walker.rb', line 68

def dirty
  @dirty
end

#failed ⇒ Object (readonly)

A list of outputs which have failed to generate:



73
74
75
 
# File 'lib/build/graph/walker.rb', line 73

def failed
  @failed
end

#outputs ⇒ Object (readonly)

Returns the value of attribute outputs.



65
66
67
 
# File 'lib/build/graph/walker.rb', line 65

def outputs
  @outputs
end

#parents ⇒ Object (readonly)

Returns the value of attribute parents.



70
71
72
 
# File 'lib/build/graph/walker.rb', line 70

def parents
  @parents
end

#task(*arguments) ⇒ Object (readonly)

Returns the value of attribute task.



63
64
65
 
# File 'lib/build/graph/walker.rb', line 63

def task
  @task
end

Instance Method Details

#exit(node) ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/build/graph/walker.rb', line 117

def exit(node)
	@dirty.delete(node)

	# Fail outputs if the node failed:
	if node.failed?
		@failed += node.outputs
		@failures += 1
	end
	
	# Clean the node's outputs:
	node.outputs.each do |path|
		if edges = @outputs.delete(path)
			edges.each{|edge| edge.traverse(node)}
		end
	end
		
	# Trigger the parent nodes:
	if parents = @parents.delete(node)
		parents.each{|edge| edge.traverse(node)}
	end
end

#failed? ⇒ Boolean

Returns:

  • (Boolean) 


75
76
77
 
# File 'lib/build/graph/walker.rb', line 75

def failed?
	@failures > 0
end

#wait_for_nodes(children) ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/build/graph/walker.rb', line 102

def wait_for_nodes(children)
	edge = Edge.new

	children.each do |child|
		if @dirty.include?(child)
			edge.increment!
		
			@parents[child] ||= []
			@parents[child] << edge
		end
	end

	edge.wait
end

#wait_on_paths(paths) ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/build/graph/walker.rb', line 83

def wait_on_paths(paths)
	edge = Edge.new
	failed = false

	paths.each do |path|
		if @outputs.include? path
			@outputs[path] << edge
		
			edge.increment!
		end
	
		if !failed and @failed.include?(path)
			failed = true
		end
	end

	edge.wait || failed
end