kwaff 1.0.0

data/examples/xhtml/Makefile

@@ -0,0 +1,9 @@
+ALL =  README.xhtml
+
+all:    $(ALL)
+
+%.xhtml:  %.kwaff
+	kwaff $< > $@
+
+clean:
+	rm -f $(ALL)

data/examples/xhtml/README.kwaff

@@ -0,0 +1,84 @@
+? encoding		= UTF-8
+? doctype		= @xhtml
+
+* html
+  - lang		= en
+
+  * head
+
+    * title		= README
+    * meta
+      - http-equiv	= Content-Type
+      - content		= text/xhtml
+
+  * body
+
+    * h1 = What is Kwaff?
+    * p
+      . Kwaff is a simplified and structured data format.
+      . See examples directory for detail.
+    * p
+      . Name of 'Kwaff' is derived from "kwa's friendly formatter".
+
+    * h1 = Installation
+    * p
+      . There are two ways to install Kwaff.
+    * dl
+      * dt = If you can be root user:
+      * dd
+        * pre = <<<END
+          $ ruby setup.rb config
+          $ ruby setup.rb setup
+          $ su
+          # ruby setup.rb install
+          END
+      * dt = If you cannot be root user:
+      * dd
+        * pre = <<<END
+          ### copy command file to appropriate directory.
+          $ cp bin/kwaff  $HOME/bin/
+          ### copy library files to appropriate directory.
+          $ mkdir -p $HOME/lib/ruby
+          $ cp -r lib/kwaff* $HOME/lib/ruby
+          ### set environment variable RUBYLIB
+          $ export RUBYLIB=$HOME/lib/ruby
+          END
+
+    * h1 = Usage
+    * p
+      . You can convert Kwaff document into XML document.
+    * pre
+      . $ kwaff example.kwaff > example.xml
+    * p
+      . You can also convert XML document into Kwaff document.
+    * pre
+      . $ kwaff -r example.xml > example.kwaff
+    * p
+      . Type `kwaff -h' for detail.
+
+    * h1 = Manifest
+    * dl
+      * dt = README.txt
+      * dd =      This file.
+      * dt = COPYING
+      * dd =      GPL file.
+      * dt = CangeLog.txt
+      * dd =      Change log file.
+      * dt = setup.rb
+      * dd =      Setup file for installation.
+      * dt = bin/kwaff
+      * dd =      Command file.
+      * dt = lib/kwaff.rb, lib/kwaff/*.rb
+      * dd =      Library file.
+      * dt = examples/*
+      * dd =      Examples of Kwaff.
+      * dt = doc/users-guide.html
+      * dd =      Users' Guide.
+      * dt = test/test.rb, test/ex*.*
+      * dd =      Unit test script and test data.
+
+    * h1 = License
+    * p  = GPL (GNU General Public License) ver 2.
+
+    * h1 = Author
+    * p  = kwatch <kwa.at.kuwata-lab.com>

data/examples/xi/Makefile

@@ -0,0 +1,9 @@
+ALL = bbs.xi
+
+all:    $(ALL)
+
+%.xi:  %.kwaff
+	kwaff $< > $@
+
+clean:
+	rm -f $(ALL)

data/examples/xi/bbs.kwaff

@@ -0,0 +1,58 @@
+//
+// from http://dock.baykit.org/xi13?Tutorial
+//
+
+* xi:program
+  - xmlns:xi		= http://www.baykit.org/Xi/1.1
+
+  # declare variable 'BBS-DATA' with initial data 
+  * xi:variable
+    - name		= BBS-DATA
+    * bbs
+      * message		= Welcom to mini-bbs
+
+  # if file 'bbs.xml' is exists, then load it into 'BBS-DATA' 
+  * xi:if
+    - test		= $FS.exists('bbs.xml')
+    * xi:set
+      - out		= $BBS-DATA
+      - select		= $IO.loadXml('bbs.xml')
+
+  # if new_message is on param, add it to end of BBS-DATA 
+  * xi:if
+    - test		= $Web.parameters.new_message != ''
+    * xi:set
+      - out		= $BBS-DATA
+      * bbs
+        * xi:copy-of
+          - select	= $BBS-DATA/bbs/*
+        * message
+          * xi:value-of
+            - select	= $Web.parameters.new_message
+    * xi:exec
+      - select		= $IO.saveXml('bbs.xml', $BBS-DATA)
+
+  * HTML
+    * BODY
+
+      # display bbs message. 
+      * UL
+        * xi:for-each
+          - item	= message
+          - select	= $BBS-DATA/bbs/*
+          * LI
+            * xi:value-of
+              - select	= $message
+
+      # FORM for posting bbs message. 
+      * HR
+      * FORM
+        - METHOD	= post
+        - ACTION	= bbs.xi
+        . 
+        .         Message to post: 
+        * BR
+        * TEXTAREA
+          - NAME	= new_message
+        * INPUT
+          - TYPE	= submit

data/lib/kwaff.rb

@@ -0,0 +1,85 @@
+#!/usr/bin/ruby
+
+##
+## kwaff.rb - kwa's friendly format
+##
+## ex. Kwaff => XML or REXML
+##   kwaff_str = <<END
+##   ?xml-version = 1.0
+##   ?encoding    = ISO-8859-1
+##   ?doctype     = @xhtml
+##   * html
+##     * body
+##       - bgcolor = white
+##       - style   = font-size:small
+##       * ul
+##         ! xml commet
+##         # kwaff comment (ignored)
+##         * li = foo
+##         * li = bar
+##         * li = baz
+##   END
+##   
+##   # Kwaff string to XML string
+##   include 'kwaff'
+##   xml_str = Kwaff::convert(kwaff_str)
+##   
+##   # XML string to Kwaff string
+##   include 'kwaff'
+##   include 'kwaff/rexml'
+##   kwaff_str = Kwaff::Rexml::revert(xml_str)
+##   
+##   # Kwaff string to REXML::Document
+##   include 'kwaff'
+##   include 'kwaff/rexml'
+##   xml_document = Kwaff::Rexml::convert(kwaff_str)
+##   
+##   # REXML::Document to Kwaff string
+##   include 'kwaff'
+##   include 'kwaff/rexml'
+##   translator = Kwaff::Rexml::KwaffTranslator.new
+##   kwaff_str = translator.translate(rexml_document)
+##   
+##   # Kwaff string to Kwaff::Document
+##   include 'kwaff'
+##   kwaff_document = Kwaff::parse_document(kwaff_str)
+##
+##
+## $Id: kwaff.rb 7 2005-05-18 14:33:37Z kwatch $
+## $Release: 1.0.0 $
+## copyright(c) 2005 kuwata-lab.com all rights reserved
+##
+
+#require 'kwaff/errors'
+#require 'kwaff/orderedhash'
+require 'kwaff/node'
+require 'kwaff/parser'
+require 'kwaff/translator'
+require 'kwaff/doctype'
+#require 'kwaff/rexml'
+
+
+module Kwaff
+
+   VERSION     = ('$Rev: 7 $' =~ /\d+(?:\.\d+)*/ && $&)
+   LAST_UPDATE = ('$Date: 2005-05-18 23:33:37 +0900 (Wed, 18 May 2005) $' =~ /\d\d\d\d[-\/]\d\d[-\/]\d\d/ && $&)
+
+end
+
+
+#begin
+#    require 'kwaff/local-setup'
+#rescue LoadError => ex
+#    # do nothing
+#end
+
+
+if $0 == __FILE__
+   input    = ARGF.read
+   parser   = Kwaff::Parser.new(input)
+   document = parser.parse_document()
+   toppings = { :newline =>  parser.newline }
+   #print document.to_xml(toppings)
+   translator = Kwaff::XmlTranslator.new(toppings)
+   print translator.translate(document)
+end

data/lib/kwaff/doctype.rb

@@ -0,0 +1,124 @@
+##
+## represents XML Dcoument Type
+##
+## document_type   ::= '<!DOCUTYPE' element_name external_subset [ internal_subset ] '>'
+## external_subset ::= 'PUBLIC' pubic_id system_id | 'SYSTEM' system_id
+## public_id       ::= '"' string '"'
+## sytem_id        ::= '"' uri '"'
+##
+## XML Specification:
+##  doctypedecl ::= '<!DOCTYPE' S Name (S ExternalID)? S? ('[' intSubset ']' S?)? '>'
+##  ExternalID  ::= 'SYSTEM' S SystemLiteral | 'PUBLIC' S PubidLiteral S SystemLiteral
+##
+## $Id: doctype.rb 11 2005-06-09 12:32:33Z kwatch $
+## $Release: 1.0.0 $
+## copyright(c) 2005 kuwata-lab.com all rights reserved
+##
+
+require 'yaml'
+
+module Kwaff
+   class DocType
+      ## ex.
+      ##   root_tag  = 'html'
+      ##   public_id = '-//W3C//DTD XHTML 1.0 Transitional//EN'
+      ##   system_id = 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'
+      ##   doctype = DocType.new(root_tag, public_id, system_id)
+      ##  or
+      ##   str = <<END
+      ##   <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+      ##             "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"
+      ##   END
+      ##   doctype = DocType.new()
+      ##   doctype.doctype = str
+
+      def initialize(root_tag, public_id, system_id, desc=nil)
+         @root_tag  = root_tag
+         @public_id = public_id
+         @system_id = system_id
+         @desc      = desc
+         @_str = nil
+         @@instances << self
+      end
+      attr_accessor :root_tag, :public_id, :system_id, :desc
+      
+      attr_accessor :names
+
+
+      ## convert to "<!DOCTYPE ...>"
+      def to_s
+         if ! @_str
+            @_str    = "<!DOCTYPE #{@root_tag}"
+            if @public_id
+               @_str << " PUBLIC \"#{@public_id}\"\n\t"
+            else
+               @_str << " SYSTEM "
+            end
+            @_str << "\"#{@system_id}\"" if @system_id
+            @_str << ">"
+         end
+         return @_str
+      end
+
+      @@instances = []
+      def self.instances
+         @@instances
+      end
+
+      @@registered = {}
+
+      #def self.registered
+      #    @@registered
+      #end
+
+      def self.register(nickname, doctype)
+         @@registered[nickname] = doctype
+      end
+
+      def self.get(nickname)
+         @@registered[nickname]
+      end
+
+      def self.find(&block)
+         return @@instances.find(&block)
+      end
+
+      def self.nickname(doctype)
+         @@registered.each do |nickname, dtype|
+            return nickname if dtype.public_id == doctype.public_id
+         end
+         return nil
+      end
+
+      def self._read_file(filename)
+         s = ''
+         File.open(filename) do |f|
+            while line = f.gets()
+               s << line.gsub(/([^\t]{8})|([^\t]*)\t/n){[$+].pack("A8")}
+            end
+         end
+         return s
+      end
+
+      ## load doctype definition
+      input = ''
+      filename = File::dirname(__FILE__) + "/doctypes.yaml"
+      input << _read_file(filename) if test(?f, filename)
+      filename = ENV['HOME'] + "/.doctypes.yaml"
+      input << _read_file(filename) if test(?f, filename)
+      context = YAML::load(input)
+      hash_list = context['doctypes']
+      hash_list.each do |hash|
+         doctype = DocType.new(hash['root-tag'], hash['public-id'], hash['system-id'], hash['desc'])
+         unless hash['names']
+            raise "`names' is not specified. (doctype=#{doctype.to_yaml})"
+         end
+         doctype.names = hash['names']
+         hash['names'].each do |name|
+            DocType.register(name, doctype)
+         end
+      end if hash_list
+      
+   end
+
+end

