Module: Asciidoctor::Substitutors

Included in:

AbstractNode

Defined in:

lib/asciidoctor/substitutors.rb

Overview

the necessary substitutions.

Constant Summary

SpecialCharsRx =

/[<&>]/

SpecialCharsTr =

{ '>' => '&gt;', '<' => '&lt;', '&' => '&amp;' }

QuotedTextSniffRx =

Detects if text is a possible candidate for the quotes substitution.

{ false => /[*_`#^~]/, true => /[*'_+#^~]/ }

SUB_GROUPS =

{
  none: NO_SUBS,
  normal: NORMAL_SUBS,
  verbatim: VERBATIM_SUBS,
  specialchars: BASIC_SUBS,
}

SUB_HINTS =

{
  a: :attributes,
  m: :macros,
  n: :normal,
  p: :post_replacements,
  q: :quotes,
  r: :replacements,
  c: :specialcharacters,
  v: :verbatim,
}

SUB_OPTIONS =

{
  block:  SUB_GROUPS.keys + NORMAL_SUBS + [:callouts],
  inline: SUB_GROUPS.keys + NORMAL_SUBS,
}

CAN =

?\u0018

DEL =

?\u007f

PASS_START =

SPA, start of guarded protected area (u0096)

?\u0096

PASS_END =

EPA, end of guarded protected area (u0097)

?\u0097

PassSlotRx =

match passthrough slot

/#{PASS_START}(\d+)#{PASS_END}/

HighlightedPassSlotRx =

fix passthrough slot after syntax highlighting

%r(<span\b[^>]*>#{PASS_START}</span>[^\d]*(\d+)[^\d]*<span\b[^>]*>#{PASS_END}</span>)

RS =

'\\'

R_SB =

']'

ESC_R_SB =

'\]'

PLUS =

'+'

CGI =

::CGI

Instance Method Summary

• #apply_header_subs(text) ⇒ A

  Apply substitutions for header metadata and attribute assignments.

• #apply_normal_subs(text) ⇒ Object

  Apply normal substitutions.

• #apply_reftext_subs(text) ⇒ Object

  Apply substitutions for reftext.

• #apply_subs(text, subs = NORMAL_SUBS) ⇒ Object (also: #apply_title_subs)

  Apply the specified substitutions to the text.

• #expand_subs(subs, subject = nil) ⇒ Object

  Expand all groups in the subs list and return.

• #extract_passthroughs(text) ⇒ Object

  Extract the passthrough text from the document for reinsertion after processing.

• #highlight_source(source, process_callouts) ⇒ Object

  Highlight (i.e., colorize) the source code during conversion using a syntax highlighter, if activated by the source-highlighter document attribute.

• #resolve_block_subs(subs, defaults, subject) ⇒ Object

  Call resolve_subs for the :block type.

• #resolve_lines_to_highlight(source, spec, start = nil) ⇒ Array

  Resolve the line numbers in the specified source to highlight from the provided spec.

• #resolve_pass_subs(subs) ⇒ Object

  Call resolve_subs for the :inline type with the subject set as passthrough macro.

• #resolve_subs(subs, type = :block, defaults = nil, subject = nil) ⇒ An

  Resolve the list of comma-delimited subs against the possible options.

• #restore_passthroughs(text) ⇒ Object

  Restore the passthrough text by reinserting into the placeholder positions.

• #sub_attributes(text, opts = {}) ⇒ String

  Substitutes attribute references in the specified text.

• #sub_callouts(text) ⇒ Object

  Substitute callout source references.

• #sub_macros(text) ⇒ Object

  Substitute inline macros (e.g., links, images, etc).

• #sub_post_replacements(text) ⇒ Object

  Substitute post replacements.

• #sub_quotes(text) ⇒ Object

  Substitute quoted text (includes emphasis, strong, monospaced, etc.).

• #sub_replacements(text) ⇒ Object

  Substitute replacement characters (e.g., copyright, trademark, etc.).

• #sub_source(source, process_callouts) ⇒ Object

  Apply verbatim substitutions on source (for use when highlighting is disabled).

• #sub_specialchars(text) ⇒ Object (also: #sub_specialcharacters)

Instance Method Details

#apply_header_subs(text) ⇒ A

Apply substitutions for header metadata and attribute assignments

Parameters:

• text —

  String containing the text process

Returns:

• (A) —

  String with header substitutions performed

# File 'lib/asciidoctor/substitutors.rb', line 141

def apply_header_subs text
  apply_subs text, HEADER_SUBS
end

#apply_normal_subs(text) ⇒ Object

Apply normal substitutions.

An alias for apply_subs with default remaining arguments.

Parameters:

• text —

  The String text to which to apply normal substitutions

Returns:

• the String with normal substitutions applied.

# File 'lib/asciidoctor/substitutors.rb', line 132

def apply_normal_subs text
  apply_subs text, NORMAL_SUBS
end

#apply_reftext_subs(text) ⇒ Object

Apply substitutions for reftext.

Parameters:

• text —

  The String to process

Returns:

• a String with all substitutions from the reftext substitution group applied

# File 'lib/asciidoctor/substitutors.rb', line 157

def apply_reftext_subs text
  apply_subs text, REFTEXT_SUBS
end

#apply_subs(text, subs = NORMAL_SUBS) ⇒ Object Also known as: apply_title_subs

Apply the specified substitutions to the text.

Parameters:

• text —

  The String or String Array of text to process; must not be nil.

• subs (defaults to: NORMAL_SUBS) —

  The substitutions to perform; must be a Symbol Array or nil (default: NORMAL_SUBS).

Returns:

• a String or String Array to match the type of the text argument with substitutions applied.

# File 'lib/asciidoctor/substitutors.rb', line 75

def apply_subs text, subs = NORMAL_SUBS
  return text if text.empty? || !subs

  if (is_multiline = ::Array === text)
    text = text[1] ? (text.join LF) : text[0]
  end

  if subs.include? :macros
    text = extract_passthroughs text
    unless @passthroughs.empty?
      passthrus = @passthroughs
      # NOTE placeholders can move around, so we can only clear in the outermost substitution call
      @passthroughs_locked ||= (clear_passthrus = true)
    end
  end

  subs.each do |type|
    case type
    when :specialcharacters
      text = sub_specialchars text
    when :quotes
      text = sub_quotes text
    when :attributes
      text = sub_attributes text if text.include? ATTR_REF_HEAD
    when :replacements
      text = sub_replacements text
    when :macros
      text = sub_macros text
    when :highlight
      text = highlight_source text, (subs.include? :callouts)
    when :callouts
      text = sub_callouts text unless subs.include? :highlight
    when :post_replacements
      text = sub_post_replacements text
    else
      logger.warn %(unknown substitution type #{type})
    end
  end

  if passthrus
    text = restore_passthroughs text
    if clear_passthrus
      passthrus.clear
      @passthroughs_locked = nil
    end
  end

  is_multiline ? (text.split LF, -1) : text
end

#expand_subs(subs, subject = nil) ⇒ Object

Expand all groups in the subs list and return. If no subs are resolved, return nil.

Parameters:

• subs —

  The substitutions to expand; can be a Symbol, Symbol Array, or String

• subject (defaults to: nil) —

  The String to use in log messages to communicate the subject for which subs are being resolved (default: nil)

Returns:

• a Symbol Array of substitutions to pass to apply_subs or nil if no substitutions were resolved.

# File 'lib/asciidoctor/substitutors.rb', line 1256

def expand_subs subs, subject = nil
  case subs
  when ::Symbol
    subs == :none ? nil : SUB_GROUPS[subs] || [subs]
  when ::Array
    expanded_subs = []
    subs.each do |key|
      unless key == :none
        if (sub_group = SUB_GROUPS[key])
          expanded_subs += sub_group
        else
          expanded_subs << key
        end
      end
    end
    expanded_subs.empty? ? nil : expanded_subs
  else
    resolve_subs subs, :inline, nil, subject
  end
end

#extract_passthroughs(text) ⇒ Object

Extract the passthrough text from the document for reinsertion after processing.

Parameters:

• text —

  The String from which to extract passthrough fragments

Returns:

• the String text with passthrough regions substituted with placeholders

# File 'lib/asciidoctor/substitutors.rb', line 1019

def extract_passthroughs text
  compat_mode = @document.compat_mode
  passthrus = @passthroughs
  text = text.gsub InlinePassMacroRx do
    if (boundary = $4) # $$, ++, or +++
      # skip ++ in compat mode, handled as normal quoted text
      next %(#{$2 ? "#{$1}[#{$2}]#{$3}" : "#{$1}#{$3}"}++#{extract_passthroughs $5}++) if compat_mode && boundary == '++'

      if (attrlist = $2)
        if (escape_count = $3.length) > 0
          # NOTE we don't look for nested unconstrained pass macros
          next %(#{$1}[#{attrlist}]#{RS * (escape_count - 1)}#{boundary}#{$5}#{boundary})
        elsif $1 == RS
          preceding = %([#{attrlist}])
        elsif boundary == '++'
          if attrlist == 'x-'
            old_behavior = true
            attributes = {}
          elsif attrlist.end_with? ' x-'
            old_behavior = true
            attributes = parse_quoted_text_attributes attrlist.slice 0, attrlist.length - 3
          else
            attributes = parse_quoted_text_attributes attrlist
          end
        else
          attributes = parse_quoted_text_attributes attrlist
        end
      elsif (escape_count = $3.length) > 0
        # NOTE we don't look for nested unconstrained pass macros
        next %(#{RS * (escape_count - 1)}#{boundary}#{$5}#{boundary})
      end
      subs = (boundary == '+++' ? [] : BASIC_SUBS)

      if attributes
        if old_behavior
          passthrus[passthru_key = passthrus.size] = { text: $5, subs: NORMAL_SUBS, type: :monospaced, attributes: attributes }
        else
          passthrus[passthru_key = passthrus.size] = { text: $5, subs: subs, type: :unquoted, attributes: attributes }
        end
      else
        passthrus[passthru_key = passthrus.size] = { text: $5, subs: subs }
      end
    else # pass:[]
      # NOTE we don't look for nested pass:[] macros
      # honor the escape
      next $&.slice 1, $&.length if $6 == RS
      if (subs = $7)
        passthrus[passthru_key = passthrus.size] = { text: (normalize_text $8, nil, true), subs: (resolve_pass_subs subs) }
      else
        passthrus[passthru_key = passthrus.size] = { text: (normalize_text $8, nil, true) }
      end
    end

    %(#{preceding || ''}#{PASS_START}#{passthru_key}#{PASS_END})
  end if (text.include? '++') || (text.include? '$$') || (text.include? 'ss:')

  pass_inline_char1, pass_inline_char2, pass_inline_rx = InlinePassRx[compat_mode]
  text = text.gsub pass_inline_rx do
    preceding = $1
    attrlist = $4 || $3
    escaped = true if $5
    quoted_text = $6
    format_mark = $7
    content = $8

    if compat_mode
      old_behavior = true
    elsif attrlist && (attrlist == 'x-' || (attrlist.end_with? ' x-'))
      old_behavior = old_behavior_forced = true
    end

    if attrlist
      if escaped
        # honor the escape of the formatting mark
        next %(#{preceding}[#{attrlist}]#{quoted_text.slice 1, quoted_text.length})
      elsif preceding == RS
        # honor the escape of the attributes
        next %(#{preceding}[#{attrlist}]#{quoted_text}) if old_behavior_forced && format_mark == '`'
        preceding = %([#{attrlist}])
      elsif old_behavior_forced
        attributes = attrlist == 'x-' ? {} : (parse_quoted_text_attributes attrlist.slice 0, attrlist.length - 3)
      else
        attributes = parse_quoted_text_attributes attrlist
      end
    elsif escaped
      # honor the escape of the formatting mark
      next %(#{preceding}#{quoted_text.slice 1, quoted_text.length})
    elsif compat_mode && preceding == RS
      next quoted_text
    end

    if compat_mode
      passthrus[passthru_key = passthrus.size] = { text: content, subs: BASIC_SUBS, attributes: attributes, type: :monospaced }
    elsif attributes
      if old_behavior
        subs = format_mark == '`' ? BASIC_SUBS : NORMAL_SUBS
        passthrus[passthru_key = passthrus.size] = { text: content, subs: subs, attributes: attributes, type: :monospaced }
      else
        passthrus[passthru_key = passthrus.size] = { text: content, subs: BASIC_SUBS, attributes: attributes, type: :unquoted }
      end
    else
      passthrus[passthru_key = passthrus.size] = { text: content, subs: BASIC_SUBS }
    end

    %(#{preceding}#{PASS_START}#{passthru_key}#{PASS_END})
  end if (text.include? pass_inline_char1) || (pass_inline_char2 && (text.include? pass_inline_char2))

  # NOTE we need to do the stem in a subsequent step to allow it to be escaped by the former
  text = text.gsub InlineStemMacroRx do
    # honor the escape
    next $&.slice 1, $&.length if $&.start_with? RS

    if (type = $1.to_sym) == :stem
      type = STEM_TYPE_ALIASES[@document.attributes['stem']].to_sym
    end
    subs = $2
    content = normalize_text $3, nil, true
    # NOTE drop enclosing $ signs around latexmath for backwards compatibility with AsciiDoc.py
    content = content.slice 1, content.length - 2 if type == :latexmath && (content.start_with? '$') && (content.end_with? '$')
    subs = subs ? (resolve_pass_subs subs) : ((@document.basebackend? 'html') ? BASIC_SUBS : nil)
    passthrus[passthru_key = passthrus.size] = { text: content, subs: subs, type: type }
    %(#{PASS_START}#{passthru_key}#{PASS_END})
  end if (text.include? ':') && ((text.include? 'stem:') || (text.include? 'math:'))

  text
end

#highlight_source(source, process_callouts) ⇒ Object

Highlight (i.e., colorize) the source code during conversion using a syntax highlighter, if activated by the source-highlighter document attribute. Otherwise return the text with verbatim substitutions applied.

If the process_callouts argument is true, this method will extract the callout marks from the source before passing it to the syntax highlighter, then subsequently restore those callout marks to the highlighted source so the callout marks don’t confuse the syntax highlighter.

Parameters:

• source —

  the source code String to syntax highlight

• process_callouts —

  a Boolean flag indicating whether callout marks should be located and substituted

Returns:

• the highlighted source code, if a syntax highlighter is defined on the document, otherwise the source with verbatim substitutions applied

# File 'lib/asciidoctor/substitutors.rb', line 947

def highlight_source source, process_callouts
  # NOTE the call to highlight? is a defensive check since, normally, we wouldn't arrive here unless it returns true
  return sub_source source, process_callouts unless (syntax_hl = @document.syntax_highlighter) && syntax_hl.highlight?

  source, callout_marks = extract_callouts source if process_callouts

  doc_attrs = @document.attributes
  syntax_hl_name = syntax_hl.name
  if (linenums_mode = (attr? 'linenums') ? (doc_attrs[%(#{syntax_hl_name}-linenums-mode)] || :table).to_sym : nil) &&
      (start_line_number = (attr 'start', 1).to_i) < 1
    start_line_number = 1
  end
  highlight_lines = resolve_lines_to_highlight source, (attr 'highlight'), start_line_number if attr? 'highlight'

  highlighted, source_offset = syntax_hl.highlight self, source, (attr 'language'),
    callouts: callout_marks,
    css_mode: (doc_attrs[%(#{syntax_hl_name}-css)] || :class).to_sym,
    highlight_lines: highlight_lines,
    number_lines: linenums_mode,
    start_line_number: start_line_number,
    style: doc_attrs[%(#{syntax_hl_name}-style)]

  # fix passthrough placeholders that got caught up in syntax highlighting
  highlighted = highlighted.gsub HighlightedPassSlotRx, %(#{PASS_START}\\1#{PASS_END}) unless @passthroughs.empty?

  # NOTE highlight method may have depleted callouts
  callout_marks.nil_or_empty? ? highlighted : (restore_callouts highlighted, callout_marks, source_offset)
end

#resolve_block_subs(subs, defaults, subject) ⇒ Object

Call resolve_subs for the :block type.

# File 'lib/asciidoctor/substitutors.rb', line 1241

def resolve_block_subs subs, defaults, subject
  resolve_subs subs, :block, defaults, subject
end

#resolve_lines_to_highlight(source, spec, start = nil) ⇒ Array

Resolve the line numbers in the specified source to highlight from the provided spec.

e.g., highlight=“1-5, !2, 10” or highlight=1-5;!2,10

Parameters:

• source —

  The String source.

• spec —

  The lines specifier (e.g., “1-5, !2, 10” or “1..5;!2;10”)

• start (defaults to: nil) —

  The line number of the first line (optional, default: false)

Returns:

• (Array) —

  Returns an Array of unique, sorted line numbers.

# File 'lib/asciidoctor/substitutors.rb', line 985

def resolve_lines_to_highlight source, spec, start = nil
  lines = []
  spec = spec.delete ' ' if spec.include? ' '
  ((spec.include? ',') ? (spec.split ',') : (spec.split ';')).map do |entry|
    if entry.start_with? '!'
      entry = entry.slice 1, entry.length
      negate = true
    end
    if (delim = (entry.include? '..') ? '..' : ((entry.include? '-') ? '-' : nil))
      from, _, to = entry.partition delim
      to = (source.count LF) + 1 if to.empty? || (to = to.to_i) < 0
      if negate
        lines -= (from.to_i..to).to_a
      else
        lines |= (from.to_i..to).to_a
      end
    elsif negate
      lines.delete entry.to_i
    elsif !lines.include?(line = entry.to_i)
      lines << line
    end
  end
  # If the start attribute is defined, then the lines to highlight specified by the provided spec should be relative to the start value.
  unless (shift = start ? start - 1 : 0) == 0
    lines = lines.map {|it| it - shift }
  end
  lines.sort
end

#resolve_pass_subs(subs) ⇒ Object

Call resolve_subs for the :inline type with the subject set as passthrough macro.

# File 'lib/asciidoctor/substitutors.rb', line 1246

def resolve_pass_subs subs
  resolve_subs subs, :inline, nil, 'passthrough macro'
end

#resolve_subs(subs, type = :block, defaults = nil, subject = nil) ⇒ An

Resolve the list of comma-delimited subs against the possible options.

Parameters:

• subs —

  The comma-delimited String of substitution names or aliases.

• type (defaults to: :block) —

  A Symbol representing the context for which the subs are being resolved (default: :block).

• defaults (defaults to: nil) —

  An Array of substitutions to start with when computing incremental substitutions (default: nil).

• subject (defaults to: nil) —

  The String to use in log messages to communicate the subject for which subs are being resolved (default: nil)

Returns:

• (An) —

  Array of Symbols representing the substitution operation or nothing if no subs are found.

# File 'lib/asciidoctor/substitutors.rb', line 1178

def resolve_subs subs, type = :block, defaults = nil, subject = nil
  return if subs.nil_or_empty?
  # QUESTION should we store candidates as a Set instead of an Array?
  candidates = nil
  subs = subs.delete ' ' if subs.include? ' '
  modifiers_present = SubModifierSniffRx.match? subs
  subs.split(',').each do |key|
    modifier_operation = nil
    if modifiers_present
      if (first = key.chr) == '+'
        modifier_operation = :append
        key = key.slice 1, key.length
      elsif first == '-'
        modifier_operation = :remove
        key = key.slice 1, key.length
      elsif key.end_with? '+'
        modifier_operation = :prepend
        key = key.chop
      end
    end
    key = key.to_sym
    # special case to disable callouts for inline subs
    if type == :inline && (key == :verbatim || key == :v)
      resolved_keys = BASIC_SUBS
    elsif SUB_GROUPS.key? key
      resolved_keys = SUB_GROUPS[key]
    elsif type == :inline && key.length == 1 && (SUB_HINTS.key? key)
      resolved_key = SUB_HINTS[key]
      if (candidate = SUB_GROUPS[resolved_key])
        resolved_keys = candidate
      else
        resolved_keys = [resolved_key]
      end
    else
      resolved_keys = [key]
    end

    if modifier_operation
      candidates ||= (defaults ? (defaults.drop 0) : [])
      case modifier_operation
      when :append
        candidates += resolved_keys
      when :prepend
        candidates = resolved_keys + candidates
      when :remove
        candidates -= resolved_keys
      end
    else
      candidates ||= []
      candidates += resolved_keys
    end
  end
  return unless candidates
  # weed out invalid options and remove duplicates (order is preserved; first occurrence wins)
  resolved = candidates & SUB_OPTIONS[type]
  unless (candidates - resolved).empty?
    invalid = candidates - resolved
    logger.warn %(invalid substitution type#{invalid.size > 1 ? 's' : ''}#{subject ? ' for ' : ''}#{subject}: #{invalid.join ', '})
  end
  resolved
end

#restore_passthroughs(text) ⇒ Object

Restore the passthrough text by reinserting into the placeholder positions

Parameters:

• text —

  The String text into which to restore the passthrough text

• returns —

  The String text with the passthrough text restored

# File 'lib/asciidoctor/substitutors.rb', line 1151

def restore_passthroughs text
  passthrus = @passthroughs
  text.gsub PassSlotRx do
    if (pass = passthrus[$1.to_i])
      subbed_text = apply_subs(pass[:text], pass[:subs])
      if (type = pass[:type])
        if (attributes = pass[:attributes])
          id = attributes['id']
        end
        subbed_text = Inline.new(self, :quoted, subbed_text, type: type, id: id, attributes: attributes).convert
      end
      subbed_text.include?(PASS_START) ? restore_passthroughs(subbed_text) : subbed_text
    else
      logger.error %(unresolved passthrough detected: #{text})
      '??pass??'
    end
  end
end

#sub_attributes(text, opts = {}) ⇒ String

Substitutes attribute references in the specified text

Attribute references are in the format {name}.

If an attribute referenced in the line is missing or undefined, the line may be dropped based on the attribute-missing or attribute-undefined setting, respectively.

Parameters:

• text —

  The String text to process

• opts (defaults to: {}) —

  A Hash of options to control processing: (default: {}) * :attribute_missing controls how to handle a missing attribute (see Compliance.attribute_missing for values) * :drop_line_severity the severity level at which to log a dropped line (:info or :ignore)

Returns:

• (String) —

  Returns the String text with the attribute references replaced with resolved values

# File 'lib/asciidoctor/substitutors.rb', line 211

def sub_attributes text, opts = {}
  doc_attrs = @document.attributes
  drop = drop_line = drop_line_severity = drop_empty_line = attribute_undefined = attribute_missing = nil
  text = text.gsub AttributeReferenceRx do
    # escaped attribute, return unescaped
    if $1 == RS || $4 == RS
      %({#{$2}})
    elsif $3
      case (args = $2.split ':', 3).shift
      when 'set'
        _, value = Parser.store_attribute args[0], args[1] || '', @document
        # NOTE since this is an assignment, only drop-line applies here (skip and drop imply the same result)
        if value || (attribute_undefined ||= (doc_attrs['attribute-undefined'] || Compliance.attribute_undefined)) != 'drop-line'
          drop = drop_empty_line = DEL
        else
          drop = drop_line = CAN
        end
      when 'counter2'
        @document.counter(*args)
        drop = drop_empty_line = DEL
      else # 'counter'
        @document.counter(*args)
      end
    elsif doc_attrs.key?(key = $2.downcase)
      doc_attrs[key]
    elsif (value = INTRINSIC_ATTRIBUTES[key])
      value
    else
      case (attribute_missing ||= (opts[:attribute_missing] || doc_attrs['attribute-missing'] || Compliance.attribute_missing))
      when 'drop'
        drop = drop_empty_line = DEL
      when 'drop-line'
        if (drop_line_severity ||= (opts[:drop_line_severity] || :info)) == :info
          logger.info { %(dropping line containing reference to missing attribute: #{key}) }
        #elsif drop_line_severity == :warn
        #  logger.warn %(dropping line containing reference to missing attribute: #{key})
        end
        drop = drop_line = CAN
      when 'warn'
        logger.warn %(skipping reference to missing attribute: #{key})
        $&
      else # 'skip'
        $&
      end
    end
  end

  if drop
    # drop lines from text
    if drop_empty_line
      lines = (text.squeeze DEL).split LF, -1
      if drop_line
        (lines.reject {|line| line == DEL || line == CAN || (line.start_with? CAN) || (line.include? CAN) }.join LF).delete DEL
      else
        (lines.reject {|line| line == DEL }.join LF).delete DEL
      end
    elsif text.include? LF
      (text.split LF, -1).reject {|line| line == CAN || (line.start_with? CAN) || (line.include? CAN) }.join LF
    else
      ''
    end
  else
    text
  end
end

#sub_callouts(text) ⇒ Object

Substitute callout source references

Parameters:

• text —

  The String text to process

Returns:

• the converted String text

# File 'lib/asciidoctor/substitutors.rb', line 921

def sub_callouts text
  callout_rx = (attr? 'line-comment') ? CalloutSourceRxMap[attr 'line-comment'] : CalloutSourceRx
  autonum = 0
  text.gsub callout_rx do
    # honor the escape
    if $2
      # use sub since it might be behind a line comment
      $&.sub RS, ''
    else
      Inline.new(self, :callout, $4 == '.' ? (autonum += 1).to_s : $4, id: @document.callouts.read_next_id, attributes: { 'guard' => $1 || ($3 == '--' ? ['<!--', '-->'] : nil) }).convert
    end
  end
end

#sub_macros(text) ⇒ Object

Substitute inline macros (e.g., links, images, etc)

Replace inline macros, which may span multiple lines, in the provided text

Parameters:

• source —

  The String text to process

• returns —

  The converted String text

# File 'lib/asciidoctor/substitutors.rb', line 296

def sub_macros text
  #return text if text.nil_or_empty?
  # some look ahead assertions to cut unnecessary regex calls
  found_square_bracket = text.include? '['
  found_colon = text.include? ':'
  found_macroish = found_square_bracket && found_colon
  found_macroish_short = found_macroish && (text.include? ':[')
  doc_attrs = (doc = @document).attributes

  # TODO allow position of substitution to be controlled (before or after other macros)
  # TODO this handling needs some cleanup
  if (extensions = doc.extensions) && extensions.inline_macros? # && found_macroish
    extensions.inline_macros.each do |extension|
      text = text.gsub extension.instance.regexp do
        # honor the escape
        next $&.slice 1, $&.length if (match = $&).start_with? RS
        if $~.names.empty?
          target, content = $1, $2
        else
          target, content = ($~[:target] rescue nil), ($~[:content] rescue nil)
        end
        attributes = (default_attrs = (ext_config = extension.config)[:default_attrs]) ? default_attrs.merge : {}
        if content
          if content.empty?
            attributes['text'] = content unless ext_config[:content_model] == :attributes
          else
            content = normalize_text content, true, true
            # QUESTION should we store the unparsed attrlist in the attrlist key?
            if ext_config[:content_model] == :attributes
              parse_attributes content, ext_config[:positional_attrs] || ext_config[:pos_attrs] || [], into: attributes
            else
              attributes['text'] = content
            end
          end
          # NOTE for convenience, map content (unparsed attrlist) to target when format is short
          target ||= ext_config[:format] == :short ? content : target
        end
        if Inline === (replacement = extension.process_method[self, target, attributes])
          if (inline_subs = replacement.attributes.delete 'subs') && (inline_subs = expand_subs inline_subs, 'custom inline macro')
            replacement.text = apply_subs replacement.text, inline_subs
          end
          replacement.convert
        elsif replacement
          logger.info { %(expected substitution value for custom inline macro to be of type Inline; got #{replacement.class}: #{match}) }
          replacement
        else
          ''
        end
      end
    end
  end

  if doc_attrs.key? 'experimental'
    if found_macroish_short && ((text.include? 'kbd:') || (text.include? 'btn:'))
      text = text.gsub InlineKbdBtnMacroRx do
        # honor the escape
        if $1
          $&.slice 1, $&.length
        elsif $2 == 'kbd'
          if (keys = $3.strip).include? R_SB
            keys = keys.gsub ESC_R_SB, R_SB
          end
          if keys.length > 1 && (delim_idx = (delim_idx = keys.index ',', 1) ?
              [delim_idx, (keys.index '+', 1)].compact.min : (keys.index '+', 1))
            delim = keys.slice delim_idx, 1
            # NOTE handle special case where keys ends with delimiter (e.g., Ctrl++ or Ctrl,,)
            if keys.end_with? delim
              keys = (keys.chop.split delim, -1).map {|key| key.strip }
              keys[-1] += delim
            else
              keys = keys.split(delim).map {|key| key.strip }
            end
          else
            keys = [keys]
          end
          (Inline.new self, :kbd, nil, attributes: { 'keys' => keys }).convert
        else # $2 == 'btn'
          (Inline.new self, :button, (normalize_text $3, true, true)).convert
        end
      end
    end

    if found_macroish && (text.include? 'menu:')
      text = text.gsub InlineMenuMacroRx do
        # honor the escape
        next $&.slice 1, $&.length if $&.start_with? RS

        menu = $1
        if (items = $2)
          items = items.gsub ESC_R_SB, R_SB if items.include? R_SB
          if (delim = items.include?('>') ? '>' : (items.include?(',') ? ',' : nil))
            submenus = items.split(delim).map {|it| it.strip }
            menuitem = submenus.pop
          else
            submenus, menuitem = [], items.rstrip
          end
        else
          submenus, menuitem = [], nil
        end

        Inline.new(self, :menu, nil, attributes: { 'menu' => menu, 'submenus' => submenus, 'menuitem' => menuitem }).convert
      end
    end

    if (text.include? '"') && (text.include? '>')
      text = text.gsub InlineMenuRx do
        # honor the escape
        next $&.slice 1, $&.length if $&.start_with? RS

        menu, *submenus = $1.split('>').map {|it| it.strip }
        menuitem = submenus.pop
        Inline.new(self, :menu, nil, attributes: { 'menu' => menu, 'submenus' => submenus, 'menuitem' => menuitem }).convert
      end
    end
  end

  if found_macroish && ((text.include? 'image:') || (text.include? 'icon:'))
    # image:filename.png[Alt Text]
    text = text.gsub InlineImageMacroRx do
      # honor the escape
      if $&.start_with? RS
        next $&.slice 1, $&.length
      elsif $&.start_with? 'icon:'
        type, posattrs = 'icon', ['size']
      else
        type, posattrs = 'image', ['alt', 'width', 'height']
      end
      target = $1
      attrs = parse_attributes $2, posattrs, unescape_input: true
      unless type == 'icon'
        doc.register :images, target
        attrs['imagesdir'] = doc_attrs['imagesdir']
      end
      attrs['alt'] ||= (attrs['default-alt'] = Helpers.basename(target, true).tr('_-', ' '))
      Inline.new(self, :image, nil, type: type, target: target, attributes: attrs).convert
    end
  end

  if ((text.include? '((') && (text.include? '))')) || (found_macroish_short && (text.include? 'dexterm'))
    # (((Tigers,Big cats)))
    # indexterm:[Tigers,Big cats]
    # ((Tigers))
    # indexterm2:[Tigers]
    text = text.gsub InlineIndextermMacroRx do
      case $1
      when 'indexterm'
        # honor the escape
        next $&.slice 1, $&.length if $&.start_with? RS

        # indexterm:[Tigers,Big cats]
        if (attrlist = normalize_text $2, true, true).include? '='
          if (primary = (attrs = (AttributeList.new attrlist, self).parse)[1])
            terms = [primary]
            if (secondary = attrs[2])
              terms << secondary
              if (tertiary = attrs[3])
                terms << tertiary
              end
            end
            attrs['terms'] = terms
            if (see_also = attrs['see-also'])
              attrs['see-also'] = (see_also.include? ',') ? (see_also.split ',').map {|it| it.lstrip } : [see_also]
            end
          else
            attrs = { 'terms' => attrlist }
          end
        else
          attrs = { 'terms' => (split_simple_csv attrlist) }
        end
        (Inline.new self, :indexterm, nil, attributes: attrs).convert
      when 'indexterm2'
        # honor the escape
        next $&.slice 1, $&.length if $&.start_with? RS

        # indexterm2:[Tigers]
        if (term = normalize_text $2, true, true).include? '='
          term = (attrs = (AttributeList.new term, self).parse)[1] || (attrs = nil) || term
          if attrs && (see_also = attrs['see-also'])
            attrs['see-also'] = (see_also.include? ',') ? (see_also.split ',').map {|it| it.lstrip } : [see_also]
          end
        end
        (Inline.new self, :indexterm, term, attributes: attrs, type: :visible).convert
      else
        encl_text = $3
        # honor the escape
        if $&.start_with? RS
          # escape concealed index term, but process nested flow index term
          if (encl_text.start_with? '(') && (encl_text.end_with? ')')
            encl_text = encl_text.slice 1, encl_text.length - 2
            visible, before, after = true, '(', ')'
          else
            next $&.slice 1, $&.length
          end
        else
          visible = true
          if encl_text.start_with? '('
            if encl_text.end_with? ')'
              encl_text, visible = (encl_text.slice 1, encl_text.length - 2), false
            else
              encl_text, before, after = (encl_text.slice 1, encl_text.length), '(', ''
            end
          elsif encl_text.end_with? ')'
            encl_text, before, after = encl_text.chop, '', ')'
          end
        end
        if visible
          # ((Tigers))
          if (term = normalize_text encl_text, true).include? ';&'
            if term.include? ' &gt;&gt; '
              term, _, see = term.partition ' &gt;&gt; '
              attrs = { 'see' => see }
            elsif term.include? ' &amp;&gt; '
              term, *see_also = term.split ' &amp;&gt; '
              attrs = { 'see-also' => see_also }
            end
          end
          subbed_term = (Inline.new self, :indexterm, term, attributes: attrs, type: :visible).convert
        else
          # (((Tigers,Big cats)))
          attrs = {}
          if (terms = normalize_text encl_text, true).include? ';&'
            if terms.include? ' &gt;&gt; '
              terms, _, see = terms.partition ' &gt;&gt; '
              attrs['see'] = see
            elsif terms.include? ' &amp;&gt; '
              terms, *see_also = terms.split ' &amp;&gt; '
              attrs['see-also'] = see_also
            end
          end
          attrs['terms'] = split_simple_csv terms
          subbed_term = (Inline.new self, :indexterm, nil, attributes: attrs).convert
        end
        before ? %(#{before}#{subbed_term}#{after}) : subbed_term
      end
    end
  end

  if found_colon && (text.include? '://')
    # inline urls, target[text] (optionally prefixed with link: or enclosed in <>)
    text = text.gsub InlineLinkRx do
      if $2 && !$5
        # honor the escapes
        next $&.slice 1, $&.length if $1.start_with? RS
        next %(#{$1}#{$&.slice $1.length + 1, $&.length}) if $3.start_with? RS
        target = $3 + $6
        next $& if target == $3
        doc.register :links, target
        link_text = (doc_attrs.key? 'hide-uri-scheme') ? (target.sub UriSniffRx, '') : target
        (Inline.new self, :anchor, link_text, type: :link, target: target, attributes: { 'role' => 'bare' }).convert
      else
        # honor the escape
        next %(#{$1}#{$&.slice $1.length + 1, $&.length}) if $3.start_with? RS
        prefix, target, suffix = $1, $3 + ($4 || $7), ''
        # NOTE if $5 is set (the attrlist), we're looking at a formal macro (e.g., https://example.org[])
        if $5
          prefix = '' if prefix == 'link:'
          link_text = nil if (link_text = $5).empty?
        else
          case prefix
          # invalid macro syntax (link: prefix w/o trailing square brackets or URL enclosed in quotes)
          # FIXME we probably shouldn't even get here when the link: prefix is present; the regex is doing too much
          when 'link:', ?", ?'
            next $&
          end
          case $8
          when ';'
            if (target = target.chop).end_with? ')'
              # move trailing ); out of URL
              target = target.chop
              suffix = ');'
            else
              # move trailing ; out of URL
              suffix = ';'
            end
            # NOTE handle case when modified target is a bare URI scheme (e.g., http://)
            next $& if target == $3
          when ':'
            if (target = target.chop).end_with? ')'
              # move trailing ): out of URL
              target = target.chop
              suffix = '):'
            else
              # move trailing : out of URL
              suffix = ':'
            end
            # NOTE handle case when modified target is a bare URI scheme (e.g., http://)
            next $& if target == $3
          end
        end

        link_opts = { type: :link }

        if link_text
          new_link_text = link_text = link_text.gsub ESC_R_SB, R_SB if link_text.include? R_SB
          if !doc.compat_mode && (link_text.include? '=')
            # NOTE if an equals sign (=) is present, extract attributes from link text
            link_text, attrs = extract_attributes_from_text link_text, ''
            new_link_text = link_text
            link_opts[:id] = attrs['id']
          end

          if link_text.end_with? '^'
            new_link_text = link_text = link_text.chop
            if attrs
              attrs['window'] ||= '_blank'
            else
              attrs = { 'window' => '_blank' }
            end
          end

          if new_link_text && new_link_text.empty?
            # NOTE the modified target will not be a bare URI scheme (e.g., http://) in this case
            link_text = (doc_attrs.key? 'hide-uri-scheme') ? (target.sub UriSniffRx, '') : target
            bare = true
          end
        else
          # NOTE the modified target will not be a bare URI scheme (e.g., http://) in this case
          link_text = (doc_attrs.key? 'hide-uri-scheme') ? (target.sub UriSniffRx, '') : target
          bare = true
        end

        if bare
          if attrs
            attrs['role'] = (attrs.key? 'role') ? %(bare #{attrs['role']}) : 'bare'
          else
            attrs = { 'role' => 'bare' }
          end
        end

        doc.register :links, (link_opts[:target] = target)
        link_opts[:attributes] = attrs if attrs
        %(#{prefix}#{(Inline.new self, :anchor, link_text, link_opts).convert}#{suffix})
      end
    end
  end

  if found_macroish && ((text.include? 'link:') || (text.include? 'ilto:'))
    # inline link macros, link:target[text]
    text = text.gsub InlineLinkMacroRx do
      # honor the escape
      if $&.start_with? RS
        next $&.slice 1, $&.length
      elsif (mailto = $1)
        target = 'mailto:' + (mailto_text = $2)
      else
        target = $2
      end
      attrs, link_opts = nil, { type: :link }
      unless (link_text = $3).empty?
        link_text = link_text.gsub ESC_R_SB, R_SB if link_text.include? R_SB
        if mailto
          if !doc.compat_mode && (link_text.include? ',')
            # NOTE if a comma (,) is present, extract attributes from link text
            link_text, attrs = extract_attributes_from_text link_text, ''
            link_opts[:id] = attrs['id']
            if attrs.key? 2
              if attrs.key? 3
                target = %(#{target}?subject=#{Helpers.encode_uri_component attrs[2]}&amp;body=#{Helpers.encode_uri_component attrs[3]})
              else
                target = %(#{target}?subject=#{Helpers.encode_uri_component attrs[2]})
              end
            end
          end
        elsif !doc.compat_mode && (link_text.include? '=')
          # NOTE if an equals sign (=) is present, extract attributes from link text
          link_text, attrs = extract_attributes_from_text link_text, ''
          link_opts[:id] = attrs['id']
        end

        if link_text.end_with? '^'
          link_text = link_text.chop
          if attrs
            attrs['window'] ||= '_blank'
          else
            attrs = { 'window' => '_blank' }
          end
        end
      end

      if link_text.empty?
        # mailto is a special case, already processed
        if mailto
          link_text = mailto_text
        else
          if doc_attrs.key? 'hide-uri-scheme'
            if (link_text = target.sub UriSniffRx, '').empty?
              link_text = target
            end
          else
            link_text = target
          end
          if attrs
            attrs['role'] = (attrs.key? 'role') ? %(bare #{attrs['role']}) : 'bare'
          else
            attrs = { 'role' => 'bare' }
          end
        end
      end

      # QUESTION should a mailto be registered as an e-mail address?
      doc.register :links, (link_opts[:target] = target)
      link_opts[:attributes] = attrs if attrs
      Inline.new(self, :anchor, link_text, link_opts).convert
    end
  end

  if text.include? '@'
    text = text.gsub InlineEmailRx do
      # honor the escape
      next $1 == RS ? ($&.slice 1, $&.length) : $& if $1

      target = 'mailto:' + (address = $&)
      # QUESTION should this be registered as an e-mail address?
      doc.register(:links, target)

      Inline.new(self, :anchor, address, type: :link, target: target).convert
    end
  end

  if found_square_bracket && @context == :list_item && @parent.style == 'bibliography'
    text = text.sub(InlineBiblioAnchorRx) { (Inline.new self, :anchor, $2, type: :bibref, id: $1).convert }
  end

  if (found_square_bracket && text.include?('[[')) || (found_macroish && text.include?('or:'))
    text = text.gsub InlineAnchorRx do
      # honor the escape
      next $&.slice 1, $&.length if $1

      # NOTE reftext is only relevant for DocBook output; used as value of xreflabel attribute
      if (id = $2)
        reftext = $3
      else
        id = $4
        if (reftext = $5) && (reftext.include? R_SB)
          reftext = reftext.gsub ESC_R_SB, R_SB
        end
      end
      Inline.new(self, :anchor, reftext, type: :ref, id: id).convert
    end
  end

  #if (text.include? ';&l') || (found_macroish && (text.include? 'xref:'))
  if ((text.include? '&') && (text.include? ';&l')) || (found_macroish && (text.include? 'xref:'))
    text = text.gsub InlineXrefMacroRx do
      # honor the escape
      next $&.slice 1, $&.length if $&.start_with? RS

      attrs = {}
      if (refid = $1)
        if refid.include? ','
          refid, _, link_text = refid.partition ','
          link_text = nil if (link_text = link_text.lstrip).empty?
        end
      else
        macro = true
        refid = $2
        if (link_text = $3)
          link_text = link_text.gsub ESC_R_SB, R_SB if link_text.include? R_SB
          # NOTE if an equals sign (=) is present, extract attributes from link text
          link_text, attrs = extract_attributes_from_text link_text if !doc.compat_mode && (link_text.include? '=')
        end
      end

      if doc.compat_mode
        fragment = refid
      elsif (hash_idx = refid.index '#') && refid[hash_idx - 1] != '&'
        if hash_idx > 0
          if (fragment_len = refid.length - 1 - hash_idx) > 0
            path, fragment = (refid.slice 0, hash_idx), (refid.slice hash_idx + 1, fragment_len)
          else
            path = refid.chop
          end
          if macro
            if path.end_with? '.adoc'
              src2src = path = path.slice 0, path.length - 5
            elsif !(Helpers.extname? path)
              src2src = path
            end
          elsif path.end_with?(*ASCIIDOC_EXTENSIONS.keys)
            src2src = path = path.slice 0, (path.rindex '.')
          else
            src2src = path
          end
        else
          target, fragment = refid, (refid.slice 1, refid.length)
        end
      elsif macro
        if refid.end_with? '.adoc'
          src2src = path = refid.slice 0, refid.length - 5
        elsif Helpers.extname? refid
          path = refid
        else
          fragment = refid
        end
      else
        fragment = refid
      end

      # handles: #id
      if target
        refid = fragment
        logger.info %(possible invalid reference: #{refid}) if logger.info? && !doc.catalog[:refs][refid]
      elsif path
        # handles: path#, path#id, path.adoc#, path.adoc#id, or path.adoc (xref macro only)
        # the referenced path is the current document, or its contents have been included in the current document
        if src2src && (doc.attributes['docname'] == path || doc.catalog[:includes][path])
          if fragment
            refid, path, target = fragment, nil, %(##{fragment})
            logger.info %(possible invalid reference: #{refid}) if logger.info? && !doc.catalog[:refs][refid]
          else
            refid, path, target = nil, nil, '#'
          end
        else
          refid, path = path, %(#{doc.attributes['relfileprefix'] || ''}#{path}#{src2src ? (doc.attributes.fetch 'relfilesuffix', doc.outfilesuffix) : ''})
          if fragment
            refid, target = %(#{refid}##{fragment}), %(#{path}##{fragment})
          else
            target = path
          end
        end
      # handles: id (in compat mode or when natural xrefs are disabled)
      elsif doc.compat_mode || !Compliance.natural_xrefs
        refid, target = fragment, %(##{fragment})
        logger.info %(possible invalid reference: #{refid}) if logger.info? && !doc.catalog[:refs][refid]
      # handles: id
      elsif doc.catalog[:refs][fragment]
        refid, target = fragment, %(##{fragment})
      # handles: Node Title or Reference Text
      # do reverse lookup on fragment if not a known ID and resembles reftext (contains a space or uppercase char)
      elsif ((fragment.include? ' ') || fragment.downcase != fragment) && (refid = doc.resolve_id fragment)
        fragment, target = refid, %(##{refid})
      else
        refid, target = fragment, %(##{fragment})
        logger.info %(possible invalid reference: #{refid}) if logger.info?
      end
      attrs['path'] = path
      attrs['fragment'] = fragment
      attrs['refid'] = refid
      Inline.new(self, :anchor, link_text, type: :xref, target: target, attributes: attrs).convert
    end
  end

  if found_macroish && (text.include? 'tnote')
    text = text.gsub InlineFootnoteMacroRx do
      # honor the escape
      next $&.slice 1, $&.length if $&.start_with? RS

      # footnoteref
      if $1
        if $3
          id, content = $3.split ',', 2
          logger.warn %(found deprecated footnoteref macro: #{$&}; use footnote macro with target instead) unless doc.compat_mode
        else
          next $&
        end
      # footnote
      else
        id = $2
        content = $3
      end

      if id
        if (footnote = doc.footnotes.find {|candidate| candidate.id == id })
          index, content = footnote.index, footnote.text
          type, target, id = :xref, id, nil
        elsif content
          content = restore_passthroughs(normalize_text content, true, true)
          index = doc.counter('footnote-number')
          doc.register(:footnotes, Document::Footnote.new(index, id, content))
          type, target = :ref, nil
        else
          logger.warn %(invalid footnote reference: #{id})
          type, target, content, id = :xref, id, id, nil
        end
      elsif content
        content = restore_passthroughs(normalize_text content, true, true)
        index = doc.counter('footnote-number')
        doc.register(:footnotes, Document::Footnote.new(index, id, content))
        type = target = nil
      else
        next $&
      end
      Inline.new(self, :footnote, content, attributes: { 'index' => index }, id: id, target: target, type: type).convert
    end
  end

  text
end

#sub_post_replacements(text) ⇒ Object

Substitute post replacements

Parameters:

• text —

  The String text to process

Returns:

• the converted String text

# File 'lib/asciidoctor/substitutors.rb', line 890

def sub_post_replacements text
  #if attr? 'hardbreaks-option', nil, true
  if @attributes['hardbreaks-option'] || @document.attributes['hardbreaks-option']
    lines = text.split LF, -1
    return text if lines.size < 2
    last = lines.pop
    (lines.map do |line|
      Inline.new(self, :break, (line.end_with? HARD_LINE_BREAK) ? (line.slice 0, line.length - 2) : line, type: :line).convert
    end << last).join LF
  elsif (text.include? PLUS) && (text.include? HARD_LINE_BREAK)
    text.gsub(HardLineBreakRx) { Inline.new(self, :break, $1, type: :line).convert }
  else
    text
  end
end

#sub_quotes(text) ⇒ Object

Substitute quoted text (includes emphasis, strong, monospaced, etc.)

Parameters:

• text —

  The String text to process

• returns —

  The converted [String] text

# File 'lib/asciidoctor/substitutors.rb', line 189

def sub_quotes text
  if QuotedTextSniffRx[compat = @document.compat_mode].match? text
    QUOTE_SUBS[compat].each do |type, scope, pattern|
      text = text.gsub(pattern) { convert_quoted_text $~, type, scope }
    end
  end
  text
end

#sub_replacements(text) ⇒ Object

Substitute replacement characters (e.g., copyright, trademark, etc.)

Parameters:

• text —

  The String text to process

• returns —

  The [String] text with the replacement characters substituted

# File 'lib/asciidoctor/substitutors.rb', line 282

def sub_replacements text
  REPLACEMENTS.each do |pattern, replacement, restore|
    text = text.gsub(pattern) { do_replacement $~, replacement, restore }
  end if ReplaceableTextRx.match? text
  text
end

#sub_source(source, process_callouts) ⇒ Object

Apply verbatim substitutions on source (for use when highlighting is disabled).

Parameters:

• source —

  the source code String on which to apply verbatim substitutions

• process_callouts —

  a Boolean flag indicating whether callout marks should be substituted

Returns:

• the substituted source

# File 'lib/asciidoctor/substitutors.rb', line 912

def sub_source source, process_callouts
  process_callouts ? sub_callouts(sub_specialchars source) : (sub_specialchars source)
end

#sub_specialchars(text) ⇒ Object Also known as: sub_specialcharacters

# File 'lib/asciidoctor/substitutors.rb', line 169

def sub_specialchars text
  (text.include? ?>) || (text.include? ?&) || (text.include? ?<) ? (text.gsub SpecialCharsRx, SpecialCharsTr) : text
end