FilesExpand file tree

 main

/

TokenStreamInterface.php

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

89 lines (80 loc) · 2.45 KB

 main

/

TokenStreamInterface.php

Copy path

Top

File metadata and controls

• Code
• Blame

89 lines (80 loc) · 2.45 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

<?php

/*

* This file is part of the Brunk\ParserUtils package.

*

* (c) YoSymfony <http://github.com/yosymfony>

*

* For the full copyright and license information, please view the LICENSE

* file that was distributed with this source code.

*/

namespace Brunk\ParserUtils;

interface TokenStreamInterface

{

/**

* Moves the pointer one token forward

*

* @return Token|null The token or null if there are not more tokens

*/

public function moveNext() : ?Token;

/**

* Matches the next token. This method moves the pointer one token forward

* if an error does not occur

*

* @param string $tokenName The name of the token

*

* @return string The value of the token

*

* @throws SyntaxErrorException If the next token does not match

*/

public function matchNext(string $tokenName) : string;

/**

* Skips tokens while they match with the token name passed as argument.

* This method moves the pointer "n" tokens forward until the last one

* that match with the token name

*

* @param string $tokenName The name of the token

*/

public function skipWhile(string $tokenName) : void;

/**

* Skips tokens while they match with one of the token names passed as

* argument. This method moves the pointer "n" tokens forward until the

* last one that match with one of the token names

*

* @param string[] $tokenNames List of token names

*/

public function skipWhileAny(array $tokenNames) : void;

/**

* Checks if the next token matches with the token name passed as argument

*

* @param string $tokenName The name of the token

*

* @return bool

*/

public function isNext(string $tokenName) : bool;

/**

* Checks if the following tokens in the stream match with the sequence of tokens

*

* @param string[] $tokenNames Sequence of token names

*

* @return bool

*/

public function isNextSequence(array $tokenNames) : bool;

/**

* Checks if one of the tokens passed as argument is the next token

*

* @param string[] $tokenNames List of token names. e.g: 'T_PLUS', 'T_SUB'

*

* @return bool

*/

public function isNextAny(array $tokenNames) : bool;

/**

* Has pending tokens?

*

* @return bool

*/

public function hasPendingTokens() :bool;

/**

* Resets the stream to the beginning

*/

public function reset() : void;

}