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
|
<?php
/*
* $Id: StripLineComments.php,v 1.8 2005/02/27 20:52:08 mrook Exp $
*
* 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/filters/BaseParamFilterReader.php';
include_once 'phing/filters/ChainableReader.php';
/*
* This filter strips line comments.
*
* Example:
*
* <pre><striplinecomments>
* <comment value="#"/>
* <comment value="--"/>
* <comment value="REM "/>
* <comment value="rem "/>
* <comment value="//"/>
* </striplinecomments></pre>
*
* Or:
*
* <pre><filterreader classname="phing.filters.StripLineComments">
* <param type="comment" value="#"/>
* <param type="comment" value="--"/>
* <param type="comment" value="REM "/>
* <param type="comment" value="rem "/>
* <param type="comment" value="//"/>
* </filterreader></pre>
*
* @author <a href="mailto:yl@seasonfive.com">Yannick Lecaillez</a>
* @author hans lellelid, hans@velum.net
* @version $Revision: 1.8 $ $Date: 2005/02/27 20:52:08 $
* @access public
* @see BaseParamFilterReader
* @package phing.filters
*/
class StripLineComments extends BaseParamFilterReader implements ChainableReader {
/** Parameter name for the comment prefix. */
const COMMENTS_KEY = "comment";
/** Array that holds the comment prefixes. */
private $_comments = array();
/**
* Returns stream only including
* lines from the original stream which don't start with any of the
* specified comment prefixes.
*
* @return mixed the resulting stream, or -1
* if the end of the resulting stream has been reached.
*
* @throws IOException if the underlying stream throws an IOException
* during reading
*/
function read($len = null) {
if ( !$this->getInitialized() ) {
$this->_initialize();
$this->setInitialized(true);
}
$buffer = $this->in->read($len);
if ($buffer === -1) {
return -1;
}
$lines = explode("\n", $buffer);
$filtered = array();
$commentsSize = count($this->_comments);
foreach($lines as $line) {
for($i = 0; $i < $commentsSize; $i++) {
$comment = $this->_comments[$i]->getValue();
if ( StringHelper::startsWith($comment, ltrim($line)) ) {
$line = null;
break;
}
}
if ($line !== null) {
$filtered[] = $line;
}
}
$filtered_buffer = implode("\n", $filtered);
return $filtered_buffer;
}
/*
* Adds a <code>comment</code> element to the list of prefixes.
*
* @return comment The <code>comment</code> element added to the
* list of comment prefixes to strip.
*/
function createComment() {
$num = array_push($this->_comments, new Comment());
return $this->_comments[$num-1];
}
/*
* Sets the list of comment prefixes to strip.
*
* @param comments A list of strings, each of which is a prefix
* for a comment line. Must not be <code>null</code>.
*/
function setComments($lineBreaks) {
if (!is_array($lineBreaks)) {
throw new Exception("Excpected 'array', got something else");
}
$this->_comments = $lineBreaks;
}
/*
* Returns the list of comment prefixes to strip.
*
* @return array The list of comment prefixes to strip.
*/
function getComments() {
return $this->_comments;
}
/*
* Creates a new StripLineComments using the passed in
* Reader for instantiation.
*
* @param reader A Reader object providing the underlying stream.
* Must not be <code>null</code>.
*
* @return a new filter based on this configuration, but filtering
* the specified reader
*/
function chain(Reader $reader) {
$newFilter = new StripLineComments($reader);
$newFilter->setComments($this->getComments());
$newFilter->setInitialized(true);
$newFilter->setProject($this->getProject());
return $newFilter;
}
/*
* Parses the parameters to set the comment prefixes.
*/
private function _initialize() {
$params = $this->getParameters();
if ( $params !== null ) {
for($i = 0 ; $i<count($params) ; $i++) {
if ( self::COMMENTS_KEY === $params[$i]->getType() ) {
$comment = new Comment();
$comment->setValue($params[$i]->getValue());
array_push($this->_comments, $comment);
}
}
}
}
}
/*
* The class that holds a comment representation.
*/
class Comment {
/** The prefix for a line comment. */
private $_value;
/*
* Sets the prefix for this type of line comment.
*
* @param string $value The prefix for a line comment of this type.
* Must not be <code>null</code>.
*/
function setValue($value) {
$this->_value = (string) $value;
}
/*
* Returns the prefix for this type of line comment.
*
* @return string The prefix for this type of line comment.
*/
function getValue() {
return $this->_value;
}
}
?>
|
