Merge lp:~zorba-coders/zorba/bug-1217140 into lp:zorba

[Paul J. Lucas]

Added item-separator serializer option.

Added item-separator serializer option.

[Paul J. Lucas (paul-lucas)]

review: Approve

[Zorba Build Bot (zorba-buildbot)]

Validation queue starting for the following merge proposals:
https://code.launchpad.net/~zorba-coders/zorba/bug-1217140/+merge/184906

Progress dashboard at http://jenkins.lambda.nu/view/ValidationQueue

[Zorba Build Bot (zorba-buildbot)]

Validation queue result for https://code.launchpad.net/~zorba-coders/zorba/bug-1217140/+merge/184906

Stage "CommitZorba" failed.

Check console output at http://jenkins.lambda.nu/job/CommitZorba/163/console to view the results.

[Zorba Build Bot (zorba-buildbot)]

Voting criteria failed for the following merge proposals:

https://code.launchpad.net/~zorba-coders/zorba/bug-1217140/+merge/184906 :
Votes: {'Approve': 1}

[Chris Hillery (ceejatec)]

item-separator isn't a drop-in replacement for the space separator which was introduced previously. If item-separator is specified, it is used to separate *every* *item* in the top-level sequence, not just adjacent strings as the space character was before. So, for example:

zorba -z item-separator="--" -q '(<hello/>,<world/>,1,2,3)'

should output

<hello/>--<world/>--1--2--3

See the discussion in section 2 of the XQuery 3.0 serialization spec:
http://www.w3.org/TR/2013/WD-xslt-xquery-serialization-30-20130108/#serdm

review: Needs Fixing

[lp:~zorba-coders/zorba/bug-1217140]

11615. By Paul J. Lucas on 2013-09-11

Can now distinguish unset vs empty item-separator.

[Paul J. Lucas (paul-lucas)]

OK, it now distinguishes between not set vs empty.

[Chris Hillery (ceejatec)]

review: Approve

[Zorba Build Bot (zorba-buildbot)]

Validation queue starting for the following merge proposals:
https://code.launchpad.net/~zorba-coders/zorba/bug-1217140/+merge/184906

Progress dashboard at http://jenkins.lambda.nu/view/ValidationQueue

[Zorba Build Bot (zorba-buildbot)]

Validation queue succeeded - proposal merged!

=== modified file 'ChangeLog'
--- ChangeLog	2013-08-21 10:25:42 +0000
+++ ChangeLog	2013-09-11 21:02:10 +0000
@@ -44,6 +44,7 @@
   * Fixed bug #1189636 (transcoding hexBinary streambuf)
   * Fixed bug in hoisting through try-catch expr
   * Fixed bug #1162631 (format-integer 'w' format of negative numbers)
+  * Fixed bug #1217140 (Support XQuery 3.0 item-separator serialization parameter)
   * Fixed bug #942171 (file module to allow for arbitrary encodings)
   * Fixed bug #1192285 (Have JSON token know number subtype)
   * Fixed bug #1210628 (file:last-modified returns wrong month)

=== modified file 'include/zorba/options.h'
--- include/zorba/options.h	2013-08-13 23:32:22 +0000
+++ include/zorba/options.h	2013-09-11 21:02:10 +0000
@@ -222,6 +222,7 @@
   Zorba_opaque_char_ptr_t       doctype_system;
   Zorba_opaque_char_ptr_t       doctype_public;
   Zorba_opaque_char_ptr_t       cdata_section_elements;
+  Zorba_opaque_char_ptr_t       item_separator;
   Zorba_opaque_char_ptr_t       version;
 
   Zorba_jsoniq_multiple_items_t jsoniq_multiple_items;

