PEAR2_Text_MarkdownPEAR2_Text_Markdown-0.1.0/php/PEAR2/Text/Markdown/Plugin/List.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
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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
<?php
/**
 * 
 * Block plugin to create ordered and unordered lists.
 * 
 * Start a line with `-`, `+`, or `*` (and a space) to
 * indicate an unordered bullet list.
 * 
 * Start a line with a number and period (and a space)
 * (for example `1. `) to indicate a numbered list.
 * 
 * @category Solar
 * 
 * @package Markdown
 * 
 * @author John Gruber <http://daringfireball.net/projects/markdown/>
 * 
 * @author Michel Fortin <http://www.michelf.com/projects/php-markdown/>
 * 
 * @author Paul M. Jones <pmjones@solarphp.com>
 * 
 * @license http://opensource.org/licenses/bsd-license.php BSD
 * 
 * @version $Id: List.php 4531 2010-04-12 17:23:56Z pmjones $
 * 
 */
namespace PEAR2\Text;

class Markdown_Plugin_List extends Markdown_Plugin
{
    /**
     * 
     * This is a block plugin.
     * 
     * @var bool
     * 
     */
    protected $_is_block = true;
    
    /**
     * 
     * These should be encoded as special Markdown characters.
     * 
     * @var string
     * 
     */
    protected $_chars = '-+*';
    
    /**
     * 
     * Tracks the current level of nested lists.
     * 
     * @var int
     * 
     */
    protected $_list_level = 0;
    
    /**
     * 
     * The tag to open an unordered (bulleted) list.
     * 
     * @var string
     * 
     */
    protected $_ul_open = "<ul>";
    
    /**
     * 
     * The tag to close an unordered (bulleted) list.
     * 
     * @var string
     * 
     */
    protected $_ul_close = "</ul>";
    
    /**
     * 
     * The tag to open an ordered (numbered) list.
     * 
     * @var string
     * 
     */
    protected $_ol_open = "<ol>";
    
    /**
     * 
     * The tag to close an ordered (numbered) list.
     * 
     * @var string
     * 
     */
    protected $_ol_close = "</ol>";
    
    /**
     * 
     * The tag to open a list item.
     * 
     * @var string
     * 
     */
    protected $_li_open = "<li>";
    
    /**
     * 
     * The tag to close a list item.
     * 
     * @var string
     * 
     */
    protected $_li_close = "</li>";
    
    /**
     * 
     * Resets for a new transformation.
     * 
     * @return void
     * 
     */
    public function reset()
    {
        parent::reset();
        $this->_list_level = 0;
    }
    
