Page MenuHomePhabricator
Diviner libphutil Tech Docs PhutilShellLexer

final class PhutilShellLexer
libphutil Technical Documentation (Lexers)

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

Tasks

Lexer Implementation

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 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

protected function getRawRules()

PhutilLexer

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

PhutilShellLexer
This method is not documented.
Return
dictLexer 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$inputInput string.
string$initial_stateInitial lexer state.
Return
listList 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$stringShell command string.
Return
arrayParsed argument vector.
Defined
src/lexer/PhutilShellLexer.php:6
Extends
PhutilLexer
Phabricator · Built by Phacility