=== modified file 'src/api/options.cpp'
--- src/api/options.cpp	2013-08-14 02:10:00 +0000
+++ src/api/options.cpp	2013-09-11 21:02:10 +0000
@@ -59,6 +59,8 @@
     to->doctype_public.ptr = ztd::new_strdup( from->doctype_public.ptr );
   if ( from->cdata_section_elements.ptr )
     to->cdata_section_elements.ptr = ztd::new_strdup( from->cdata_section_elements.ptr );
+  if ( from->item_separator.ptr )
+    to->item_separator.ptr = ztd::new_strdup( from->item_separator.ptr );
   if ( from->version.ptr )
     to->version.ptr = ztd::new_strdup( from->version.ptr );
 }
@@ -69,6 +71,7 @@
   opts->doctype_system.ptr = nullptr;
   opts->doctype_public.ptr = nullptr;
   opts->cdata_section_elements.ptr = nullptr;
+  opts->item_separator.ptr = nullptr;
   opts->version.ptr = nullptr;
 }
 
@@ -122,6 +125,7 @@
   delete[] opts->doctype_system.ptr;
   delete[] opts->doctype_public.ptr;
   delete[] opts->cdata_section_elements.ptr;
+  delete[] opts->item_separator.ptr;
   delete[] opts->version.ptr;
   null_ptrs( opts );
 }
@@ -165,6 +169,11 @@
   if ( strcmp( option, "indent" ) == 0 )
     return parse_yes_no( value, &opts->indent );
 
+  if ( strcmp( option, "item-separator" ) == 0 ) {
+    assign( opts->item_separator, value );
+    return true;
+  }
+
   if ( strcmp( option, "jsoniq-multiple-items" ) == 0 )
     return parse_yes_no( value, &opts->jsoniq_multiple_items );
 

=== modified file 'src/api/serialization/serializer.cpp'
--- src/api/serialization/serializer.cpp	2013-08-16 21:37:19 +0000
+++ src/api/serialization/serializer.cpp	2013-09-11 21:02:10 +0000
@@ -412,8 +412,7 @@
 
       rollover = emit_expanded_string(buffer, static_cast<zstring::size_type>(read_bytes + rollover));
       memmove(buffer, buffer + 1024 - rollover, rollover);
-    }
-    while (read_bytes > 0);
+    } while (read_bytes > 0);
     break;
   }
   case store::XS_BASE64BINARY:
