Diviner Arcanist Tech Docs ArcanistMercurialParser

final class ArcanistMercurialParser
Arcanist Technical Documentation ()

Parses output from various "hg" commands into structured data. This class provides low-level APIs for reading "hg" output.

Tasks

Parsing "hg" Output

public static function parseMercurialStatusDetails($stdout) — Parse the output of "hg status". This provides detailed information, you can get less detailed information with @{method:parseMercurialStatus}. In particular, this will parse copy sources as per "hg status -C".
public static function parseMercurialStatus($stdout) — Parse the output of "hg status". This provides only basic information, you can get more detailed information by invoking @{method:parseMercurialStatusDetails}.
public static function parseMercurialLog($stdout) — Parse the output of "hg log". This also parses "hg outgoing", "hg parents", and other similar commands. This assumes "--style default".
public static function parseMercurialBranches($stdout) — Parse the output of "hg branches".

Other Methods

public function __get($name)
public function __set($name, $value)
public function current()
public function key()
public function next()
public function rewind()
public function valid()
private function throwOnAttemptedIteration()
public function getPhobjectClassConstant($key, $byte_limit) — Read the value of a class constant.

Methods

public function __get($name)
Inherited

This method is not documented.

Parameters

$name

Return

wild

public function __set($name, $value)
Inherited

This method is not documented.

Parameters

	$name
	$value

Return

wild

public function current()
Inherited

This method is not documented.

Return

wild

public function key()
Inherited

This method is not documented.

Return

wild

public function next()
Inherited

This method is not documented.

Return

wild

public function rewind()
Inherited

This method is not documented.

Return

wild

public function valid()
Inherited

This method is not documented.

Return

wild

private function throwOnAttemptedIteration()
Inherited

This method is not documented.

Return

wild

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

Phobject

Read the value of a class constant.

This is the same as just typing self::CONSTANTNAME, but throws a more useful message if the constant is not defined and allows the constant to be limited to a maximum length.

Parameters

string	$key	Name of the constant.
int\|null	$byte_limit	Maximum number of bytes permitted in the value.

Return

string

Value of the constant.

public static function parseMercurialStatusDetails($stdout)

Parse the output of "hg status". This provides detailed information, you can get less detailed information with parseMercurialStatus(). In particular, this will parse copy sources as per "hg status -C".

Parameters

string

$stdout

The stdout from running an "hg status" command.

Return

dict	Map of paths to status dictionaries.

public static function parseMercurialStatus($stdout)

Parse the output of "hg status". This provides only basic information, you can get more detailed information by invoking parseMercurialStatusDetails().

Parameters

string

$stdout

The stdout from running an "hg status" command.

Return

dict	Map of paths to ArcanistRepositoryAPI status flags.

public static function parseMercurialLog($stdout)

Parse the output of "hg log". This also parses "hg outgoing", "hg parents", and other similar commands. This assumes "--style default".

Parameters

string

$stdout

The stdout from running an "hg log" command.

Return

list	List of dictionaries with commit information.

public static function parseMercurialBranches($stdout)

Parse the output of "hg branches".

Parameters

string

$stdout

The stdout from running an "hg branches" command.

Return

list	A list of dictionaries with branch information.

Defined: src/repository/parser/ArcanistMercurialParser.php:9
Extends: Phobject

final class ArcanistMercurialParserArcanist Technical Documentation ()

Tasks

Parsing "hg" Output

Other Methods

Methods

public function __get($name)Inherited

public function __set($name, $value)Inherited

public function current()Inherited

public function key()Inherited

public function next()Inherited

public function rewind()Inherited

public function valid()Inherited

private function throwOnAttemptedIteration()Inherited

public function getPhobjectClassConstant($key, $byte_limit)Inherited

public static function parseMercurialStatusDetails($stdout)

public static function parseMercurialStatus($stdout)

public static function parseMercurialLog($stdout)

public static function parseMercurialBranches($stdout)

final class ArcanistMercurialParser
Arcanist Technical Documentation ()

public function __get($name)
Inherited

public function __set($name, $value)
Inherited

public function current()
Inherited

public function key()
Inherited

public function next()
Inherited

public function rewind()
Inherited

public function valid()
Inherited

private function throwOnAttemptedIteration()
Inherited

public function getPhobjectClassConstant($key, $byte_limit)
Inherited