-
-
Notifications
You must be signed in to change notification settings - Fork 130
/
Tokenizer.php
111 lines (102 loc) · 3.36 KB
/
Tokenizer.php
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
<?php
/**
* This file is part of PDepend.
*
* PHP Version 5
*
* Copyright (c) 2008-2013, Manuel Pichler <mapi@pdepend.org>.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* * Neither the name of Manuel Pichler nor the names of his
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* @copyright 2008-2013 Manuel Pichler. All rights reserved.
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
*/
namespace PDepend\Source\Tokenizer;
/**
* Base interface for all php code tokenizers.
*
* @copyright 2008-2013 Manuel Pichler. All rights reserved.
* @license http://www.opensource.org/licenses/bsd-license.php BSD License
*/
interface Tokenizer
{
/**
* Marks the end of the token stream.
*/
const T_EOF = -1;
/**
* Marks the beginning of the token stream.
*/
const T_BOF = -2;
/**
* Returns the name of the source file.
*
* @return string
*/
public function getSourceFile();
/**
* Sets a new php source file.
*
* @param string $sourceFile A php source file.
*
* @return void
*/
public function setSourceFile($sourceFile);
/**
* Returns the next token or {@link \PDepend\Source\Tokenizer\Tokenizer::T_EOF} if
* there is no next token.
*
* @return \PDepend\Source\Tokenizer\Token
*/
public function next();
/**
* Returns the next token type or {@link \PDepend\Source\Tokenizer\Tokenizer::T_EOF} if
* there is no next token.
*
* @return integer
*/
public function peek();
/**
* Returns the type of next token, after the current token. This method
* ignores all comments between the current and the next token.
*
* @return integer
* @since 0.9.12
*/
public function peekNext();
/**
* Returns the previous token type or {@link \PDepend\Source\Tokenizer\Tokenizer::T_BOF}
* if there is no previous token.
*
* @return integer
*/
public function prev();
}