Home · Overviews · Reference · Classes

RuleEngine Class Reference

    #include <RuleEngine>

• List of all members, including inherited members

Public Types

• enum Result { Succeeded, Failed, NothingToDo }
• enum StringFlags { None, Evaluatable, NoEcho, Hidden, ..., EchoIfNeeded }

Public Functions

• Result createFile ( Project * project, const QString & filename )
• Result execute ( Project * project, const QString & r = QString() )

Static Public Members

• StringFlags flags ( const QString & input, QString & output )

Detailed Description

Member Type Documentation

enum RuleEngine::Result

enum RuleEngine::StringFlags

Member Function Documentation

Result RuleEngine::createFile ( Project * project, const QString & filename )

Create filename for project.

Result RuleEngine::execute ( Project * project, const QString & r = QString() )

Execute rule r in project project.

For each rule, the following occurs:

• Run each prereq *once*, updating the list of prereqs each time (rules can create new prereqs)
• Run the commands if:
  • Any inputFiles are newer than any of the outputFiles
  • There are no outputFiles
  • An inputFile is missing, but can be created by another rule (rescan *new* inputFiles and prereqs)
  • Any (non-hidden) prerequisite was run (not just tested)
  • -forceRule was passed
• Fail the rule if:
  • An input File is missing, and cannot be created by another rule
  • A (non-optional) prerequisite is missing

StringFlags RuleEngine::flags ( const QString & input, QString & output )   [static]

Returns the flags for input. Return the corrected string in output.