Class: MarkdownIt::RulesBlock::List

Inherits:
Object
  • Object
show all
Extended by:
Common::Utils
Defined in:
lib/motion-markdown-it/rules_block/list.rb

Constant Summary

Constants included from Common::Utils

Common::Utils::DIGITAL_ENTITY_TEST_RE, Common::Utils::ENTITY_RE, Common::Utils::HTML_ESCAPE_REPLACE_RE, Common::Utils::HTML_ESCAPE_TEST_RE, Common::Utils::HTML_REPLACEMENTS, Common::Utils::REGEXP_ESCAPE_RE, Common::Utils::UNESCAPE_ALL_RE, Common::Utils::UNESCAPE_MD_RE, Common::Utils::UNICODE_PUNCT_RE

Class Method Summary collapse

Methods included from Common::Utils

arrayReplaceAt, assign, charCodeAt, escapeHtml, escapeRE, fromCharCode, fromCodePoint, isMdAsciiPunct, isPunctChar, isSpace, isValidEntityCode, isWhiteSpace, normalizeReference, replaceEntityPattern, unescapeAll, unescapeMd

Class Method Details

.list(state, startLine, endLine, silent) ⇒ Object 



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
 
# File 'lib/motion-markdown-it/rules_block/list.rb', line 105

def self.list(state, startLine, endLine, silent)
  isTerminatingParagraph = false
  tight = true

  # if it's indented more than 3 spaces, it should be a code block
  return false if (state.sCount[startLine] - state.blkIndent >= 4)

  # Special case:
  #  - item 1
  #   - item 2
  #    - item 3
  #     - item 4
  #      - this one is a paragraph continuation
  if (state.listIndent >= 0 &&
      state.sCount[startLine] - state.listIndent >= 4 &&
      state.sCount[startLine] < state.blkIndent)
    return false
  end

  # limit conditions when list can interrupt
  # a paragraph (validation mode only)
  if silent && state.parentType == 'paragraph'
    # Next list item should still terminate previous list item;
    #
    # This code can fail if plugins use blkIndent as well as lists,
    # but I hope the spec gets fixed long before that happens.
    #
    if state.tShift[startLine] >= state.blkIndent
      isTerminatingParagraph = true
    end
  end

  # Detect list type and position after marker
  if ((posAfterMarker = skipOrderedListMarker(state, startLine)) >= 0)
    isOrdered   = true
    start       = state.bMarks[startLine] + state.tShift[startLine]
    markerValue = state.src[start, posAfterMarker - start - 1].to_i

    # If we're starting a new ordered list right after
    # a paragraph, it should start with 1.
    return false if isTerminatingParagraph && markerValue != 1
  elsif ((posAfterMarker = skipBulletListMarker(state, startLine)) >= 0)
    isOrdered = false
  else
    return false
  end

  # If we're starting a new unordered list right after
  # a paragraph, first line should not be empty.
  if isTerminatingParagraph
    return false if state.skipSpaces(posAfterMarker) >= state.eMarks[startLine]
  end

  # We should terminate list on style change. Remember first one to compare.
  markerCharCode = charCodeAt(state.src, posAfterMarker - 1)

  # For validation mode we can terminate immediately
  return true if (silent)

  # Start list
  listTokIdx = state.tokens.length

  if (isOrdered)
    start       = state.bMarks[startLine] + state.tShift[startLine]
    markerValue = state.src[start, posAfterMarker - start - 1].to_i
    token       = state.push('ordered_list_open', 'ol', 1)
    if (markerValue != 1)
      token.attrs = [ [ 'start', markerValue ] ]
    end

  else
    token       = state.push('bullet_list_open', 'ul', 1)
  end

  token.map    = listLines = [ startLine, 0 ]
  token.markup = markerCharCode.chr

  #
  # Iterate list items
  #

  nextLine        = startLine
  prevEmptyEnd    = false
  terminatorRules = state.md.block.ruler.getRules('list')

  oldParentType    = state.parentType
  state.parentType = 'list'

  while (nextLine < endLine)
    pos          = posAfterMarker
    max          = state.eMarks[nextLine]

    initial = offset = state.sCount[nextLine] + posAfterMarker - (state.bMarks[startLine] + state.tShift[startLine])

    while pos < max
      ch = charCodeAt(state.src, pos)

      if ch == 0x09
        offset += 4 - (offset + state.bsCount[nextLine]) % 4
      elsif ch == 0x20
        offset += 1
      else
        break
      end

      pos += 1
    end

    contentStart = pos

    if (contentStart >= max)
      # trimming space in "-    \n  3" case, indent is 1 here
      indentAfterMarker = 1
    else
      indentAfterMarker = offset - initial
    end

    # If we have more than 4 spaces, the indent is 1
    # (the rest is just indented code block)
    indentAfterMarker = 1 if (indentAfterMarker > 4)

    # "  -  test"
    #  ^^^^^ - calculating total length of this thing
    indent = initial + indentAfterMarker

    # Run subparser & write tokens
    token        = state.push('list_item_open', 'li', 1)
    token.markup = markerCharCode.chr
    token.map    = itemLines = [ startLine, 0 ]

    # change current state, then restore it after parser subcall
    oldTight                = state.tight
    oldTShift               = state.tShift[startLine]
    oldSCount               = state.sCount[startLine]

    #  - example list
    # ^ listIndent position will be here
    #   ^ blkIndent position will be here
    #
    oldListIndent           = state.listIndent
    state.listIndent        = state.blkIndent
    state.blkIndent         = indent

    state.tight             = true
    state.tShift[startLine] = contentStart - state.bMarks[startLine]
    state.sCount[startLine] = offset

    if contentStart >= max && state.isEmpty(startLine + 1)
      # workaround for this case
      # (list item is empty, list terminates before "foo"):
      # ~~~~~~~~
      #   -
      #
      #     foo
      # ~~~~~~~~
      state.line = [state.line + 2, endLine].min
    else
      state.md.block.tokenize(state, startLine, endLine, true)
    end

    # If any of list item is tight, mark list as tight
    if (!state.tight || prevEmptyEnd)
      tight = false
    end
    # Item become loose if finish with empty line,
    # but we should filter last element, because it means list finish
    prevEmptyEnd = (state.line - startLine) > 1 && state.isEmpty(state.line - 1)

    state.blkIndent         = state.listIndent
    state.listIndent        = oldListIndent
    state.tShift[startLine] = oldTShift
    state.sCount[startLine] = oldSCount
    state.tight             = oldTight

    token                   = state.push('list_item_close', 'li', -1)
    token.markup            = markerCharCode.chr

    nextLine                = startLine = state.line
    itemLines[1]            = nextLine
    contentStart            = state.bMarks[startLine]

    break if (nextLine >= endLine)

    #
    # Try to check if list is terminated or continued.
    #
    break if (state.sCount[nextLine] < state.blkIndent)

    # if it's indented more than 3 spaces, it should be a code block
    break if (state.sCount[startLine] - state.blkIndent >= 4)

    # fail if terminating block found
    terminate = false
    (0...terminatorRules.length).each do |i|
      if (terminatorRules[i].call(state, nextLine, endLine, true))
        terminate = true
        break
      end
    end
    break if (terminate)

    # fail if list has another type
    if (isOrdered)
      posAfterMarker = skipOrderedListMarker(state, nextLine)
      break if (posAfterMarker < 0)
    else
      posAfterMarker = skipBulletListMarker(state, nextLine)
      break if (posAfterMarker < 0)
    end

    break if (markerCharCode != charCodeAt(state.src, posAfterMarker - 1))
  end

  # Finalize list
  if (isOrdered)
    token = state.push('ordered_list_close', 'ol', -1)
  else
    token = state.push('bullet_list_close', 'ul', -1)
  end
  token.markup = markerCharCode.chr

  listLines[1] = nextLine
  state.line   = nextLine

  state.parentType = oldParentType

  # mark paragraphs tight if needed
  if (tight)
    markTightParagraphs(state, listTokIdx)
  end

  return true
