Mercurial > octave
view libinterp/corefcn/oct-stream.h @ 21244:1473547f50f5
include octave-config.h in public header files
* mk-opts.pl, mkbuiltins, mk-ops.awk, sparse-mk-ops.awk:
Emit "#include octave-config.h" statement for generated header files.
* build-env.h, builtins.h, Cell.h, base-text-renderer.h,
c-file-ptr-stream.h, cdisplay.h, comment-list.h, data.h, debug.h,
defaults.in.h, defun-dld.h, defun-int.h, defun.h, dirfns.h, display.h,
dynamic-ld.h, error.h, errwarn.h, event-queue.h, file-io.h,
ft-text-renderer.h, gl-render.h, gl2ps-print.h, graphics.in.h,
gripes.h, help.h, hook-fcn.h, input.h, jit-ir.h, jit-typeinfo.h,
jit-util.h, load-path.h, load-save.h, ls-ascii-helper.h, ls-hdf5.h,
ls-mat-ascii.h, ls-mat4.h, ls-mat5.h, ls-oct-binary.h, ls-oct-text.h,
ls-utils.h, mex.h, mexproto.h, mxarray.in.h, oct-errno.h, oct-fstrm.h,
oct-handle.h, oct-hdf5-types.h, oct-hdf5.h, oct-hist.h, oct-iostrm.h,
oct-lvalue.h, oct-map.h, oct-obj.h, oct-opengl.h, oct-prcstrm.h,
oct-procbuf.h, oct-stdstrm.h, oct-stream.h, oct-strstrm.h, oct.h,
octave-default-image.h, octave-link.h, octave-preserve-stream-state.h,
pager.h, pr-output.h, procstream.h, profiler.h, pt-jit.h,
sighandlers.h, siglist.h, sparse-xdiv.h, sparse-xpow.h, symtab.h,
sysdep.h, text-renderer.h, toplev.h, txt-eng.h, utils.h, variables.h,
workspace-element.h, xdiv.h, xnorm.h, xpow.h, zfstream.h, oct-qhull.h,
ov-base-diag.h, ov-base-int.h, ov-base-mat.h, ov-base-scalar.h,
ov-base-sparse.h, ov-base.h, ov-bool-mat.h, ov-bool-sparse.h,
ov-bool.h, ov-builtin.h, ov-cell.h, ov-ch-mat.h, ov-class.h,
ov-classdef.h, ov-colon.h, ov-complex.h, ov-cs-list.h, ov-cx-diag.h,
ov-cx-mat.h, ov-cx-sparse.h, ov-dld-fcn.h, ov-fcn-handle.h,
ov-fcn-inline.h, ov-fcn.h, ov-float.h, ov-flt-complex.h,
ov-flt-cx-diag.h, ov-flt-cx-mat.h, ov-flt-re-diag.h, ov-flt-re-mat.h,
ov-int-traits.h, ov-int16.h, ov-int32.h, ov-int64.h, ov-int8.h,
ov-intx.h, ov-java.h, ov-lazy-idx.h, ov-mex-fcn.h, ov-null-mat.h,
ov-oncleanup.h, ov-perm.h, ov-range.h, ov-re-diag.h, ov-re-mat.h,
ov-re-sparse.h, ov-scalar.h, ov-str-mat.h, ov-struct.h,
ov-type-conv.h, ov-typeinfo.h, ov-uint16.h, ov-uint32.h, ov-uint64.h,
ov-uint8.h, ov-usr-fcn.h, ov.h, ovl.h, octave.h, op-int.h, ops.h,
options-usage.h, lex.h, parse.h, pt-all.h, pt-arg-list.h,
pt-array-list.h, pt-assign.h, pt-binop.h, pt-bp.h, pt-cbinop.h,
pt-cell.h, pt-check.h, pt-classdef.h, pt-cmd.h, pt-colon.h,
pt-const.h, pt-decl.h, pt-eval.h, pt-except.h, pt-exp.h,
pt-fcn-handle.h, pt-funcall.h, pt-id.h, pt-idx.h, pt-jump.h,
pt-loop.h, pt-mat.h, pt-misc.h, pt-pr-code.h, pt-select.h, pt-stmt.h,
pt-unop.h, pt-walk.h, pt.h, token.h, version.in.h, Array-util.h,
Array.h, CColVector.h, CDiagMatrix.h, CMatrix.h, CNDArray.h,
CRowVector.h, CSparse.h, DiagArray2.h, MArray.h, MDiagArray2.h,
MSparse.h, Matrix.h, MatrixType.h, PermMatrix.h, Range.h, Sparse.h,
boolMatrix.h, boolNDArray.h, boolSparse.h, chMatrix.h, chNDArray.h,
dColVector.h, dDiagMatrix.h, dMatrix.h, dNDArray.h, dRowVector.h,
dSparse.h, dim-vector.h, fCColVector.h, fCDiagMatrix.h, fCMatrix.h,
fCNDArray.h, fCRowVector.h, fColVector.h, fDiagMatrix.h, fMatrix.h,
fNDArray.h, fRowVector.h, idx-vector.h, int16NDArray.h,
int32NDArray.h, int64NDArray.h, int8NDArray.h, intNDArray.h,
uint16NDArray.h, uint32NDArray.h, uint64NDArray.h, uint8NDArray.h,
f77-fcn.h, lo-error.h, quit.h, CmplxAEPBAL.h, CmplxCHOL.h,
CmplxGEPBAL.h, CmplxHESS.h, CmplxLU.h, CmplxQR.h, CmplxQRP.h,
CmplxSCHUR.h, CmplxSVD.h, CollocWt.h, DAE.h, DAEFunc.h, DAERT.h,
DAERTFunc.h, DASPK.h, DASRT.h, DASSL.h, DET.h, EIG.h, LSODE.h, ODE.h,
ODEFunc.h, ODES.h, ODESFunc.h, Quad.h, base-aepbal.h, base-dae.h,
base-de.h, base-lu.h, base-min.h, base-qr.h, bsxfun-decl.h, bsxfun.h,
dbleAEPBAL.h, dbleCHOL.h, dbleGEPBAL.h, dbleHESS.h, dbleLU.h,
dbleQR.h, dbleQRP.h, dbleSCHUR.h, dbleSVD.h, eigs-base.h,
fCmplxAEPBAL.h, fCmplxCHOL.h, fCmplxGEPBAL.h, fCmplxHESS.h,
fCmplxLU.h, fCmplxQR.h, fCmplxQRP.h, fCmplxSCHUR.h, fCmplxSVD.h,
fEIG.h, floatAEPBAL.h, floatCHOL.h, floatGEPBAL.h, floatHESS.h,
floatLU.h, floatQR.h, floatQRP.h, floatSCHUR.h, floatSVD.h,
lo-mappers.h, lo-specfun.h, oct-convn.h, oct-fftw.h, oct-norm.h,
oct-rand.h, oct-spparms.h, randgamma.h, randmtzig.h, randpoisson.h,
sparse-chol.h, sparse-dmsolve.h, sparse-lu.h, sparse-qr.h,
Sparse-diag-op-defs.h, Sparse-op-decls.h, Sparse-op-defs.h,
Sparse-perm-op-defs.h, mx-base.h, mx-defs.h, mx-ext.h, mx-op-decl.h,
mx-op-defs.h, dir-ops.h, file-ops.h, file-stat.h, lo-sysdep.h,
mach-info.h, oct-env.h, oct-group.h, oct-openmp.h, oct-passwd.h,
oct-syscalls.h, oct-time.h, oct-uname.h, pathlen.h, sysdir.h,
syswait.h, action-container.h, base-list.h, byte-swap.h,
caseless-str.h, cmd-edit.h, cmd-hist.h, data-conv.h, functor.h,
glob-match.h, lo-array-errwarn.h, lo-array-gripes.h, lo-cutils.h,
lo-ieee.h, lo-macros.h, lo-math.h, lo-regexp.h, lo-traits.h,
lo-utils.h, oct-alloc.h, oct-base64.h, oct-binmap.h, oct-cmplx.h,
oct-glob.h, oct-inttypes.h, oct-locbuf.h, oct-mutex.h, oct-refcount.h,
oct-rl-edit.h, oct-rl-hist.h, oct-shlib.h, oct-sort.h, oct-sparse.h,
pathsearch.h, singleton-cleanup.h, sparse-sort.h, sparse-util.h,
statdefs.h, str-vec.h, sun-utils.h, unwind-prot.h, url-transfer.h:
Include octave-config.h.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 10 Feb 2016 14:25:53 -0500 |
parents | 538b57866b90 |
children | 4f3e63d75f33 |
line wrap: on
line source
/* Copyright (C) 1996-2015 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/>. */ #if ! defined (octave_oct_stream_h) #define octave_oct_stream_h 1 #include "octave-config.h" class Matrix; class string_vector; class octave_value; class octave_value_list; #include <iosfwd> #include <sstream> #include <string> #include <list> #include <map> #include "Array.h" #include "data-conv.h" #include "lo-utils.h" #include "mach-info.h" #include "oct-refcount.h" class OCTINTERP_API scanf_format_elt { public: enum special_conversion { whitespace_conversion = 1, literal_conversion = 2, null = 3 }; scanf_format_elt (const char *txt = 0, int w = 0, bool d = false, char typ = '\0', char mod = '\0', const std::string& ch_class = "") : text (strsave (txt)), width (w), discard (d), type (typ), modifier (mod), char_class (ch_class) { } scanf_format_elt (const scanf_format_elt& e) : text (strsave (e.text)), width (e.width), discard (e.discard), type (e.type), modifier (e.modifier), char_class (e.char_class) { } scanf_format_elt& operator = (const scanf_format_elt& e) { if (this != &e) { text = strsave (e.text); width = e.width; discard = e.discard; type = e.type; modifier = e.modifier; char_class = e.char_class; } return *this; } ~scanf_format_elt (void) { delete [] text; } // The C-style format string. const char *text; // The maximum field width. int width; // TRUE if we are not storing the result of this conversion. bool discard; // Type of conversion -- 'd', 'i', 'o', 'u', 'x', 'e', 'f', 'g', // 'c', 's', 'p', '%', or '['. char type; // A length modifier -- 'h', 'l', or 'L'. char modifier; // The class of characters in a '[' format. std::string char_class; }; class OCTINTERP_API scanf_format_list { public: scanf_format_list (const std::string& fmt = ""); ~scanf_format_list (void); octave_idx_type num_conversions (void) { return nconv; } // The length can be different than the number of conversions. // For example, "x %d y %d z" has 2 conversions but the length of // the list is 3 because of the characters that appear after the // last conversion. octave_idx_type length (void) { return list.numel (); } const scanf_format_elt *first (void) { curr_idx = 0; return current (); } const scanf_format_elt *current (void) const { return list.numel () > 0 ? list.elem (curr_idx) : 0; } const scanf_format_elt *next (bool cycle = true) { static scanf_format_elt dummy (0, 0, false, scanf_format_elt::null, '\0', ""); curr_idx++; if (curr_idx >= list.numel ()) { if (cycle) curr_idx = 0; else return &dummy; } return current (); } void printme (void) const; bool ok (void) const { return (nconv >= 0); } operator bool () const { return ok (); } bool all_character_conversions (void); bool all_numeric_conversions (void); private: // Number of conversions specified by this format string, or -1 if // invalid conversions have been found. octave_idx_type nconv; // Index to current element; octave_idx_type curr_idx; // FIXME: maybe LIST should be a std::list object? // List of format elements. Array<scanf_format_elt*> list; // Temporary buffer. std::ostringstream *buf; void add_elt_to_list (int width, bool discard, char type, char modifier, octave_idx_type& num_elts, const std::string& char_class = ""); void process_conversion (const std::string& s, size_t& i, size_t n, int& width, bool& discard, char& type, char& modifier, octave_idx_type& num_elts); int finish_conversion (const std::string& s, size_t& i, size_t n, int& width, bool discard, char& type, char modifier, octave_idx_type& num_elts); // No copying! scanf_format_list (const scanf_format_list&); scanf_format_list& operator = (const scanf_format_list&); }; class printf_format_elt { public: printf_format_elt (const char *txt = 0, int n = 0, int w = -1, int p = -1, const std::string& f = "", char typ = '\0', char mod = '\0') : text (strsave (txt)), args (n), fw (w), prec (p), flags (f), type (typ), modifier (mod) { } printf_format_elt (const printf_format_elt& e) : text (strsave (e.text)), args (e.args), fw (e.fw), prec (e.prec), flags (e.flags), type (e.type), modifier (e.modifier) { } printf_format_elt& operator = (const printf_format_elt& e) { if (this != &e) { text = strsave (e.text); args = e.args; fw = e.fw; prec = e.prec; flags = e.flags; type = e.type; modifier = e.modifier; } return *this; } ~printf_format_elt (void) { delete [] text; } // The C-style format string. const char *text; // How many args do we expect to consume? int args; // Field width. int fw; // Precision. int prec; // Flags -- '-', '+', ' ', '0', or '#'. std::string flags; // Type of conversion -- 'd', 'i', 'o', 'x', 'X', 'u', 'c', 's', // 'f', 'e', 'E', 'g', 'G', 'p', or '%' char type; // A length modifier -- 'h', 'l', or 'L'. char modifier; }; class OCTINTERP_API printf_format_list { public: printf_format_list (const std::string& fmt = ""); ~printf_format_list (void); octave_idx_type num_conversions (void) { return nconv; } const printf_format_elt *first (void) { curr_idx = 0; return current (); } const printf_format_elt *current (void) const { return list.numel () > 0 ? list.elem (curr_idx) : 0; } const printf_format_elt *next (bool cycle = true) { curr_idx++; if (curr_idx >= list.numel ()) { if (cycle) curr_idx = 0; else return 0; } return current (); } bool last_elt_p (void) { return (curr_idx + 1 == list.numel ()); } void printme (void) const; bool ok (void) const { return (nconv >= 0); } operator bool () const { return ok (); } private: // Number of conversions specified by this format string, or -1 if // invalid conversions have been found. octave_idx_type nconv; // Index to current element; octave_idx_type curr_idx; // FIXME: maybe LIST should be a std::list object? // List of format elements. Array<printf_format_elt*> list; // Temporary buffer. std::ostringstream *buf; void add_elt_to_list (int args, const std::string& flags, int fw, int prec, char type, char modifier, octave_idx_type& num_elts); void process_conversion (const std::string& s, size_t& i, size_t n, int& args, std::string& flags, int& fw, int& prec, char& modifier, char& type, octave_idx_type& num_elts); void finish_conversion (const std::string& s, size_t& i, int args, const std::string& flags, int fw, int prec, char modifier, char& type, octave_idx_type& num_elts); // No copying! printf_format_list (const printf_format_list&); printf_format_list& operator = (const printf_format_list&); }; // Provide an interface for Octave streams. class OCTINTERP_API octave_base_stream { friend class octave_stream; public: octave_base_stream (std::ios::openmode arg_md = std::ios::in|std::ios::out, oct_mach_info::float_format ff = oct_mach_info::native_float_format ()) : count (0), md (arg_md), flt_fmt (ff), fail (false), open_state (true), errmsg () { } virtual ~octave_base_stream (void) { } // The remaining functions are not specific to input or output only, // and must be provided by the derived classes. // Position a stream at OFFSET relative to ORIGIN. virtual int seek (off_t offset, int origin) = 0; // Return current stream position. virtual off_t tell (void) = 0; // Return TRUE if EOF has been reached on this stream. virtual bool eof (void) const = 0; // The name of the file. virtual std::string name (void) const = 0; // If the derived class provides this function and it returns a // pointer to a valid istream, scanf(), read(), getl(), and gets() // will automatically work for this stream. virtual std::istream *input_stream (void) { return 0; } // If the derived class provides this function and it returns a // pointer to a valid ostream, flush(), write(), and printf() will // automatically work for this stream. virtual std::ostream *output_stream (void) { return 0; } // Return TRUE if this stream is open. bool is_open (void) const { return open_state; } virtual void do_close (void) { } void close (void) { if (is_open ()) { open_state = false; do_close (); } } virtual int file_number (void) const { // Kluge alert! if (name () == "stdin") return 0; else if (name () == "stdout") return 1; else if (name () == "stderr") return 2; else return -1; } bool ok (void) const { return ! fail; } // Return current error message for this stream. std::string error (bool clear, int& err_num); protected: int mode (void) const { return md; } oct_mach_info::float_format float_format (void) const { return flt_fmt; } // Set current error state and set fail to TRUE. void error (const std::string& msg); void error (const std::string& who, const std::string& msg); // Clear any error message and set fail to FALSE. void clear (void); // Clear stream state. void clearerr (void); private: // A reference count. octave_refcount<octave_idx_type> count; // The permission bits for the file. Should be some combination of // std::ios::open_mode bits. int md; // Data format. oct_mach_info::float_format flt_fmt; // TRUE if an error has occurred. bool fail; // TRUE if this stream is open. bool open_state; // Should contain error message if fail is TRUE. std::string errmsg; // Functions that are defined for all input streams (input streams // are those that define is). std::string do_gets (octave_idx_type max_len, bool& err, bool strip_newline, const std::string& who /* = "gets" */); std::string getl (octave_idx_type max_len, bool& err, const std::string& who /* = "getl" */); std::string gets (octave_idx_type max_len, bool& err, const std::string& who /* = "gets" */); off_t skipl (off_t count, bool& err, const std::string& who /* = "skipl" */); octave_value do_scanf (scanf_format_list& fmt_list, octave_idx_type nr, octave_idx_type nc, bool one_elt_size_spec, octave_idx_type& count, const std::string& who /* = "scanf" */); octave_value scanf (const std::string& fmt, const Array<double>& size, octave_idx_type& count, const std::string& who /* = "scanf" */); bool do_oscanf (const scanf_format_elt *elt, octave_value&, const std::string& who /* = "scanf" */); octave_value_list oscanf (const std::string& fmt, const std::string& who /* = "scanf" */); // Functions that are defined for all output streams (output streams // are those that define os). int flush (void); int do_numeric_printf_conv (std::ostream& os, const printf_format_elt *elt, int nsa, int sa_1, int sa_2, const octave_value& val, const std::string& who); int do_printf (printf_format_list& fmt_list, const octave_value_list& args, const std::string& who /* = "printf" */); int printf (const std::string& fmt, const octave_value_list& args, const std::string& who /* = "printf" */); int puts (const std::string& s, const std::string& who /* = "puts" */); // We can always do this in terms of seek(), so the derived class // only has to provide that. void invalid_operation (const std::string& who, const char *rw); // No copying! octave_base_stream (const octave_base_stream&); octave_base_stream& operator = (const octave_base_stream&); }; class OCTINTERP_API octave_stream { public: octave_stream (octave_base_stream *bs = 0); ~octave_stream (void); octave_stream (const octave_stream&); octave_stream& operator = (const octave_stream&); int flush (void); std::string getl (octave_idx_type max_len, bool& err, const std::string& who /* = "getl" */); std::string getl (const octave_value& max_len, bool& err, const std::string& who /* = "getl" */); std::string gets (octave_idx_type max_len, bool& err, const std::string& who /* = "gets" */); std::string gets (const octave_value& max_len, bool& err, const std::string& who /* = "gets" */); off_t skipl (off_t count, bool& err, const std::string& who /* = "skipl" */); off_t skipl (const octave_value& count, bool& err, const std::string& who /* = "skipl" */); int seek (off_t offset, int origin); int seek (const octave_value& offset, const octave_value& origin); off_t tell (void); int rewind (void); bool is_open (void) const; void close (void); octave_value read (const Array<double>& size, octave_idx_type block_size, oct_data_conv::data_type input_type, oct_data_conv::data_type output_type, octave_idx_type skip, oct_mach_info::float_format flt_fmt, octave_idx_type& count); octave_idx_type write (const octave_value& data, octave_idx_type block_size, oct_data_conv::data_type output_type, octave_idx_type skip, oct_mach_info::float_format flt_fmt); bool write_bytes (const void *data, size_t n_elts); bool skip_bytes (size_t n_elts); template <typename T> octave_idx_type write (const Array<T>& data, octave_idx_type block_size, oct_data_conv::data_type output_type, octave_idx_type skip, oct_mach_info::float_format flt_fmt); octave_value scanf (const std::string& fmt, const Array<double>& size, octave_idx_type& count, const std::string& who /* = "scanf" */); octave_value scanf (const octave_value& fmt, const Array<double>& size, octave_idx_type& count, const std::string& who /* = "scanf" */); octave_value_list oscanf (const std::string& fmt, const std::string& who /* = "scanf" */); octave_value_list oscanf (const octave_value& fmt, const std::string& who /* = "scanf" */); int printf (const std::string& fmt, const octave_value_list& args, const std::string& who /* = "printf" */); int printf (const octave_value& fmt, const octave_value_list& args, const std::string& who /* = "printf" */); int puts (const std::string& s, const std::string& who /* = "puts" */); int puts (const octave_value& s, const std::string& who /* = "puts" */); bool eof (void) const; std::string error (bool clear, int& err_num); std::string error (bool clear = false) { int err_num; return error (clear, err_num); } // Set the error message and state. void error (const std::string& msg) { if (rep) rep->error (msg); } void error (const char *msg) { error (std::string (msg)); } int file_number (void) { return rep ? rep->file_number () : -1; } bool is_valid (void) const { return (rep != 0); } bool ok (void) const { return rep && rep->ok (); } operator bool () const { return ok (); } std::string name (void) const; int mode (void) const; oct_mach_info::float_format float_format (void) const; static std::string mode_as_string (int mode); std::istream *input_stream (void) { return rep ? rep->input_stream () : 0; } std::ostream *output_stream (void) { return rep ? rep->output_stream () : 0; } void clearerr (void) { if (rep) rep->clearerr (); } private: // The actual representation of this stream. octave_base_stream *rep; bool stream_ok (bool clear = true) const { bool retval = true; if (rep) { if (clear) rep->clear (); } else retval = false; return retval; } void invalid_operation (const std::string& who, const char *rw) { if (rep) rep->invalid_operation (who, rw); } octave_value finalize_read (std::list<void *>& input_buf_list, octave_idx_type input_buf_elts, octave_idx_type elts_read, octave_idx_type nr, octave_idx_type nc, oct_data_conv::data_type input_type, oct_data_conv::data_type output_type, oct_mach_info::float_format ffmt); }; class OCTINTERP_API octave_stream_list { protected: octave_stream_list (void) : list (), lookup_cache (list.end ()) { } public: ~octave_stream_list (void) { } static bool instance_ok (void); static int insert (octave_stream& os); static octave_stream lookup (int fid, const std::string& who = ""); static octave_stream lookup (const octave_value& fid, const std::string& who = ""); static int remove (int fid, const std::string& who = ""); static int remove (const octave_value& fid, const std::string& who = ""); static void clear (bool flush = true); static string_vector get_info (int fid); static string_vector get_info (const octave_value& fid); static std::string list_open_files (void); static octave_value open_file_numbers (void); static int get_file_number (const octave_value& fid); private: typedef std::map<int, octave_stream> ostrl_map; ostrl_map list; mutable ostrl_map::const_iterator lookup_cache; static octave_stream_list *instance; static void cleanup_instance (void) { delete instance; instance = 0; } int do_insert (octave_stream& os); octave_stream do_lookup (int fid, const std::string& who = "") const; octave_stream do_lookup (const octave_value& fid, const std::string& who = "") const; int do_remove (int fid, const std::string& who = ""); int do_remove (const octave_value& fid, const std::string& who = ""); void do_clear (bool flush = true); string_vector do_get_info (int fid) const; string_vector do_get_info (const octave_value& fid) const; std::string do_list_open_files (void) const; octave_value do_open_file_numbers (void) const; int do_get_file_number (const octave_value& fid) const; }; #endif