doxyparser 1.2

data/lib/nodes/friend.rb

@@ -0,0 +1,20 @@
+module Doxyparser
+
+	class Friend < Member
+
+		def is_class?
+			args.nil? || args == ""
+		end
+
+		def is_qualified?
+			basename.include? '::'
+		end
+		
+		private 
+		
+		def find_name
+			@basename = @node.xpath("name")[0].child.content
+			@parent.name + '::' + @basename
+		end
+	end
+end

data/lib/nodes/function.rb

@@ -0,0 +1,54 @@
+module Doxyparser
+
+	class Function < Member
+
+		def == another
+			super
+			self.args == another.args
+		end
+
+		def eql? another
+			super
+			self.args == another.args
+		end
+
+		def to_str
+			super + @args
+		end
+
+		def to_s
+			super + @args
+		end
+
+		def constructor?
+			@basename==parent.basename
+		end
+
+		def destructor?
+			@basename.start_with? %Q{~}
+		end
+
+		def getter_for
+			if @params.empty? || (@params.size == 1 && @params[0].type.name =~ /\s*void\s*/)
+				if @basename.start_with?('get') || @basename.start_with?('Get')
+					return @basename.gsub(/get[_]?(\w)/i){|match| $1.downcase}
+				end
+				if @type.name == 'bool'
+					if @basename.start_with?('is') || @basename.start_with?('Is')
+						return @basename.gsub(/is[_]?(\w)/i){|match| $1.downcase}
+					end
+				end
+			end
+			return nil
+		end
+
+		def setter_for
+			if @type.name == 'void'
+				if @basename.start_with?('set') || @basename.start_with?('Set')
+					return @basename.gsub(/set[_]?(\w)/i){|match| $1.downcase}
+				end
+			end
+			return nil
+		end
+	end
+end

data/lib/nodes/group.rb

@@ -0,0 +1,6 @@
+module Doxyparser
+
+  class Group < Compound
+    
+  end
+end

data/lib/nodes/hfile.rb

