rdoc-f95 0.0.1

data/lib/rdoc-f95/tokenstream.rb

@@ -0,0 +1,33 @@
+module RDocF95; end
+
+##
+# 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 RDocF95::TokenStream
+
+  def token_stream
+    @token_stream
+  end
+
+  def start_collecting_tokens
+    @token_stream = []
+  end
+
+  def add_token(tk)
+    @token_stream << tk
+  end
+
+  def add_tokens(tks)
+    tks.each  {|tk| add_token(tk)}
+  end
+
+  def pop_token
+    @token_stream.pop
+  end
+
+end
+

data/lib/rdoc-f95/usage.rb

@@ -0,0 +1,210 @@
+# = Synopsis
+#
+# This library allows command-line tools to encapsulate their usage
+# as a comment at the top of the main file. Calling <tt>RDocF95::usage</tt>
+# then displays some or all of that comment, and optionally exits
+# the program with an exit status. We always look for the comment
+# in the main program file, so it is safe to call this method
+# from anywhere in the executing program.
+#
+# = Usage
+#
+#   RDocF95::usage( [ exit_status ], [ section, ...])
+#   RDocF95::usage_no_exit( [ section, ...])
+#
+# where:
+#
+# exit_status::
+#     the integer exit code (default zero). RDocF95::usage will exit
+#     the calling program with this status.
+#
+# section::
+#     an optional list of section names. If specified, only the
+#     sections with the given names as headings will be output.
+#     For example, this section is named 'Usage', and the next
+#     section is named 'Examples'. The section names are case
+#     insensitive.
+#
+# = Examples
+#
+#    # Comment block describing usage
+#    # with (optional) section headings
+#    # . . .
+#
+#    require 'rdoc-f95/usage'
+#
+#    # Display all usage and exit with a status of 0
+#
+#    RDocF95::usage
+#
+#    # Display all usage and exit with a status of 99
+#
+#    RDocF95::usage(99)
+#
+#    # Display usage in the 'Summary' section only, then
+#    # exit with a status of 99
+#
+#    RDocF95::usage(99, 'Summary')
+#
+#    # Display information in the Author and Copyright
+#    # sections, then exit 0.
+#    
+#    RDocF95::usage('Author', 'Copyright')
+#
+#    # Display information in the Author and Copyright
+#    # sections, but don't exit
+#  
+#    RDocF95::usage_no_exit('Author', 'Copyright')
+#
+# = Author
+#
+# Dave Thomas, The Pragmatic Programmers, LLC
+#
+# = Copyright
+#
+# Copyright (c) 2004 Dave Thomas.
+# Licensed under the same terms as Ruby
+#
+
+require 'rdoc-f95/markup/simple_markup'
+require 'rdoc-f95/markup/simple_markup/to_flow'
+require 'rdoc-f95/ri/ri_formatter'
+require 'rdoc-f95/ri/ri_options'
+
+module RDocF95
+
+  # Display usage information from the comment at the top of
+  # the file. String arguments identify specific sections of the
+  # comment to display. An optional integer first argument
+  # specifies the exit status  (defaults to 0)
+
+  def RDocF95.usage(*args)
+    exit_code = 0
+
+    if args.size > 0
+      status = args[0]
+      if status.respond_to?(:to_int)
+        exit_code = status.to_int
+        args.shift
+      end
+    end
+
+    # display the usage and exit with the given code
+    usage_no_exit(*args)
+    exit(exit_code)
+  end
+
+  # Display usage
+  def RDocF95.usage_no_exit(*args)
+    main_program_file, = caller[-1].split(/:\d+/, 2)
+    comment = File.open(main_program_file) do |file|
+      find_comment(file)
+    end
+
+    comment = comment.gsub(/^\s*#/, '')
+
+    markup = SM::SimpleMarkup.new
+    flow_convertor = SM::ToFlow.new
+    
+    flow = markup.convert(comment, flow_convertor)
+
+    format = "plain"
+
+    unless args.empty?
+      flow = extract_sections(flow, args)
+    end
+
+    options = RI::Options.instance
+    if args = ENV["RI"]
+      options.parse(args.split)
+    end
+    formatter = options.formatter.new(options, "")
+    formatter.display_flow(flow)
+  end
+
+  ######################################################################
+
+  private
+
+  # Find the first comment in the file (that isn't a shebang line)
+  # If the file doesn't start with a comment, report the fact
+  # and return empty string
+
+  def RDocF95.gets(file)
+    if (line = file.gets) && (line =~ /^#!/) # shebang
+      throw :exit, find_comment(file)
+    else
+      line
+    end
+  end
+
+  def RDocF95.find_comment(file)
+    catch(:exit) do
+      # skip leading blank lines
+      0 while (line = gets(file)) && (line =~ /^\s*$/)
+
+      comment = []
+      while line && line =~ /^\s*#/
+        comment << line
+        line = gets(file)
+      end
+
+      0 while line && (line = gets(file))
+      return no_comment if comment.empty?
+      return comment.join
+    end
+  end
+
+
+  #####
+  # Given an array of flow items and an array of section names, extract those
+  # sections from the flow which have headings corresponding to
+  # a section name in the list. Return them in the order
+  # of names in the +sections+ array.
+
+  def RDocF95.extract_sections(flow, sections)
+    result = []
+    sections.each do |name|
+      name = name.downcase
+      copy_upto_level = nil
+
+      flow.each do |item|
+        case item
+        when SM::Flow::H
+          if copy_upto_level && item.level >= copy_upto_level
+            copy_upto_level = nil
+          else
+            if item.text.downcase == name
+              result << item
+              copy_upto_level = item.level
+            end
+          end
+        else
+          if copy_upto_level
+            result << item
+          end
+        end
+      end
+    end
+    if result.empty?
+      puts "Note to developer: requested section(s) [#{sections.join(', ')}] " +
+           "not found"
+      result = flow
+    end
+    result
+  end
+
+  #####
+  # Report the fact that no doc comment count be found
+  def RDocF95.no_comment
+    $stderr.puts "No usage information available for this program"
+    ""
+  end
+end
+
+
+if $0 == __FILE__
+
+  RDocF95::usage(*ARGV)
+
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/rdoc-f95.rb'}"
+puts "Loading rdoc-f95 gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/rdoc-f95'

data/test/test_rdoc-f95.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class TestRdoc-f95 < Test::Unit::TestCase
+
+  def setup
+  end
+  
+  def test_truth
+    assert true
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification 
+name: rdoc-f95
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- FIXME full name
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-09 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: FIX (describe your package)
+email: 
+- morikawa@gfd-dennou.org
+executables: 
+- rdoc-f95
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/rdoc-f95.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_rdoc-f95.rb
+- bin/rdoc-f95
+- lib/rdoc-f95/code_objects.rb
+- lib/rdoc-f95/diagram.rb
+- lib/rdoc-f95/dot.rb
+- lib/rdoc-f95/generator
+- lib/rdoc-f95/generator/chm.rb
+- lib/rdoc-f95/generator/html.rb
+- lib/rdoc-f95/generator/ri.rb
+- lib/rdoc-f95/generator/xhtml.rb
+- lib/rdoc-f95/generator/xml.rb
+- lib/rdoc-f95/generator/chm
+- lib/rdoc-f95/generator/chm/chm.rb
+- lib/rdoc-f95/generator/html
+- lib/rdoc-f95/generator/html/hefss.rb
+- lib/rdoc-f95/generator/html/html.rb
+- lib/rdoc-f95/generator/html/kilmer.rb
+- lib/rdoc-f95/generator/html/one_page_html.rb
+- lib/rdoc-f95/generator/xhtml
+- lib/rdoc-f95/generator/xhtml/ctop.xsl
+- lib/rdoc-f95/generator/xhtml/mathml.xsl
+- lib/rdoc-f95/generator/xhtml/pmathml.xsl
+- lib/rdoc-f95/generator/xhtml/pmathmlcss.xsl
+- lib/rdoc-f95/generator/xhtml/xhtml.rb
+- lib/rdoc-f95/generator/xml
+- lib/rdoc-f95/generator/xml/rdf.rb
+- lib/rdoc-f95/generator/xml/xml.rb
+- lib/rdoc-f95/generator.rb
+- lib/rdoc-f95/install.rb
+- lib/rdoc-f95/markup
+- lib/rdoc-f95/markup/formatter.rb
+- lib/rdoc-f95/markup/fragments.rb
+- lib/rdoc-f95/markup/inline.rb
+- lib/rdoc-f95/markup/install.rb
+- lib/rdoc-f95/markup/lines.rb
+- lib/rdoc-f95/markup/mathml_wrapper.rb
+- lib/rdoc-f95/markup/preprocess.rb
+- lib/rdoc-f95/markup/to_flow.rb
+- lib/rdoc-f95/markup/to_html.rb
+- lib/rdoc-f95/markup/to_html_crossref.rb
+- lib/rdoc-f95/markup/to_latex.rb
+- lib/rdoc-f95/markup/to_test.rb
+- lib/rdoc-f95/markup/to_xhtml_texparser.rb
+- lib/rdoc-f95/markup/sample
+- lib/rdoc-f95/markup/sample/rdoc2latex.rb
+- lib/rdoc-f95/markup/sample/sample.rb
+- lib/rdoc-f95/markup.rb
+- lib/rdoc-f95/options.rb
+- lib/rdoc-f95/parsers
+- lib/rdoc-f95/parsers/parse_c.rb
+- lib/rdoc-f95/parsers/parse_f95.rb
+- lib/rdoc-f95/parsers/parse_rb.rb
+- lib/rdoc-f95/parsers/parse_simple.rb
+- lib/rdoc-f95/parsers/parserfactory.rb
+- lib/rdoc-f95/ri
+- lib/rdoc-f95/ri/cache.rb
+- lib/rdoc-f95/ri/descriptions.rb
+- lib/rdoc-f95/ri/display.rb
+- lib/rdoc-f95/ri/driver.rb
+- lib/rdoc-f95/ri/formatter.rb
+- lib/rdoc-f95/ri/paths.rb
+- lib/rdoc-f95/ri/reader.rb
+- lib/rdoc-f95/ri/util.rb
+- lib/rdoc-f95/ri/writer.rb
+- lib/rdoc-f95/ri.rb
+- lib/rdoc-f95/stats.rb
+- lib/rdoc-f95/template.rb
+- lib/rdoc-f95/tokenstream.rb
+- lib/rdoc-f95/usage.rb
+has_rdoc: true
+homepage: FIX (url)
+post_install_message: PostInstall.txt
+rdoc_options: 
+- --main
+- README.rdoc.org
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rdoc-f95
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: FIX (describe your package)
+test_files: 
+- test/test_helper.rb
+- test/test_rdoc-f95.rb