summaryrefslogtreecommitdiff
path: root/buildscripts/phing/classes/phing/util/PathTokenizer.php
blob: 0a469acfb69f563f262c7912ceb089aa8eed5c25 (plain)
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
<?php
/*
 *  $Id: 0ca7f2a419b5cc4285a8f84695c4b680b0aa190b $
 *
 * 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.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information please see
 * <http://phing.info>. 
 */



include_once 'phing/util/StringHelper.php';



/**

 * A Path tokenizer takes a path and returns the components that make up

 * that path.

 *

 * The path can use path separators of either ':' or ';' and file separators

 * of either '/' or '\'.

 *

 * @author Hans Lellelid <hans@xmpl.org> (Phing)

 * @author Conor MacNeill (Ant)

 * @author Jeff Tulley <jtulley@novell.com>  (Ant)

 * @package phing.util

 */ 

class PathTokenizer {

    

    /**

     * A array of tokens, created by preg_split().

     */

    private $tokens = array();

    

    /**

     * A string which stores any path components which have been read ahead

     * due to DOS filesystem compensation.

     * @var string

     */

    private $lookahead;

    

    /**

     * Flag to indicate whether or not we are running on a platform with a

     * DOS style filesystem

     * @var boolean

     */

    private $dosStyleFilesystem;



    /**

     * Constructs a path tokenizer for the specified path.

     * 

     * @param path The path to tokenize. Must not be <code>null</code>.

     */

    public function __construct($path) {

        // on Windows and Unix, we can ignore delimiters and still have

        // enough information to tokenize correctly.    

        $this->tokens = preg_split("/[;:]/", $path, -1, PREG_SPLIT_NO_EMPTY);

        $this->dosStyleFilesystem = ( PATH_SEPARATOR == ';');

    }



    /**

     * Tests if there are more path elements available from this tokenizer's

     * path. If this method returns <code>true</code>, then a subsequent call 

     * to nextToken will successfully return a token.

     * 

     * @return <code>true</code> if and only if there is at least one token 

     * in the string after the current position; <code>false</code> otherwise.

     */

    public function hasMoreTokens() {

        if ($this->lookahead !== null) {

            return true;

        }        

        return !empty($this->tokens);

    }

    

    /**

     * Returns the next path element from this tokenizer.

     * 

     * @return the next path element from this tokenizer.

     * 

     * @throws Exception if there are no more elements in this tokenizer's path.

     */

    public function nextToken() {

            

        if ($this->lookahead !== null) {

            $token = $this->lookahead;

            $this->lookahead = null;

        } else {

            $token = trim(array_shift($this->tokens));

        }

            



        if (strlen($token) === 1 && Character::isLetter($token{0})

                                && $this->dosStyleFilesystem

                                && !empty($this->tokens)) {

            // we are on a dos style system so this path could be a drive

            // spec. We look at the next token

            $nextToken = trim(array_shift($this->tokens));

            if (StringHelper::startsWith('\\', $nextToken) || StringHelper::startsWith('/', $nextToken)) {

                // we know we are on a DOS style platform and the next path

                // starts with a slash or backslash, so we know this is a 

                // drive spec

                $token .= ':' . $nextToken;

            } else {

                // store the token just read for next time

                $this->lookahead = $nextToken;

            }

        }

        

        return $token;

    }



    /**

     * Non StringTokenizer function, that indicates whether the specified path is contained in loaded tokens.

     * We can do this easily because in PHP implimentation we're using arrays.

     * @param string $path path to search for.

     * @return boolean

     */

    public function contains($path) {

        return in_array($path, $this->tokens, true);        

    }

    

}