Class: Rice::Doc::CppReference

Inherits:
Object
  • Object
show all
Defined in:
lib/rice/doc/cpp_reference.rb

Constant Summary collapse

ROOT = 
"https://en.cppreference.com/w"
INDEX = 
"https://raw.githubusercontent.com/p12tic/cppreference-doc/refs/heads/master/index-functions-cpp.xml"
OPERATORS =

INDEX = “c:/Users/cfis/Downloads/index-functions-cpp.xml”

{"assign" => "operator=",
"assign_plus" => "operator+=",
"assign_minus" => "operator-=",
"assign_multiply" => "operator*=",
"assign_divide" => "operator/=",
"call" => "operator()",
"decrement" => "operator--",
"dereference" => "operator*",
"increment" => "operator++",
"==" => "operator==",
"!=" => "operator!=",
"+" => "operator+",
"-" => "operator-",
"*" => "operator*",
"/" => "operator/",
"&" => "operator&",
"|" => "operator|",
"<" => "operator<",
">" => "operator>",
"<=" => "operator<=",
"<<" => "operator<<",
"[]" => "operator[]",
"[]=" => "operator[]"}

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CppReference

Returns a new instance of CppReference.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/rice/doc/cpp_reference.rb', line 35

def initialize
  @type_mappings = {/^enum\s*/i => '',
                    /^union\s*/i => '',
                    /<.*>/ => ''}

  @method_mappings = {'std::exception' => {'message' => 'what'},
                      'std::map' => {'delete' => 'erase',
                                      'include?' => 'find'},
                      'std::multimap' => {'delete' => 'erase',
                                          'include?' => 'find'},
                      'std::runtime_error' => {'message' => 'what'},
                      'std::unorderedmap' => {'delete' => 'erase',
                                               'include?' => 'find'},
                      'std::vector' => {'delete_at' => 'erase',
                                        'first' => 'front',
                                        'last' => 'back',
                                        'pop' => 'pop_back',
                                        'push' => 'push_back'}}

                      @cache = Hash.new
  data = URI.open(INDEX).read
  parser = LibXML::XML::Parser.string(data)
  @doc = parser.parse
end

Instance Method Details

#attribute_url(klass, native) ⇒ Object 



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/rice/doc/cpp_reference.rb', line 144

def attribute_url(klass, native)
  node = class_node(klass)

  # Find the member node
  attribute_name = camelize(native.name, false)

  xpath = "variable[@name='#{attribute_name}']"
  member_node = node&.find_first(xpath)
  link = member_node.attributes["link"]
  if member_node && link && link != "."
    "#{class_base(klass)}/#{member_node.attributes['link']}.html"
  elsif member_node && link && link == "."
    "#{class_base(klass)}.html"
  elsif member_node
    "#{class_base(klass)}/#{member_node.attributes['name']}.html"
  end
end

#camelize(content, capitalize = true) ⇒ Object 



60
61
62
63
64
65
66
67
 
# File 'lib/rice/doc/cpp_reference.rb', line 60

def camelize(content, capitalize = true)
  result = content.gsub(/(?:_)(.)/) do |matched|
    $1.capitalize
  end

  result[0] = capitalize ? result[0].upcase : result[0].downcase
  result
end

#class_base(klass) ⇒ Object 



90
91
92
93
94
95
96
 
# File 'lib/rice/doc/cpp_reference.rb', line 90

def class_base(klass)
  node = class_node(klass)
  if node
    path = node.attributes["link"]
    "#{ROOT}/#{path}"
  end
end

#class_node(klass) ⇒ Object 



85
86
87
88
 
# File 'lib/rice/doc/cpp_reference.rb', line 85

def class_node(klass)
  xpath = "//class[@name='#{cpp_name(klass)}']"
  get_node(klass, xpath)
end

#class_url(klass) ⇒ Object 



98
99
100
101
102
103
 
# File 'lib/rice/doc/cpp_reference.rb', line 98

def class_url(klass)
  node = class_node(klass)
  if node
    "#{class_base(klass)}.html"
  end
end

#cpp_name(klass) ⇒ Object 



69
70
71
72
73
74
75
 
# File 'lib/rice/doc/cpp_reference.rb', line 69

def cpp_name(klass)
  result = klass.cpp_class
  @type_mappings.each do |key, value|
    result = result.gsub(key, value)
  end
  result
end

#get_node(klass, xpath) ⇒ Object 



77
78
79
80
81
82
83
 
# File 'lib/rice/doc/cpp_reference.rb', line 77

def get_node(klass, xpath)
  node = @cache[klass]
  if node.nil? && !@cache.has_key?(klass)
    node = @cache[klass] = @doc.find_first(xpath)
  end
  node
end

#method_url(klass, native) ⇒ Object 



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
 
# File 'lib/rice/doc/cpp_reference.rb', line 108

def method_url(klass, native)
  node = class_node(klass)
  if node
    ruby_name = native.name
    method_names = Array.new
    if ruby_name == "initialize" || ruby_name == "initialize_copy"
      return "#{class_base(klass)}.html"
    elsif native_name = OPERATORS[ruby_name]
      method_names << native_name
    elsif native_name = @method_mappings.dig(cpp_name(klass), ruby_name)
      method_names << native_name
    elsif ruby_name.match(/\?$/)
      native_name = ruby_name.gsub(/\?$/, "")
      method_names << camelize(native_name, false)
      method_names << camelize(native_name, true)
      method_names << "is#{camelize(native_name, true)}"
    else
      method_names << ruby_name
      method_names << camelize(ruby_name, false)
      method_names << camelize(ruby_name, true)
    end

    pattern = method_names.map do |method_name|
      "@name='#{method_name}'"
    end.join(" or ")

    xpath = "function[#{pattern}]"
    member_node = node&.find_first(xpath)
    if member_node && member_node.attributes["link"]
      "#{class_base(klass)}/#{member_node.attributes['link']}.html"
    elsif member_node
      "#{class_base(klass)}/#{member_node.attributes['name']}.html"
    end
  end
end

#module_url(klass) ⇒ Object 



105
106
 
# File 'lib/rice/doc/cpp_reference.rb', line 105

def module_url(klass)
end