Class: Markbridge::Parse

Inherits:

Data

• Object
• Data
• Markbridge::Parse

Defined in:

lib/markbridge/parse.rb

Overview

Result of a parse-only call (Markbridge.parse_bbcode and friends).

Instance Attribute Summary

• #ast ⇒ AST::Document readonly
• #diagnostics ⇒ Hash{Symbol => Object} readonly

  Format-specific diagnostics.

• #format ⇒ Symbol^? readonly

  :bbcode, :html, :text_formatter_xml, or :mediawiki.

• #unknown_tags ⇒ Hash{String => Integer} readonly

  Tag-name → occurrence count.

Instance Attribute Details

#ast ⇒ AST::Document (readonly)

Returns:

• (AST::Document)

# File 'lib/markbridge/parse.rb', line 19

Parse = Data.define(:ast, :format, :unknown_tags, :diagnostics)

#diagnostics ⇒ Hash{Symbol => Object} (readonly)

Returns format-specific diagnostics. BBCode supplies :auto_closed_tags_count, :depth_exceeded_count, :unclosed_raw_tags. Other parsers supply an empty hash for now.

Returns:

• (Hash{Symbol => Object}) —

  format-specific diagnostics. BBCode supplies :auto_closed_tags_count, :depth_exceeded_count, :unclosed_raw_tags. Other parsers supply an empty hash for now.

# File 'lib/markbridge/parse.rb', line 19

Parse = Data.define(:ast, :format, :unknown_tags, :diagnostics)

#format ⇒ Symbol^? (readonly)

Returns :bbcode, :html, :text_formatter_xml, or :mediawiki. nil when synthesized by Markbridge.render from a bare AST node — there was no source document to parse.

Returns:

• (Symbol, nil) —

  :bbcode, :html, :text_formatter_xml, or :mediawiki. nil when synthesized by Markbridge.render from a bare AST node — there was no source document to parse.

# File 'lib/markbridge/parse.rb', line 19

Parse = Data.define(:ast, :format, :unknown_tags, :diagnostics)

#unknown_tags ⇒ Hash{String => Integer} (readonly)

Returns tag-name → occurrence count. Empty for parsers that do not yet track unknown tags.

Returns:

• (Hash{String => Integer}) —

  tag-name → occurrence count. Empty for parsers that do not yet track unknown tags.

# File 'lib/markbridge/parse.rb', line 19

Parse = Data.define(:ast, :format, :unknown_tags, :diagnostics)