CharacterReference.php
3 years ago
DOMTreeBuilder.php
3 years ago
EventHandler.php
3 years ago
FileInputStream.php
3 years ago
InputStream.php
3 years ago
ParseError.php
3 years ago
Scanner.php
3 years ago
StringInputStream.php
3 years ago
Tokenizer.php
3 years ago
TreeBuildingRules.php
3 years ago
UTF8Utils.php
3 years ago
InputStream.php
82 lines
| 1 | <?php |
| 2 | |
| 3 | namespace IAWP\Masterminds\HTML5\Parser; |
| 4 | |
| 5 | /** |
| 6 | * Interface for stream readers. |
| 7 | * |
| 8 | * The parser only reads from streams. Various input sources can write |
| 9 | * an adapater to this InputStream. |
| 10 | * |
| 11 | * Currently provided InputStream implementations include |
| 12 | * FileInputStream and StringInputStream. |
| 13 | * |
| 14 | * @deprecated since 2.4, to remove in 3.0. Use a string in the scanner instead. |
| 15 | */ |
| 16 | interface InputStream extends \Iterator |
| 17 | { |
| 18 | /** |
| 19 | * Returns the current line that is being consumed. |
| 20 | * |
| 21 | * TODO: Move this to the scanner. |
| 22 | */ |
| 23 | public function currentLine(); |
| 24 | /** |
| 25 | * Returns the current column of the current line that the tokenizer is at. |
| 26 | * |
| 27 | * Newlines are column 0. The first char after a newline is column 1. |
| 28 | * |
| 29 | * @TODO Move this to the scanner. |
| 30 | * |
| 31 | * @return int The column number. |
| 32 | */ |
| 33 | public function columnOffset(); |
| 34 | /** |
| 35 | * Get all characters until EOF. |
| 36 | * |
| 37 | * This consumes characters until the EOF. |
| 38 | */ |
| 39 | public function remainingChars(); |
| 40 | /** |
| 41 | * Read to a particular match (or until $max bytes are consumed). |
| 42 | * |
| 43 | * This operates on byte sequences, not characters. |
| 44 | * |
| 45 | * Matches as far as possible until we reach a certain set of bytes |
| 46 | * and returns the matched substring. |
| 47 | * |
| 48 | * @see strcspn |
| 49 | * |
| 50 | * @param string $bytes Bytes to match. |
| 51 | * @param int $max Maximum number of bytes to scan. |
| 52 | * |
| 53 | * @return mixed Index or false if no match is found. You should use strong |
| 54 | * equality when checking the result, since index could be 0. |
| 55 | */ |
| 56 | public function charsUntil($bytes, $max = null); |
| 57 | /** |
| 58 | * Returns the string so long as $bytes matches. |
| 59 | * |
| 60 | * Matches as far as possible with a certain set of bytes |
| 61 | * and returns the matched substring. |
| 62 | * |
| 63 | * @see strspn |
| 64 | * |
| 65 | * @param string $bytes A mask of bytes to match. If ANY byte in this mask matches the |
| 66 | * current char, the pointer advances and the char is part of the |
| 67 | * substring. |
| 68 | * @param int $max The max number of chars to read. |
| 69 | */ |
| 70 | public function charsWhile($bytes, $max = null); |
| 71 | /** |
| 72 | * Unconsume one character. |
| 73 | * |
| 74 | * @param int $howMany The number of characters to move the pointer back. |
| 75 | */ |
| 76 | public function unconsume($howMany = 1); |
| 77 | /** |
| 78 | * Retrieve the next character without advancing the pointer. |
| 79 | */ |
| 80 | public function peek(); |
| 81 | } |
| 82 |