rbczmq 1.6.2 → 1.6.4

data/ext/czmq/doc/mkman

@@ -0,0 +1,100 @@
+#! /usr/bin/perl
+#   
+#   mkman - Generates man pages from C source and header files.
+#
+#   Syntax: 'mkman classname', in doc subdirectory.
+#
+#   Copyright (c) 1996-2011 iMatix Corporation
+#
+#   This is free software; you can redistribute it and/or modify it under the
+#   terms of the GNU General Public License as published by the Free Software
+#   Foundation; either version 3 of the License, or (at your option) any later
+#   version.
+#
+#   This software is distributed in the hope that it will be useful, but
+#   WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABIL-
+#   ITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
+#   License for more details.
+#
+#   You should have received a copy of the GNU General Public License along
+#   with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+use File::Basename;
+
+$class = $ARGV [0];
+$class = $1 if $class =~ /(\w+)\.\w+/;
+$top_srcdir = "..";
+
+#   Look for class title in 2nd line of source
+#   If there's no class file, leave hand-written man page alone
+exit unless open (SOURCE, "$top_srcdir/src/$class.c");
+$_ = <SOURCE>;
+$_ = <SOURCE>;
+$title = "no title found";
+$title = $1 if (/    \w+ - (.*)/);
+close (SOURCE);
+
+#   Open output file
+die "Can't create $class.txt: $!"
+    unless open (OUTPUT, ">$class.txt");
+
+printf "Generating $class.txt...\n";
+$underline = "=" x (length ($class) + 3);
+
+$template = <<"END";
+$class(3)
+$underline
+
+NAME
+----
+$class - $title
+
+SYNOPSIS
+--------
+----
+pull $top_srcdir/include/$class.h\@interface
+----
+
+DESCRIPTION
+-----------
+
+pull $top_srcdir/src/$class.c\@header,left
+
+pull $top_srcdir/src/$class.c\@discuss,left
+
+EXAMPLE
+-------
+.From $class\_test method
+----
+pull $top_srcdir/src/$class.c\@selftest
+----
+
+SEE ALSO
+--------
+linkczmq:czmq[7]
+END
+
+#   Now process template
+for (split /^/, $template) {
+    if (/^pull (.*)(@[a-zA-Z0-9]+)(,(.*)\s*)?/) {
+        $source = $1;
+        $tag = $2;
+        $opts = $4;
+        die "Can't read $source: $!"
+            unless open (SOURCE, $source);
+        while (<SOURCE>) {
+            if (/$tag/) {
+                while (<SOURCE>) {
+                    last if /@[a-zA-Z0-9]+/;
+                    $_ = "    $_" if ($opts eq "code");
+                    s/^    // if ($opts eq "left");
+                    print OUTPUT $_;
+                }
+            }
+        }
+        close (SOURCE);
+    }
+    else {
+        print OUTPUT $_;
+    }
+}

data/ext/czmq/doc/mksite

