sqlpostgres 1.2.4

data/tools/rdoc/debian/rdoc.pod

@@ -0,0 +1,149 @@
+=head1 NAME
+
+rdoc - Generate documentation from ruby source files
+
+=head1 SYNOPSIS
+
+Usage:
+
+  rdoc [options]  [names...]
+
+=head1 DESCRIPTION
+
+Files are parsed, and the information they contain
+collected, before any output is produced. This allows cross
+references between all files to be resolved. If a name is a
+directory, it is traversed. If no names are specified, all
+Ruby files in the current directory (and subdirectories) are
+processed.
+
+=head1 OPTIONS
+
+Options:
+
+=over 8
+
+=item B<-a>, B<--all>
+
+include all methods (not just public) in the output
+
+=item B<-c> I<charset>, B<--charset> I<charset>
+
+specifies HTML character-set
+
+=item B<-D>, B<--debug>
+
+displays lots on internal stuff
+
+=item B<-d>, B<--diagram>
+
+Generate diagrams showing modules and classes.
+You need dot V1.8.6 or later to use the --diagram
+option correctly. Dot is available from
+http://www.research.att.com/sw/tools/graphviz/
+
+=item B<-x> I<pattern>, B<--exclude> I<pattern>
+
+do not process files or directories matching
+pattern. Files given explicitly on the command
+line will never be excluded.
+
+=item B<-F>, B<--fileboxes>
+
+classes are put in boxes which represents
+files, where these classes reside. Classes
+shared between more than one file are
+shown with list of files that sharing them.
+Silently discarded if --diagram is not given
+Experimental.
+
+=item B<-f> I<format_name>, B<--fmt> I<format_name>
+
+set the output formatter (see below)
+
+=item B<-h>, B<--help>
+
+print out a brief help summary
+
+=item B<-O>, B<--help-output>
+
+explain the various output options
+
+=item B<-I> I<gif|jpg|jpg|jpeg>, B<--image-format> I<gif|png|jpg|jpeg>
+
+Sets output image format for diagrams. Can
+be png, gif, jpeg, jpg. If this option is
+omitted, png is used. Requires --diagram.
+
+=item B<-i> I<dir[,dir,...]>, B<--include> I<dir[,dir,...]>
+
+set (or add to) the list of directories
+to be searched when satisfying :include:
+requests. Can be used more than once.
+
+=item B<-S>, B<--inline-source>
+
+Show method source code inline, rather
+than via a popup link
+
+=item B<-N>, B<--line-numbers>
+
+Include line numbers in the source code
+
+=item B<-m> I<name>, B<--main> I<name>
+
+'name' will be the initial page displayed
+
+=item B<-1>, B<--one-file>
+
+put all the output into a single file
+
+=item B<-o> I<dir>, B<--op> I<dir>
+
+set the output directory
+
+=item B<-n> I<name>, B<--opname> I<name>
+
+Set the 'name' of the output. Has no
+effect for HTML.
+
+=item B<-q>, B<--quiet>
+
+don't show progress as we parse
+
+=item B<-H>, B<--show-hash>
+
+A name of the form #name in a comment
+is a possible hyperlink to an instance
+method name. When displayed, the '#' is
+removed unless this option is specified
+
+=item B<-w> I<width>, B<--tab-width> I<width>
+
+Set the width of tab characters (default 8)
+
+=item B<-T> I<template_name>, B<--template> I<template_name>
+
+Set the template used when generating output
+
+=item B<-t> I<text>, B<--title> I<text>
+
+Set 'txt' as the title for the output
+
+=item B<-v>, B<--version>
+
+display  RDoc's version
+
+=back
+
+=head1 NOTES
+
+Available output formatters: chm, html, xml
+
+For information on where the output goes, use
+
+   rdoc --help-output
+
+=head1 AUTHOR
+
+This manpage was contributed by Brian Almeida <bma@debian.org>

data/tools/rdoc/debian/rules

@@ -0,0 +1,9 @@
+#!/usr/bin/make -f
+
+include /usr/share/cdbs/1/rules/debhelper.mk
+
+
+common-install-arch common-install-indep:: common-install-impl
+common-install-impl::
+	DESTDIR=$(CURDIR)/debian/rdoc ruby install.rb
+	chmod a+x $(CURDIR)/debian/rdoc/usr/lib/ruby/1.6/rdoc/parsers/parse_rb.rb

