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 additionnal 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.
709 710 711 712 713 |
# File 'lib/asciidoctor/extensions.rb', line 709 def initialize groups = {} @groups = groups @preprocessor_extensions = @tree_processor_extensions = @postprocessor_extensions = @include_processor_extensions = @docinfo_processor_extensions = @block_extensions = @block_macro_extensions = @inline_macro_extensions = nil @document = nil end |
Instance Attribute Details
#document ⇒ Object (readonly)
Returns the Document on which the extensions in this registry are being used.
704 705 706 |
# File 'lib/asciidoctor/extensions.rb', line 704 def document @document end |
#groups ⇒ Object (readonly)
Returns the Hash of Group classes, instances, and/or Procs that have been registered with this registry.
707 708 709 |
# File 'lib/asciidoctor/extensions.rb', line 707 def groups @groups end |
Instance Method Details
#activate(document) ⇒ Registry
721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 |
# File 'lib/asciidoctor/extensions.rb', line 721 def activate 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.
1083 1084 1085 |
# File 'lib/asciidoctor/extensions.rb', line 1083 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.
1172 1173 1174 |
# File 'lib/asciidoctor/extensions.rb', line 1172 def block_macro *args, &block add_syntax_processor :block_macro, args, &block end |
#block_macros? ⇒ Boolean
Checks whether any BlockMacroProcessor extensions have been registered.
1179 1180 1181 |
# File 'lib/asciidoctor/extensions.rb', line 1179 def block_macros? !!@block_macro_extensions end |
#blocks? ⇒ Boolean
Checks whether any BlockProcessor extensions have been registered.
1090 1091 1092 |
# File 'lib/asciidoctor/extensions.rb', line 1090 def blocks? !!@block_extensions end |
#docinfo_processor(*args, &block) ⇒ Extension
Registers an DocinfoProcessor with the extension registry to add additionnal 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.
990 991 992 |
# File 'lib/asciidoctor/extensions.rb', line 990 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.
1017 1018 1019 1020 1021 1022 1023 1024 1025 |
# File 'lib/asciidoctor/extensions.rb', line 1017 def docinfo_processors location = nil if @docinfo_processor_extensions if location @docinfo_processor_extensions.select {|ext| ext.config[:location] == location } else @docinfo_processor_extensions end end end |
#docinfo_processors?(location = nil) ⇒ Boolean
Checks whether any DocinfoProcessor extensions have been registered.
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 |
# File 'lib/asciidoctor/extensions.rb', line 999 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.
1114 1115 1116 |
# File 'lib/asciidoctor/extensions.rb', line 1114 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.
1203 1204 1205 |
# File 'lib/asciidoctor/extensions.rb', line 1203 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.
1290 1291 1292 |
# File 'lib/asciidoctor/extensions.rb', line 1290 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.
937 938 939 |
# File 'lib/asciidoctor/extensions.rb', line 937 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.
952 953 954 |
# File 'lib/asciidoctor/extensions.rb', line 952 def include_processors @include_processor_extensions end |
#include_processors? ⇒ Boolean
Checks whether any IncludeProcessor extensions have been registered.
944 945 946 |
# File 'lib/asciidoctor/extensions.rb', line 944 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.
1261 1262 1263 |
# File 'lib/asciidoctor/extensions.rb', line 1261 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.
1298 1299 1300 |
# File 'lib/asciidoctor/extensions.rb', line 1298 def inline_macros @inline_macro_extensions.values end |
#inline_macros? ⇒ Boolean
Checks whether any InlineMacroProcessor extensions have been registered.
1268 1269 1270 |
# File 'lib/asciidoctor/extensions.rb', line 1268 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.
885 886 887 |
# File 'lib/asciidoctor/extensions.rb', line 885 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.
900 901 902 |
# File 'lib/asciidoctor/extensions.rb', line 900 def postprocessors @postprocessor_extensions end |
#postprocessors? ⇒ Boolean
Checks whether any Postprocessor extensions have been registered.
892 893 894 |
# File 'lib/asciidoctor/extensions.rb', line 892 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.
1315 1316 1317 1318 1319 1320 |
# File 'lib/asciidoctor/extensions.rb', line 1315 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.
776 777 778 |
# File 'lib/asciidoctor/extensions.rb', line 776 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.
791 792 793 |
# File 'lib/asciidoctor/extensions.rb', line 791 def preprocessors @preprocessor_extensions end |
#preprocessors? ⇒ Boolean
Checks whether any Preprocessor extensions have been registered.
783 784 785 |
# File 'lib/asciidoctor/extensions.rb', line 783 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.
1099 1100 1101 1102 1103 1104 1105 |
# File 'lib/asciidoctor/extensions.rb', line 1099 def registered_for_block? name, context if (ext = @block_extensions[name.to_sym]) (ext.config[:contexts].include? context) ? ext : false else false end end |
#registered_for_block_macro?(name) ⇒ Extension
Checks whether any BlockMacroProcessor extensions are registered to handle the block macro with the specified name.
1192 1193 1194 |
# File 'lib/asciidoctor/extensions.rb', line 1192 def registered_for_block_macro? name (ext = @block_macro_extensions[name.to_sym]) ? ext : false end |
#registered_for_inline_macro?(name) ⇒ Extension
Checks whether any InlineMacroProcessor extensions are registered to handle the inline macro with the specified name.
1279 1280 1281 |
# File 'lib/asciidoctor/extensions.rb', line 1279 def registered_for_inline_macro? name (ext = @inline_macro_extensions[name.to_sym]) ? ext : 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.
828 829 830 |
# File 'lib/asciidoctor/extensions.rb', line 828 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.
843 844 845 |
# File 'lib/asciidoctor/extensions.rb', line 843 def tree_processors @tree_processor_extensions end |
#tree_processors? ⇒ Boolean Also known as: treeprocessors?
Checks whether any TreeProcessor extensions have been registered.
835 836 837 |
# File 'lib/asciidoctor/extensions.rb', line 835 def tree_processors? !!@tree_processor_extensions end |