@@ -0,0 +1,65 @@
+#! /bin/bash
+#
+#   mksite - Upload CZMQ manual to czmq.zeromq.org/manual:
+#
+#   Author: Pieter Hintjens <ph@imatix.com>
+#   License: public domain
+#
+#   syntax: mksite
+#
+
+#   Export so child scripts can access these
+export UPLOAD=1            #   If 0, don't actually upload
+export CATEGORY=manual     #   Category to receive man pages
+export WEBSITE=czmq        #   Wikidot website prefix
+
+# This function uploads a file to wikidot
+# Error in upload will cause the script to exit with non-zero status
+
+function do_upload {
+    ./wdput $WEBSITE $CATEGORY $1 $2
+    if [ $? != 0 ]; then
+        echo "Error uploading file to wikidot"
+        exit 1
+    fi
+}
+
+echo "Building docs..."
+make --quiet
+rm -f *.xml    #   Makefile does not detect version differences for XML
+for FILE in z*.txt; do 
+    ./mkman $FILE
+    make `basename $FILE .txt`.xml
+done
+
+echo "Generating XML pages for manual..."
+FILES=
+for FILE in czmq.txt z*.txt; do
+    BASE=`basename $FILE .txt`
+    make --quiet $BASE.xml;
+    FILES="$FILES $BASE"
+done
+
+echo "Generating Wikidot pages..."
+for FILE in $FILES; do
+    perl ./xml2wd.pl $FILE.xml > $FILE.wd
+done
+
+if [ $UPLOAD -eq 1 ]; then
+    echo "Uploading to $CATEGORY..."
+
+    #   Send table of contents as category:_start
+    do_upload "_start" "CZMQ Documentation"
+
+    #   Now send individual man pages
+    for FILE in $FILES; do
+        TITLE=`egrep --after-context 1 PAGE_TITLE $FILE.wd | egrep $FILE`
+        do_upload $FILE $TITLE
+    done
+fi
+
+#   Cleanup generated files
+rm _start.wd
+for FILE in $FILES; do
+    rm $FILE.wd
+done

data/ext/czmq/doc/wdput

@@ -0,0 +1,43 @@
+#! /usr/bin/python
+#
+#   wdput - Send one Wikidot page to api.zero.mq
+#   Part of the ztools/apisite toolkit. Install into any directory on PATH.
+#
+#   Author: Pieter Hintjens <ph@imatix.com>
+#   License: public domain
+#
+#   syntax: wdput sitename category page title
+#
+#   Wikidot text must be in page + '.wd'
+#
+#   Supply your Wikidot user name as an environment variable APISITE_USER
+#   Supply your Wikidot API key as an environment variable APISITE_KEY
+
+#   Get script arguments
+import sys
+sitename = sys.argv [1]
+category = sys.argv [2]
+name     = sys.argv [3]
+title    = sys.argv [4]
+
+#   Get authentication credentials
+import os
+user = os.environ ['APISITE_USER']
+key  = os.environ ['APISITE_KEY']
+
+#   Create XML/RPC connection to Wikidot
+from xmlrpclib import ServerProxy
+server = ServerProxy ('https://' + user + ':' + key + '@www.wikidot.com/xml-rpc-api.php')
+
+#   Send page content (create or update)
+file = open (name + ".wd", "r")
+content = ""
+for line in file:
+    content = content + line
+
+print " - " + category + ":" + name
+server.pages.save_one ({
+    "site": sitename,
+    "page": category + ":" + name,
+    "title": title,
+    "content": content})

data/ext/czmq/doc/xml2wd.pl

