Ninja: State Struct Reference

Ninja

Global state (file status) for a single run. More...

#include <state.h>

Public Types
typedef ExternalStringHashMap< Node * >::Type	Paths
	Mapping of path -> Node. More...

Public Member Functions
bool	AddDefault (StringPiece path, std::string *error)

Edge *	AddEdge (const Rule *rule)

void	AddIn (Edge *edge, StringPiece path, uint64_t slash_bits)
	Add input / output / validation nodes to a given edge. More...

bool	AddOut (Edge edge, StringPiece path, uint64_t slash_bits, std::string err)

void	AddPool (Pool *pool)

void	AddValidation (Edge *edge, StringPiece path, uint64_t slash_bits)

std::vector< Node * >	DefaultNodes (std::string *error) const

void	Dump ()
	Dump the nodes and Pools (useful for debugging). More...

Node *	GetNode (StringPiece path, uint64_t slash_bits)

Node *	LookupNode (StringPiece path) const

Pool *	LookupPool (const std::string &pool_name)

void	Reset ()
	Reset state. More...

std::vector< Node * >	RootNodes (std::string *error) const

Node *	SpellcheckNode (const std::string &path)

	State ()

Public Attributes
BindingEnv	bindings_

std::vector< Node * >	defaults_

std::vector< Edge * >	edges_
	All the edges of the graph. More...

Paths	paths_

std::map< std::string, Pool * >	pools_
	All the pools used in the graph. More...

Static Public Attributes
static Pool	kConsolePool

static Pool	kDefaultPool

Detailed Description

Global state (file status) for a single run.

Definition at line 95 of file state.h.

Member Typedef Documentation

◆ Paths

typedef ExternalStringHashMap<Node*>::Type State::Paths

Mapping of path -> Node.

Definition at line 131 of file state.h.

Constructor & Destructor Documentation

◆ State()

State::State ( )

Definition at line 67 of file state.cc.

References Rule::Phony().

Member Function Documentation

◆ AddDefault()

bool State::AddDefault	(	StringPiece	path,
		std::string *	error
	)

Definition at line 159 of file state.cc.

References StringPiece::AsString().

Referenced by ManifestParser::ParseDefault().

◆ AddEdge()

Edge * State::AddEdge ( const Rule * rule )

Definition at line 85 of file state.cc.

References Edge::env_, Edge::id_, kDefaultPool, Edge::pool_, and Edge::rule_.

Referenced by MissingDependencyScannerTest::CreateInitialState(), and ManifestParser::ParseEdge().

◆ AddIn()

void State::AddIn	(	Edge *	edge,
		StringPiece	path,
		uint64_t	slash_bits
	)

Add input / output / validation nodes to a given edge.

This also ensures that the generated_by_dep_loader() flag for all these nodes is set to false, to indicate that they come from the input manifest.

Definition at line 128 of file state.cc.

References Node::AddOutEdge(), Edge::inputs_, and Node::set_generated_by_dep_loader().

Referenced by MissingDependencyScannerTest::CreateGraphDependencyBetween(), and ManifestParser::ParseEdge().

◆ AddOut()

bool State::AddOut	(	Edge *	edge,
		StringPiece	path,
		uint64_t	slash_bits,
		std::string *	err
	)

Definition at line 135 of file state.cc.

References StringPiece::AsString(), Node::in_edge(), Edge::outputs_, Node::set_generated_by_dep_loader(), and Node::set_in_edge().

Referenced by MissingDependencyScannerTest::CreateInitialState(), and ManifestParser::ParseEdge().

◆ AddPool()

void State::AddPool ( Pool * pool )

Definition at line 73 of file state.cc.

References Pool::name().

Referenced by ManifestParser::ParsePool().

◆ AddValidation()

void State::AddValidation	(	Edge *	edge,
		StringPiece	path,
		uint64_t	slash_bits
	)

Definition at line 152 of file state.cc.

References Node::AddValidationOutEdge(), Node::set_generated_by_dep_loader(), and Edge::validations_.

Referenced by ManifestParser::ParseEdge().

◆ DefaultNodes()

vector< Node * > State::DefaultNodes ( std::string * error ) const

Definition at line 187 of file state.cc.

◆ Dump()

void State::Dump ( )

Dump the nodes and Pools (useful for debugging).

Definition at line 201 of file state.cc.

References Node::dirty(), Node::id(), Node::path(), and Node::status_known().

◆ GetNode()

Node * State::GetNode	(	StringPiece	path,
		uint64_t	slash_bits
	)

Definition at line 95 of file state.cc.

References StringPiece::AsString(), and Node::path().

Referenced by Builder::ExtractDeps(), DepsLog::Load(), DyndepParser::ParseEdge(), ManifestParser::ParseEdge(), and TEST_F().

◆ LookupNode()

Node * State::LookupNode ( StringPiece path ) const

Definition at line 104 of file state.cc.

Referenced by MissingDependencyScannerTest::AssertMissingDependencyBetween(), Cleaner::CleanDead(), Cleaner::CleanTarget(), Cleaner::CleanTargets(), MissingDependencyScannerTest::CreateGraphDependencyBetween(), DyndepParser::ParseEdge(), and MissingDependencyScannerTest::RecordDepsLogDep().

◆ LookupPool()

Pool * State::LookupPool ( const std::string & pool_name )

Definition at line 78 of file state.cc.

Referenced by ManifestParser::ParseEdge(), ManifestParser::ParsePool(), and TEST_F().

◆ Reset()

void State::Reset ( )

Reset state.

Keeps all nodes and edges, but restores them to the state where we haven't yet examined the disk for dirty state.

Definition at line 191 of file state.cc.

References Edge::VisitNone.

Referenced by TEST_F(), and TestPhonyUseCase().

◆ RootNodes()

vector< Node * > State::RootNodes ( std::string * error ) const

Returns: the root node(s) of the graph. (Root nodes have no output edges).

Parameters

error where to write the error message if somethings went wrong.

Definition at line 169 of file state.cc.

Referenced by MissingDependencyScannerTest::ProcessAllNodes().

◆ SpellcheckNode()

Node * State::SpellcheckNode ( const std::string & path )

Definition at line 111 of file state.cc.

References EditDistance().

Member Data Documentation

◆ bindings_

BindingEnv State::bindings_

Definition at line 140 of file state.h.

Referenced by Builder::Builder(), Cleaner::CleanRule(), Cleaner::CleanRules(), and ManifestParser::ManifestParser().

◆ defaults_

std::vector<Node*> State::defaults_

Definition at line 141 of file state.h.

◆ edges_

std::vector<Edge*> State::edges_

All the edges of the graph.

Definition at line 138 of file state.h.

Referenced by Cleaner::CleanAll(), Cleaner::DoCleanRule(), Cleaner::LoadDyndeps(), LoadManifests(), ManifestParser::ParseEdge(), TEST_F(), VerifyGraph(), and WriteTestData().

◆ kConsolePool

Pool State::kConsolePool

static

Definition at line 97 of file state.h.

Referenced by Edge::use_console().

◆ kDefaultPool

Pool State::kDefaultPool

static

Definition at line 96 of file state.h.

Referenced by AddEdge().

◆ paths_

Paths State::paths_

Definition at line 132 of file state.h.

Referenced by VerifyGraph().

◆ pools_

std::map<std::string, Pool*> State::pools_

All the pools used in the graph.

Definition at line 135 of file state.h.

The documentation for this struct was generated from the following files: