Diviner Arcanist Tech Docs PhutilShellLexer

final class PhutilShellLexer
Arcanist Technical Documentation ()

Lexer for shell-like argument strings. Somewhat similar to Python's shlex.

Tasks

Lexer Implementation

protected function getRawRules()

Lexer Rules

protected function getRules() — Process, normalize, and validate the raw lexer rules.

Lexer Tokens

public function getTokens($input, $initial_state) — Lex an input string into tokens.

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.
public function mergeTokens($tokens) — Merge adjacent tokens of the same type. For example, if a comment is tokenized as <"//", "comment">, this method will merge the two tokens into a single combined token.
public function getLexerState()
public function splitArguments($string) — Convert a shell command string into an argument vector. For example, this converts a string like:

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.

protected function getRawRules()

PhutilLexer

Return a set of rules for this lexer. See description in PhutilLexer.

PhutilShellLexer

This method is not documented.

Return

dict	Lexer rules.

protected function getRules()
Inherited

PhutilLexer

Process, normalize, and validate the raw lexer rules.

Return

wild

public function getTokens($input, $initial_state)
Inherited

PhutilLexer

Lex an input string into tokens.

Parameters

string	$input	Input string.
string	$initial_state	Initial lexer state.

Return

list	List of lexer tokens.

public function mergeTokens($tokens)
Inherited

PhutilLexer

Merge adjacent tokens of the same type. For example, if a comment is tokenized as <"//", "comment">, this method will merge the two tokens into a single combined token.

Parameters

array

$tokens

Return

wild

public function getLexerState()
Inherited

This method is not documented.

Return

wild

public function splitArguments($string)

Convert a shell command string into an argument vector. For example, this converts a string like:

a 'b c' "d"'"'"e" f\ g "\""

...into this argument vector:

array(
  "a",
  "b c",
  "d\"e",
  "f g",
  "\"",
);

Parameters

string

$string

Shell command string.

Return

array

Parsed argument vector.

Defined: src/lexer/PhutilShellLexer.php:6
Extends: PhobjectPhutilLexer

final class PhutilShellLexerArcanist Technical Documentation ()

Tasks

Lexer Implementation

Lexer Rules

Lexer Tokens

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

protected function getRawRules()

protected function getRules()Inherited

public function getTokens($input, $initial_state)Inherited

public function mergeTokens($tokens)Inherited

public function getLexerState()Inherited

public function splitArguments($string)

final class PhutilShellLexer
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

protected function getRules()
Inherited

public function getTokens($input, $initial_state)
Inherited

public function mergeTokens($tokens)
Inherited

public function getLexerState()
Inherited