Class: Asciidoctor::Extensions::Registry
- Inherits:
-
Object
- Object
- Asciidoctor::Extensions::Registry
- Defined in:
- lib/asciidoctor/extensions.rb
Overview
The primary entry point into the extension system.
Registry holds the extensions which have been registered and activated, has methods for registering or defining a processor and looks up extensions stored in the registry during parsing.
Instance Attribute Summary collapse
-
#document ⇒ Object
readonly
Returns the Document on which the extensions in this registry are being used.
-
#groups ⇒ Object
readonly
Returns the Hash of Group classes, instances, and/or Procs that have been registered with this registry.
Instance Method Summary collapse
- #activate(document) ⇒ Registry
-
#block(*args, &block) ⇒ Extension
Registers a BlockProcessor with the extension registry to process the block content (i.e., delimited block or paragraph) in the AsciiDoc source annotated with the specified block name (i.e., style).
-
#block_macro(*args, &block) ⇒ Extension
Registers a BlockMacroProcessor with the extension registry to process a block macro with the specified name.
-
#block_macros? ⇒ Boolean
Checks whether any BlockMacroProcessor extensions have been registered.
-
#blocks? ⇒ Boolean
Checks whether any BlockProcessor extensions have been registered.
-
#docinfo_processor(*args, &block) ⇒ Extension
Registers an DocinfoProcessor with the extension registry to add additional docinfo to the document.
-
#docinfo_processors(location = nil) ⇒ Array
Retrieves the Extension proxy objects for all the DocinfoProcessor instances stored in this registry.
-
#docinfo_processors?(location = nil) ⇒ Boolean
Checks whether any DocinfoProcessor extensions have been registered.
-
#find_block_extension(name) ⇒ Extension
Retrieves the Extension proxy object for the BlockProcessor registered to handle block content with the name.
-
#find_block_macro_extension(name) ⇒ Extension
Retrieves the Extension proxy object for the BlockMacroProcessor registered to handle a block macro with the specified name.
-
#find_inline_macro_extension(name) ⇒ Extension
Retrieves the Extension proxy object for the InlineMacroProcessor registered to handle an inline macro with the specified name.
-
#include_processor(*args, &block) ⇒ Extension
Registers an IncludeProcessor with the extension registry to have a shot at handling the include directive.
-
#include_processors ⇒ Array
Retrieves the Extension proxy objects for all the IncludeProcessor instances stored in this registry.
-
#include_processors? ⇒ Boolean
Checks whether any IncludeProcessor extensions have been registered.
-
#initialize(groups = {}) ⇒ Registry
constructor
A new instance of Registry.
-
#inline_macro(*args, &block) ⇒ Extension
Registers a InlineMacroProcessor with the extension registry to process an inline macro with the specified name.
-
#inline_macros ⇒ Array
Retrieves the Extension proxy objects for all InlineMacroProcessor instances in this registry.
-
#inline_macros? ⇒ Boolean
Checks whether any InlineMacroProcessor extensions have been registered.
-
#postprocessor(*args, &block) ⇒ Extension
Registers a Postprocessor with the extension registry to process the output after conversion is complete.
-
#postprocessors ⇒ Array
Retrieves the Extension proxy objects for all Postprocessor instances in this registry.
-
#postprocessors? ⇒ Boolean
Checks whether any Postprocessor extensions have been registered.
-
#prefer(*args, &block) ⇒ Extension
Inserts the document processor Extension instance as the first processor of its kind in the extension registry.
-
#preprocessor(*args, &block) ⇒ Extension
Registers a Preprocessor with the extension registry to process the AsciiDoc source before parsing begins.
-
#preprocessors ⇒ Array
Retrieves the Extension proxy objects for all Preprocessor instances in this registry.
-
#preprocessors? ⇒ Boolean
Checks whether any Preprocessor extensions have been registered.
-
#registered_for_block?(name, context) ⇒ Extension
Checks whether any BlockProcessor extensions are registered to handle the specified block name appearing on the specified context.
-
#registered_for_block_macro?(name) ⇒ Extension
Checks whether any BlockMacroProcessor extensions are registered to handle the block macro with the specified name.
-
#registered_for_inline_macro?(name) ⇒ Extension
Checks whether any InlineMacroProcessor extensions are registered to handle the inline macro with the specified name.
-
#tree_processor(*args, &block) ⇒ Extension
(also: #treeprocessor)
Registers a TreeProcessor with the extension registry to process the AsciiDoc source after parsing is complete.
-
#tree_processors ⇒ Array
(also: #treeprocessors)
Retrieves the Extension proxy objects for all TreeProcessor instances in this registry.
-
#tree_processors? ⇒ Boolean
(also: #treeprocessors?)
Checks whether any TreeProcessor extensions have been registered.
Constructor Details
#initialize(groups = {}) ⇒ Registry
Returns a new instance of Registry.
735 736 737 738 |
# File 'lib/asciidoctor/extensions.rb', line 735 def initialize groups = {} @groups = groups reset end |
Instance Attribute Details
#document ⇒ Object (readonly)
Returns the Document on which the extensions in this registry are being used.
730 731 732 |
# File 'lib/asciidoctor/extensions.rb', line 730 def document @document end |
#groups ⇒ Object (readonly)
Returns the Hash of Group classes, instances, and/or Procs that have been registered with this registry.
733 734 735 |
# File 'lib/asciidoctor/extensions.rb', line 733 def groups @groups end |
Instance Method Details
#activate(document) ⇒ Registry
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 |
# File 'lib/asciidoctor/extensions.rb', line 746 def activate document reset if @document @document = document unless (ext_groups = Extensions.groups.values + @groups.values).empty? ext_groups.each do |group| case group when ::Proc case group.arity when 0, -1 instance_exec(&group) when 1 group.call self end when ::Class group.new.activate self else group.activate self end end end self end |
#block(*args, &block) ⇒ Extension
Registers a BlockProcessor with the extension registry to process the block content (i.e., delimited block or paragraph) in the AsciiDoc source annotated with the specified block name (i.e., style).
The BlockProcessor may be one of four types:
-
A BlockProcessor subclass
-
An instance of a BlockProcessor subclass
-
The String name of a BlockProcessor subclass
-
A method block (i.e., Proc) that conforms to the BlockProcessor contract
Unless the BlockProcessor is passed as the method block, it must be the first argument to this method. The second argument is the name (coersed to a Symbol) of the AsciiDoc block content (i.e., delimited block or paragraph) that this processor is registered to handle. If a block name is not passed as an argument, it gets read from the name property of the BlockProcessor instance. If a name still cannot be determined, an error is raised.
1103 1104 1105 |
# File 'lib/asciidoctor/extensions.rb', line 1103 def block *args, &block add_syntax_processor :block, args, &block end |
#block_macro(*args, &block) ⇒ Extension
Registers a BlockMacroProcessor with the extension registry to process a block macro with the specified name.
The BlockMacroProcessor may be one of four types:
-
A BlockMacroProcessor subclass
-
An instance of a BlockMacroProcessor subclass
-
The String name of a BlockMacroProcessor subclass
-
A method block (i.e., Proc) that conforms to the BlockMacroProcessor contract
Unless the BlockMacroProcessor is passed as the method block, it must be the first argument to this method. The second argument is the name (coersed to a Symbol) of the AsciiDoc block macro that this processor is registered to handle. If a block macro name is not passed as an argument, it gets read from the name property of the BlockMacroProcessor instance. If a name still cannot be determined, an error is raised.
1188 1189 1190 |
# File 'lib/asciidoctor/extensions.rb', line 1188 def block_macro *args, &block add_syntax_processor :block_macro, args, &block end |
#block_macros? ⇒ Boolean
Checks whether any BlockMacroProcessor extensions have been registered.
1195 1196 1197 |
# File 'lib/asciidoctor/extensions.rb', line 1195 def block_macros? !!@block_macro_extensions end |
#blocks? ⇒ Boolean
Checks whether any BlockProcessor extensions have been registered.
1110 1111 1112 |
# File 'lib/asciidoctor/extensions.rb', line 1110 def blocks? !!@block_extensions end |
#docinfo_processor(*args, &block) ⇒ Extension
Registers an DocinfoProcessor with the extension registry to add additional docinfo to the document.
The DocinfoProcessor may be one of four types:
-
A DocinfoProcessor subclass
-
An instance of a DocinfoProcessor subclass
-
The String name of a DocinfoProcessor subclass
-
A method block (i.e., Proc) that conforms to the DocinfoProcessor contract
Unless the DocinfoProcessor is passed as the method block, it must be the first argument to this method.
1016 1017 1018 |
# File 'lib/asciidoctor/extensions.rb', line 1016 def docinfo_processor *args, &block add_document_processor :docinfo_processor, args, &block end |
#docinfo_processors(location = nil) ⇒ Array
Retrieves the Extension proxy objects for all the DocinfoProcessor instances stored in this registry.
1043 1044 1045 |
# File 'lib/asciidoctor/extensions.rb', line 1043 def docinfo_processors location = nil @docinfo_processor_extensions && location ? @docinfo_processor_extensions.select {|ext| ext.config[:location] == location } : (@docinfo_processor_extensions || []) end |
#docinfo_processors?(location = nil) ⇒ Boolean
Checks whether any DocinfoProcessor extensions have been registered.
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 |
# File 'lib/asciidoctor/extensions.rb', line 1025 def docinfo_processors? location = nil if @docinfo_processor_extensions if location @docinfo_processor_extensions.any? {|ext| ext.config[:location] == location } else true end else false end end |
#find_block_extension(name) ⇒ Extension
Retrieves the Extension proxy object for the BlockProcessor registered to handle block content with the name.
1130 1131 1132 |
# File 'lib/asciidoctor/extensions.rb', line 1130 def find_block_extension name @block_extensions&.[] name.to_sym end |
#find_block_macro_extension(name) ⇒ Extension
Retrieves the Extension proxy object for the BlockMacroProcessor registered to handle a block macro with the specified name.
1219 1220 1221 |
# File 'lib/asciidoctor/extensions.rb', line 1219 def find_block_macro_extension name @block_macro_extensions&.[] name.to_sym end |
#find_inline_macro_extension(name) ⇒ Extension
Retrieves the Extension proxy object for the InlineMacroProcessor registered to handle an inline macro with the specified name.
1306 1307 1308 |
# File 'lib/asciidoctor/extensions.rb', line 1306 def find_inline_macro_extension name @inline_macro_extensions&.[] name.to_sym end |
#include_processor(*args, &block) ⇒ Extension
Registers an IncludeProcessor with the extension registry to have a shot at handling the include directive.
The IncludeProcessor may be one of four types:
-
A IncludeProcessor subclass
-
An instance of a IncludeProcessor subclass
-
The String name of a IncludeProcessor subclass
-
A method block (i.e., Proc) that conforms to the IncludeProcessor contract
Unless the IncludeProcessor is passed as the method block, it must be the first argument to this method.
963 964 965 |
# File 'lib/asciidoctor/extensions.rb', line 963 def include_processor *args, &block add_document_processor :include_processor, args, &block end |
#include_processors ⇒ Array
Retrieves the Extension proxy objects for all the IncludeProcessor instances stored in this registry.
978 979 980 |
# File 'lib/asciidoctor/extensions.rb', line 978 def include_processors @include_processor_extensions end |
#include_processors? ⇒ Boolean
Checks whether any IncludeProcessor extensions have been registered.
970 971 972 |
# File 'lib/asciidoctor/extensions.rb', line 970 def include_processors? !!@include_processor_extensions end |
#inline_macro(*args, &block) ⇒ Extension
Registers a InlineMacroProcessor with the extension registry to process an inline macro with the specified name.
The InlineMacroProcessor may be one of four types:
-
An InlineMacroProcessor subclass
-
An instance of an InlineMacroProcessor subclass
-
The String name of an InlineMacroProcessor subclass
-
A method block (i.e., Proc) that conforms to the InlineMacroProcessor contract
Unless the InlineMacroProcessor is passed as the method block, it must be the first argument to this method. The second argument is the name (coersed to a Symbol) of the AsciiDoc block macro that this processor is registered to handle. If a block macro name is not passed as an argument, it gets read from the name property of the InlineMacroProcessor instance. If a name still cannot be determined, an error is raised.
1277 1278 1279 |
# File 'lib/asciidoctor/extensions.rb', line 1277 def inline_macro *args, &block add_syntax_processor :inline_macro, args, &block end |
#inline_macros ⇒ Array
Retrieves the Extension proxy objects for all InlineMacroProcessor instances in this registry.
1314 1315 1316 |
# File 'lib/asciidoctor/extensions.rb', line 1314 def inline_macros (@inline_macro_extensions || {}).values end |
#inline_macros? ⇒ Boolean
Checks whether any InlineMacroProcessor extensions have been registered.
1284 1285 1286 |
# File 'lib/asciidoctor/extensions.rb', line 1284 def inline_macros? !!@inline_macro_extensions end |
#postprocessor(*args, &block) ⇒ Extension
Registers a Postprocessor with the extension registry to process the output after conversion is complete.
The Postprocessor may be one of four types:
-
A Postprocessor subclass
-
An instance of a Postprocessor subclass
-
The String name of a Postprocessor subclass
-
A method block (i.e., Proc) that conforms to the Postprocessor contract
Unless the Postprocessor is passed as the method block, it must be the first argument to this method.
911 912 913 |
# File 'lib/asciidoctor/extensions.rb', line 911 def postprocessor *args, &block add_document_processor :postprocessor, args, &block end |
#postprocessors ⇒ Array
Retrieves the Extension proxy objects for all Postprocessor instances in this registry.
926 927 928 |
# File 'lib/asciidoctor/extensions.rb', line 926 def postprocessors @postprocessor_extensions end |
#postprocessors? ⇒ Boolean
Checks whether any Postprocessor extensions have been registered.
918 919 920 |
# File 'lib/asciidoctor/extensions.rb', line 918 def postprocessors? !!@postprocessor_extensions end |
#prefer(*args, &block) ⇒ Extension
Inserts the document processor Extension instance as the first processor of its kind in the extension registry.
1331 1332 1333 1334 1335 1336 |
# File 'lib/asciidoctor/extensions.rb', line 1331 def prefer *args, &block extension = ProcessorExtension === (arg0 = args.shift) ? arg0 : (send arg0, *args, &block) extensions_store = instance_variable_get %(@#{extension.kind}_extensions).to_sym extensions_store.unshift extensions_store.delete extension extension end |
#preprocessor(*args, &block) ⇒ Extension
Registers a Preprocessor with the extension registry to process the AsciiDoc source before parsing begins.
The Preprocessor may be one of four types:
-
A Preprocessor subclass
-
An instance of a Preprocessor subclass
-
The String name of a Preprocessor subclass
-
A method block (i.e., Proc) that conforms to the Preprocessor contract
Unless the Preprocessor is passed as the method block, it must be the first argument to this method.
802 803 804 |
# File 'lib/asciidoctor/extensions.rb', line 802 def preprocessor *args, &block add_document_processor :preprocessor, args, &block end |
#preprocessors ⇒ Array
Retrieves the Extension proxy objects for all Preprocessor instances in this registry.
817 818 819 |
# File 'lib/asciidoctor/extensions.rb', line 817 def preprocessors @preprocessor_extensions end |
#preprocessors? ⇒ Boolean
Checks whether any Preprocessor extensions have been registered.
809 810 811 |
# File 'lib/asciidoctor/extensions.rb', line 809 def preprocessors? !!@preprocessor_extensions end |
#registered_for_block?(name, context) ⇒ Extension
Checks whether any BlockProcessor extensions are registered to handle the specified block name appearing on the specified context.
1119 1120 1121 |
# File 'lib/asciidoctor/extensions.rb', line 1119 def registered_for_block? name, context (ext = @block_extensions&.[] name.to_sym) ? (ext.config[:contexts].include? context) && ext : false end |
#registered_for_block_macro?(name) ⇒ Extension
Checks whether any BlockMacroProcessor extensions are registered to handle the block macro with the specified name.
1208 1209 1210 |
# File 'lib/asciidoctor/extensions.rb', line 1208 def registered_for_block_macro? name (@block_macro_extensions&.[] name.to_sym) || false end |
#registered_for_inline_macro?(name) ⇒ Extension
Checks whether any InlineMacroProcessor extensions are registered to handle the inline macro with the specified name.
1295 1296 1297 |
# File 'lib/asciidoctor/extensions.rb', line 1295 def registered_for_inline_macro? name (@inline_macro_extensions&.[] name.to_sym) || false end |
#tree_processor(*args, &block) ⇒ Extension Also known as: treeprocessor
Registers a TreeProcessor with the extension registry to process the AsciiDoc source after parsing is complete.
The TreeProcessor may be one of four types:
-
A TreeProcessor subclass
-
An instance of a TreeProcessor subclass
-
The String name of a TreeProcessor subclass
-
A method block (i.e., Proc) that conforms to the TreeProcessor contract
Unless the TreeProcessor is passed as the method block, it must be the first argument to this method.
854 855 856 |
# File 'lib/asciidoctor/extensions.rb', line 854 def tree_processor *args, &block add_document_processor :tree_processor, args, &block end |
#tree_processors ⇒ Array Also known as: treeprocessors
Retrieves the Extension proxy objects for all TreeProcessor instances in this registry.
869 870 871 |
# File 'lib/asciidoctor/extensions.rb', line 869 def tree_processors @tree_processor_extensions end |
#tree_processors? ⇒ Boolean Also known as: treeprocessors?
Checks whether any TreeProcessor extensions have been registered.
861 862 863 |
# File 'lib/asciidoctor/extensions.rb', line 861 def tree_processors? !!@tree_processor_extensions end |