data/tools/rdoc/dot/dot.rb

@@ -0,0 +1,255 @@
+module DOT
+    
+    # these glogal vars are used to make nice graph source
+    $tab = '    '
+    $tab2 = $tab * 2
+    
+    # if we don't like 4 spaces, we can change it any time
+    def change_tab( t )
+        $tab = t
+        $tab2 = t * 2
+    end
+    
+    # options for node declaration
+    NODE_OPTS = [
+        'bgcolor',
+        'color',
+        'fontcolor',
+        'fontname',
+        'fontsize',
+        'height',
+        'width',
+        'label',
+        'layer',
+        'rank',
+        'shape',
+        'shapefile',
+        'style',
+        'URL',
+    ]
+    
+    # options for edge declaration
+    EDGE_OPTS = [
+        'color',
+        'decorate',
+        'dir',
+        'fontcolor',
+        'fontname',
+        'fontsize',
+        'id',
+        'label',
+        'layer',
+        'lhead',
+        'ltail',
+        'minlen',
+        'style',
+        'weight'
+    ]
+    
+    # options for graph declaration
+    GRAPH_OPTS = [
+        'bgcolor',
+        'center',
+        'clusterrank',
+        'color',
+        'compound',
+        'concentrate',
+        'fillcolor',
+        'fontcolor',
+        'fontname',
+        'fontsize',
+        'label',
+        'layerseq',
+        'margin',
+        'mclimit',
+        'nodesep',
+        'nslimit',
+        'ordering',
+        'orientation',
+        'page',
+        'rank',
+        'rankdir',
+        'ranksep',
+        'ratio',
+        'size',
+        'style',
+        'URL'
+    ]
+    
+    # a root class for any element in dot notation
+    class DOTSimpleElement
+        attr_accessor :name
+
+        def initialize( params = {} )
+            @label = params['name'] ? params['name'] : ''
+        end
+
+        def to_s
+            @name
+        end
+    end
+    
+    # an element that has options ( node, edge or graph )
+    class DOTElement < DOTSimpleElement
+        #attr_reader :parent
+        attr_accessor :name, :options
+
+        def initialize( params = {}, option_list = [] )
+            super( params )
+            @name = params['name'] ? params['name'] : nil 
+            @parent = params['parent'] ? params['parent'] : nil
+            @options = {}
+            option_list.each{ |i|
+                @options[i] = params[i] if params[i]
+            }
+            @options['label'] ||= @name if @name != 'node'
+        end
+        
+        def each_option
+            @options.each{ |i| yield i }
+        end
+
+        def each_option_pair
+            @options.each_pair{ |key, val| yield key, val }
+        end
+
+        #def parent=( thing )
+        #    @parent.delete( self ) if defined?( @parent ) and @parent
+        #    @parent = thing
+        #end
+    end
+    
+    
+    # this is used when we build nodes that have shape=record
+    # ports don't have options :)
+    class DOTPort < DOTSimpleElement
+        attr_accessor :label
+        
+        def initialize( params = {} )
+            super( params )
+            @name = params['label'] ? params['label'] : ''
+        end
+        def to_s
+            ( @name && @name != "" ? "<#{@name}>" : "" ) + "#{@label}"
+        end
+    end
+    
+    # node element
+    class DOTNode < DOTElement
+
+        def initialize( params = {}, option_list = NODE_OPTS )
+            super( params, option_list )
+            @ports = params['ports'] ? params['ports'] : []
+        end
+
+        def each_port
+            @ports.each{ |i| yield i }
+        end
+
+        def << ( thing )
+            @ports << thing
+        end
+
+        def push ( thing )
+            @ports.push( thing )
+        end
+
+        def pop
+            @ports.pop
+        end
+
+        def to_s( t = '' )
+
+            label = @options['shape'] != 'record' && @ports.length == 0 ?
+                @options['label'] ? 
+                    t + $tab + "label = \"#{@options['label']}\"\n" :
+                    '' :
+                t + $tab + 'label = "' + " \\\n" +
+                t + $tab2 + "#{@options['label']}| \\\n" +
+                @ports.collect{ |i|
+                    t + $tab2 + i.to_s
+                }.join( "| \\\n" ) + " \\\n" +
+                t + $tab + '"' + "\n"
+            
+            t + "#{@name} [\n" +
+            @options.to_a.collect{ |i|
+                i[1] && i[0] != 'label' ? 
+                    t + $tab + "#{i[0]} = #{i[1]}" : nil
+            }.compact.join( ",\n" ) + ( label != '' ? ",\n" : "\n" ) + 
+            label +
+            t + "]\n" 
+        end
+    end
+
+    # subgraph element is the same to graph, but has another header in dot
+    # notation
+    class DOTSubgraph < DOTElement
+
+        def initialize( params = {}, option_list = GRAPH_OPTS )
+            super( params, option_list )
+            @nodes = params['nodes'] ? params['nodes'] : []
+            @dot_string = 'subgraph'
+        end
+
+        def each_node
+            @nodes.each{ |i| yield i }
+        end
+
+        def << ( thing )
+            @nodes << thing
+        end
+       
+        def push( thing )
+            @nodes.push( thing )
+        end
+
+        def pop
+            @nodes.pop
+        end
+
+        def to_s( t = '' )
+          hdr = t + "#{@dot_string} #{@name} {\n"
+
+          options = @options.to_a.collect{ |name, val|
+            val && name != 'label' ? 
+            t + $tab + "#{name} = #{val}" : 
+              name ? t + $tab + "#{name} = \"#{val}\"" : nil
+          }.compact.join( "\n" ) + "\n"
+
+          nodes = @nodes.collect{ |i|
+            i.to_s( t + $tab )
+          }.join( "\n" ) + "\n" 
+          hdr + options + nodes + t + "}\n"
+        end
+    end
+
+    # this is graph
+    class DOTDigraph < DOTSubgraph
+        def initialize( params = {}, option_list = GRAPH_OPTS )
+            super( params, option_list )
+            @dot_string = 'digraph'
+        end
+    end
+
+    # this is edge
+    class DOTEdge < DOTElement
+        attr_accessor :from, :to
+        def initialize( params = {}, option_list = EDGE_OPTS )
+            super( params, option_list )
+            @from = params['from'] ? params['from'] : nil
+            @to = params['to'] ? params['to'] : nil
+        end
+        
+        def to_s( t = '' )
+            t + "#{@from} -> #{to} [\n" +
+            @options.to_a.collect{ |i|
+                i[1] && i[0] != 'label' ? 
+                    t + $tab + "#{i[0]} = #{i[1]}" : 
+                    i[1] ? t + $tab + "#{i[0]} = \"#{i[1]}\"" : nil
+            }.compact.join( "\n" ) + "\n" + t + "]\n"
+        end
+    end
+end
+
+
+

