Mercurial > octave-antonio
view libinterp/corefcn/ls-oct-ascii.cc @ 17281:bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Macro handles options ("on") or properties ("position") more elegantly
than @code{"text"}.
* doc/interpreter/macros.texi: Add new @qcode macro.
* doc/interpreter/tips.txi: Add documentation about @qcode macro.
* doc/interpreter/basics.txi, doc/interpreter/container.txi,
doc/interpreter/emacs.txi, doc/interpreter/errors.txi,
doc/interpreter/eval.txi, doc/interpreter/expr.txi,
doc/interpreter/external.txi, doc/interpreter/func.txi,
doc/interpreter/grammar.txi, doc/interpreter/image.txi,
doc/interpreter/install.txi, doc/interpreter/interp.txi,
doc/interpreter/io.txi, doc/interpreter/matrix.txi,
doc/interpreter/numbers.txi, doc/interpreter/oop.txi,
doc/interpreter/package.txi, doc/interpreter/plot.txi,
doc/interpreter/quad.txi, doc/interpreter/sparse.txi,
doc/interpreter/strings.txi, doc/interpreter/system.txi,
doc/interpreter/vectorize.txi, libinterp/corefcn/balance.cc,
libinterp/corefcn/bitfcns.cc, libinterp/corefcn/cellfun.cc,
libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc,
libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc,
libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc,
libinterp/corefcn/error.cc, libinterp/corefcn/file-io.cc,
libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc,
libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc,
libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc,
libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc,
libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lu.cc,
libinterp/corefcn/luinc.cc, libinterp/corefcn/matrix_type.cc,
libinterp/corefcn/oct-hist.cc, libinterp/corefcn/pager.cc,
libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc,
libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc,
libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc,
libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc,
libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc,
libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc,
libinterp/corefcn/syscalls.cc, libinterp/corefcn/toplev.cc,
libinterp/corefcn/tril.cc, libinterp/corefcn/typecast.cc,
libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc,
libinterp/dldfcn/__init_fltk__.cc, libinterp/dldfcn/chol.cc,
libinterp/dldfcn/colamd.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc,
libinterp/dldfcn/symbfact.cc, libinterp/octave-value/ov-base.cc,
libinterp/octave-value/ov-fcn-handle.cc,
libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc,
libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc,
libinterp/octave-value/ov-usr-fcn.cc, libinterp/parse-tree/oct-parse.in.yy,
libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc,
libinterp/parse-tree/pt-mat.cc, scripts/@ftp/ftp.m,
scripts/deprecated/java_convert_matrix.m, scripts/deprecated/java_debug.m,
scripts/deprecated/java_unsigned_conversion.m, scripts/deprecated/shell_cmd.m,
scripts/general/dblquad.m, scripts/general/display.m,
scripts/general/genvarname.m, scripts/general/idivide.m,
scripts/general/interp1.m, scripts/general/interp2.m,
scripts/general/interp3.m, scripts/general/interpn.m, scripts/general/isa.m,
scripts/general/profexplore.m, scripts/general/profile.m,
scripts/general/quadgk.m, scripts/general/randi.m, scripts/general/structfun.m,
scripts/general/subsindex.m, scripts/general/triplequad.m,
scripts/geometry/griddata.m, scripts/geometry/griddata3.m,
scripts/geometry/griddatan.m, scripts/geometry/voronoi.m, scripts/help/help.m,
scripts/help/lookfor.m, scripts/image/cmpermute.m, scripts/image/colormap.m,
scripts/image/image.m, scripts/image/imagesc.m, scripts/image/imfinfo.m,
scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imshow.m,
scripts/image/imwrite.m, scripts/image/ind2gray.m, scripts/image/lines.m,
scripts/image/rgb2ind.m, scripts/image/spinmap.m, scripts/io/dlmwrite.m,
scripts/io/strread.m, scripts/io/textread.m, scripts/io/textscan.m,
scripts/java/javaclasspath.m, scripts/java/usejava.m,
scripts/miscellaneous/bzip2.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/copyfile.m, scripts/miscellaneous/debug.m,
scripts/miscellaneous/dos.m, scripts/miscellaneous/edit.m,
scripts/miscellaneous/gzip.m, scripts/miscellaneous/license.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/movefile.m,
scripts/miscellaneous/parseparams.m, scripts/miscellaneous/unix.m,
scripts/optimization/fminbnd.m, scripts/optimization/fminsearch.m,
scripts/optimization/fminunc.m, scripts/optimization/fsolve.m,
scripts/optimization/fzero.m, scripts/optimization/glpk.m,
scripts/optimization/lsqnonneg.m, scripts/optimization/optimset.m,
scripts/optimization/pqpnonneg.m, scripts/pkg/pkg.m, scripts/plot/allchild.m,
scripts/plot/ancestor.m, scripts/plot/area.m, scripts/plot/axis.m,
scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/box.m,
scripts/plot/caxis.m, scripts/plot/cla.m, scripts/plot/clabel.m,
scripts/plot/clf.m, scripts/plot/close.m, scripts/plot/colorbar.m,
scripts/plot/daspect.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m,
scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, scripts/plot/findall.m,
scripts/plot/findobj.m, scripts/plot/gcbo.m, scripts/plot/gcf.m,
scripts/plot/gco.m, scripts/plot/grid.m, scripts/plot/guihandles.m,
scripts/plot/hdl2struct.m, scripts/plot/hidden.m, scripts/plot/hold.m,
scripts/plot/isonormals.m, scripts/plot/isosurface.m, scripts/plot/legend.m,
scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshz.m,
scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m,
scripts/plot/patch.m, scripts/plot/pbaspect.m, scripts/plot/pcolor.m,
scripts/plot/plot.m, scripts/plot/print.m,
scripts/plot/private/__add_default_menu__.m, scripts/plot/quiver.m,
scripts/plot/quiver3.m, scripts/plot/refreshdata.m, scripts/plot/saveas.m,
scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/shading.m,
scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/stem.m,
scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m,
scripts/plot/surf.m, scripts/plot/surfc.m, scripts/plot/surfl.m,
scripts/plot/tetramesh.m, scripts/plot/uigetfile.m, scripts/plot/uimenu.m,
scripts/plot/uiputfile.m, scripts/plot/waterfall.m, scripts/plot/whitebg.m,
scripts/plot/xlim.m, scripts/plot/ylim.m, scripts/plot/zlim.m,
scripts/polynomial/conv.m, scripts/polynomial/polyout.m,
scripts/polynomial/splinefit.m, scripts/set/ismember.m, scripts/set/powerset.m,
scripts/set/setdiff.m, scripts/set/union.m, scripts/set/unique.m,
scripts/signal/detrend.m, scripts/signal/filter2.m, scripts/signal/freqz.m,
scripts/signal/periodogram.m, scripts/signal/spectral_adf.m,
scripts/signal/spectral_xdf.m, scripts/sparse/eigs.m, scripts/sparse/svds.m,
scripts/specfun/legendre.m, scripts/special-matrix/gallery.m,
scripts/statistics/base/mean.m, scripts/statistics/base/moment.m,
scripts/statistics/tests/cor_test.m,
scripts/statistics/tests/kolmogorov_smirnov_test.m,
scripts/statistics/tests/kolmogorov_smirnov_test_2.m,
scripts/statistics/tests/kruskal_wallis_test.m,
scripts/statistics/tests/prop_test_2.m, scripts/statistics/tests/sign_test.m,
scripts/statistics/tests/t_test.m, scripts/statistics/tests/t_test_2.m,
scripts/statistics/tests/t_test_regression.m,
scripts/statistics/tests/u_test.m, scripts/statistics/tests/var_test.m,
scripts/statistics/tests/welch_test.m,
scripts/statistics/tests/wilcoxon_test.m, scripts/statistics/tests/z_test.m,
scripts/statistics/tests/z_test_2.m, scripts/strings/base2dec.m,
scripts/strings/index.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/regexptranslate.m,
scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m,
scripts/strings/strjust.m, scripts/strings/strmatch.m,
scripts/strings/validatestring.m, scripts/testfun/demo.m,
scripts/testfun/example.m, scripts/testfun/test.m, scripts/time/addtodate.m,
scripts/time/asctime.m, scripts/time/datestr.m, scripts/time/datetick.m,
scripts/time/weekday.m, scripts/ui/errordlg.m, scripts/ui/helpdlg.m,
scripts/ui/inputdlg.m, scripts/ui/listdlg.m, scripts/ui/msgbox.m,
scripts/ui/questdlg.m, scripts/ui/warndlg.m: Use new @qcode macro.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 19 Aug 2013 20:46:38 -0700 |
parents | 9deb214ae9d5 |
children | d63878346099 |
line wrap: on
line source
/* Copyright (C) 1996-2012 John W. Eaton This file is part of Octave. Octave 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. Octave 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 Octave; see the file COPYING. If not, see <http://www.gnu.org/licenses/>. */ // Author: John W. Eaton. #ifdef HAVE_CONFIG_H #include <config.h> #endif #include <cstring> #include <cctype> #include <fstream> #include <iomanip> #include <iostream> #include <sstream> #include <string> #include "byte-swap.h" #include "data-conv.h" #include "file-ops.h" #include "glob-match.h" #include "lo-mappers.h" #include "mach-info.h" #include "oct-env.h" #include "oct-time.h" #include "quit.h" #include "str-vec.h" #include "Cell.h" #include "defun.h" #include "error.h" #include "gripes.h" #include "load-save.h" #include "ls-ascii-helper.h" #include "ls-oct-ascii.h" #include "oct-obj.h" #include "oct-map.h" #include "ov-cell.h" #include "pager.h" #include "pt-exp.h" #include "unwind-prot.h" #include "utils.h" #include "variables.h" #include "version.h" #include "dMatrix.h" // The number of decimal digits to use when writing ascii data. static int Vsave_precision = 16; // Functions for reading ascii data. // Extract a KEYWORD and its value from stream IS, returning the // associated value in a new string. // // Input should look something like: // // [%#][ \t]*keyword[ \t]*:[ \t]*string-value[ \t]*\n std::string extract_keyword (std::istream& is, const char *keyword, const bool next_only) { std::string retval; int ch = is.peek (); if (next_only && ch != '%' && ch != '#') return retval; char c; while (is.get (c)) { if (c == '%' || c == '#') { std::ostringstream buf; while (is.get (c) && (c == ' ' || c == '\t' || c == '%' || c == '#')) ; // Skip whitespace and comment characters. if (isalpha (c)) buf << c; while (is.get (c) && isalpha (c)) buf << c; std::string tmp = buf.str (); bool match = (tmp.compare (0, strlen (keyword), keyword) == 0); if (match) { std::ostringstream value; while (is.get (c) && (c == ' ' || c == '\t' || c == ':')) ; // Skip whitespace and the colon. is.putback (c); retval = read_until_newline (is, false); break; } else if (next_only) break; else skip_until_newline (is, false); } } int len = retval.length (); if (len > 0) { while (len) { c = retval[len-1]; if (c == ' ' || c == '\t') len--; else { retval.resize (len); break; } } } return retval; } // Extract one value (scalar, matrix, string, etc.) from stream IS and // place it in TC, returning the name of the variable. If the value // is tagged as global in the file, return TRUE in GLOBAL. // // Each type supplies its own function to load the data, and so this // function is extensible. // // FILENAME is used for error messages. // // The data is expected to be in the following format: // // The input file must have a header followed by some data. // // All lines in the header must begin with a '#' character. // // The header must contain a list of keyword and value pairs with the // keyword and value separated by a colon. // // Keywords must appear in the following order: // // # name: <name> // # type: <type> // # <info> // // Where, for the built in types are: // // <name> : a valid identifier // // <type> : <typename> // | global <typename> // // <typename> : scalar // | complex scalar // | matrix // | complex matrix // | bool // | bool matrix // | string // | range // // <info> : <matrix info> // | <string info> // // <matrix info> : # rows: <integer> // : # columns: <integer> // // <string info> : # elements: <integer> // : # length: <integer> (once before each string) // // For backward compatibility the type "string array" is treated as a // "string" type. Also "string" can have a single element with no elements // line such that // // <string info> : # length: <integer> // // Formatted ASCII data follows the header. // // Example: // // # name: foo // # type: matrix // # rows: 2 // # columns: 2 // 2 4 // 1 3 // // Example: // // # name: foo // # type: string // # elements: 5 // # length: 4 // this // # length: 2 // is // # length: 1 // a // # length: 6 // string // # length: 5 // array // // FIXME -- this format is fairly rigid, and doesn't allow for // arbitrary comments. Someone should fix that. It does allow arbitrary // types however. // Ugh. The signature of the compare method is not standard in older // versions of the GNU libstdc++. Do this instead: #define SUBSTRING_COMPARE_EQ(s, pos, n, t) (s.substr (pos, n) == t) std::string read_ascii_data (std::istream& is, const std::string& filename, bool& global, octave_value& tc, octave_idx_type count) { // Read name for this entry or break on EOF. std::string name = extract_keyword (is, "name"); if (name.empty ()) { if (count == 0) error ("load: empty name keyword or no data found in file '%s'", filename.c_str ()); return std::string (); } if (! (name == ".nargin." || name == ".nargout." || name == CELL_ELT_TAG || valid_identifier (name))) { error ("load: bogus identifier '%s' found in file '%s'", name.c_str (), filename.c_str ()); return std::string (); } // Look for type keyword. std::string tag = extract_keyword (is, "type"); if (! tag.empty ()) { std::string typ; size_t pos = tag.rfind (' '); if (pos != std::string::npos) { global = SUBSTRING_COMPARE_EQ (tag, 0, 6, "global"); typ = global ? tag.substr (7) : tag; } else typ = tag; // Special case for backward compatiablity. A small bit of cruft if (SUBSTRING_COMPARE_EQ (typ, 0, 12, "string array")) tc = charMatrix (); else tc = octave_value_typeinfo::lookup_type (typ); if (! tc.load_ascii (is)) error ("load: trouble reading ascii file '%s'", filename.c_str ()); } else error ("load: failed to extract keyword specifying value type"); if (error_state) { error ("load: reading file %s", filename.c_str ()); return std::string (); } return name; } // Save the data from TC along with the corresponding NAME, and global // flag MARK_AS_GLOBAL on stream OS in the plain text format described // above for load_ascii_data. If NAME is empty, the name: line is not // generated. PRECISION specifies the number of decimal digits to print. // // Assumes ranges and strings cannot contain Inf or NaN values. // // Returns 1 for success and 0 for failure. // FIXME -- should probably write the help string here too. bool save_ascii_data (std::ostream& os, const octave_value& val_arg, const std::string& name, bool mark_as_global, int precision) { bool success = true; if (! name.empty ()) os << "# name: " << name << "\n"; octave_value val = val_arg; if (mark_as_global) os << "# type: global " << val.type_name () << "\n"; else os << "# type: " << val.type_name () << "\n"; if (! precision) precision = Vsave_precision; long old_precision = os.precision (); os.precision (precision); success = val.save_ascii (os); // Insert an extra pair of newline characters after the data so that // multiple data elements may be handled separately by gnuplot (see // the description of the index qualifier for the plot command in the // gnuplot documentation). os << "\n\n"; os.precision (old_precision); return (os && success); } bool save_ascii_data_for_plotting (std::ostream& os, const octave_value& t, const std::string& name) { return save_ascii_data (os, t, name, false, 6); } // Maybe this should be a static function in tree-plot.cc? // If TC is matrix, save it on stream OS in a format useful for // making a 3-dimensional plot with gnuplot. If PARAMETRIC is // TRUE, assume a parametric 3-dimensional plot will be generated. bool save_three_d (std::ostream& os, const octave_value& tc, bool parametric) { bool fail = false; octave_idx_type nr = tc.rows (); octave_idx_type nc = tc.columns (); if (tc.is_real_matrix ()) { os << "# 3-D data...\n" << "# type: matrix\n" << "# total rows: " << nr << "\n" << "# total columns: " << nc << "\n"; long old_precision = os.precision (); os.precision (6); if (parametric) { octave_idx_type extras = nc % 3; if (extras) warning ("ignoring last %d columns", extras); Matrix tmp = tc.matrix_value (); nr = tmp.rows (); for (octave_idx_type i = 0; i < nc-extras; i += 3) { os << tmp.extract (0, i, nr-1, i+2); if (i+3 < nc-extras) os << "\n"; } } else { Matrix tmp = tc.matrix_value (); nr = tmp.rows (); for (octave_idx_type i = 0; i < nc; i++) { os << tmp.extract (0, i, nr-1, i); if (i+1 < nc) os << "\n"; } } os.precision (old_precision); } else { ::error ("for now, I can only save real matrices in 3-D format"); fail = true; } return (os && ! fail); } DEFUN (save_precision, args, nargout, "-*- texinfo -*-\n\ @deftypefn {Built-in Function} {@var{val} =} save_precision ()\n\ @deftypefnx {Built-in Function} {@var{old_val} =} save_precision (@var{new_val})\n\ @deftypefnx {Built-in Function} {} save_precision (@var{new_val}, \"local\")\n\ Query or set the internal variable that specifies the number of\n\ digits to keep when saving data in text format.\n\ \n\ When called from inside a function with the @qcode{\"local\"} option, the\n\ variable is changed locally for the function and any subroutines it calls.\n\ The original variable value is restored when exiting the function.\n\ @end deftypefn") { return SET_INTERNAL_VARIABLE_WITH_LIMITS (save_precision, -1, std::numeric_limits<int>::max ()); }