RubyGems - rgen - Versions diffs - 0.5.4 → 0.6.0 - Mend

rgen 0.5.4 → 0.6.0

Files changed (125) hide show

data/CHANGELOG +28 -0
data/Rakefile +3 -4
data/lib/ea_support/uml13_ea_metamodel.rb +3 -3
data/lib/ea_support/uml13_ea_to_uml13.rb +33 -2
data/lib/ea_support/uml13_to_uml13_ea.rb +7 -0
data/lib/mmgen/mm_ext/ecore_mmgen_ext.rb +4 -4
data/lib/mmgen/templates/metamodel_generator.tpl +143 -143
data/lib/rgen/ecore/ecore.rb +11 -1
data/lib/rgen/ecore/ecore_interface.rb +47 -0
data/lib/rgen/ecore/ecore_to_ruby.rb +166 -0
data/lib/rgen/ecore/{ecore_transformer.rb → ruby_to_ecore.rb} +11 -11
data/lib/rgen/environment.rb +15 -2
data/lib/rgen/fragment/dump_file_cache.rb +63 -0
data/lib/rgen/fragment/fragmented_model.rb +139 -0
data/lib/rgen/fragment/model_fragment.rb +268 -0
data/lib/rgen/instantiator/abstract_xml_instantiator.rb +44 -72
data/lib/rgen/instantiator/default_xml_instantiator.rb +2 -2
data/lib/rgen/instantiator/ecore_xml_instantiator.rb +16 -1
data/lib/rgen/instantiator/json_instantiator.rb +16 -2
data/lib/rgen/instantiator/nodebased_xml_instantiator.rb +118 -138
data/lib/rgen/instantiator/qualified_name_resolver.rb +5 -1
data/lib/rgen/instantiator/reference_resolver.rb +126 -24
data/lib/rgen/instantiator/xmi11_instantiator.rb +6 -2
data/lib/rgen/metamodel_builder.rb +18 -6
data/lib/rgen/metamodel_builder/builder_extensions.rb +431 -407
data/lib/rgen/metamodel_builder/builder_runtime.rb +8 -8
data/lib/rgen/metamodel_builder/constant_order_helper.rb +4 -4
data/lib/rgen/metamodel_builder/data_types.rb +5 -1
data/lib/rgen/metamodel_builder/intermediate/feature.rb +167 -0
data/lib/rgen/metamodel_builder/module_extension.rb +2 -2
data/lib/rgen/model_builder.rb +10 -5
data/lib/rgen/model_builder/builder_context.rb +17 -1
data/lib/rgen/serializer/opposite_reference_filter.rb +18 -0
data/lib/rgen/serializer/qualified_name_provider.rb +45 -0
data/lib/rgen/template_language/template_container.rb +3 -1
data/lib/rgen/{auto_class_creator.rb → util/auto_class_creator.rb} +6 -1
data/lib/rgen/util/cached_glob.rb +67 -0
data/lib/rgen/util/file_cache_map.rb +104 -0
data/lib/rgen/util/file_change_detector.rb +78 -0
data/lib/rgen/{method_delegation.rb → util/method_delegation.rb} +18 -3
data/lib/rgen/{model_comparator.rb → util/model_comparator.rb} +17 -5
data/lib/rgen/{model_comparator_base.rb → util/model_comparator_base.rb} +6 -1
data/lib/rgen/{model_dumper.rb → util/model_dumper.rb} +6 -1
data/lib/rgen/{name_helper.rb → util/name_helper.rb} +6 -1
data/lib/rgen/util/pattern_matcher.rb +329 -0
data/lib/transformers/uml13_to_ecore.rb +103 -60
data/test/ecore_self_test.rb +43 -42
data/test/json_test.rb +15 -0
data/test/metamodel_builder_test.rb +361 -206
data/test/metamodel_from_ecore_test.rb +45 -0
data/test/metamodel_order_test.rb +10 -4
data/test/metamodel_roundtrip_test.rb +2 -2
data/test/metamodel_roundtrip_test/TestModel_Regenerated.rb +1 -1
data/test/metamodel_roundtrip_test/houseMetamodel_Regenerated.ecore +50 -50
data/test/method_delegation_test.rb +9 -9
data/test/model_builder/ecore_internal.rb +19 -9
data/test/model_builder/serializer_test.rb +1 -1
data/test/reference_resolver_test.rb +79 -12
data/test/rgen_test.rb +2 -0
data/test/template_language_test.rb +7 -0
data/test/template_language_test/templates/callback_indent_test/a.tpl +12 -0
data/test/template_language_test/templates/callback_indent_test/b.tpl +5 -0
data/test/testmodel/ea_testmodel_regenerated.xml +588 -583
data/test/transformer_test.rb +3 -3
data/test/util/file_cache_map_test.rb +91 -0
data/test/util/file_cache_map_test/testdir/fileA +1 -0
data/test/util_test.rb +4 -0
data/test/xml_instantiator_test.rb +139 -135
metadata +49 -104
data/lib/rgen/ecore/ecore_instantiator.rb +0 -31
data/lib/rgen/metamodel_builder/metamodel_description.rb +0 -232
data/redist/xmlscan/ChangeLog +0 -1301
data/redist/xmlscan/README +0 -34
data/redist/xmlscan/THANKS +0 -11
data/redist/xmlscan/doc/changes.html +0 -74
data/redist/xmlscan/doc/changes.rd +0 -80
data/redist/xmlscan/doc/en/conformance.html +0 -136
data/redist/xmlscan/doc/en/conformance.rd +0 -152
data/redist/xmlscan/doc/en/manual.html +0 -356
data/redist/xmlscan/doc/en/manual.rd +0 -402
data/redist/xmlscan/doc/ja/conformance.ja.html +0 -118
data/redist/xmlscan/doc/ja/conformance.ja.rd +0 -134
data/redist/xmlscan/doc/ja/manual.ja.html +0 -325
data/redist/xmlscan/doc/ja/manual.ja.rd +0 -370
data/redist/xmlscan/doc/src/Makefile +0 -41
data/redist/xmlscan/doc/src/conformance.rd.src +0 -256
data/redist/xmlscan/doc/src/langsplit.rb +0 -110
data/redist/xmlscan/doc/src/manual.rd.src +0 -614
data/redist/xmlscan/install.rb +0 -41
data/redist/xmlscan/lib/xmlscan/encoding.rb +0 -311
data/redist/xmlscan/lib/xmlscan/htmlscan.rb +0 -289
data/redist/xmlscan/lib/xmlscan/namespace.rb +0 -352
data/redist/xmlscan/lib/xmlscan/parser.rb +0 -299
data/redist/xmlscan/lib/xmlscan/scanner.rb +0 -1109
data/redist/xmlscan/lib/xmlscan/version.rb +0 -22
data/redist/xmlscan/lib/xmlscan/visitor.rb +0 -158
data/redist/xmlscan/lib/xmlscan/xmlchar.rb +0 -441
data/redist/xmlscan/memo/CONFORMANCE +0 -1249
data/redist/xmlscan/memo/PRODUCTIONS +0 -195
data/redist/xmlscan/memo/contentspec.ry +0 -335
data/redist/xmlscan/samples/chibixml.rb +0 -105
data/redist/xmlscan/samples/getxmlchar.rb +0 -122
data/redist/xmlscan/samples/rexml.rb +0 -159
data/redist/xmlscan/samples/xmlbench.rb +0 -88
data/redist/xmlscan/samples/xmlbench/parser/chibixml.rb +0 -22
data/redist/xmlscan/samples/xmlbench/parser/nqxml.rb +0 -29
data/redist/xmlscan/samples/xmlbench/parser/rexml.rb +0 -62
data/redist/xmlscan/samples/xmlbench/parser/xmlparser.rb +0 -22
data/redist/xmlscan/samples/xmlbench/parser/xmlscan-0.0.10.rb +0 -62
data/redist/xmlscan/samples/xmlbench/parser/xmlscan-chibixml.rb +0 -22
data/redist/xmlscan/samples/xmlbench/parser/xmlscan-rexml.rb +0 -22
data/redist/xmlscan/samples/xmlbench/parser/xmlscan.rb +0 -99
data/redist/xmlscan/samples/xmlbench/xmlbench-lib.rb +0 -116
data/redist/xmlscan/samples/xmlconftest.rb +0 -200
data/redist/xmlscan/test.rb +0 -7
data/redist/xmlscan/tests/deftestcase.rb +0 -73
data/redist/xmlscan/tests/runtest.rb +0 -47
data/redist/xmlscan/tests/testall.rb +0 -14
data/redist/xmlscan/tests/testencoding.rb +0 -438
data/redist/xmlscan/tests/testhtmlscan.rb +0 -752
data/redist/xmlscan/tests/testnamespace.rb +0 -457
data/redist/xmlscan/tests/testparser.rb +0 -591
data/redist/xmlscan/tests/testscanner.rb +0 -1749
data/redist/xmlscan/tests/testxmlchar.rb +0 -143
data/redist/xmlscan/tests/visitor.rb +0 -34

