Mercurial > octave-nkf

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
17571:6e4ea5c8a4bb 17572:7bb76a22cde1
1 ## Copyright (C) 1994-2012 John W. Eaton
2 ##
3 ## This file is part of Octave.
4 ##
5 ## Octave is free software; you can redistribute it and/or modify it
6 ## under the terms of the GNU General Public License as published by
7 ## the Free Software Foundation; either version 3 of the License, or (at
8 ## your option) any later version.
9 ##
10 ## Octave is distributed in the hope that it will be useful, but
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 ## General Public License for more details.
14 ##
15 ## You should have received a copy of the GNU General Public License
16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>.
18
19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} __pltopt__ (@var{caller}, @var{opt})
21 ## Undocumented internal function.
22 ## @end deftypefn
23
24 ## @deftypefn {Function File} {} __pltopt__ (@var{caller}, @var{opt})
25 ##
26 ## Decode plot option strings.
27 ##
28 ## @var{opt} can currently be some combination of the following:
29 ##
30 ## @table @code
31 ## @item "-"
32 ## For solid linestyle (default).
33 ##
34 ## @item "--"
35 ## For dashed line style.
36 ##
37 ## @item "-."
38 ## For linespoints plot style.
39 ##
40 ## @item ":"
41 ## For dots plot style.
42 ##
43 ## @item "r"
44 ## Red line color.
45 ##
46 ## @item "g"
47 ## Green line color.
48 ##
49 ## @item "b"
50 ## Blue line color.
51 ##
52 ## @item "c"
53 ## Cyan line color.
54 ##
55 ## @item "m"
56 ## Magenta line color.
57 ##
58 ## @item "y"
59 ## Yellow line color.
60 ##
61 ## @item "k"
62 ## Black line color.
63 ##
64 ## @item "w"
65 ## White line color.
66 ##
67 ## @item ";title;"
68 ## Here @code{"title"} is the label for the key.
69 ##
70 ## @item "+"
71 ## @itemx "o"
72 ## @itemx "*"
73 ## @itemx "."
74 ## @itemx "x"
75 ## @itemx "s"
76 ## @itemx "d"
77 ## @itemx "^"
78 ## @itemx "v"
79 ## @itemx ">"
80 ## @itemx "<"
81 ## @itemx "p"
82 ## @itemx "h"
83 ## Used in combination with the points or linespoints styles, set the point
84 ## style.
85 ## @end table
86 ##
87 ## The legend may be fixed to include the name of the variable
88 ## plotted in some future version of Octave.
89
90 ## Author: jwe
91
92 function [options, valid] = __pltopt__ (caller, opt, err_on_invalid = true)
93
94 options = __default_plot_options__ ();
95 valid = true;
96
97 if (ischar (opt))
98 opt = cellstr (opt);
99 elseif (! iscellstr (opt))
100 error ("__pltopt__: argument must be a character string or cell array of character strings");
101 endif
102
103 nel = numel (opt);
104
105 for i = nel:-1:1
106 [options(i), valid] = __pltopt1__ (caller, opt{i}, err_on_invalid);
107 if (! err_on_invalid && ! valid)
108 return;
109 endif
110 endfor
111
112 endfunction
113
114 ## Really decode plot option strings.
115
116 ## Author: Rick Niles <niles@axp745.gsfc.nasa.gov>
117 ## Adapted-By: jwe
118 ## Maintainer: jwe
119
120 function [options, valid] = __pltopt1__ (caller, opt, err_on_invalid)
121
122 options = __default_plot_options__ ();
123 valid = true;
124
125 have_linestyle = false;
126 have_marker = false;
127
128 ## If called by __errplot__, extract the linestyle before proceeding.
129 if (strcmp (caller, "__errplot__"))
130 if (strncmp (opt, "#~>", 3))
131 n = 3;
132 elseif (strncmp (opt, "#~", 2) || strncmp (opt, "~>", 2))
133 n = 2;
134 elseif (strncmp (opt, "~", 1) || strncmp (opt, ">", 1)
135 || strncmp (opt, "#", 1))
136 n = 1;
137 else
138 n = 0;
139 endif
140 options.errorstyle = opt(1:n);
141 opt(1:n) = [];
142 else
143 options.errorstyle = "~";
144 endif
145
146 while (! isempty (opt))
147 if (strncmp (opt, "--", 2) || strncmp (opt, "-.", 2))
148 options.linestyle = opt(1:2);
149 have_linestyle = true;
150 n = 2;
151 else
152 topt = opt(1);
153 n = 1;
154 if (topt == "-" || topt == ":")
155 have_linestyle = true;
156 options.linestyle = topt;
157 elseif (topt == "+" || topt == "o" || topt == "*"
158 || topt == "." || topt == "x" || topt == "s"
159 || topt == "d" || topt == "^" || topt == "v"
160 || topt == ">" || topt == "<" || topt == "p"
161 || topt == "h" || topt == "@")
162 have_marker = true;
163 ## Check for long form marker styles
164 if (any (topt == "sdhp"))
165 if (strncmp (opt, "square", 6))
166 n = 6;
167 elseif (strncmp (opt, "diamond", 7))
168 n = 7;
169 elseif (strncmp (opt, "hexagram", 8))
170 n = 8;
171 elseif (strncmp (opt, "pentagram", 9))
172 n = 9;
173 endif
174 endif
175 ## Backward compatibility. Leave undocumented.
176 if (topt == "@")
177 topt = "+";
178 endif
179 options.marker = topt;
180 ## Numeric color specs are for backward compatibility. Don't document.
181 elseif (topt == "k" || topt == "0")
182 options.color = [0, 0, 0];
183 elseif (topt == "r" || topt == "1")
184 options.color = [1, 0, 0];
185 elseif (topt == "g" || topt == "2")
186 options.color = [0, 1, 0];
187 elseif (topt == "b" || topt == "3")
188 options.color = [0, 0, 1];
189 elseif (topt == "y")
190 options.color = [1, 1, 0];
191 elseif (topt == "m" || topt == "4")
192 options.color = [1, 0, 1];
193 elseif (topt == "c" || topt == "5")
194 options.color = [0, 1, 1];
195 elseif (topt == "w" || topt == "6")
196 options.color = [1, 1, 1];
197 elseif (isspace (topt))
198 ## Do nothing.
199 elseif (topt == ";")
200 t = index (opt(2:end), ";");
201 if (t)
202 options.key = opt(2:t);
203 n = t+1;
204 else
205 if (err_on_invalid)
206 error ("%s: unfinished key label", caller);
207 else
208 valid = false;
209 options = __default_plot_options__ ();
210 return;
211 endif
212 endif
213 else
214 if (err_on_invalid)
215 error ("%s: unrecognized format character: '%s'", caller, topt);
216 else
217 valid = false;
218 options = __default_plot_options__ ();
219 return;
220 endif
221 endif
222 endif
223 opt(1:n) = [];
224 endwhile
225
226 if (! have_linestyle && have_marker)
227 options.linestyle = "none";
228 endif
229
230 if (have_linestyle && ! have_marker)
231 options.marker = "none";
232 endif
233
234 endfunction
235