--- /dev/null
+## Copyright (C) 2009,2010,2011,2012 Philip Nienhuis <prnienhuis at users.sf.net>
+##
+## This program 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 program is distributed in the hope that it will be useful, but WITHOUT
+## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 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/>.
+
+## -*- texinfo -*-
+## @deftypefn {Function File} [@var{ods}] = odsclose (@var{ods})
+## @deftypefnx {Function File} [@var{ods}] = odsclose (@var{ods}, @var{filename})
+## @deftypefnx {Function File} [@var{ods}] = odsclose (@var{ods}, "FORCE")
+## Close the OpenOffice_org Calc spreadsheet pointed to in struct
+## @var{ods}, if needed write the file to disk.
+## odsclose will determine if the file must be written to disk based on
+## information contained in @var{ods}.
+## An empty pointer struct will be returned if no errors occurred.
+## Optional argument @var{filename} can be used to write changed spreadsheet
+## files to an other file than opened by odsopen().
+## Optional string argument "FORCE" can be specified to force resetting the
+## file pointer struct. However, in case of UNO, a hidden OOo invocation
+## may linger on in memory then, preventing proper closing of Octave.
+##
+## You need the Java package >= 1.2.6 plus odfdom.jar + xercesImpl.jar
+## and/or jopendocument-<version>.jar installed on your computer +
+## proper javaclasspath set, to make this function work at all.
+## For UNO support, Octave-Java package >= 1.2.8 + latest fixes is imperative;
+## furthermore the relevant classes had best be added to the javaclasspath by
+## utility function chk_spreadsheet_support().
+##
+## @var{ods} must be a valid pointer struct made by odsopen() in the same
+## octave session.
+##
+## Examples:
+##
+## @example
+## ods1 = odsclose (ods1);
+## (Close spreadsheet file pointed to in pointer struct ods1; ods1 is reset)
+## @end example
+##
+## @seealso {odsopen, odsread, odswrite, ods2oct, oct2ods, odsfinfo, chk_spreadsheet_support}
+##
+## @end deftypefn
+
+## Author: Philip Nienhuis
+## Created: 2009-12-13
+## Updates:
+## 2010-01-08 (OTK ODS write support)
+## 2010-04-13 Improved help text a little bit
+## 2010-08-25 Swapped in texinfo help text
+## 2010-10-17 Fixed typo in error message about unknown interface
+## 2010-10-27 Improved file change tracking tru ods.changed
+## 2010-11-12 Keep ods file pointer when write errors occur.
+## '' Added optional filename arg to change filename to be written to
+## 2011-05-06 Experimental UNO support
+## 2011-05-07 In case of UNO, soffice now properly closed using xDesk
+## 2011-05-18 Saving newly created files using UNO supported now
+## 2011-09-08 FIXME - closing OOo kills all other OOo invocations (known Java-UNO issue)
+## 2012-01-26 Fixed "seealso" help string
+## 2012-06-08 tabs replaced by double space
+
+function [ ods ] = odsclose (ods, varargs)
+
+ # If needed warn that dangling spreadsheet pointers may be left
+ if (nargout < 1) warning ("return argument missing - ods invocation not reset."); endif
+
+ force = 0;
+
+ if (nargin > 1)
+ for ii=2:nargin
+ if (strcmp (lower (varargin{ii}), "force"))
+ # Close .ods anyway even if write errors occur
+ force = 1;
+ elseif (~isempty (strfind (tolower (varargin{ii}), '.ods')) || ...
+ ~isempty (strfind (tolower (varargin{ii}), '.sxc')))
+ # Apparently a file name
+ if (ods.changed == 0 || ods.changed > 2)
+ warning ("File %s wasn't changed, new filename ignored.", ods.filename);
+ else
+ if (strfind (tolower (filename), '.sxc') || strfind (tolower (filename), '.ods'))
+ ods.filename = filename;
+ else
+ error ('No .sxc or .ods filename extension specified');
+ endif
+ endif
+ endif
+ endfor
+ endif
+
+ if (strcmp (ods.xtype, 'OTK'))
+ # Java & ODF toolkit
+ try
+ if (ods.changed && ods.changed < 3)
+ ods.app.save (ods.filename);
+ ods.changed = 0;
+ endif
+ ods.app.close ();
+ catch
+ if (force)
+ ods.app.close ();
+ endif
+ end_try_catch
+
+ elseif (strcmp (ods.xtype, 'JOD'))
+ # Java & jOpenDocument
+ try
+ if (ods.changed && ods.changed < 3)
+ ofile = java_new ('java.io.File', ods.filename);
+ ods.workbook.saveAs (ofile);
+ ods.changed = 0;
+ endif
+ catch
+ end_try_catch
+
+ elseif (strcmp (ods.xtype, 'UNO'))
+ # Java & UNO bridge
+ try
+ if (ods.changed && ods.changed < 3)
+ # Workaround:
+ unotmp = java_new ('com.sun.star.uno.Type', 'com.sun.star.frame.XModel');
+ xModel = ods.workbook.queryInterface (unotmp);
+ unotmp = java_new ('com.sun.star.uno.Type', 'com.sun.star.util.XModifiable');
+ xModified = xModel.queryInterface (unotmp);
+ if (xModified.isModified ())
+ unotmp = java_new ('com.sun.star.uno.Type', 'com.sun.star.frame.XStorable'); # isReadonly() ?
+ xStore = ods.app.xComp.queryInterface (unotmp);
+ if (ods.changed == 2)
+ # Some trickery as Octave Java cannot create non-numeric arrays
+ lProps = javaArray ('com.sun.star.beans.PropertyValue', 1);
+ lProp = java_new ('com.sun.star.beans.PropertyValue', "Overwrite", 0, true, []);
+ lProps(1) = lProp;
+ # OK, save file to disk
+ xStore.storeAsURL (ods.filename, lProps);
+ else
+ xStore.store ();
+ endif
+ endif
+ endif
+ ods.changed = -1; # Needed for check op properly shutting down OOo
+ # Workaround:
+ unotmp = java_new ('com.sun.star.uno.Type', 'com.sun.star.frame.XModel');
+ xModel = ods.app.xComp.queryInterface (unotmp);
+ unotmp = java_new ('com.sun.star.uno.Type', 'com.sun.star.util.XCloseable');
+ xClosbl = xModel.queryInterface (unotmp);
+ xClosbl.close (true);
+ unotmp = java_new ('com.sun.star.uno.Type', 'com.sun.star.frame.XDesktop');
+ xDesk = ods.app.aLoader.queryInterface (unotmp);
+ xDesk.terminate();
+ ods.changed = 0;
+ catch
+ if (force)
+ # Force closing OOo
+ unotmp = java_new ('com.sun.star.uno.Type', 'com.sun.star.frame.XDesktop');
+ xDesk = ods.app.aLoader.queryInterface (unotmp);
+ xDesk.terminate();
+ else
+ warning ("Error dbclosing ods pointer (UNO)");
+ endif
+ return
+ end_try_catch
+
+# elseif ---- < Other interfaces here >
+
+ else
+ error (sprintf ("ods2close: unknown OpenOffice.org .ods interface - %s.", ods.xtype));
+
+ endif
+
+ if (ods.changed && ods.changed < 3)
+ error ( sprintf ("Could not save file %s - read-only or in use elsewhere?\nFile pointer preserved", ods.filename));
+ if (force)
+ ods = [];
+ endif
+ else
+ # Reset file pointer
+ ods = [];
+ endif
+
+endfunction
git://git.creatis.insa-lyon.fr / CreaPhase.git / blobdiff