@@ -1,34 +0,0 @@
-xmlscan
-=======
-  The fastest XML parser written in 100% pure Ruby.
-Installation
-------------
-  Run install.rb. Type as follows:
-    $ ruby install.rb
-Samples
--------
-  In directory `samples', there are sample programs.
-LICENCE
--------
-  This module's license is the same of Ruby. You can redistribute
-  it and/or modify it under the same term as Ruby.
-    Japanese: http://www.ruby-lang.org/ja/LICENSE.txt
-    English:  http://www.ruby-lang.org/en/LICENSE.txt
-Bug Reports
------------
-  Any kinds of comments and bug reports are welcome.
-  If you find bugs, please email me.
-                             UENO Katsuhiro <katsu@blue.sky.or.jp>

data/redist/xmlscan/THANKS DELETED

@@ -1,11 +0,0 @@
-$Id: THANKS,v 1.5 2003/02/15 13:21:39 katsu Exp $
-Thanks to all of the following for their valuable hints, fixes,
-discussions, and contributions:
-Yoshida Masato <yoshidam@yoshidam.net>
-TAKAHASHI Masayoshi <maki@inac.co.jp>
-NAKAMURA, Hiroshi <nakahiro@sarion.co.jp>
-James Britt <james@jamesbritt.com>
-Takaaki Tateishi <ttate@kt.jaist.ac.jp>
-Tanaka Akira <akr@m17n.org>

data/redist/xmlscan/doc/changes.html DELETED

@@ -1,74 +0,0 @@
-<?xml version="1.0" ?>
-<!DOCTYPE html
-  PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-<title>changes.rd</title>
-</head>
-<body>
-<h1><a name="label-0" id="label-0">Changes of xmlscan</a></h1><!-- RDLabel: "Changes of xmlscan" -->
-<h2><a name="label-1" id="label-1">0.3 series</a></h2><!-- RDLabel: "0.3 series" -->
-<h3><a name="label-2" id="label-2">0.3.0</a></h3><!-- RDLabel: "0.3.0" -->
-<ul>
-<li>The head of development.</li>
-</ul>
-<h2><a name="label-3" id="label-3">0.2 series</a></h2><!-- RDLabel: "0.2 series" -->
-<h3><a name="label-4" id="label-4">0.2.1 - Jan 23, 2003</a></h3><!-- RDLabel: "0.2.1 - Jan 23, 2003" -->
-<ul>
-<li>Independented from $KCODE. XMLScanner#kcode and XMLScanner#kcode= were
-    added.</li>
-<li>XMLScan::XMLParser doesn't replace any entity references.
-    XMLScan::XMLParser::PredefinedEntity was removed.</li>
-<li>XMLScan::XMLParser doesn't exchange any method calls. The following
-    methods were never called in xmlscan-0.1, but are called in xmlscan-0.2.
-<ul>
-<li>XMLScan::Visitor#on_charref_hex</li>
-<li>XMLScan::Visitor#on_attr_charref_hex</li>
-<li>XMLScan::Visitor#on_stag_end_empty</li>
-</ul></li>
-<li>XMLScan::XMLChar now uses regular expressions to search illegal
-    characters in an XML document. The parsing speed of XMLScan::XMLParser
-    with :strict_char option was dramatically improved.</li>
-<li>Fixed a few bugs in XMLScan::XMLScanner.</li>
-<li>Improved parsing speed.</li>
-<li>Ready for Ruby-1.8.</li>
-</ul>
-<h2><a name="label-5" id="label-5">0.1 series</a></h2><!-- RDLabel: "0.1 series" -->
-<h3><a name="label-6" id="label-6">0.1.3 - Jan 10, 2003</a></h3><!-- RDLabel: "0.1.3 - Jan 10, 2003" -->
-<ul>
-<li>Added install.rb, which is an simple installer.</li>
-<li>Fixed a couple of bugs.</li>
-<li>Improved parsing speed.</li>
-<li>Rewrote sample benchmark script.</li>
-</ul>
-<h3><a name="label-7" id="label-7">0.1.2 - Dec 20, 2002</a></h3><!-- RDLabel: "0.1.2 - Dec 20, 2002" -->
-<ul>
-<li>Fixed several bugs in XMLScan::XMLScanner.</li>
-<li>XMLScan::Visitor was moved from scanner.rb to visitor.rb.</li>
-<li>XMLScan::Version was renamed to XMLScan::VERSION.</li>
-<li>Added new constant XMLScan::RELEASE_DATE.</li>
-</ul>
-<h3><a name="label-8" id="label-8">0.1.1 - Oct 10, 2002</a></h3><!-- RDLabel: "0.1.1 - Oct 10, 2002" -->
-<ul>
-<li>The first stable version of xmlscan.</li>
-</ul>
-<h3><a name="label-9" id="label-9">0.1.0rc2 - Sep 30, 2002</a></h3><!-- RDLabel: "0.1.0rc2 - Sep 30, 2002" -->
-<ul>
-<li>Another release candidate.</li>
-</ul>
-<h3><a name="label-10" id="label-10">0.1.0rc1 - Sep 28, 2002</a></h3><!-- RDLabel: "0.1.0rc1 - Sep 28, 2002" -->
-<ul>
-<li>An release candidate for the stable release.</li>
-</ul>
-<h3><a name="label-11" id="label-11">0.1.0-20020920 - Sep 20, 2000</a></h3><!-- RDLabel: "0.1.0-20020920 - Sep 20, 2000" -->
-<ul>
-<li>Restarted the project, and this is the first announced version of
-      new xmlscan.</li>
-</ul>
-<h2><a name="label-12" id="label-12">0.0 series</a></h2><!-- RDLabel: "0.0 series" -->
-<p>All versions before 0.1.0-20020920 are called as ``ancient xmlscan'',
-since they are so old that even the author have forgotten what they are ;p</p>
-</body>
-</html>

data/redist/xmlscan/doc/changes.rd DELETED

@@ -1,80 +0,0 @@
-=begin
-# $Id: changes.rd,v 1.3 2003/01/22 17:02:25 katsu Exp $
-= Changes of xmlscan
-== 0.3 series
-=== 0.3.0
-  * The head of development.
-== 0.2 series
-=== 0.2.1 - Jan 23, 2003
-  * Independented from $KCODE. XMLScanner#kcode and XMLScanner#kcode= were
-    added.
-  * XMLScan::XMLParser doesn't replace any entity references.
-    XMLScan::XMLParser::PredefinedEntity was removed.
-  * XMLScan::XMLParser doesn't exchange any method calls. The following
-    methods were never called in xmlscan-0.1, but are called in xmlscan-0.2.
-      * XMLScan::Visitor#on_charref_hex
-      * XMLScan::Visitor#on_attr_charref_hex
-      * XMLScan::Visitor#on_stag_end_empty
-  * XMLScan::XMLChar now uses regular expressions to search illegal
-    characters in an XML document. The parsing speed of XMLScan::XMLParser
-    with :strict_char option was dramatically improved.
-  * Fixed a few bugs in XMLScan::XMLScanner.
-  * Improved parsing speed.
-  * Ready for Ruby-1.8.
-== 0.1 series
-=== 0.1.3 - Jan 10, 2003
-    * Added install.rb, which is an simple installer.
-    * Fixed a couple of bugs.
-    * Improved parsing speed.
-    * Rewrote sample benchmark script.
-=== 0.1.2 - Dec 20, 2002
-    * Fixed several bugs in XMLScan::XMLScanner.
-    * XMLScan::Visitor was moved from scanner.rb to visitor.rb.
-    * XMLScan::Version was renamed to XMLScan::VERSION.
-    * Added new constant XMLScan::RELEASE_DATE.
-=== 0.1.1 - Oct 10, 2002
-    * The first stable version of xmlscan.
-=== 0.1.0rc2 - Sep 30, 2002
-    * Another release candidate.
-=== 0.1.0rc1 - Sep 28, 2002
-    * An release candidate for the stable release.
-=== 0.1.0-20020920 - Sep 20, 2000
-    * Restarted the project, and this is the first announced version of
-      new xmlscan.
-== 0.0 series
-All versions before 0.1.0-20020920 are called as ``ancient xmlscan'',
-since they are so old that even the author have forgotten what they are ;p
-=end

data/redist/xmlscan/doc/en/conformance.html DELETED

@@ -1,136 +0,0 @@
-<?xml version="1.0" ?>
-<!DOCTYPE html
-  PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-<title>en/conformance.rd</title>
-</head>
-<body>
-<h1><a name="label-0" id="label-0">Conformance of xmlscan to the specifications</a></h1><!-- RDLabel: "Conformance of xmlscan to the specifications" -->
-<p>This document describes the conformance of each parser
-included in xmlscan for XML related specifications.</p>
-<h2><a name="label-1" id="label-1">Abstract</a></h2><!-- RDLabel: "Abstract" -->
-<p>XMLscan is one of "non-validating XML processor" according to
-XML 1.0 Specification <a href="#label-6">[XML]</a>. XMLscan is satisfied with
-almost conditions required for a non-validation XML processor,
-though, for the limitations of implementations, there are mainly
-the following restrictions. For detail, See the below
-descriptions for each class.</p>
-<ul>
-<li>It is impossible to parse an XML document encoded in UTF-16
-   directly.</li>
-<li>By default, it is not checked for illegal characters which
-   must not appear in an XML document or in a context.</li>
-<li>XMLscan doesn't read any external entities. Well-formedness
-   constraints for external entities are not checked.</li>
-<li>XMLscan skips an internal DTD subset. (it will be supported
-   in future version). Well-formedness constraints for an
-   internal DTD subset are not checked.</li>
-</ul>
-<h2><a name="label-2" id="label-2">Conformance of XMLScan::XMLScanner</a></h2><!-- RDLabel: "Conformance of XMLScan::XMLScanner" -->
-<p>XMLScan::XMLScanner tokenize an XML document and only recognize
-each XML declaration, document type declaration, processing
-instruction, comment, start tag, end tag, empty element tag,
-CDATA section, general entity reference, and character reference.
-It is NOT an error even that one of these parts appears in the
-context which prohibits existence of it, except in the case
-described below.</p>
-<p>It is reported as an parse error that an XML declaration,
-document type definition (except internal DTD subset),
-processing instruction, comment, start tag, end tag, empty
-element tag, CDATA section, general entity reference, or a
-character reference is not matched with its production defined
-in XML 1.0 Specification <a href="#label-6">[XML]</a>.</p>
-<p>For reasonably speed, if `strict_char' option is not specified,
-XMLScan::XMLScanner doesn't check whether a name or character
-data includes an illegal characters for it. All characters
-except ones recognized as one of delimiters in that context
-are allowed. To be more precise, without `strict_char' option,
-the production Char[2], Name[5], Nmtoken[7], EntityValue[9],
-AttValue[10], SystemLiteral[11], PubidChar[13], CharData[14],
-VersionNum[26], and EncName[81] are not checked strictly.</p>
-<p>XMLScan::XMLScanner doesn't normalize linebreaks.</p>
-<p>Since Ruby is not supported UTF-16, it is impossible to parse
-an XML document encoded in UTF-16 as it is. You need to convert
-it to UTF-8 before parsing.</p>
-<p>`&lt;?xml' in a place except the beginning of an XML document is
-regarded as a processing instruction.</p>
-<p>It is not checked whether the value of a standalone document
-documentation is either "yes" or "no".</p>
-<p>It is not checked whether a target in a processing instruction
-is not "xml" or like, which is a reserved target.</p>
-<p>It is reported as a parse error in the case that a document type
-declaration appears in a place except prolog, or two or more
-document type declarations are found in one document.</p>
-<p>It is reported as a well-formedness constraint violation
-that `&lt;' appears directly in a attribute value. If strict_char
-option is specified, XMLScan::XMLScanner checks
-well-formedness constraint: Legal Character.
-Any other well-formedness constraints are not checked.</p>
-<p>XMLScan::XMLScanner skips an internal DTD subset.</p>
-<h2><a name="label-3" id="label-3">Conformance of XMLScan::XMLParser</a></h2><!-- RDLabel: "Conformance of XMLScan::XMLParser" -->
-<p>The goal of XMLScan::XMLParser is to satisfy almost all
-conditions required to a non-validating XML parser.</p>
-<p>The description for XMLScan::XMLScanner about `strict_char'
-option and the description for UTF-16 are applicable to
-XMLScan::XMLParser. The following well-formedness constraints
-about a character reference are checked only if `strict_char'
-option is specified;</p>
-<ul>
-<li>Well-formedness constraint: Legal Character</li>
-</ul>
-<p>XMLScan::XMLScanner doesn't normalize linebreaks.</p>
-<p>XMLScan::XMLParser skips an internal DTD subset. The following
-well-formedness constraints about an internal DTD subset are
-not checked;</p>
-<ul>
-<li>Well-formedness constraint: PEs in Internal Subset</li>
-<li>Well-formedness constraint: PE Between Declarations</li>
-<li>Well-formedness constraint: No External Entity References</li>
-<li>Well-formedness constraint: Entity Declared</li>
-<li>Well-formedness constraint: Parsed Entity</li>
-<li>Well-formedness constraint: No Recursion</li>
-<li>Well-formedness constraint: In DTD</li>
-</ul>
-<p>All general entity references except ones to predefined entities
-(lt,gt,amp,quot,apos) are reported as ones to undeclared entities.</p>
-<p>External DTD subsets are not read. The following well-formedness
-constraints about an external DTD subset are not checked;</p>
-<ul>
-<li>Well-formedness constraint: External Subset</li>
-</ul>
-<p>Since XMLScan::XMLParser cannot check whether a replacement text
-of an undeclared entity includes `&lt;', the following
-well-formedness constraints are not checked completely;</p>
-<ul>
-<li>Well-formedness constraint: No &lt; in Attribute Values</li>
-</ul>
-<h2><a name="label-4" id="label-4">Conformance of XMLScan::XMLNamespace</a></h2><!-- RDLabel: "Conformance of XMLScan::XMLNamespace" -->
-<p>XMLScan::XMLNamespace checks for all constraints specified in
-``Namespaces in XML'' and its errata <a href="#label-7">[Namespaces]</a>, and
-ensure that an XML document is namespace-well-formed.</p>
-<p>All limitations for XMLScan::XMLParser are inherited to
-XMLScan::XMLNamespace.</p>
-<h2><a name="label-5" id="label-5">References</a></h2><!-- RDLabel: "References" -->
-<dl>
-<dt><a name="label-6" id="label-6">[XML]</a></dt><!-- RDLabel: "[XML]" -->
-<dd>
-W3C (World Wide Web Consortium).
-Extensible Markup Language (XML) 1.0 (Second Edition),
-January 2000.
-<a href="http://www.w3.org/TR/2000/REC-xml-20001006">&lt;URL:http://www.w3.org/TR/2000/REC-xml-20001006&gt;</a>
-</dd>
-<dt><a name="label-7" id="label-7">[Namespaces]</a></dt><!-- RDLabel: "[Namespaces]" -->
-<dd>
-W3C (World Wide Web Consortium).
-Namespaces in XML,
-January 1999.
-<a href="http://www.w3.org/TR/1999/REC-xml-names-19990114">&lt;URL:http://www.w3.org/TR/1999/REC-xml-names-19990114&gt;</a>.
-Important corrections are found at
-<a href="http://www.w3.org/XML/xml-names-19990114-errata">&lt;URL:http://www.w3.org/XML/xml-names-19990114-errata&gt;</a>.
-</dd>
-</dl>
-</body>
-</html>