data/lib/kwaff/doctypes.yaml

@@ -0,0 +1,138 @@
+
+## $Id: doctypes.yaml 9 2005-06-09 08:44:11Z kwatch $
+## $Release: 1.0.0 $
+## copyright(c) 2005 kuwata-lab.com all rights reserved
+
+doctypes:
+
+
+  - desc:       XHTML1.0 Transitional
+    root-tag:   html
+    public-id:  '-//W3C//DTD XHTML 1.0 Transitional//EN'
+    system-id:  'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'
+    names:
+      - @xhtml10-transitional
+      - @xhtml-transitional
+      - @xhtml10
+      - @xhtml
+
+
+  - desc:       XHTML1.0 Strict
+    root-tag:   html
+    public-id:  '-//W3C//DTD XHTML 1.0 Strict//EN'
+    system-id:  'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'
+    names:
+      - @xhtml10-strict
+      - @xhtml-strict
+
+
+  - desc:       Deployment Descriptor 2.3
+    root-tag:   web-app
+    public-id:  '-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN'
+    system-id:  'http://java.sun.com/dtd/web-app_2_3.dtd'
+    names:
+      - @web-app23
+      - @web-app
+
+
+  - desc:       EJB2.0
+    root-tag:   ejb-jar
+    public-id:  '-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 2.0//EN'
+    system-id:  'http://java.sun.com/dtd/ejb-jar_2_0.dtd'
+    names:
+      - @ejb-jar20
+      - @ejb-jar
+
+
+  - desc:       SVG (Scalable Vector Graphics) 1.1
+    root-tag:   svg
+    public-id:  '-//W3C//DTD SVG 1.1//EN'
+    system-id:  'http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd'
+    names:
+      - @svg11
+      - @svg
+
+
+  - desc:       Spring Framework
+    root-tag:   beans
+    public-id:  '-//SPRING//DTD BEAN//EN'
+    system-id:  'http://www.springframework.org/dtd/spring-beans.dtd'
+    names:
+      - @spring-beans
+
+
+  - desc:       Struts
+    root-tag:   struts-config
+    public-id:  '-//Apache Software Foundation//DTD Struts Configuration 1.0//EN'
+    system-id:  'http://jakarta.apache.org/struts/dtds/struts-config_1_0.dtd'
+    names:
+      - @struts-config10
+      - @struts-config
+
+
+  - desc:       BayServer
+    root-tag:   system
+    public-id:  '-//Yokohama Baykit//DTD BayServer 1.3//EN'
+    system-id:  'http://www.baykit.org/bserv/system_1_3.dtd'
+    names:
+      - @bserv13
+      - @bserv14
+
+
+  - desc:       Hibernate configuration
+    root-tag:   hibernate-configuration
+    public-id:  '-//Hibernate/Hibernate Configuration DTD//EN'
+    system-id:  'http://hibernate.sourceforge.net/hibernate-configuration-2.0.dtd'
+    names:
+      - @hibernate-config20
+      - @hibernate-configuration20
+      #- @hibernate-config
+      #- @hibernate-configuration
+
+
+  - desc:       Hibernate configuration
+    root-tag:   hibernate-configuration
+    public-id:  '-//Hibernate/Hibernate Configuration DTD 3.0//EN'
+    system-id:  'http://hibernate.sourceforge.net/hibernate-configuration-3.0.dtd'
+    names:
+      - @hibernate-config30
+      - @hibernate-configuration30
+      - @hibernate-config
+      - @hibernate-configuration
+
+
+  - desc:       Hibernate mapping
+    root-tag:   hibernate-mapping
+    public-id:  '-//Hibernate/Hibernate Mapping DTD//EN'
+    system-id:  'http://hibernate.sourceforge.net/hibernate-mapping-2.0.dtd'
+    names:
+      - @hibernate-mapping20
+      #- @hibernate-mapping
+
+
+  - desc:       Hibernate mapping
+    root-tag:   hibernate-mapping
+    public-id:  '-//Hibernate/Hibernate Mapping DTD 3.0//EN'
+    system-id:  'http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd'
+    names:
+      - @hibernate-mapping30
+      - @hibernate-mapping
+
+
+  - desc:       Seasar2
+    root-tag:   components
+    public-id:  "-//SEASAR2.1//DTD S2Container//EN"
+    system-id:  "http://www.seasar.org/dtd/components21.dtd"
+    names:
+      - @seasar21
+      - @seasar2
+
+
+#  - desc:       Deployment Descriptor 2.4
+#    root-tag:   web-app
+#    schema:     xml-schema
+#    attrs:
+#      xmlns:     "http://java.sun.com/xml/ns/j2ee"
+#      xmlns:xsi: "http://www.w3.org/2001/XMLSchema-instance"
+#      xsi:schemaLocation: "http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
+#      version:   "2.4"