@@ -0,0 +1,73 @@
+module Doxyparser
+
+	class HFile < Compound
+
+		def list_included
+			lst=doc.xpath(%Q{/doxygen/compounddef/includes})
+			lst.map { |f| f.child.content }
+		end
+
+		def list_including
+			lst=doc.xpath(%Q{/doxygen/compounddef/includedby})
+			lst.map { |f| f[:refid].nil? ? f.child.content : escape_file_name(f[:refid]) }
+		end
+
+		def files_included
+			lst=doc.xpath(%Q{/doxygen/compounddef/includes[@local="yes"]})
+			lst.map { |f| Doxyparser::HFile.new(dir: @dir, node: f) }
+		end
+
+		def files_including
+			lst=doc.xpath(%Q{/doxygen/compounddef/includedby[@local="yes"]})
+			lst.map { |f| Doxyparser::HFile.new(dir: @dir, node: f) }
+		end
+
+		def structs
+			lst=doc.xpath(%Q{/doxygen/compounddef/innerclass})
+			lst = lst.select { |c| c["refid"].start_with?("struct") }
+			lst.map { |node| Doxyparser::Struct.new(dir: @dir, node: node) }
+		end
+
+		def classes
+			lst=doc.xpath(%Q{/doxygen/compounddef/innerclass})
+			lst = lst.select { |c| c["refid"].start_with?("class") }
+			lst.map { |node| Doxyparser::Class.new(dir: @dir, node: node) }
+		end
+
+		def namespaces
+			lst=doc.xpath(%Q{/doxygen/compounddef/innernamespace})
+			lst.map { |node| Doxyparser::Namespace.new(dir: @dir, node: node) }
+		end
+
+		def functions
+			lst=doc.xpath(%Q{/doxygen/compounddef/sectiondef[@kind="func"]/memberdef[@kind="function"]})
+			lst.map { |node| Doxyparser::Function.new(parent: self, node: node) }
+		end
+
+		def variables
+			lst=doc.xpath(%Q{/doxygen/compounddef/sectiondef[@kind="var"]/memberdef[@kind="variable"]})
+			lst.map { |node| Doxyparser::Variable.new(parent: self, node: node) }
+		end
+
+		def enums
+			lst=doc.xpath(%Q{/doxygen/compounddef/sectiondef[@kind="enum"]/memberdef[@kind="enum"]})
+			lst.map { |node| Doxyparser::Enum.new(parent: self, node: node) }
+		end
+
+		def typedefs
+			lst=doc.xpath(%Q{/doxygen/compounddef/sectiondef[@kind="typedef"]/memberdef[@kind="typedef"]})
+			lst.map { |node| Doxyparser::Typedef.new(parent: self, node: node) }
+		end
+
+		private
+		
+		def find_name
+			escape_file_name self.refid
+		end
+
+		def compute_path
+			aux= escape_file_name @name
+			@xml_path = %Q{#{@dir}/#{aux}.xml}
+		end
+	end
+end

data/lib/nodes/member.rb

@@ -0,0 +1,61 @@
+module Doxyparser
+
+	class Member < Node
+
+		attr_reader :location
+		attr_reader :definition
+		attr_reader :args
+		attr_reader :type
+		attr_reader :static
+		attr_reader :params
+
+		def file
+			HFile.new(:name => @filename, :dir => @dir)
+		end
+
+		private
+
+		def init_attributes
+			super
+			raise "No XML node was associated to this member" if @node.nil?
+			@xml_path=parent.xml_path
+			if @node['static']
+				@static = (@node['static'] == 'yes') ? 'static' : nil
+			end
+			aux= self.xpath("location")[0]
+			@filename=File.basename(aux["file"])
+			@location="#{aux["file"]}:#{aux["line"]}"
+			temp=self.xpath("definition")
+			if temp == nil || temp.empty? || temp[0].child==nil
+				@definition = ""
+			else
+				@definition = temp[0].child.content
+			end
+			temp = self.xpath("argsstring")
+			if temp == nil || temp.empty? || temp[0].child==nil
+				@args = ""
+			else
+				@args = temp[0].child.content
+			end
+			@type = find_type @node
+
+			@params=[]
+			all_params= self.xpath("param")
+			return if all_params == nil || all_params.empty? || all_params[0].child==nil
+
+			all_params.each { |param|
+				@params << Doxyparser::Param.new(node: param, parent: self, name: 'param''param')
+			}
+		end
+
+		def find_name
+			@parent.name + '::' + @node.xpath("name")[0].child.content
+		end
+
+		def find_type n
+			type = n.xpath("type")
+			return "" if type.nil? || type.empty? || type[0].child==nil
+			Type.new node: type[0], dir: @dir
+		end
+	end
+end

data/lib/nodes/namespace.rb

@@ -0,0 +1,66 @@
+module Doxyparser
+
+  class Namespace < Compound
+
+    def functions filter=nil
+      lst=doc.xpath(%Q{/doxygen/compounddef/sectiondef[@kind="func"]/memberdef[@kind="function"]})
+      do_filter(filter, lst, Doxyparser::Function) { |node|
+         node.xpath("name")[0].child.content.strip
+      }
+    end
+    
+    def enums filter=nil
+      lst=doc.xpath(%Q{/doxygen/compounddef/sectiondef[@kind="enum"]/memberdef[@kind="enum"]})
+      filter.map!{ |exp| exp =~ /^_Enum/ ? /@\d*/ : exp} unless filter.nil?
+      do_filter(filter, lst, Doxyparser::Enum) { |node|
+      	node.xpath("name")[0].child.content.strip
+      }
+    end
+
+    def variables filter=nil
+      lst=doc.xpath(%Q{/doxygen/compounddef/sectiondef[@kind="var"]/memberdef[@kind="variable"]})
+      do_filter(filter, lst, Doxyparser::Variable) { |node|
+        node.xpath("name")[0].child.content.strip
+      }
+    end
+    
+    def typedefs filter=nil
+    	lst=doc.xpath(%Q{/doxygen/compounddef/sectiondef[@kind="typedef"]/memberdef[@kind="typedef"]})
+      do_filter(filter, lst, Doxyparser::Typedef) { |node| del_spaces node.xpath("name")[0].child.content }
+    end
+    
+    def innernamespaces filter=nil
+      lst=doc.xpath(%Q{/doxygen/compounddef/innernamespace})
+      do_filter(filter, lst, Doxyparser::Namespace) { |node|
+        del_spaces del_prefix(node.child.content)
+      }
+    end
+    
+    def structs filter=nil
+      lst=doc.xpath(%Q{/doxygen/compounddef/innerclass})
+      lst = lst.select { |c| c["refid"].start_with?("struct") }
+      do_filter(filter, lst, Doxyparser::Struct) { |node|
+        del_spaces del_prefix(node.child.content)
+      }
+    end
+
+    def classes filter=nil
+    	 lst=doc.xpath(%Q{/doxygen/compounddef/innerclass})
+      lst = lst.select { |c| c["refid"].start_with?("class") }
+      do_filter(filter, lst, Doxyparser::Class) { |node|
+        del_spaces del_prefix(node.child.content)
+      }
+    end   
+
+    def file
+      nil
+    end
+
+    private
+
+    def compute_path
+      aux = escape_class_name(@name)
+      @xml_path = %Q{#{@dir}/namespace#{aux}.xml}
+    end
+  end
+end

data/lib/nodes/node.rb

@@ -0,0 +1,63 @@
+module Doxyparser
+
+	class Node
+		include Doxyparser::Util
+
+		attr_reader :dir
+		attr_reader :name
+		attr_reader :basename
+		attr_reader :node
+		attr_reader :doc
+		attr_reader :parent
+
+		def == another
+			self.name == another.name
+		end
+
+		def eql? another
+			self.name == another.name
+		end
+
+		def to_str
+			@name
+		end
+
+		def to_s
+			@name
+		end
+
+		# Takes a hash as input with following keys: :node, :parent, :dir, :name
+		def initialize hash
+			@dir = hash[:dir]
+			@name = hash[:name]
+			if hash[:node] # If a reference to an xml declaration (node) is given then...
+				@node = hash[:node]
+				@parent = hash[:parent]
+				@name = find_name
+				@dir ||= @parent.dir unless @parent.nil?
+			end
+			raise "No name given for node: #{self.class.name}" unless @name
+			raise "No xml directory given for node: #{self.class.name}" unless @dir
+			init_attributes
+		end
+
+		private
+
+		def method_missing sym, *args
+			if @node.respond_to? sym
+			@node.send(sym, *args)
+			else
+			@node[sym.to_s] || super
+			end
+		end
+
+		def init_attributes
+			@basename ||= del_prefix @name
+		end
+
+		def find_name
+			# For Inheritance
+		end
+
+	end
+end

data/lib/nodes/param.rb

@@ -0,0 +1,34 @@
+module Doxyparser
+
+	class Param < Node
+
+		attr_reader :type
+		attr_reader :declname
+		attr_reader :value
+		
+		private
+		
+		def find_name
+    		'param' # Default name if nothing else
+    	end
+
+		def init_attributes
+			type_temp = @node.xpath("type")
+			return if type_temp.nil? || type_temp.empty?
+			@type = Type.new node: type_temp[0], parent: @parent
+			@name = @type.name			
+
+			declname_temp = @node.xpath("declname")
+			return if declname_temp.nil? || declname_temp.empty?
+			@declname = declname_temp[0].content
+			
+			@name += @declname
+			
+			@basename = @declname
+
+			value_temp = @node.xpath("defval")
+			return if value_temp.nil? || value_temp.empty?
+			@value = value_temp[0].content
+		end
+	end
+end

data/lib/nodes/struct.rb

@@ -0,0 +1,89 @@
+module Doxyparser
+
+	class Struct < Compound
+
+		def file
+			n=doc.xpath("/doxygen/compounddef/includes")[0]
+			raise "#{self.name} #{self.class.name} does not have correctly generated documentation. Use 'EXTRACT_ALL' Doxygen flag" unless n
+			HFile.new(dir: @dir, node: n)
+		end
+
+		def friends
+			lst=doc.xpath(%Q{/doxygen/compounddef/sectiondef[@kind="friend"]/memberdef[@kind="friend"]})
+			lst.map { |node|
+				Doxyparser::Friend.new(parent: self, node: node)
+			}
+		end
+
+		def template_params
+			params=doc.xpath(%Q{/doxygen/compounddef/templateparamlist/param})
+			params.map { |param|
+				Doxyparser::Param.new(parent: self, node: param)
+			}
+		end
+
+		def methods access=:public, static=nil, filter=nil
+			if static.nil?
+				static="-"
+			else
+				static="-static-"
+			end
+			sectiondef=%Q{#{access}#{static}func}
+			lst=doc.xpath(%Q{/doxygen/compounddef/sectiondef[@kind="#{sectiondef}"]/memberdef[@kind="function"][@prot="#{access}"]})
+			do_filter(filter, lst, Doxyparser::Function) { |node|
+				node.xpath("name")[0].child.content
+			}
+		end
+
+		def attributes access=:public, static=nil, filter=nil
+			if static.nil?
+				static="-"
+			else
+				static="-static-"
+			end
+			sectiondef=%Q{#{access}#{static}attrib}
+			lst=doc.xpath(%Q{/doxygen/compounddef/sectiondef[@kind="#{sectiondef}"]/memberdef[@kind="variable"][@prot="#{access}"]})
+			do_filter(filter, lst, Doxyparser::Variable) { |node|
+				node.xpath("name")[0].child.content
+			}
+		end
+
+		def innerclasses access=:public, filter=nil
+			lst=doc.xpath(%Q{/doxygen/compounddef/innerclass[@prot="#{access}"]})
+			lst = lst.select { |c| c["refid"].start_with?("class") }
+			do_filter(filter, lst, Doxyparser::Class) { |node|
+				del_prefix(node.child.content)
+			}
+		end
+
+		def innerstructs access=:public, filter=nil
+			lst=doc.xpath(%Q{/doxygen/compounddef/innerclass[@prot="#{access}"]})
+			lst = lst.select { |c| c["refid"].start_with?("struct") }
+			do_filter(filter, lst, Doxyparser::Struct) { |node|
+				del_prefix(node.child.content)
+			}
+		end
+
+		def innerenums access=:public, filter=nil
+			sectiondef=%Q{#{access}-type}
+			lst=doc.xpath(%Q{/doxygen/compounddef/sectiondef[@kind="#{sectiondef}"]/memberdef[@kind="enum"][@prot="#{access}"]})
+			filter.map!{ |exp| exp =~ /^_Enum/ ? /@\d*/ : exp} unless filter.nil?
+			do_filter(filter, lst, Doxyparser::Enum) { |node|
+				node.xpath("name")[0].child.content
+			}
+		end
+
+		def typedefs access=:public, filter=nil
+			sectiondef=%Q{#{access}-type}
+			lst=doc.xpath(%Q{/doxygen/compounddef/sectiondef[@kind="#{sectiondef}"]/memberdef[@kind="typedef"][@prot="#{access}"]})
+			do_filter(filter, lst, Doxyparser::Typedef) { |node| del_spaces node.xpath("name")[0].child.content }
+		end
+
+		private
+
+		def compute_path
+			aux = escape_class_name @name
+			@xml_path = %Q{#{@dir}/struct#{aux}.xml}
+		end
+	end
+end