end

.markTightParagraphs(state, idx) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/motion-markdown-it/rules_block/list.rb', line 89

def self.markTightParagraphs(state, idx)
  level = state.level + 2

  i = idx + 2
  l =  state.tokens.length
  while i < l
    if (state.tokens[i].level == level && state.tokens[i].type == 'paragraph_open')
      state.tokens[i + 2].hidden = true
      state.tokens[i].hidden     = true
      i += 2
    end
    i += 1
  end
end

.skipBulletListMarker(state, startLine) ⇒ Object

Search ‘[-+*][n ]`, returns next pos after marker on success or -1 on fail.



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/motion-markdown-it/rules_block/list.rb', line 11

def self.skipBulletListMarker(state, startLine)
  pos = state.bMarks[startLine] + state.tShift[startLine]
  max = state.eMarks[startLine]

  marker = charCodeAt(state.src, pos)
  pos   += 1
  # Check bullet
  if (marker != 0x2A && # *
      marker != 0x2D && # -
      marker != 0x2B)   # +
    return -1
  end

  if pos < max
    ch = charCodeAt(state.src, pos)

    if !isSpace(ch)
      # " -test " - is not a list item
      return -1
    end
  end

  return pos
end

.skipOrderedListMarker(state, startLine) ⇒ Object

Search ‘d+[n ]`, returns next pos after marker on success or -1 on fail.



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
 
# File 'lib/motion-markdown-it/rules_block/list.rb', line 39

def self.skipOrderedListMarker(state, startLine)
  start = state.bMarks[startLine] + state.tShift[startLine]
  pos   = start
  max   = state.eMarks[startLine]

  # List marker should have at least 2 chars (digit + dot)
  return -1 if (pos + 1 >= max)

  ch   = charCodeAt(state.src, pos)
  pos += 1

  return -1 if ch.nil?
  return -1 if (ch < 0x30 || ch > 0x39) # < 0 || > 9

  while true
    # EOL -> fail
    return -1 if (pos >= max)

    ch   = charCodeAt(state.src, pos)
    pos += 1

    if (ch >= 0x30 && ch <= 0x39) #  >= 0 && <= 9

      # List marker should have no more than 9 digits
      # (prevents integer overflow in browsers)
      return -1 if pos - start >= 10

      next
    end

    # found valid marker
    if (ch === 0x29 || ch === 0x2e) # ')' || '.'
      break
    end

    return -1
  end

  if pos < max
    ch = charCodeAt(state.src, pos)

    if !isSpace(ch)
      # " 1.test " - is not a list item
      return -1
    end
  end
  return pos
end