ArcanistBaseXHPASTLinter.php
No OneTemporary
Actions

Size

6 KB

Referenced Files

None

Subscribers

None

ArcanistBaseXHPASTLinter.php
View Options

	<?php

	/**
	* @task sharing Sharing Parse Trees
	*/
	abstract class ArcanistBaseXHPASTLinter extends ArcanistFutureLinter {

	private $futures = array();
	private $trees = array();
	private $exceptions = array();
	private $refcount = array();

	final public function getCacheVersion() {
	$parts = array();

	$parts[] = $this->getVersion();

	$version = PhutilXHPASTBinary::getVersion();
	if ($version) {
	$parts[] = $version;
	}

	return implode('-', $parts);
	}

	final public function raiseLintAtToken(
	XHPASTToken $token,
	$code,
	$desc,
	$replace = null) {
	return $this->raiseLintAtOffset(
	$token->getOffset(),
	$code,
	$desc,
	$token->getValue(),
	$replace);
	}

	final public function raiseLintAtNode(
	XHPASTNode $node,
	$code,
	$desc,
	$replace = null) {
	return $this->raiseLintAtOffset(
	$node->getOffset(),
	$code,
	$desc,
	$node->getConcreteString(),
	$replace);
	}

	final protected function buildFutures(array $paths) {
	return $this->getXHPASTLinter()->buildSharedFutures($paths);
	}

	protected function didResolveLinterFutures(array $futures) {
	$this->getXHPASTLinter()->releaseSharedFutures(array_keys($futures));
	}


	/* -( Sharing Parse Trees )------------------------------------------------ */

	/**
	* Get the linter object which is responsible for building parse trees.
	*
	* When the engine specifies that several XHPAST linters should execute,
	* we designate one of them as the one which will actually build parse trees.
	* The other linters share trees, so they don't have to recompute them.
	*
	* Roughly, the first linter to execute elects itself as the builder.
	* Subsequent linters request builds and retrieve results from it.
	*
	* @return ArcanistBaseXHPASTLinter Responsible linter.
	* @task sharing
	*/
	final protected function getXHPASTLinter() {
	$resource_key = 'xhpast.linter';

	// If we're the first linter to run, share ourselves. Otherwise, grab the
	// previously shared linter.

	$engine = $this->getEngine();
	$linter = $engine->getLinterResource($resource_key);
	if (!$linter) {
	$linter = $this;
	$engine->setLinterResource($resource_key, $linter);
	}

	$base_class = __CLASS__;
	if (!($linter instanceof $base_class)) {
	throw new Exception(
	pht(
	'Expected resource "%s" to be an instance of "%s"!',
	$resource_key,
	$base_class));
	}

	return $linter;
	}

	/**
	* Build futures on this linter, for use and to share with other linters.
	*
	* @param list<string> $paths Paths to build futures for.
	* @return list<ExecFuture> Futures.
	* @task sharing
	*/
	final protected function buildSharedFutures(array $paths) {
	foreach ($paths as $path) {
	if (!isset($this->futures[$path])) {
	$this->futures[$path] = PhutilXHPASTBinary::getParserFuture(
	$this->getData($path));
	$this->refcount[$path] = 1;
	} else {
	$this->refcount[$path]++;
	}
	}
	return array_select_keys($this->futures, $paths);
	}


	/**
	* Release futures on this linter which are no longer in use elsewhere.
	*
	* @param list<string> $paths Paths to release futures for.
	* @return void
	* @task sharing
	*/
	final protected function releaseSharedFutures(array $paths) {
	foreach ($paths as $path) {
	if (empty($this->refcount[$path])) {
	throw new Exception(
	pht(
	'Imbalanced calls to shared futures: each call to '.
	'%s for a path must be paired with a call to %s.',
	'buildSharedFutures()',
	'releaseSharedFutures()'));
	}

	$this->refcount[$path]--;

	if (!$this->refcount[$path]) {
	unset($this->refcount[$path]);
	unset($this->futures[$path]);
	unset($this->trees[$path]);
	unset($this->exceptions[$path]);
	}
	}
	}


	/**
	* Get a path's tree from the responsible linter.
	*
	* @param string $path Path to retrieve tree for.
	* @return XHPASTTree\|null Tree, or null if unparseable.
	* @task sharing
	*/
	final protected function getXHPASTTreeForPath($path) {
	// If we aren't the linter responsible for actually building the parse
	// trees, go get the tree from that linter.
	if ($this->getXHPASTLinter() !== $this) {
	return $this->getXHPASTLinter()->getXHPASTTreeForPath($path);
	}

	if (!array_key_exists($path, $this->trees)) {
	if (!array_key_exists($path, $this->futures)) {
	return;
	}

	$this->trees[$path] = null;

	try {
	$this->trees[$path] = XHPASTTree::newFromDataAndResolvedExecFuture(
	$this->getData($path),
	$this->futures[$path]->resolve());
	$root = $this->trees[$path]->getRootNode();
	$root->buildSelectCache();
	$root->buildTokenCache();
	} catch (Exception $ex) {
	$this->exceptions[$path] = $ex;
	}
	}

	return $this->trees[$path];
	}

	/**
	* Get a path's parse exception from the responsible linter.
	*
	* @param string $path Path to retrieve exception for.
	* @return Exception\|null Parse exception, if available.
	* @task sharing
	*/
	final protected function getXHPASTExceptionForPath($path) {
	if ($this->getXHPASTLinter() !== $this) {
	return $this->getXHPASTLinter()->getXHPASTExceptionForPath($path);
	}

	return idx($this->exceptions, $path);
	}


	/* -( Deprecated )--------------------------------------------------------- */

	/**
	* Retrieve all calls to some specified function(s).
	*
	* Returns all descendant nodes which represent a function call to one of the
	* specified functions.
	*
	* @param XHPASTNode $root Root node.
	* @param list<string> $function_names Function names.
	* @return AASTNodeList
	*/
	protected function getFunctionCalls(XHPASTNode $root, array $function_names) {
	$calls = $root->selectDescendantsOfType('n_FUNCTION_CALL');
	$nodes = array();

	foreach ($calls as $call) {
	$node = $call->getChildByIndex(0);
	$name = strtolower($node->getConcreteString());

	if (in_array($name, $function_names)) {
	$nodes[] = $call;
	}
	}

	return AASTNodeList::newFromTreeAndNodes($root->getTree(), $nodes);
	}

	public function getSuperGlobalNames() {
	return array(
	'$GLOBALS',
	'$_SERVER',
	'$_GET',
	'$_POST',
	'$_FILES',
	'$_COOKIE',
	'$_SESSION',
	'$_REQUEST',
	'$_ENV',
	);
	}

	}

File Metadata

Mime Type: text/x-php
Expires: Jan 19 2025, 23:35 (6 w, 6 d ago)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1115874
Default Alt Text: ArcanistBaseXHPASTLinter.php (6 KB)

ArcanistBaseXHPASTLinter.phpNo OneTemporaryActions

ArcanistBaseXHPASTLinter.phpView Options

File Metadata

Event Timeline

ArcanistBaseXHPASTLinter.php
No OneTemporary
Actions

ArcanistBaseXHPASTLinter.php
View Options