module Asciidoctor::SyntaxHighlighter

def self.included into

Return the [String] markup to insert.

location - The Symbol representing the location slot (:head or :footer).

Public: Generates docinfo markup to insert in the output document at the specified location.

def docinfo location
  raise ::NotImplementedError, %(#{SyntaxHighlighter} subclass #{self.class} must implement the ##{__method__} method since #docinfo? returns true)
end

Returns a [Boolean] indicating whether the docinfo method should be called for this location.

location - The Symbol representing the location slot (:head or :footer).

the specified location.
Public: Indicates whether this syntax highlighter has docinfo (i.e., markup) to insert into the output document at

def docinfo? location; end

Returns the highlighted source [String] wrapped in preformatted tags (e.g., pre and code)

:nowrap - A Boolean that indicates whether wrapping should be disabled (optional).
opts - A Hash of options that control syntax highlighting:
lang - The source language String for this Block (e.g., ruby).
node - The source Block being processed.

Public: Format the highlighted source for inclusion in an HTML document.

def format node, lang, opts
  raise ::NotImplementedError, %(#{SyntaxHighlighter} subclass #{self.class} must implement the ##{__method__} method)
end

Returns the highlighted source String or a tuple of the highlighted source String and an Integer line offset.

:style - The String style (aka theme) to use for colorizing the code (optional).
:start_line_number - The starting Integer (1-based) line number (optional, default: 1).
:number_lines - A Symbol indicating whether lines should be numbered (:table or :inline) (optional).
:highlight_lines - A 1-based Array of Integer line numbers to highlight (aka emphasize) (optional).
:css_mode - The Symbol CSS mode (:class or :inline).
:callouts - A Hash of callouts extracted from the source, indexed by line number (1-based) (optional).
opts - A Hash of options that configure the syntax highlighting:
lang - The source language String specified on this block (e.g., ruby).
source - The raw source text String of this source block (after preprocessing).
node - The source Block to syntax highlight.

tuple containing the highlighted source and the number of lines by which the source was shifted.
are added to the end of each line. If the source gets shifted by one or more lines, this method must return a
If the source contains callout marks, the caller assumes the source remains on the same lines and no closing tags

Public: Highlights the specified source when this source block is being converted.

def highlight node, source, lang, opts
  raise ::NotImplementedError, %(#{SyntaxHighlighter} subclass #{self.class} must implement the ##{__method__} method since #highlight? returns true)
end

Returns a [Boolean] indicating whether the highlight method should be used to handle the :specialchars substitution.

Public: Indicates whether highlighting is handled by this syntax highlighter or by the client.

def highlight?; end

def initialize name, backend = 'html5', opts = {}
  @name = @pre_class = name
end

Returns nothing.

to_dir - The absolute String path of the stylesheet output directory.
doc - The Document in which this syntax highlighter is being used.

Public: Writes the stylesheet to support the highlighted source(s) to disk.

def write_stylesheet doc, to_dir
  raise ::NotImplementedError, %(#{SyntaxHighlighter} subclass #{self.class} must implement the ##{__method__} method since #write_stylesheet? returns true)
end

Returns a [Boolean] indicating whether the write_stylesheet method should be called.

doc - The Document in which this syntax highlighter is being used.

linkcss and copycss attributes are set on the document.
Public: Indicates whether this syntax highlighter wants to write a stylesheet to disk. Only called if both the

def write_stylesheet? doc; end