Ninja
Public Member Functions | Static Public Member Functions | List of all members
Status Struct Referenceabstract

Abstract interface to object that tracks the status of a build: completion fraction, printing updates. More...

#include <status.h>

Inheritance diagram for Status:
Inheritance graph
[legend]

Public Member Functions

virtual void BuildEdgeFinished (Edge *edge, int64_t start_time_millis, int64_t end_time_millis, ExitStatus exit_code, const std::string &output)=0
 
virtual void BuildEdgeStarted (const Edge *edge, int64_t start_time_millis)=0
 
virtual void BuildFinished ()=0
 
virtual void BuildStarted ()=0
 
virtual void EdgeAddedToPlan (const Edge *edge)=0
 
virtual void EdgeRemovedFromPlan (const Edge *edge)=0
 
virtual void Error (const char *msg,...)=0
 
virtual void Info (const char *msg,...)=0
 
virtual void SetExplanations (Explanations *)=0
 Set the Explanations instance to use to report explanations, argument can be nullptr if no explanations need to be printed (which is the default). More...
 
virtual void Warning (const char *msg,...)=0
 
virtual ~Status ()
 

Static Public Member Functions

static Statusfactory (const BuildConfig &)
 creates the actual implementation More...
 

Detailed Description

Abstract interface to object that tracks the status of a build: completion fraction, printing updates.

Definition at line 27 of file status.h.

Constructor & Destructor Documentation

◆ ~Status()

virtual Status::~Status ( )
inlinevirtual

Definition at line 47 of file status.h.

Member Function Documentation

◆ BuildEdgeFinished()

virtual void Status::BuildEdgeFinished ( Edge edge,
int64_t  start_time_millis,
int64_t  end_time_millis,
ExitStatus  exit_code,
const std::string &  output 
)
pure virtual

Implemented in StatusPrinter.

Referenced by Builder::FinishCommand().

◆ BuildEdgeStarted()

virtual void Status::BuildEdgeStarted ( const Edge edge,
int64_t  start_time_millis 
)
pure virtual

Implemented in StatusPrinter.

Referenced by Builder::StartEdge().

◆ BuildFinished()

virtual void Status::BuildFinished ( )
pure virtual

Implemented in StatusPrinter.

Referenced by Builder::Build().

◆ BuildStarted()

virtual void Status::BuildStarted ( )
pure virtual

Implemented in StatusPrinter.

Referenced by Builder::Build().

◆ EdgeAddedToPlan()

virtual void Status::EdgeAddedToPlan ( const Edge edge)
pure virtual

Implemented in StatusPrinter.

Referenced by Plan::EdgeWanted().

◆ EdgeRemovedFromPlan()

virtual void Status::EdgeRemovedFromPlan ( const Edge edge)
pure virtual

Implemented in StatusPrinter.

Referenced by Plan::CleanNode().

◆ Error()

virtual void Status::Error ( const char *  msg,
  ... 
)
pure virtual

Implemented in StatusPrinter.

Referenced by Builder::Cleanup().

◆ factory()

Status * Status::factory ( const BuildConfig config)
static

creates the actual implementation

Definition at line 40 of file status_printer.cc.

◆ Info()

virtual void Status::Info ( const char *  msg,
  ... 
)
pure virtual

Implemented in StatusPrinter.

◆ SetExplanations()

virtual void Status::SetExplanations ( Explanations )
pure virtual

Set the Explanations instance to use to report explanations, argument can be nullptr if no explanations need to be printed (which is the default).

Implemented in StatusPrinter.

Referenced by Builder::Builder(), and Builder::~Builder().

◆ Warning()

virtual void Status::Warning ( const char *  msg,
  ... 
)
pure virtual

Implemented in StatusPrinter.


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