@@ -448,7 +447,9 @@
   if (item->isAtomic())
   {
     if (thePreviousItemKind == PREVIOUS_ITEM_WAS_TEXT)
-      tr << " ";
+      tr << (ser->item_separator_is_set ? ser->item_separator : " ");
+    else if (thePreviousItemKind)
+      tr << ser->item_separator;
 
     if (item->isStreamable())
     {
@@ -494,6 +495,8 @@
 ********************************************************************************/
 void serializer::emitter::emit_node(const store::Item* item, int depth)
 {
+  if (thePreviousItemKind)
+    tr << ser->item_separator;
   switch (item->getNodeKind())
   {
   case store::StoreConsts::documentNode:
@@ -2090,7 +2093,9 @@
   if (item->isAtomic())
   {
     if (thePreviousItemKind == PREVIOUS_ITEM_WAS_TEXT)
-      tr << " ";
+      tr << (ser->item_separator_is_set ? ser->item_separator : " ");
+    else if (thePreviousItemKind)
+      tr << ser->item_separator;
 
     if (item->isStreamable())
       emit_streamable_item(item);
@@ -2304,6 +2309,9 @@
 
   include_content_type = PARAMETER_VALUE_NO;
 
+  item_separator.clear();
+  item_separator_is_set = false;
+
   media_type.clear();
 
   // This default should match the default for ser_method in Zorba_SerializerOptions
@@ -2469,6 +2477,11 @@
   {
     cdata_section_elements = aValue;
   }
+  else if (!strcmp(aName, "item-separator"))
+  {
+    item_separator = aValue;
+    item_separator_is_set = true;
+  }
   else if (!strcmp(aName, "jsoniq-multiple-items"))
   {
     if (!strcmp(aValue, "no"))

=== modified file 'src/api/serialization/serializer.h'
--- src/api/serialization/serializer.h	2013-08-13 17:43:02 +0000
+++ src/api/serialization/serializer.h	2013-09-11 21:02:10 +0000
@@ -95,6 +95,8 @@
   zstring encoding;
   short int escape_uri_attributes; // TODO: yes/no requires unicode normalization
   short int include_content_type;  // yes/no, implemented
+  zstring item_separator;
+  bool item_separator_is_set;
   zstring media_type;              // string, implemented
   short int method;                // an expanded QName: "xml", "html", "xhtml",
                                    // "text" and "binary"

=== modified file 'src/api/serializerimpl.cpp'
--- src/api/serializerimpl.cpp	2013-08-13 05:43:39 +0000
+++ src/api/serializerimpl.cpp	2013-09-11 21:02:10 +0000
@@ -206,6 +206,9 @@
   if (aSerializerOptions.cdata_section_elements)
     aInternalSerializer.setParameter("cdata-section-elements", aSerializerOptions.cdata_section_elements);
 
+  if (aSerializerOptions.item_separator)
+    aInternalSerializer.setParameter("item-separator", aSerializerOptions.item_separator);
+
   if (aSerializerOptions.version)
     aInternalSerializer.setParameter("version", aSerializerOptions.version);
 

=== added file 'test/rbkt/ExpQueryResults/zorba/serialization/item-separator-1.xml.res'
--- test/rbkt/ExpQueryResults/zorba/serialization/item-separator-1.xml.res	1970-01-01 00:00:00 +0000
+++ test/rbkt/ExpQueryResults/zorba/serialization/item-separator-1.xml.res	2013-09-11 21:02:10 +0000
@@ -0,0 +1,1 @@
+12<hello/>3

=== added file 'test/rbkt/ExpQueryResults/zorba/serialization/item-separator-2.xml.res'
--- test/rbkt/ExpQueryResults/zorba/serialization/item-separator-2.xml.res	1970-01-01 00:00:00 +0000
+++ test/rbkt/ExpQueryResults/zorba/serialization/item-separator-2.xml.res	2013-09-11 21:02:10 +0000
@@ -0,0 +1,1 @@
+1|2|<hello/>|3

=== added file 'test/rbkt/Queries/zorba/serialization/item-separator-1.spec'
--- test/rbkt/Queries/zorba/serialization/item-separator-1.spec	1970-01-01 00:00:00 +0000
+++ test/rbkt/Queries/zorba/serialization/item-separator-1.spec	2013-09-11 21:02:10 +0000
@@ -0,0 +1,1 @@
+Serialization: item-separator=

=== added file 'test/rbkt/Queries/zorba/serialization/item-separator-1.xq'
--- test/rbkt/Queries/zorba/serialization/item-separator-1.xq	1970-01-01 00:00:00 +0000
+++ test/rbkt/Queries/zorba/serialization/item-separator-1.xq	2013-09-11 21:02:10 +0000
@@ -0,0 +1,1 @@
+(1, 2, <hello/>, 3)

=== added file 'test/rbkt/Queries/zorba/serialization/item-separator-2.spec'
--- test/rbkt/Queries/zorba/serialization/item-separator-2.spec	1970-01-01 00:00:00 +0000
+++ test/rbkt/Queries/zorba/serialization/item-separator-2.spec	2013-09-11 21:02:10 +0000
@@ -0,0 +1,1 @@
+Serialization: item-separator=|

=== added file 'test/rbkt/Queries/zorba/serialization/item-separator-2.xq'
--- test/rbkt/Queries/zorba/serialization/item-separator-2.xq	1970-01-01 00:00:00 +0000
+++ test/rbkt/Queries/zorba/serialization/item-separator-2.xq	2013-09-11 21:02:10 +0000
@@ -0,0 +1,1 @@
+(1, 2, <hello/>, 3)