annotate scripts/plot/util/__pltopt__.m @ 17572:7bb76a22cde1

maint: Split scripts/plot directory into 4 pieces. scripts/gui : user-interface functions scripts/plot/appearance : functions controlling plot appearance scripts/plot/draw : plotting functions which produce graphs scripts/plot/util : low-level plotting functions and utilities. * scripts/gui/guidata.m, scripts/gui/guihandles.m, scripts/gui/module.mk, scripts/gui/private/__file_filter__.m, scripts/gui/private/__fltk_file_filter__.m, scripts/gui/private/__is_function__.m, scripts/gui/private/__uigetdir_fltk__.m, scripts/gui/private/__uigetfile_fltk__.m, scripts/gui/private/__uiobject_split_args__.m, scripts/gui/private/__uiputfile_fltk__.m, scripts/gui/uicontextmenu.m, scripts/gui/uicontrol.m, scripts/gui/uigetdir.m, scripts/gui/uigetfile.m, scripts/gui/uimenu.m, scripts/gui/uipanel.m, scripts/gui/uipushtool.m, scripts/gui/uiputfile.m, scripts/gui/uiresume.m, scripts/gui/uitoggletool.m, scripts/gui/uitoolbar.m, scripts/gui/uiwait.m, scripts/gui/waitbar.m, scripts/gui/waitforbuttonpress.m: Moved from scripts/plot to scripts/gui * scripts/plot/appearance/__clabel__.m, scripts/plot/appearance/__getlegenddata__.m, scripts/plot/appearance/axis.m, scripts/plot/appearance/box.m, scripts/plot/appearance/caxis.m, scripts/plot/appearance/clabel.m, scripts/plot/appearance/daspect.m, scripts/plot/appearance/diffuse.m, scripts/plot/appearance/grid.m, scripts/plot/appearance/gtext.m, scripts/plot/appearance/hidden.m, scripts/plot/appearance/legend.m, scripts/plot/appearance/orient.m, scripts/plot/appearance/pbaspect.m, scripts/plot/appearance/private/__axis_label__.m, scripts/plot/appearance/private/__axis_limits__.m, scripts/plot/appearance/shading.m, scripts/plot/appearance/specular.m, scripts/plot/appearance/text.m, scripts/plot/appearance/title.m, scripts/plot/appearance/view.m, scripts/plot/appearance/whitebg.m, scripts/plot/appearance/xlabel.m, scripts/plot/appearance/xlim.m, scripts/plot/appearance/ylabel.m, scripts/plot/appearance/ylim.m, scripts/plot/appearance/zlabel.m, scripts/plot/appearance/zlim.m: Moved from scripts/plot to subdir appearance. * scripts/plot/draw/area.m, scripts/plot/draw/bar.m, scripts/plot/draw/barh.m, scripts/plot/draw/colorbar.m, scripts/plot/draw/comet.m, scripts/plot/draw/comet3.m, scripts/plot/draw/compass.m, scripts/plot/draw/contour.m, scripts/plot/draw/contour3.m, scripts/plot/draw/contourc.m, scripts/plot/draw/contourf.m, scripts/plot/draw/cylinder.m, scripts/plot/draw/ellipsoid.m, scripts/plot/draw/errorbar.m, scripts/plot/draw/ezcontour.m, scripts/plot/draw/ezcontourf.m, scripts/plot/draw/ezmesh.m, scripts/plot/draw/ezmeshc.m, scripts/plot/draw/ezplot.m, scripts/plot/draw/ezplot3.m, scripts/plot/draw/ezpolar.m, scripts/plot/draw/ezsurf.m, scripts/plot/draw/ezsurfc.m, scripts/plot/draw/feather.m, scripts/plot/draw/fill.m, scripts/plot/draw/fplot.m, scripts/plot/draw/hist.m, scripts/plot/draw/isocolors.m, scripts/plot/draw/isonormals.m, scripts/plot/draw/isosurface.m, scripts/plot/draw/line.m, scripts/plot/draw/loglog.m, scripts/plot/draw/loglogerr.m, scripts/plot/draw/mesh.m, scripts/plot/draw/meshc.m, scripts/plot/draw/meshz.m, scripts/plot/draw/pareto.m, scripts/plot/draw/patch.m, scripts/plot/draw/pcolor.m, scripts/plot/draw/peaks.m, scripts/plot/draw/pie.m, scripts/plot/draw/pie3.m, scripts/plot/draw/plot.m, scripts/plot/draw/plot3.m, scripts/plot/draw/plotmatrix.m, scripts/plot/draw/plotyy.m, scripts/plot/draw/polar.m, scripts/plot/draw/private/__add_datasource__.m, scripts/plot/draw/private/__bar__.m, scripts/plot/draw/private/__contour__.m, scripts/plot/draw/private/__errcomm__.m, scripts/plot/draw/private/__errplot__.m, scripts/plot/draw/private/__ezplot__.m, scripts/plot/draw/private/__interp_cube__.m, scripts/plot/draw/private/__line__.m, scripts/plot/draw/private/__marching_cube__.m, scripts/plot/draw/private/__patch__.m, scripts/plot/draw/private/__pie__.m, scripts/plot/draw/private/__plt__.m, scripts/plot/draw/private/__quiver__.m, scripts/plot/draw/private/__scatter__.m, scripts/plot/draw/private/__stem__.m, scripts/plot/draw/quiver.m, scripts/plot/draw/quiver3.m, scripts/plot/draw/rectangle.m, scripts/plot/draw/ribbon.m, scripts/plot/draw/rose.m, scripts/plot/draw/scatter.m, scripts/plot/draw/scatter3.m, scripts/plot/draw/semilogx.m, scripts/plot/draw/semilogxerr.m, scripts/plot/draw/semilogy.m, scripts/plot/draw/semilogyerr.m, scripts/plot/draw/shrinkfaces.m, scripts/plot/draw/slice.m, scripts/plot/draw/sombrero.m, scripts/plot/draw/sphere.m, scripts/plot/draw/stairs.m, scripts/plot/draw/stem.m, scripts/plot/draw/stem3.m, scripts/plot/draw/stemleaf.m, scripts/plot/draw/surf.m, scripts/plot/draw/surface.m, scripts/plot/draw/surfc.m, scripts/plot/draw/surfl.m, scripts/plot/draw/surfnorm.m, scripts/plot/draw/tetramesh.m, scripts/plot/draw/trimesh.m, scripts/plot/draw/triplot.m, scripts/plot/draw/trisurf.m, scripts/plot/draw/waterfall.m: Moved from plot/ to subdir draw. * scripts/plot/util/__actual_axis_position__.m, scripts/plot/util/__default_plot_options__.m, scripts/plot/util/__gnuplot_drawnow__.m, scripts/plot/util/__next_line_color__.m, scripts/plot/util/__next_line_style__.m, scripts/plot/util/__plt_get_axis_arg__.m, scripts/plot/util/__pltopt__.m, scripts/plot/util/allchild.m, scripts/plot/util/ancestor.m, scripts/plot/util/axes.m, scripts/plot/util/cla.m, scripts/plot/util/clf.m, scripts/plot/util/close.m, scripts/plot/util/closereq.m, scripts/plot/util/colstyle.m, scripts/plot/util/copyobj.m, scripts/plot/util/figure.m, scripts/plot/util/findall.m, scripts/plot/util/findfigs.m, scripts/plot/util/findobj.m, scripts/plot/util/gca.m, scripts/plot/util/gcbf.m, scripts/plot/util/gcbo.m, scripts/plot/util/gcf.m, scripts/plot/util/gco.m, scripts/plot/util/ginput.m, scripts/plot/util/gnuplot_binary.in, scripts/plot/util/graphics_toolkit.m, scripts/plot/util/hdl2struct.m, scripts/plot/util/hggroup.m, scripts/plot/util/hold.m, scripts/plot/util/isaxes.m, scripts/plot/util/isfigure.m, scripts/plot/util/ishghandle.m, scripts/plot/util/ishold.m, scripts/plot/util/isprop.m, scripts/plot/util/linkprop.m, scripts/plot/util/meshgrid.m, scripts/plot/util/ndgrid.m, scripts/plot/util/newplot.m, scripts/plot/util/print.m, scripts/plot/util/printd.m, scripts/plot/util/private/__add_default_menu__.m, scripts/plot/util/private/__fltk_ginput__.m, scripts/plot/util/private/__fltk_print__.m, scripts/plot/util/private/__ghostscript__.m, scripts/plot/util/private/__gnuplot_get_var__.m, scripts/plot/util/private/__gnuplot_ginput__.m, scripts/plot/util/private/__gnuplot_has_feature__.m, scripts/plot/util/private/__gnuplot_has_terminal__.m, scripts/plot/util/private/__gnuplot_open_stream__.m, scripts/plot/util/private/__gnuplot_print__.m, scripts/plot/util/private/__gnuplot_version__.m, scripts/plot/util/private/__go_draw_axes__.m, scripts/plot/util/private/__go_draw_figure__.m, scripts/plot/util/private/__print_parse_opts__.m, scripts/plot/util/private/__tight_eps_bbox__.m, scripts/plot/util/refresh.m, scripts/plot/util/refreshdata.m, scripts/plot/util/saveas.m, scripts/plot/util/shg.m, scripts/plot/util/struct2hdl.m, scripts/plot/util/subplot.m: Moved from plot to subdir util. * etc/HACKING: Updated directory structure info. * scripts/Makefile.am, scripts/plot/appearance/module.mk, scripts/plot/draw/module.mk, scripts/plot/util/module.mk: Added new directories to build system.
author Rik <rik@octave.org>
date Fri, 04 Oct 2013 17:09:08 -0700
parents scripts/plot/private/__pltopt__.m@ec5bd610a11f
children d63878346099
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 11587
diff changeset
1 ## Copyright (C) 1994-2012 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
8 ## your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
17 ## <http://www.gnu.org/licenses/>.
933
598a3aa40360 [project @ 1994-11-17 04:23:41 by jwe]
jwe
parents:
diff changeset
18
8812
7d48766c21a5 use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
19 ## -*- texinfo -*-
7d48766c21a5 use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
20 ## @deftypefn {Function File} {} __pltopt__ (@var{caller}, @var{opt})
6895
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6459
diff changeset
21 ## Undocumented internal function.
8812
7d48766c21a5 use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
22 ## @end deftypefn
6895
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6459
diff changeset
23
3500
7923abdeb4e5 [project @ 2000-01-31 06:35:00 by jwe]
jwe
parents: 3449
diff changeset
24 ## @deftypefn {Function File} {} __pltopt__ (@var{caller}, @var{opt})
6895
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6459
diff changeset
25 ##
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
26 ## Decode plot option strings.
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
27 ##
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3426
diff changeset
28 ## @var{opt} can currently be some combination of the following:
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
29 ##
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3426
diff changeset
30 ## @table @code
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3426
diff changeset
31 ## @item "-"
6267
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
32 ## For solid linestyle (default).
3717
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
33 ##
6267
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
34 ## @item "--"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
35 ## For dashed line style.
3717
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
36 ##
6267
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
37 ## @item "-."
3717
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
38 ## For linespoints plot style.
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
39 ##
6267
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
40 ## @item ":"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
41 ## For dots plot style.
3717
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
42 ##
6267
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
43 ## @item "r"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
44 ## Red line color.
3717
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
45 ##
6267
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
46 ## @item "g"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
47 ## Green line color.
3717
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
48 ##
6267
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
49 ## @item "b"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
50 ## Blue line color.
3717
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
51 ##
6267
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
52 ## @item "c"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
53 ## Cyan line color.
3717
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
54 ##
6267
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
55 ## @item "m"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
56 ## Magenta line color.
4006
efac4b97bb09 [project @ 2002-07-26 01:20:46 by jwe]
jwe
parents: 3717
diff changeset
57 ##
6267
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
58 ## @item "y"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
59 ## Yellow line color.
3717
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
60 ##
6267
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
61 ## @item "k"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
62 ## Black line color.
3717
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
63 ##
6267
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
64 ## @item "w"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
65 ## White line color.
3717
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
66 ##
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3426
diff changeset
67 ## @item ";title;"
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3426
diff changeset
68 ## Here @code{"title"} is the label for the key.
3717
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
69 ##
6267
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
70 ## @item "+"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
71 ## @itemx "o"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
72 ## @itemx "*"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
73 ## @itemx "."
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
74 ## @itemx "x"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
75 ## @itemx "s"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
76 ## @itemx "d"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
77 ## @itemx "^"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
78 ## @itemx "v"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
79 ## @itemx ">"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
80 ## @itemx "<"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
81 ## @itemx "p"
0078497b3b0b [project @ 2007-02-01 10:34:14 by jwe]
jwe
parents: 6264
diff changeset
82 ## @itemx "h"
3717
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
83 ## Used in combination with the points or linespoints styles, set the point
e3501697c995 [project @ 2000-09-08 06:27:44 by jwe]
jwe
parents: 3500
diff changeset
84 ## style.
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3426
diff changeset
85 ## @end table
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
86 ##
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3426
diff changeset
87 ## The legend may be fixed to include the name of the variable
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3426
diff changeset
88 ## plotted in some future version of Octave.
933
598a3aa40360 [project @ 1994-11-17 04:23:41 by jwe]
jwe
parents:
diff changeset
89
3162
7c96e85c76db [project @ 1998-04-08 18:19:35 by jwe]
jwe
parents: 3101
diff changeset
90 ## Author: jwe
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
91
17462
177147bf7b55 Overhaul use of __pltopt__.m to correctly check for cellstr, not just cell.
Rik <rik@octave.org>
parents: 17338
diff changeset
92 function [options, valid] = __pltopt__ (caller, opt, err_on_invalid = true)
933
598a3aa40360 [project @ 1994-11-17 04:23:41 by jwe]
jwe
parents:
diff changeset
93
17462
177147bf7b55 Overhaul use of __pltopt__.m to correctly check for cellstr, not just cell.
Rik <rik@octave.org>
parents: 17338
diff changeset
94 options = __default_plot_options__ ();
177147bf7b55 Overhaul use of __pltopt__.m to correctly check for cellstr, not just cell.
Rik <rik@octave.org>
parents: 17338
diff changeset
95 valid = true;
177147bf7b55 Overhaul use of __pltopt__.m to correctly check for cellstr, not just cell.
Rik <rik@octave.org>
parents: 17338
diff changeset
96
17176
abf384f5d243 maint: Remove unneeded input validation from internal fcns in private/ directories.
Rik <rik@octave.org>
parents: 15467
diff changeset
97 if (ischar (opt))
17462
177147bf7b55 Overhaul use of __pltopt__.m to correctly check for cellstr, not just cell.
Rik <rik@octave.org>
parents: 17338
diff changeset
98 opt = cellstr (opt);
177147bf7b55 Overhaul use of __pltopt__.m to correctly check for cellstr, not just cell.
Rik <rik@octave.org>
parents: 17338
diff changeset
99 elseif (! iscellstr (opt))
17176
abf384f5d243 maint: Remove unneeded input validation from internal fcns in private/ directories.
Rik <rik@octave.org>
parents: 15467
diff changeset
100 error ("__pltopt__: argument must be a character string or cell array of character strings");
abf384f5d243 maint: Remove unneeded input validation from internal fcns in private/ directories.
Rik <rik@octave.org>
parents: 15467
diff changeset
101 endif
17462
177147bf7b55 Overhaul use of __pltopt__.m to correctly check for cellstr, not just cell.
Rik <rik@octave.org>
parents: 17338
diff changeset
102
177147bf7b55 Overhaul use of __pltopt__.m to correctly check for cellstr, not just cell.
Rik <rik@octave.org>
parents: 17338
diff changeset
103 nel = numel (opt);
177147bf7b55 Overhaul use of __pltopt__.m to correctly check for cellstr, not just cell.
Rik <rik@octave.org>
parents: 17338
diff changeset
104
17176
abf384f5d243 maint: Remove unneeded input validation from internal fcns in private/ directories.
Rik <rik@octave.org>
parents: 15467
diff changeset
105 for i = nel:-1:1
abf384f5d243 maint: Remove unneeded input validation from internal fcns in private/ directories.
Rik <rik@octave.org>
parents: 15467
diff changeset
106 [options(i), valid] = __pltopt1__ (caller, opt{i}, err_on_invalid);
abf384f5d243 maint: Remove unneeded input validation from internal fcns in private/ directories.
Rik <rik@octave.org>
parents: 15467
diff changeset
107 if (! err_on_invalid && ! valid)
abf384f5d243 maint: Remove unneeded input validation from internal fcns in private/ directories.
Rik <rik@octave.org>
parents: 15467
diff changeset
108 return;
6146
1a6d826e92b5 [project @ 2006-11-09 03:13:11 by jwe]
jwe
parents: 6046
diff changeset
109 endif
17176
abf384f5d243 maint: Remove unneeded input validation from internal fcns in private/ directories.
Rik <rik@octave.org>
parents: 15467
diff changeset
110 endfor
933
598a3aa40360 [project @ 1994-11-17 04:23:41 by jwe]
jwe
parents:
diff changeset
111
598a3aa40360 [project @ 1994-11-17 04:23:41 by jwe]
jwe
parents:
diff changeset
112 endfunction
9896
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
113
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
114 ## Really decode plot option strings.
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
115
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
116 ## Author: Rick Niles <niles@axp745.gsfc.nasa.gov>
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
117 ## Adapted-By: jwe
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
118 ## Maintainer: jwe
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
119
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
120 function [options, valid] = __pltopt1__ (caller, opt, err_on_invalid)
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
121
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
122 options = __default_plot_options__ ();
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
123 valid = true;
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
124
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
125 have_linestyle = false;
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
126 have_marker = false;
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
127
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
128 ## If called by __errplot__, extract the linestyle before proceeding.
17462
177147bf7b55 Overhaul use of __pltopt__.m to correctly check for cellstr, not just cell.
Rik <rik@octave.org>
parents: 17338
diff changeset
129 if (strcmp (caller, "__errplot__"))
9896
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
130 if (strncmp (opt, "#~>", 3))
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
131 n = 3;
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
132 elseif (strncmp (opt, "#~", 2) || strncmp (opt, "~>", 2))
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
133 n = 2;
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
134 elseif (strncmp (opt, "~", 1) || strncmp (opt, ">", 1)
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
135 || strncmp (opt, "#", 1))
9896
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
136 n = 1;
10575
3eba2cc7cbda Allow matlab style linestyles in errorbar plots
David Bateman <dbateman@free.fr>
parents: 10549
diff changeset
137 else
3eba2cc7cbda Allow matlab style linestyles in errorbar plots
David Bateman <dbateman@free.fr>
parents: 10549
diff changeset
138 n = 0;
9896
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
139 endif
10580
1479b93ee655 Respect linestyleorder in errorbar plots
David Bateman <dbateman@free.fr>
parents: 10575
diff changeset
140 options.errorstyle = opt(1:n);
10135
4516a0c97ced Handle linestyleorder. Remove @ markers. Treat edgecolor, markeredgecolor and markerfacecolor correctly in scatter.
David Bateman <dbateman@free.fr>
parents: 10121
diff changeset
141 opt(1:n) = [];
10580
1479b93ee655 Respect linestyleorder in errorbar plots
David Bateman <dbateman@free.fr>
parents: 10575
diff changeset
142 else
1479b93ee655 Respect linestyleorder in errorbar plots
David Bateman <dbateman@free.fr>
parents: 10575
diff changeset
143 options.errorstyle = "~";
9896
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
144 endif
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
145
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
146 while (! isempty (opt))
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
147 if (strncmp (opt, "--", 2) || strncmp (opt, "-.", 2))
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
148 options.linestyle = opt(1:2);
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
149 have_linestyle = true;
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
150 n = 2;
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
151 else
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
152 topt = opt(1);
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
153 n = 1;
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
154 if (topt == "-" || topt == ":")
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
155 have_linestyle = true;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
156 options.linestyle = topt;
9896
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
157 elseif (topt == "+" || topt == "o" || topt == "*"
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
158 || topt == "." || topt == "x" || topt == "s"
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
159 || topt == "d" || topt == "^" || topt == "v"
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
160 || topt == ">" || topt == "<" || topt == "p"
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
161 || topt == "h" || topt == "@")
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
162 have_marker = true;
17529
ec5bd610a11f Add support for long form marker styles such as "square", "diamond", etc.
Rik <rik@octave.org>
parents: 17462
diff changeset
163 ## Check for long form marker styles
ec5bd610a11f Add support for long form marker styles such as "square", "diamond", etc.
Rik <rik@octave.org>
parents: 17462
diff changeset
164 if (any (topt == "sdhp"))
ec5bd610a11f Add support for long form marker styles such as "square", "diamond", etc.
Rik <rik@octave.org>
parents: 17462
diff changeset
165 if (strncmp (opt, "square", 6))
ec5bd610a11f Add support for long form marker styles such as "square", "diamond", etc.
Rik <rik@octave.org>
parents: 17462
diff changeset
166 n = 6;
ec5bd610a11f Add support for long form marker styles such as "square", "diamond", etc.
Rik <rik@octave.org>
parents: 17462
diff changeset
167 elseif (strncmp (opt, "diamond", 7))
ec5bd610a11f Add support for long form marker styles such as "square", "diamond", etc.
Rik <rik@octave.org>
parents: 17462
diff changeset
168 n = 7;
ec5bd610a11f Add support for long form marker styles such as "square", "diamond", etc.
Rik <rik@octave.org>
parents: 17462
diff changeset
169 elseif (strncmp (opt, "hexagram", 8))
ec5bd610a11f Add support for long form marker styles such as "square", "diamond", etc.
Rik <rik@octave.org>
parents: 17462
diff changeset
170 n = 8;
ec5bd610a11f Add support for long form marker styles such as "square", "diamond", etc.
Rik <rik@octave.org>
parents: 17462
diff changeset
171 elseif (strncmp (opt, "pentagram", 9))
ec5bd610a11f Add support for long form marker styles such as "square", "diamond", etc.
Rik <rik@octave.org>
parents: 17462
diff changeset
172 n = 9;
ec5bd610a11f Add support for long form marker styles such as "square", "diamond", etc.
Rik <rik@octave.org>
parents: 17462
diff changeset
173 endif
ec5bd610a11f Add support for long form marker styles such as "square", "diamond", etc.
Rik <rik@octave.org>
parents: 17462
diff changeset
174 endif
10135
4516a0c97ced Handle linestyleorder. Remove @ markers. Treat edgecolor, markeredgecolor and markerfacecolor correctly in scatter.
David Bateman <dbateman@free.fr>
parents: 10121
diff changeset
175 ## Backward compatibility. Leave undocumented.
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
176 if (topt == "@")
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
177 topt = "+";
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
178 endif
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
179 options.marker = topt;
17529
ec5bd610a11f Add support for long form marker styles such as "square", "diamond", etc.
Rik <rik@octave.org>
parents: 17462
diff changeset
180 ## Numeric color specs are for backward compatibility. Don't document.
9896
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
181 elseif (topt == "k" || topt == "0")
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
182 options.color = [0, 0, 0];
9896
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
183 elseif (topt == "r" || topt == "1")
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
184 options.color = [1, 0, 0];
9896
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
185 elseif (topt == "g" || topt == "2")
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
186 options.color = [0, 1, 0];
9896
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
187 elseif (topt == "b" || topt == "3")
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
188 options.color = [0, 0, 1];
9896
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
189 elseif (topt == "y")
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
190 options.color = [1, 1, 0];
9896
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
191 elseif (topt == "m" || topt == "4")
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
192 options.color = [1, 0, 1];
9896
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
193 elseif (topt == "c" || topt == "5")
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
194 options.color = [0, 1, 1];
9896
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
195 elseif (topt == "w" || topt == "6")
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
196 options.color = [1, 1, 1];
9896
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
197 elseif (isspace (topt))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
198 ## Do nothing.
9896
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
199 elseif (topt == ";")
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
200 t = index (opt(2:end), ";");
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
201 if (t)
14236
35903f035390 Escaping strings for legend entries are handled by __go_draw_axes__.
Ben Abbott <bpabbott@mac.com>
parents: 14138
diff changeset
202 options.key = opt(2:t);
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
203 n = t+1;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
204 else
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
205 if (err_on_invalid)
9896
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
206 error ("%s: unfinished key label", caller);
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
207 else
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
208 valid = false;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
209 options = __default_plot_options__ ();
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
210 return;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
211 endif
9896
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
212 endif
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
213 else
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
214 if (err_on_invalid)
15466
d174210ce1ec use ' instead of ` in error messages, warnings and most comments
John W. Eaton <jwe@octave.org>
parents: 14138
diff changeset
215 error ("%s: unrecognized format character: '%s'", caller, topt);
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
216 else
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
217 valid = false;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
218 options = __default_plot_options__ ();
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
219 return;
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10135
diff changeset
220 endif
9896
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
221 endif
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
222 endif
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
223 opt(1:n) = [];
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
224 endwhile
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
225
10135
4516a0c97ced Handle linestyleorder. Remove @ markers. Treat edgecolor, markeredgecolor and markerfacecolor correctly in scatter.
David Bateman <dbateman@free.fr>
parents: 10121
diff changeset
226 if (! have_linestyle && have_marker)
9896
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
227 options.linestyle = "none";
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
228 endif
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
229
10135
4516a0c97ced Handle linestyleorder. Remove @ markers. Treat edgecolor, markeredgecolor and markerfacecolor correctly in scatter.
David Bateman <dbateman@free.fr>
parents: 10121
diff changeset
230 if (have_linestyle && ! have_marker)
4516a0c97ced Handle linestyleorder. Remove @ markers. Treat edgecolor, markeredgecolor and markerfacecolor correctly in scatter.
David Bateman <dbateman@free.fr>
parents: 10121
diff changeset
231 options.marker = "none";
4516a0c97ced Handle linestyleorder. Remove @ markers. Treat edgecolor, markeredgecolor and markerfacecolor correctly in scatter.
David Bateman <dbateman@free.fr>
parents: 10121
diff changeset
232 endif
4516a0c97ced Handle linestyleorder. Remove @ markers. Treat edgecolor, markeredgecolor and markerfacecolor correctly in scatter.
David Bateman <dbateman@free.fr>
parents: 10121
diff changeset
233
9896
1aeb39118764 convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
234 endfunction
17338
1c89599167a6 maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents: 17176
diff changeset
235