Page MenuHomeWickedGov Phorge
Files F1429287

DomSourceRange.php
No OneTemporary
Actions

Size
7 KB
Referenced Files
None
Subscribers
None

DomSourceRange.php
View Options

<?php
declare( strict_types = 1 );
namespace Wikimedia\Parsoid\Core;
use Wikimedia\Assert\Assert;
use Wikimedia\Parsoid\Tokens\SourceRange;
use Wikimedia\Parsoid\Utils\PHPUtils;
/**
* Represents a DOM source range. That is, for a given DOM tree, gives
* the source offset range in the original wikitext for this DOM tree,
* as well as the opening and closing tag widths if appropriate.
*/
class DomSourceRange extends SourceRange {
/**
* Opening tag width.
* @var ?int
*/
public $openWidth;
/**
* Closing tag width.
* @var ?int
*/
public $closeWidth;
/**
* Width of trimmed whitespace between opening tag & first child.
* Defaults to zero since for most nodes, there is no ws trimming.
* -1 indicates that this information is invalid and should not be used.
* @var int
*/
public $leadingWS = 0;
/**
* Width of trimmed whitespace between last child & closing tag.
* Defaults to zero since for most nodes, there is no ws trimming.
* -1 indicates that this information is invalid and should not be used.
* @var int
*/
public $trailingWS = 0;
/**
* Create a new DOM source offset range (DSR).
* @param ?int $start The starting index (UTF-8 byte count, inclusive)
* @param ?int $end The ending index (UTF-8 byte count, exclusive)
* @param ?int $openWidth The width of the open container tag
* @param ?int $closeWidth The width of the close container tag
* @param int $leadingWS The width of WS chars between opening tag & first child
* @param int $trailingWS The width of WS chars between last child & closing tag
*/
public function __construct(
?int $start, ?int $end, ?int $openWidth, ?int $closeWidth,
int $leadingWS = 0,
int $trailingWS = 0
) {
parent::__construct( $start, $end );
$this->openWidth = $openWidth;
$this->closeWidth = $closeWidth;
$this->leadingWS = $leadingWS;
$this->trailingWS = $trailingWS;
}
/**
* Return the substring of the given string corresponding to the
* inner portion of this range (that is, not including the opening
* and closing tag widths).
* @param string $str The source text string
* @return string
*/
public function innerSubstr( string $str ): string {
return PHPUtils::safeSubstr( $str, $this->innerStart(), $this->innerLength() );
}
/**
* Return the "inner start", that is, the start offset plus the open width.
* @return int
*/
public function innerStart(): int {
return $this->start + ( $this->openWidth ?? 0 );
}
/**
* Return the "inner end", that is, the end offset minus the close width.
* @return int
*/
public function innerEnd(): int {
return $this->end - ( $this->closeWidth ?? 0 );
}
/**
* Return the length of this source range, excluding the open and close
* tag widths.
* @return int
*/
public function innerLength(): int {
return $this->innerEnd() - $this->innerStart();
}
/**
* Return the substring of the given string corresponding to the
* open portion of this range.
* @param string $str The source text string
* @return string
*/
public function openSubstr( string $str ): string {
return PHPUtils::safeSubstr( $str, $this->start, $this->openWidth );
}
/**
* Return the substring of the given string corresponding to the
* close portion of this range.
* @param string $str The source text string
* @return string
*/
public function closeSubstr( string $str ): string {
return PHPUtils::safeSubstr( $str, $this->innerEnd(), $this->closeWidth );
}
/**
* Return the source range corresponding to the open portion of this range.
* @return SourceRange
*/
public function openRange(): SourceRange {
return new SourceRange( $this->start, $this->innerStart() );
}
/**
* Return the source range corresponding to the close portion of this range.
* @return SourceRange
*/
public function closeRange(): SourceRange {
return new SourceRange( $this->innerEnd(), $this->end );
}
/**
* Return the source range corresponding to the inner portion of this range.
* @return SourceRange
*/
public function innerRange(): SourceRange {
return new SourceRange( $this->innerStart(), $this->innerEnd() );
}
/**
* Strip the tag open and close from the beginning and end of the
* provided string. This is similar to `DomSourceRange::innerSubstr()`
* but we assume that the string before `$this->start` and after
* `$this->end` has already been removed. (That is, that the input
* is `$this->substr( $originalWikitextSource )`.)
*
* @param string $src The source text string from `$this->start`
* (inclusive) to `$this->end` (exclusive).
* @return string
*/
public function stripTags( string $src ): string {
Assert::invariant(
strlen( $src ) === $this->length(),
"Input string not the expected length"
);
return PHPUtils::safeSubstr(
$src,
$this->openWidth,
-$this->closeWidth
);
}
/**
* Return a new DOM source range shifted by $amount.
* @param int $amount The amount to shift by
* @return DomSourceRange
*/
public function offset( int $amount ): DomSourceRange {
return new DomSourceRange(
$this->start + $amount,
$this->end + $amount,
$this->openWidth,
$this->closeWidth,
$this->leadingWS,
$this->trailingWS
);
}
/**
* @return bool True if the tag widths are valid.
*/
public function hasValidTagWidths(): bool {
return $this->openWidth !== null && $this->closeWidth !== null &&
$this->openWidth >= 0 && $this->closeWidth >= 0;
}
/**
* Determine if this DSR records that whitespace was trimmed from
* this node. Note that this doesn't mean that the amount trimmed
* is known; use ::hasValidLeadingWS() or ::hasValidTrimmedWS()
* to determine that.
* @return bool True if either leadingWS or trailingWS is non-zero.
*/
public function hasTrimmedWS(): bool {
return $this->leadingWS !== 0 || $this->trailingWS !== 0;
}
/**
* @note In most cases you should check to see if this node
* ::hasTrimmedWS() *and* whether the amount is valid.
* @return bool if the amount of leading whitespace is known.
*/
public function hasValidLeadingWS(): bool {
return $this->leadingWS !== -1;
}
/**
* @note In most cases you should check to see if this node
* ::hasTrimmedWS() *and* whether the amount is valid.
* @return bool if the amount of trailing whitespace is known.
*/
public function hasValidTrailingWS(): bool {
return $this->trailingWS !== -1;
}
/**
* Convert a TSR to a DSR with zero-width container open/close tags.
* @param SourceRange $tsr
* @return DomSourceRange
*/
public static function fromTsr( SourceRange $tsr ): DomSourceRange {
return new DomSourceRange( $tsr->start, $tsr->end, null, null );
}
/**
* Create a new DomSourceRange from an array of integers/null (such as
* created during JSON serialization).
* @param array<int|null> $dsr
* @return DomSourceRange
*/
public static function newFromJsonArray( array $dsr ): DomSourceRange {
$n = count( $dsr );
Assert::invariant( $n === 2 || $n === 4 || $n === 6, 'Not enough elements in DSR array' );
return new DomSourceRange(
$dsr[0], $dsr[1], $dsr[2] ?? null, $dsr[3] ?? null, $dsr[4] ?? 0, $dsr[5] ?? 0
);
}
/**
* @inheritDoc
*/
public function toJsonArray(): array {
$a = [ $this->start, $this->end, $this->openWidth, $this->closeWidth ];
if ( $this->leadingWS !== 0 || $this->trailingWS !== 0 ) {
$a[] = $this->leadingWS;
$a[] = $this->trailingWS;
}
return $a;
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 17:23 (9 h, 9 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
61/b1/76234583c867a74e15fda3ad533a
Default Alt Text
DomSourceRange.php (7 KB)

Event Timeline