summaryrefslogtreecommitdiff
path: root/lib/rdoc/generator/markup.rb
blob: a90b15a1e7a2dffc7fe1173f8104e4cf4d7e8df4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
require 'rdoc/text'
require 'rdoc/code_objects'
require 'rdoc/generator'
require 'rdoc/markup/to_html_crossref'

##
# Handle common RDoc::Markup tasks for various CodeObjects

module RDoc::Generator::Markup

  ##
  # Generates a relative URL from this object's path to +target_path+

  def aref_to(target_path)
    RDoc::Markup::ToHtml.gen_relative_url path, target_path
  end

  ##
  # Generates a relative URL from +from_path+ to this object's path

  def as_href(from_path)
    RDoc::Markup::ToHtml.gen_relative_url from_path, path
  end

  ##
  # Handy wrapper for marking up this object's comment

  def description
    markup @comment
  end

  ##
  # Creates an RDoc::Markup::ToHtmlCrossref formatter

  def formatter
    return @formatter if defined? @formatter

    show_hash = RDoc::RDoc.current.options.show_hash
    this = RDoc::Context === self ? self : @parent
    @formatter = RDoc::Markup::ToHtmlCrossref.new this.path, this, show_hash
  end

  ##
  # Build a webcvs URL starting for the given +url+ with +full_path+ appended
  # as the destination path.  If +url+ contains '%s' +full_path+ will be
  # sprintf'd into +url+ instead.

  def cvs_url(url, full_path)
    if /%s/ =~ url then
      sprintf url, full_path
    else
      url + full_path
    end
  end

end

class RDoc::AnyMethod

  include RDoc::Generator::Markup

  ##
  # Prepend +src+ with line numbers.  Relies on the first line of a source
  # code listing having:
  #
  #    # File xxxxx, line dddd

  def add_line_numbers(src)
    if src =~ /\A.*, line (\d+)/ then
      first = $1.to_i - 1
      last  = first + src.count("\n")
      size = last.to_s.length

      line = first
      src.gsub!(/^/) do
        res = if line == first then
                " " * (size + 2)
              else
                "%2$*1$d: " % [size, line]
              end

        line += 1
        res
      end
    end
  end

  ##
  # Turns the method's token stream into HTML

  def markup_code
    return '' unless @token_stream

    src = ""

    @token_stream.each do |t|
      next unless t
      #        style = STYLE_MAP[t.class]
      style = case t
              when RDoc::RubyToken::TkCONSTANT then "ruby-constant"
              when RDoc::RubyToken::TkKW       then "ruby-keyword kw"
              when RDoc::RubyToken::TkIVAR     then "ruby-ivar"
              when RDoc::RubyToken::TkOp       then "ruby-operator"
              when RDoc::RubyToken::TkId       then "ruby-identifier"
              when RDoc::RubyToken::TkNode     then "ruby-node"
              when RDoc::RubyToken::TkCOMMENT  then "ruby-comment cmt"
              when RDoc::RubyToken::TkREGEXP   then "ruby-regexp re"
              when RDoc::RubyToken::TkSTRING   then "ruby-value str"
              when RDoc::RubyToken::TkVal      then "ruby-value"
              else
                nil
              end

      text = CGI.escapeHTML t.text

      if style
        src << "<span class=\"#{style}\">#{text}</span>"
      else
        src << text
      end
    end

    add_line_numbers src

    src
  end

end

class RDoc::Attr

  include RDoc::Generator::Markup

end

class RDoc::Constant

  include RDoc::Generator::Markup

end

class RDoc::Context

  include RDoc::Generator::Markup

end

class RDoc::Context::Section

  include RDoc::Generator::Markup

end

class RDoc::TopLevel

  ##
  # Returns a URL for this source file on some web repository.  Use the -W
  # command line option to set.

  def cvs_url
    url = RDoc::RDoc.current.options.webcvs

    if /%s/ =~ url then
      url % @absolute_name
    else
      url + @absolute_name
    end
  end

end