summaryrefslogtreecommitdiff
path: root/lib/rdoc/token_stream.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/rdoc/token_stream.rb')
-rw-r--r--lib/rdoc/token_stream.rb50
1 files changed, 50 insertions, 0 deletions
diff --git a/lib/rdoc/token_stream.rb b/lib/rdoc/token_stream.rb
new file mode 100644
index 0000000..fb887f2
--- /dev/null
+++ b/lib/rdoc/token_stream.rb
@@ -0,0 +1,50 @@
+##
+# A TokenStream is a list of tokens, gathered during the parse of some entity
+# (say a method). Entities populate these streams by being registered with the
+# lexer. Any class can collect tokens by including TokenStream. From the
+# outside, you use such an object by calling the start_collecting_tokens
+# method, followed by calls to add_token and pop_token.
+
+module RDoc::TokenStream
+
+ ##
+ # Adds +tokens+ to the collected tokens
+
+ def add_tokens(*tokens)
+ tokens.flatten.each { |token| @token_stream << token }
+ end
+
+ alias add_token add_tokens
+
+ ##
+ # Starts collecting tokens
+
+ def collect_tokens
+ @token_stream = []
+ end
+
+ alias start_collecting_tokens collect_tokens
+
+ ##
+ # Remove the last token from the collected tokens
+
+ def pop_token
+ @token_stream.pop
+ end
+
+ ##
+ # Current token stream
+
+ def token_stream
+ @token_stream
+ end
+
+ ##
+ # Returns a string representation of the token stream
+
+ def tokens_to_s
+ token_stream.map { |token| token.text }.join ''
+ end
+
+end
+