data/redist/xmlscan/doc/en/conformance.rd DELETED

@@ -1,152 +0,0 @@
-=begin
-# $Id: conformance.rd.src,v 1.1 2003/01/22 16:41:45 katsu Exp $
-= Conformance of xmlscan to the specifications
-This document describes the conformance of each parser
-included in xmlscan for XML related specifications.
-== Abstract
-XMLscan is one of "non-validating XML processor" according to
-XML 1.0 Specification ((<[XML]>)). XMLscan is satisfied with
-almost conditions required for a non-validation XML processor,
-though, for the limitations of implementations, there are mainly
-the following restrictions. For detail, See the below
-descriptions for each class.
- * It is impossible to parse an XML document encoded in UTF-16
-   directly.
- * By default, it is not checked for illegal characters which
-   must not appear in an XML document or in a context.
- * XMLscan doesn't read any external entities. Well-formedness
-   constraints for external entities are not checked.
- * XMLscan skips an internal DTD subset. (it will be supported
-   in future version). Well-formedness constraints for an
-   internal DTD subset are not checked.
-== Conformance of XMLScan::XMLScanner
-XMLScan::XMLScanner tokenize an XML document and only recognize
-each XML declaration, document type declaration, processing
-instruction, comment, start tag, end tag, empty element tag,
-CDATA section, general entity reference, and character reference.
-It is NOT an error even that one of these parts appears in the
-context which prohibits existence of it, except in the case
-described below.
-It is reported as an parse error that an XML declaration,
-document type definition (except internal DTD subset),
-processing instruction, comment, start tag, end tag, empty
-element tag, CDATA section, general entity reference, or a
-character reference is not matched with its production defined
-in XML 1.0 Specification ((<[XML]>)).
-For reasonably speed, if `strict_char' option is not specified,
-XMLScan::XMLScanner doesn't check whether a name or character
-data includes an illegal characters for it. All characters
-except ones recognized as one of delimiters in that context
-are allowed. To be more precise, without `strict_char' option,
-the production Char[2], Name[5], Nmtoken[7], EntityValue[9],
-AttValue[10], SystemLiteral[11], PubidChar[13], CharData[14],
-VersionNum[26], and EncName[81] are not checked strictly.
-XMLScan::XMLScanner doesn't normalize linebreaks.
-Since Ruby is not supported UTF-16, it is impossible to parse
-an XML document encoded in UTF-16 as it is. You need to convert
-it to UTF-8 before parsing.
-`<?xml' in a place except the beginning of an XML document is
-regarded as a processing instruction.
-It is not checked whether the value of a standalone document
-documentation is either "yes" or "no".
-It is not checked whether a target in a processing instruction
-is not "xml" or like, which is a reserved target.
-It is reported as a parse error in the case that a document type
-declaration appears in a place except prolog, or two or more
-document type declarations are found in one document.
-It is reported as a well-formedness constraint violation
-that `<' appears directly in a attribute value. If strict_char
-option is specified, XMLScan::XMLScanner checks
-well-formedness constraint: Legal Character.
-Any other well-formedness constraints are not checked.
-XMLScan::XMLScanner skips an internal DTD subset.
-== Conformance of XMLScan::XMLParser
-The goal of XMLScan::XMLParser is to satisfy almost all
-conditions required to a non-validating XML parser.
-The description for XMLScan::XMLScanner about `strict_char'
-option and the description for UTF-16 are applicable to
-XMLScan::XMLParser. The following well-formedness constraints
-about a character reference are checked only if `strict_char'
-option is specified;
- * Well-formedness constraint: Legal Character
-XMLScan::XMLScanner doesn't normalize linebreaks.
-XMLScan::XMLParser skips an internal DTD subset. The following
-well-formedness constraints about an internal DTD subset are
-not checked;
- * Well-formedness constraint: PEs in Internal Subset
- * Well-formedness constraint: PE Between Declarations
- * Well-formedness constraint: No External Entity References
- * Well-formedness constraint: Entity Declared
- * Well-formedness constraint: Parsed Entity
- * Well-formedness constraint: No Recursion
- * Well-formedness constraint: In DTD
-All general entity references except ones to predefined entities
-(lt,gt,amp,quot,apos) are reported as ones to undeclared entities.
-External DTD subsets are not read. The following well-formedness
-constraints about an external DTD subset are not checked;
- * Well-formedness constraint: External Subset
-Since XMLScan::XMLParser cannot check whether a replacement text
-of an undeclared entity includes `<', the following
-well-formedness constraints are not checked completely;
- * Well-formedness constraint: No < in Attribute Values
-== Conformance of XMLScan::XMLNamespace
-XMLScan::XMLNamespace checks for all constraints specified in
-``Namespaces in XML'' and its errata ((<[Namespaces]>)), and
-ensure that an XML document is namespace-well-formed.
-All limitations for XMLScan::XMLParser are inherited to
-XMLScan::XMLNamespace.
-== References
-: [XML]
-    W3C (World Wide Web Consortium).
-    Extensible Markup Language (XML) 1.0 (Second Edition),
-    January 2000.
-    ((<URL:http://www.w3.org/TR/2000/REC-xml-20001006>))
-: [Namespaces]
-    W3C (World Wide Web Consortium).
-    Namespaces in XML,
-    January 1999.
-    ((<URL:http://www.w3.org/TR/1999/REC-xml-names-19990114>)).
-    Important corrections are found at
-    ((<URL:http://www.w3.org/XML/xml-names-19990114-errata>)).
-=end