    /**
     * 
     * Makes ordered (numbered) and unordered (bulleted) XHTML lists.
     * 
     * @param string $text Portion of the Markdown source text.
     * 
     * @return string The transformed XHTML.
     * 
     */
    public function parse($text)
    {
        $less_than_tab = $this->_getTabWidth() - 1;
        
        // Re-usable patterns to match list item bullets and number markers:
        $marker_ul  = '[*+-]';
        $marker_ol  = '\d+[.]';
        $marker_any = "(?:$marker_ul|$marker_ol)";
        
        $markers = array($marker_ul, $marker_ol);
        
        foreach ($markers as $marker) {
            // Re-usable pattern to match any entire ul or ol list:
            $whole_list = '
                (                                # $1 = whole list
                  (                              # $2
                    [ ]{0,'.$less_than_tab.'}    
                    ('.$marker.')                # $3 = first list item marker
                    [ \t]+                       
                  )                              
                  (?s:.+?)                       
                  (                              # $4
                      \z                         
                    |                            
                      \n{2,}                     
                      (?=\S)                     
                      (?!                        # Negative lookahead for another list item marker
                        [ \t]*
                        '.$marker.'[ \t]+
                      )
                  )
                )
            '; // mx
        
            // We use a different prefix before nested lists than top-level lists.
            // See extended comment in _ProcessListItems().
            if ($this->_list_level) {
                $text = preg_replace_callback('{
                        ^
                        '.$whole_list.'
                    }mx',
                    array($this, '_parse'),
                    $text
                );
            } else {
                $text = preg_replace_callback('{
                        (?:(?<=\n\n)|\A\n?)
                        '.$whole_list.'
                    }mx',
                    array($this, '_parseNested'),
                    $text
                );
            }
        }
        
        return $text;
    }
    
    /**
     * 
     * Support callback for top-level list blocks.
     * 
     * @param array $matches Matches from preg_replace_callback().
     * 
     * @return string The replacement text.
     * 
     */
    protected function _parse($matches)
    {
        // Re-usable patterns to match list item bullets and number markers:
        $marker_ul  = '[*+-]';
        $marker_ol  = '\d+[.]';
        $marker_any = "(?:$marker_ul|$marker_ol)";
    
        $list = $matches[1];
        if (preg_match("/$marker_ul/", $matches[3])) {
            $open = $this->_ul_open;
            $close = $this->_ul_close;
            $marker_any = $marker_ul;
        } else {
            $open = $this->_ol_open;
            $close = $this->_ol_close;
            $marker_any = $marker_ol;
        }
    
        // Turn double returns into triple returns, so that we can make a
        // paragraph for the last item in a list, if necessary:
        $list = preg_replace("/\n{2,}/", "\n\n\n", $list);
        $result = $this->_processItems($list, $marker_any);
        
        return $this->_toHtmlToken($open . $result . $close) . "\n";
    }
    
    /**
     * 
     * Support callback for nested lists.
     * 
     * @todo How is this different from top-level lists?
     * 
     * @param string $matches Matches from preg_replace_callback().
     * 
     * @return string The replacement text.
     * 
     */
    protected function _parseNested($matches)
    {
        // Re-usable patterns to match list item bullets and number markers:
        $marker_ul  = '[*+-]';
        $marker_ol  = '\d+[.]';
        $marker_any = "(?:$marker_ul|$marker_ol)";
    
        $list = $matches[1];
        if (preg_match("/$marker_ul/", $matches[3])) {
            $open = $this->_ul_open;
            $close = $this->_ul_close;
            $marker_any = $marker_ul;
        } else {
            $open = $this->_ol_open;
            $close = $this->_ol_close;
            $marker_any = $marker_ol;
        }
    
        // Turn double returns into triple returns, so that we can make a
        // paragraph for the last item in a list, if necessary:
        $list = preg_replace("/\n{2,}/", "\n\n\n", $list);
        $result = $this->_processItems($list, $marker_any);
        return $this->_toHtmlToken("$open\n" . $result . $close) . "\n\n"; // extra \n?
    }
    
    
    /**
     * 
     * Process the contents of a single ordered or unordered
     * list, splitting it into individual list items.
     * 
     * @param string $list_str The source text of the list block.
     * 
     * @param string $marker_any The list-style markers to use when
     * identifying list items.
     * 
     * @return string The replacement text.
     * 
     */
    protected function _processItems($list_str, $marker_any)
    {
        // The $this->_list_level global keeps track of when we're inside a list.
        // Each time we enter a list, we increment it; when we leave a list,
        // we decrement. If it's zero, we're not in a list anymore.
        //
        // We do this because when we're not inside a list, we want to treat
        // something like this:
        //
        //        I recommend upgrading to version
        //        8. Oops, now this line is treated
        //        as a sub-list.
        //
        // As a single paragraph, despite the fact that the second line starts
        // with a digit-period-space sequence.
        //
        // Whereas when we're inside a list (or sub-list), that line will be
        // treated as the start of a sub-list. What a kludge, huh? This is
        // an aspect of Markdown's syntax that's hard to parse perfectly
        // without resorting to mind-reading. Perhaps the solution is to
        // change the syntax rules such that sub-lists must start with a
        // starting cardinal number; for example "1." or "a.".
        $this->_list_level ++;
        
        // trim trailing blank lines:
        $list_str = preg_replace("/\n{2,}\\z/", "\n", $list_str);
        
        // process items
        $list_str = preg_replace_callback('{
                (\n)?                          # leading line = $1
                (^[ \t]*)                      # leading whitespace = $2
                ('.$marker_any.') [ \t]+       # list marker = $3
                ((?s:.+?)                      # list item text   = $4
                (\n{1,2}))
                (?= \n* (\z | \2 ('.$marker_any.') [ \t]+))
            }xm',
            array($this, '_processItemsCallback'),
            $list_str
        );
        
        $this->_list_level --;
        return $list_str;
    }
    
    /**
     * 
     * Support callback for processing list items.
     * 
     * @param array $matches Matches from preg_replace_callback().
     * 
     * @return string The replacement text.
     * 
     */
    protected function _processItemsCallback($matches)
    {
        $item = $matches[4];
        $leading_line =& $matches[1];
        $leading_space =& $matches[2];
        
        if ($leading_line || preg_match('/\n{2,}/', $item)) {
            $item = $this->_processBlocks($this->_outdent($item));
        } else {
            // Recursion for sub-lists:
            $item = $this->parse($this->_outdent($item));
            $item = preg_replace('/\n+$/', '', $item);
            $item = $this->_processSpans($item);
        }
        
        return $this->_li_open . $item . $this->_li_close . "\n";
    }
}
EOF