@@ -0,0 +1,242 @@
+#! /bin/perl
+#
+#   xml2wd.pl - Convert docbook XML to Wikidot syntax
+#   Part of the ztools/apisite toolkit. Modified for CZMQ.
+#
+#   Author: Pieter Hintjens <ph@imatix.com>
+#   License: public domain
+#
+#   This is a very hacky tool that turns a docbook XML file into Wikidot
+#   content ready for upload via the Wikidot API. It would be better to
+#   do this conversion using an XML stylesheet but I'm too lazy for that.
+#
+#   syntax: perl xml2wd.pl < inputfile > outputfile
+#
+#   Supply the Wikidot page category as an environment variable CATEGORY.
+
+$category = $ENV{'CATEGORY'} || "page";
+
+while (<>) {
+    $output = "";
+    s/\[/@@[@@/g;
+    s/\]/@@]@@/g;
+
+    $title = $1 if (/<refentrytitle>(.*)<\/refentrytitle>/);
+    $volume = $1 if (/<manvolnum>(.*)<\/manvolnum>/);
+    $source = $1 if (/<refmiscinfo class="source">(.*)<\/refmiscinfo>/);
+    $version = $1 if (/<refmiscinfo class="version">(.*)<\/refmiscinfo>/);
+    $manual = $1 if (/<refmiscinfo class="manual">(.*)<\/refmiscinfo>/);
+    $name = $1 if (/<refname>(.*)<\/refname>/);
+    $purpose = $1 if (/<refpurpose>(.*)<\/refpurpose>/);
+    if (/<\/refmeta>/) {
+        $output = <<"END";
+[!-- PAGE_TITLE
+$title($volume)
+--]
+[[div style="width:30%; float:left;"]]
+$title($volume)
+[[/div]]
+[[div style="width:40%; float:left;; text-align:center"]]
+[/$category:_start Back to Contents]
+[[/div]]
+[[div style="width:30%; float:left; text-align:right"]]
+$manual - $source/$version
+[[/div]]
+END
+        if ($title eq "czmq") {
+            open (TOC, ">_start.wd");
+            print TOC "[[image http://czmq.zeromq.org/local--files/admin:css/logo.gif link=\"page:start\"]]\n\n";
+            print TOC "++ CZMQ/$version reference\n\n";
+            close (TOC);
+        }
+    }
+    elsif (/<\/refnamediv>/) {
+        $output = <<"END";
+[[div class="foldedtoc" style="margin:10px"]]
+[[collapsible show="+ Table of Contents" hide="- Table of Contents"]]
+[[toc]]
+[[/collapsible]]
+[[/div]]
+
+++ Name
+
+$name - $purpose
+END
+        open (TOC, ">>_start.wd");
+        print TOC "* [/$category:$name $name] - $purpose\n";
+        close (TOC);
+    }
+    if (/<refsynopsisdiv id="_synopsis">/) {
+        $_ = load_tag ("refsynopsisdiv");
+        $output = "\n++ Synopsis\n\n[[div class=\"synopsis\"]]\n$_\n[[/div]]\n";
+    }
+    elsif (/<refsect1/) {
+        $header = "++";
+    }
+    elsif (/<refsect2/) {
+        $header = "+++";
+    }
+    elsif (/<refsect3/) {
+        $header = "++++";
+    }
+    elsif (/<variablelist>/) {
+        $variable_list = 1;
+    }
+    elsif (/<\/variablelist>/) {
+        $variable_list = 0;
+    }
+
+    if (/<table.*<title>(.*)<\/title>/) {
+        $output = "\n||||~ $1 ||\n";
+    }
+    elsif (/<entry>/) {
+        $_ = load_tag ("entry");
+        $output = "|| $_";
+    }
+    elsif (/<\/row>/) {
+        $output = "||\n";
+    }
+    elsif (/<formalpara>/) {
+        $_ = load_tag ("formalpara");
+        if (/<title>(.*)<\/title><para>\s*(.*)<\/para>/s) {
+            $output = "\n**". title_case ($1) ."**\n\n$2\n";
+        }
+    }
+    elsif (/<title>(.*)<\/title>/) {
+        $output = "\n$header ". title_case ($1) ."\n";
+    }
+    elsif (/<note>/) {
+        $_ = load_tag ("note");
+        $output = "\n[[note]]\n$_\n[[/note]]\n";
+    }
+    elsif (/<simpara>/) {
+        $_ = load_tag ("simpara");
+        $output = "\n$_\n";
+    }
+    elsif (/<literallayout>/) {
+        $_ = load_tag ("literallayout");
+        $output = "\n> {{$_}}\n";
+    }
+    elsif (/<literallayout class="monospaced">/) {
+        $_ = $';
+        chop while /\s$/;
+        $line = $_;
+        while (<>) {
+            chop while /\s$/;
+            $line .= "\n$_";
+            if ($line =~ /(.*)<\/literallayout>/s) {
+                $_ = $1;
+                last;
+            }
+        }
+        $output = "\n[[code]]\n$_\n[[/code]]\n";
+    }
+    elsif (/<screen>/) {
+        $_ = $';
+        chop while /\s$/;
+        $line = $_;
+        while (<>) {
+            chop while /\s$/;
+            $line .= "\n$_";
+            if ($line =~ /(.*)<\/screen>/s) {
+                $_ = $1;
+                last;
+            }
+        }
+        s/\/\//\\\/\\\//g;
+        $output = "\n[[code]]\n$_\n[[/code]]\n";
+    }
+
+    if (/<term>/) {
+        $term = load_tag ("term");
+    }
+    if (/<listitem>/) {
+        $_ = load_tag ("listitem");
+        #print "---- $_\n";
+        #   Sometimes tables end up inside list items
+        s/<informal.*?<tbody valign="top">/\n/s;
+        s/\s*<\/tbody><\/tgroup><\/informaltable>//s;
+        while (/\s*<entry>\s*(.*?)\s*<\/entry>\s*/s) {
+            $_ = $` . "$1 ||" . $';
+        }
+        while (/\s*<row>\s*(.*?)\s*<\/row>/) {
+            $_ = $` . "\n|| $1\n" . $';
+        }
+        if ($variable_list) {
+            die "Missing term in $name:$.\n" unless $term;
+            $output = "\n: $term:$_\n";
+            $term = "";
+        }
+        else {
+            $output = "* $_\n";
+        }
+    }
+
+    #   General substitutions
+    $output =~ s/\/\//@@\/\/@@/g;
+    $output =~ s/\\\/\\\//\/\//g;   #   // in code blocks was escaped
+    $output =~ s/http:@@\/\/@@/http:\/\//g;
+
+    $output =~ s/0MQ/ØMQ/g;
+    $output =~ s/<emphasis>([^<]*)<\/emphasis>/\/\/$1\/\//g;
+    $output =~ s/<emphasis role="strong">([^<]*)<\/emphasis>/**$1**/g;
+    $output =~ s/<literal>([^<]*)<\/literal>/{{ $1}}/g;
+    $output =~ s/<manvolnum>([^<]*)<\/manvo>/{{$1}}/g;
+    $output =~ s/<citerefentry>\s*<refentrytitle>([^<]*)<\/refentrytitle><manvolnum>([^<]*)<\/manvolnum>\s*<\/citerefentry>/\[\/$category:$1 $1($2)\]/g;
+    $output =~ s/<ulink url="[^"]*">([^<]*)<\/ulink>/$1/g;
+    $output =~ s/<simpara>([^<]*)<\/simpara>/$1/g;
+    $output =~ s/&lt;/</g;
+    $output =~ s/&gt;/>/g;
+    $output =~ s/&amp;/&/g;
+    $output =~ s/&#8217;/'/g;
+    $output =~ s/&#8230;/.../g;
+
+    print $output if $output;
+}
+
+
+sub load_tag {
+    local ($tag) = @_;
+    if (/<$tag[^>]*>(.*)<\/$tag>/) {
+        return $1;
+    }
+    else {
+        chop while /\s$/;
+        /<$tag[^>]*>/;
+        $line = $';
+        while (<>) {
+            chop while /\s$/;
+            if (/<screen>/) {
+                $_ = "[[code]]\n$'";
+                s/\/\//\\\/\\\//g;
+                $code = 1;
+            }
+            elsif (/<\/screen>/) {
+                $_ = "\n$`\n[[/code]]";
+                s/\/\//\\\/\\\//g;
+                $code = 0;
+            }
+            if ($code) {
+                s/\/\//\\\/\\\//g;
+                $line .= "\n$_";
+            }
+            else {
+                $line .= " " if $line;
+                $line .= $_;
+            }
+            if ($line =~ /(.*)<\/$tag>/s) {
+                return $1;
+                last;
+            }
+        }
+    }
+}
+
+sub title_case {
+    local ($_) = @_;
+    if (!/^ZMQ_/) {
+        tr/[A-Z]/[a-z]/;
+        s/(\w+)/\u\L$1/;
+    }
+    return $_;
+}