Page MenuHomeWickedGov Phorge
Files F1431910

SourceRange.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

SourceRange.php
View Options

<?php
declare( strict_types = 1 );
namespace Wikimedia\Parsoid\Tokens;
use Wikimedia\Assert\Assert;
use Wikimedia\JsonCodec\JsonCodecable;
use Wikimedia\JsonCodec\JsonCodecableTrait;
use Wikimedia\Parsoid\Utils\PHPUtils;
/**
* Represents a source offset range.
*/
class SourceRange implements JsonCodecable {
use JsonCodecableTrait;
/**
* Offset of the first character (range start is inclusive).
* @var ?int
*/
public $start;
/**
* Offset just past the last character (range end is exclusive).
* @var ?int
*/
public $end;
/**
* Create a new source offset range.
* @param ?int $start The starting index (UTF-8 byte count, inclusive)
* @param ?int $end The ending index (UTF-8 byte count, exclusive)
*/
public function __construct( ?int $start, ?int $end ) {
$this->start = $start;
$this->end = $end;
}
/**
* Return a KVSourceRange where this SourceRange is the key,
* and the value has zero length.
* @return KVSourceRange
*/
public function expandTsrK(): KVSourceRange {
return new KVSourceRange(
$this->start, $this->end, $this->end, $this->end
);
}
/**
* Return a KVSourceRange where this SourceRange is the value,
* and the key has zero length.
* @return KVSourceRange
*/
public function expandTsrV(): KVSourceRange {
return new KVSourceRange(
$this->start, $this->start, $this->start, $this->end
);
}
/**
* Return a KVSourceRange by using this SourceRange for the key
* and the given SourceRange parameter for the value.
* @param SourceRange $value
* @return KVSourceRange
*/
public function join( SourceRange $value ): KVSourceRange {
return new KVSourceRange(
$this->start, $this->end, $value->start, $value->end
);
}
/**
* Return the substring of the given string corresponding to this
* range.
* @param string $str The source text string
* @return string
*/
public function substr( string $str ): string {
$start = $this->start;
$length = $this->length();
Assert::invariant( ( $start ?? -1 ) >= 0, "Bad SourceRange start" );
// @phan-suppress-next-line PhanCoalescingNeverNull
Assert::invariant( ( $length ?? -1 ) >= 0, "Bad SourceRange length" );
return PHPUtils::safeSubstr( $str, $start, $length );
}
/**
* Return a new source range shifted by $amount.
* @param int $amount The amount to shift by
* @return SourceRange
*/
public function offset( int $amount ): SourceRange {
return new SourceRange( $this->start + $amount, $this->end + $amount );
}
/**
* Return a range from the end of this range to the start of the given
* range.
* @param SourceRange $sr
* @return SourceRange
*/
public function to( SourceRange $sr ): SourceRange {
return new SourceRange( $this->end, $sr->start );
}
/**
* Return the length of this source range.
* @return int
*/
public function length(): int {
return $this->end - $this->start;
}
/**
* Create a new source offset range from an array of
* integers (such as created during JSON serialization).
* @param int[] $sr
* @return SourceRange
* @deprecated
*/
public static function fromArray( array $sr ): SourceRange {
// Dynamic dispatch (DomSourceRange subclasses this)
return static::newFromJsonArray( $sr );
}
/** @inheritDoc */
public function toJsonArray(): array {
return [ $this->start, $this->end ];
}
/** @inheritDoc */
public static function newFromJsonArray( array $json ): SourceRange {
Assert::invariant(
count( $json ) === 2,
'Wrong # of elements in SourceRange array'
);
return new SourceRange( $json[0], $json[1] );
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 21:12 (1 d, 13 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
eb/de/a0f0d06397874cada73e1a0483f1
Default Alt Text
SourceRange.php (3 KB)

Event Timeline