data/tools/rdoc/etc/rdoc.dtd

@@ -0,0 +1,203 @@
+<!--
+  This is the DTD for the XML produced by the RDoc package.
+
+  Some conventions:
+
+  Cross references:
+     - targets are labeled using id="..." attributes
+     - references use conventional <a href="...">...</a> notation
+
+  
+ -->
+
+
+<!-- ==================== common entities ======================== -->
+
+<!ENTITY % idattr
+ "id    CDATA  #IMPLIED"
+>
+
+<!ENTITY % name-id
+ "id    CDATA  #IMPLIED
+  name  CDATA  #REQUIRED"
+>
+
+<!-- a name or a reference to a name -->
+
+<!ENTITY % aref "(#PCDATA | a)*">
+
+<!-- the contents of a markup section -->
+
+<!ENTITY % markup.attrs    "b | tt | em">
+
+<!ENTITY % markup.lists    "ul | ol | dl | table ">
+
+<!ENTITY % markup.heading  "h1 | h2 | h3 | h4 | h5 | h6 ">
+
+<!ENTITY % markup.internal "#PCDATA | p | a | pre | hr | %markup.attrs; | %markup.lists;">
+
+<!ENTITY % flow            "(#PCDATA | %markup.attrs;)*">
+
+<!ENTITY % markup          "(%markup.internal;)*">
+
+<!ENTITY % toplevel        "(%markup.internal; | %markup.heading;)*">
+
+<!-- ================== document structure ======================= -->
+
+<!ELEMENT rdoc (file-list?, class-module-list?)>
+
+<!-- ================== file-list ================================
+
+  A file list contains a <file> entry for every source file
+  processed.
+
+ -->
+
+<!ELEMENT file-list (file*)>
+
+<!ELEMENT file (file-info, description?, contents)>
+<!ATTLIST file %name-id;>
+
+
+<!ELEMENT file-info (path, dtm-modified)>
+
+<!-- the full path to the file -->
+
+<!ELEMENT path (#PCDATA)>
+
+<!-- last modified dtms of file -->
+
+<!ELEMENT dtm-modified (#PCDATA)>
+
+
+<!-- =================== class list ======================== -->
+
+<!ELEMENT class-module-list (Class|Module)*>
+
+<!ELEMENT Class (classmod-info, description?, contents)>
+<!ATTLIST Class %name-id;>
+
+<!ELEMENT Module (classmod-info, description?, contents)>
+<!ATTLIST Module %name-id;>
+
+<!ELEMENT classmod-info (infiles?, superclass?)>
+
+<!ELEMENT infiles (infile*)>
+
+<!ELEMENT infile %aref;>
+
+<!ELEMENT superclass %aref;>
+
+
+<!-- ==================== description =========================== -->
+
+<!ELEMENT description %toplevel;>
+
+<!-- ==================== contents ==============================
+
+  These are the contents, shared between files and classes
+
+ -->
+
+<!ELEMENT contents (required-file-list?,
+                    attribute-list?,
+                    included-module-list?,
+                    method-list?)>
+
+<!ELEMENT required-file-list (required-file*)>
+
+<!ELEMENT required-file EMPTY>
+<!ATTLIST required-file
+  name     CDATA  #REQUIRED
+  href     CDATA  #IMPLIED
+>
+
+<!ELEMENT attribute-list (attribute*)>
+
+<!ELEMENT attribute (attribute-rw, description)>
+<!ATTLIST attribute
+  name     CDATA  #REQUIRED
+>
+
+<!ELEMENT attribute-name (#PCDATA)>
+<!ELEMENT attribute-rw   (#PCDATA)>
+
+<!ELEMENT included-module-list (included-module*)>
+
+<!ELEMENT included-module EMPTY>
+<!ATTLIST included-module
+  name    CDATA    #REQUIRED
+  href    CDATA    #IMPLIED
+>
+
+<!ELEMENT method-list (method*)>
+
+<!ELEMENT method (parameters, description?, source-code-listing?)>
+<!ATTLIST method
+  name     CDATA  #REQUIRED
+  id       CDATA  #REQUIRED
+  type     (Public | Private | Protected)  #REQUIRED
+  category (Instance | Class)              #REQUIRED
+>
+
+<!ELEMENT parameters (#PCDATA)>
+
+<!ELEMENT source-code-listing (#PCDATA | span)*>
+
+<!-- for marking up code
+     kw  - keyword
+     cmt - comment
+     str - string
+     re  - regexp
+-->
+
+<!ELEMENT span (#PCDATA)>
+<!ATTLIST span
+  class   (kw | cmt | str | re)   #REQUIRED
+>
+
+<!-- ================== cross references ================== -->
+
+<!ELEMENT a (#PCDATA)>
+<!ATTLIST a
+  href  CDATA  #REQUIRED
+>
+
+<!-- ================== markup ============================ -->
+
+<!ELEMENT p %markup;>
+
+<!ELEMENT h1 %flow;>
+<!ELEMENT h2 %flow;>
+<!ELEMENT h3 %flow;>
+<!ELEMENT h4 %flow;>
+<!ELEMENT h5 %flow;>
+<!ELEMENT h6 %flow;>
+
+<!ELEMENT b  %markup;>
+<!ELEMENT tt %markup;>
+<!ELEMENT em %markup;>
+
+<!ELEMENT pre (#PCDATA)>
+
+<!ELEMENT hr EMPTY>
+<!ATTLIST hr
+  size    CDATA  #IMPLIED
+>
+
+
+<!ELEMENT ul (li*)>
+<!ELEMENT ol (li*)>
+<!ELEMENT li %markup;>
+<!ELEMENT dl (dt|dd)+>
+<!ELEMENT dt %markup;>
+<!ELEMENT dd %markup;>
+
+<!ELEMENT table (tr)+>
+
+<!ELEMENT tr (td)+>
+
+<!ELEMENT td %markup;>
+<!ATTLIST td
+  valign CDATA #FIXED "top"
+>