Merge lp:~zorba-coders/zorba/bug-1188041 into lp:zorba/data-formatting-module

[Luis Rodriguez Gonzalez]

Changes for Zorba 3.0 for data formatting internal module.

[Chris Hillery (ceejatec)]

I think it makes sense to remove the Deprecated functions entirely at this point.

review: Needs Fixing

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

49. By Luis Rodriguez Gonzalez on 2013-09-19

Deprecated function removed

[Luis Rodriguez Gonzalez (kuraru)]

> I think it makes sense to remove the Deprecated functions entirely at this
> point.
Deprecated function is now removed.

[Luis Rodriguez Gonzalez (kuraru)]

review: Approve

[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-1188041/+merge/183023

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

[Zorba Build Bot (zorba-buildbot)]

Validation queue succeeded - proposal merged!

=== removed file 'src/CMakeLists.txt'
--- src/CMakeLists.txt	2011-07-26 10:43:11 +0000
+++ src/CMakeLists.txt	1970-01-01 00:00:00 +0000
@@ -1,20 +0,0 @@
-# Copyright 2006-2008 The FLWOR Foundation.
-# 
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-# 
-# http://www.apache.org/licenses/LICENSE-2.0
-# 
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# all external module libraries are generated in the directory
-# of the corresponding .xq file
-MESSAGE(STATUS "Add com")
-ADD_SUBDIRECTORY(com)
-
-MESSAGE(STATUS "End modules")

=== renamed file 'src/com/zorba-xquery/www/modules/CMakeLists.txt' => 'src/CMakeLists.txt'
--- src/com/zorba-xquery/www/modules/CMakeLists.txt	2013-01-22 13:19:42 +0000
+++ src/CMakeLists.txt	2013-09-19 20:45:27 +0000
@@ -76,7 +76,7 @@
 
     INCLUDE_DIRECTORIES (${JAVA_INCLUDE_PATH} ${JAVA_INCLUDE_PATH2})
     INCLUDE_DIRECTORIES (${JAVA_INCLUDE_PATH})
-    DECLARE_ZORBA_MODULE (URI "http://www.zorba-xquery.com/modules/xsl-fo"
+    DECLARE_ZORBA_MODULE (URI "http://zorba.io/modules/xsl-fo"
       VERSION 1.0 FILE "xsl-fo.xq"
       LINK_LIBRARIES "${JAVA_JVM_LIBRARY}" ${zorba_util-jvm_module_LIBRARIES})
 

=== removed directory 'src/com'
=== removed file 'src/com/CMakeLists.txt'
--- src/com/CMakeLists.txt	2011-10-06 08:17:52 +0000
+++ src/com/CMakeLists.txt	1970-01-01 00:00:00 +0000
@@ -1,17 +0,0 @@
-# Copyright 2006-2008 The FLWOR Foundation.
-# 
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-# 
-# http://www.apache.org/licenses/LICENSE-2.0
-# 
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# all external module libraries are generated in the directory
-# of the corresponding .xq file
-ADD_SUBDIRECTORY(zorba-xquery)

=== removed directory 'src/com/zorba-xquery'
=== removed file 'src/com/zorba-xquery/CMakeLists.txt'
--- src/com/zorba-xquery/CMakeLists.txt	2011-10-06 08:17:52 +0000
+++ src/com/zorba-xquery/CMakeLists.txt	1970-01-01 00:00:00 +0000
@@ -1,17 +0,0 @@
-# Copyright 2006-2008 The FLWOR Foundation.
-# 
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-# 
-# http://www.apache.org/licenses/LICENSE-2.0
-# 
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# all external module libraries are generated in the directory
-# of the corresponding .xq file
-ADD_SUBDIRECTORY(www)

=== removed directory 'src/com/zorba-xquery/www'
=== removed file 'src/com/zorba-xquery/www/CMakeLists.txt'
--- src/com/zorba-xquery/www/CMakeLists.txt	2011-10-06 08:17:52 +0000
+++ src/com/zorba-xquery/www/CMakeLists.txt	1970-01-01 00:00:00 +0000
@@ -1,17 +0,0 @@
-# Copyright 2006-2008 The FLWOR Foundation.
-# 
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-# 
-# http://www.apache.org/licenses/LICENSE-2.0
-# 
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# all external module libraries are generated in the directory
-# of the corresponding .xq file
-ADD_SUBDIRECTORY(modules)

=== removed directory 'src/com/zorba-xquery/www/modules'
=== renamed file 'src/com/zorba-xquery/www/modules/xsl-fo.xq' => 'src/xsl-fo.xq'
--- src/com/zorba-xquery/www/modules/xsl-fo.xq	2013-08-09 09:37:05 +0000
+++ src/xsl-fo.xq	2013-09-19 20:45:27 +0000
@@ -20,8 +20,8 @@
  : This module converts <a href="http://www.w3schools.com/xslfo/default.asp">XSL-FO</a> documents
  : to various formats such as PDF, EPS, PCL, AFP, Text, PNG, Postscript, RTF, and TIFF.
  : For instance, the following example converts a simple XSL-FO document to PDF:
- : <br />
- : <pre class="ace-static" ace-mode="xquery"><![CDATA[import module namespace fop = "http://www.zorba-xquery.com/modules/xsl-fo";
+ : <p/>
+ : <pre class="ace-static" ace-mode="xquery"><![CDATA[import module namespace fop = "http://zorba.io/modules/xsl-fo";
  : import module namespace file = "http://expath.org/ns/file";
  : 
  : declare namespace fo = "http://www.w3.org/1999/XSL/Format";
@@ -41,11 +41,10 @@
  :  </fo:root>
  : let $pdf := fop:generator($fop:PDF, $xsl-fo)
  : return file:write-binary("simple.pdf", $pdf)]]></pre>
- : <br /> 
+ : <p/> 
  : This module uses Apache-FOP to generate content from an XSL-FO document.
  : See <a href="http://xmlgraphics.apache.org/fop/">the Apache FOP documentation</a> for further information.
- : <br />
- : <br />
+ : <p/>
  : <b>Note for Windows users</b>: On Windows, this module won't work out of the box, since
  : this module uses Java. But the Java VM dll is not in the system path by default. To make
  : this module work, you need to add the directory where the jvm.dll is located to the
@@ -57,7 +56,7 @@
  : @library <a href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">JDK - Java Development Kit</a>
  : @project Zorba/Data Formatting/XSL-FO
  :)
-module namespace xsl-fo = "http://www.zorba-xquery.com/modules/xsl-fo";
+module namespace xsl-fo = "http://zorba.io/modules/xsl-fo";
 
 import module namespace util-jvm = "http://www.zorba-xquery.com/modules/util-jvm";
 
@@ -104,45 +103,36 @@
 declare variable $xsl-fo:TIFF as xs:string := "image/tiff";
 
 (:~
- : Deprecated. This function has been deprecated, the JVM and it's classpath is handled diffrently.<br/>
- : The generator function takes an XSL-FO document as input and generates output in the format given as input.
- : The output format can be given as a MIME type - for example "application/pdf" - or one of the predefined
- : variables can be used - like $xsl-fo:PDF. Please refer to the Apache FOP documentation for
+ : The generator function takes an XSL-FO document as input and generates output
+ : in the format given as input.
+ : The output format can be given as a MIME type - for example "application/pdf"
+ : - or one of the predefined variables can be used - like $xsl-fo:PDF. Please
+ : refer to the Apache FOP documentation for
  : <a href="http://xmlgraphics.apache.org/fop/0.95/output.html">supported output formats</a>.
  :
  : Apache FOP does not support 100% of the XSL-FO standard.
- : Please consult the <a href="http://xmlgraphics.apache.org/fop/">official documentation for further information</a>.
+ : Please consult the <a href="http://xmlgraphics.apache.org/fop/">official
+ : documentation for further information</a>.
  :
- : @param $output-format The mime of the output format.
- : @param $xsl-fo-document The XSL-FO document from which the output should be generated. <a href="http://www.w3schools.com/xslfo/xslfo_intro.asp">More information about XSL-FO documents.</a>.
- : @param $classpath This parameter is not used, hence the deprecation of this function.
- : @return The generated output document.
- : @error xsl-fo:VM001 If zorba was unable to start the JVM.
- : @error xsl-fo:JAVA-EXCEPTION If Apache FOP throws an exception - i.e. if the input format is not correct/supported.
- : @deprecated
- :)
-declare function xsl-fo:generator($output-format as xs:string, $xsl-fo-document as node(), $classpath as xs:string+) as xs:base64Binary {
-  xsl-fo:generator-impl($output-format, $xsl-fo-document)
-};
-
-(:~
- : The function behaves like <a href="#generator#3">generator#3</a>, but tries to find the needed Java libraries itself.
- : <br />
- : On a Mac OS X computer, it should be sufficient to install Apache FOP via Mac Ports.<br />
- : On Ubuntu it should be sufficient to install the fop packages via apt-get.<br />
- : On Windows, the classpath needs to be set manually using <a href="#generator#3">generator#3</a>.
- : <br />
+ : This function tries to find the needed Java libraries itself.<p/>
+ : On a Mac OS X computer, it should be sufficient to install Apache FOP via Mac
+ : Ports.<p/>
+ : On Ubuntu it should be sufficient to install the fop packages via apt-get.<p/>
+ : On Windows, the classpath needs to be set manually using
+ : <a href="#generator#3">generator#3</a>.<p/>
  : This function tries to find the jar files via environment variables. The user can set the
  : variable FOP_HOME to the root directory of an Apache FOP distribution. If you have all
  : JAR files in the same directory, you can set the environment variable FOP_LIB_DIR to this
  : directory.
  :
- : @param $output-format The mime of the output format, to tell Apache FOP which kind of document it should
- :        create.
+ : @param $output-format The mime of the output format, to tell Apache FOP which
+ : kind of document it should create.
  : @param $xsl-fo-document The XSL-FO document from which the output should be generated.
+ : 
  : @return The generated output document.
- : @error xsl-fo:VM001 If zorba was unable to start the JVM.
- : @error xsl-fo:JAVA-EXCEPTION If Apache FOP throws an exception - i.e. if the input format is not correct/supported.
+ : @error xsl-fo:JVM-NOT-STARTED If zorba was unable to start the JVM.
+ : @error xsl-fo:JAVA-EXCEPTION If Apache FOP throws an exception - i.e. if the
+ : input format is not correct/supported.
  : @error xsl-fo:JAR-NOT-FOUND If a needed Java library could not be found.
  :)
 declare function xsl-fo:generator($output-format as xs:string, $xsl-fo-document as node()) as xs:base64Binary {

=== renamed directory 'src/com/zorba-xquery/www/modules/xsl-fo.xq.src' => 'src/xsl-fo.xq.src'
=== modified file 'src/xsl-fo.xq.src/xslfo.cpp'
--- src/com/zorba-xquery/www/modules/xsl-fo.xq.src/xslfo.cpp	2013-07-31 22:05:37 +0000
+++ src/xsl-fo.xq.src/xslfo.cpp	2013-09-19 20:45:27 +0000
@@ -33,7 +33,7 @@
 
 #include "JavaVMSingleton.h"
 
-#define XSL_MODULE_NAMESPACE "http://www.zorba-xquery.com/modules/xsl-fo"
+#define XSL_MODULE_NAMESPACE "http://zorba.io/modules/xsl-fo"
 
 class JavaException {
 };
@@ -236,8 +236,8 @@
     Item lRes( theFactory->createBase64Binary(base64S.data(), base64S.size(), true) );
     return ItemSequence_t(new SingletonItemSequence(lRes));
   } catch (zorba::jvm::VMOpenException&) {
-    Item lQName = theFactory->createQName("http://www.zorba-xquery.com/modules/xsl-fo",
-        "VM001");
+    Item lQName = theFactory->createQName("http://zorba.io/modules/xsl-fo",
+        "JVM-NOT-STARTED");
     throw USER_EXCEPTION(lQName, "Could not start the Java VM (is the classpath set?)");
   } catch (JavaException&) {
     jclass stringWriterClass = env->FindClass("java/io/StringWriter");
@@ -261,7 +261,7 @@
     std::string err("");
     err += s.str();
     env->ExceptionClear();
-    Item lQName = theFactory->createQName("http://www.zorba-xquery.com/modules/xsl-fo",
+    Item lQName = theFactory->createQName("http://zorba.io/modules/xsl-fo",
         "JAVA-EXCEPTION");
     throw USER_EXCEPTION(lQName, err);
   }

=== modified file 'test/Queries/data-formatting/xslfo.xq'
--- test/Queries/data-formatting/xslfo.xq	2012-05-08 21:07:27 +0000
+++ test/Queries/data-formatting/xslfo.xq	2013-09-19 20:45:27 +0000
@@ -1,4 +1,4 @@
-import module namespace fop = "http://www.zorba-xquery.com/modules/xsl-fo";
+import module namespace fop = "http://zorba.io/modules/xsl-fo";
 import module namespace file = "http://expath.org/ns/file";
 
 declare namespace fo = "http://www.w3.org/1999/XSL/Format";