annotate scripts/plot/__gnuplot_ginput__.m @ 7673:e0c930dda642

ginput: new function
author David Bateman <dbateman@free.fr>
date Mon, 31 Mar 2008 16:30:29 -0400
parents
children 52d8d50e74c1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7673
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
1 ## Copyright (C) 2004, 2006, 2008 Petr Mikulik
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
2 ##
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
3 ## This file is part of Octave.
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
4 ##
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
8 ## your option) any later version.
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
9 ##
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
13 ## General Public License for more details.
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
14 ##
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
18
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
19 ## This is ginput.m implementation for gnuplot and X11.
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
20 ## It requires gnuplot 4.1 and later.
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
21
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
22 ## This file initially bore the copyright statement
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
23 ## Petr Mikulik
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
24 ## History: June 2006; August 2005; June 2004; April 2004
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
25 ## License: public domain
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
26
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
27 ## -*- texinfo -*-
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
28 ## @deftypefn {Function File} {[@var{x}, @var{y}, @var{buttons}] =} __gnuplot_ginput__ (@var{f}, @var{n})
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
29 ## Undocumented internal function.
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
30 ## @end deftypefn
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
31
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
32 function [x, y, button] = __gnuplot_ginput__ (f, n)
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
33
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
34 stream = get (f, "__plot_stream__");
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
35
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
36 if (compare_versions (__gnuplot_version__ (), "4.0", "<="))
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
37 error ("ginput: version %s of gnuplot not supported", gnuplot_version ());
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
38 endif
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
39
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
40 if (nargin == 0)
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
41 x = zeros (n, 1);
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
42 y = zeros (n, 1);
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
43 button = zeros (n, 1);
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
44 else
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
45 x = zeros (n, 1);
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
46 y = zeros (n, 1);
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
47 button = zeros (n, 1);
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
48 endif
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
49
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
50 gpin_name = tmpnam ();
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
51
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
52 ## 6*8*8 == 0600
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
53 [err, msg] = mkfifo (gpin_name, 6*8*8);
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
54 if (err != 0)
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
55 error ("ginput: Can not open fifo (%s)", msg);
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
56 endif
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
57
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
58 unwind_protect
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
59
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
60 k = 0;
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
61 while (true)
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
62 k++;
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
63 fprintf (stream, "set print \"%s\";\n", gpin_name);
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
64 fflush (stream);
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
65 gpin = fopen (gpin_name, "r");
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
66 fputs (stream, "pause mouse any;\n\n");
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
67
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
68 ## Notes: MOUSE_* can be undefined if user closes gnuplot by "q"
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
69 ## or Alt-F4. Further, this abrupt close also requires the leading
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
70 ## "\n" on the next line.
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
71 fputs (stream, "\nif (exists(\"MOUSE_KEY\") && exists(\"MOUSE_X\")) print MOUSE_X, MOUSE_Y, MOUSE_KEY; else print \"0 0 -1\"\n");
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
72
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
73 ## Close output file, otherwise all blocks (why?!).
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
74 fputs (stream, "set print;\n");
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
75 fflush (stream);
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
76
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
77 ## Now read from fifo.
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
78 [x(k), y(k), button(k), count] = fscanf (gpin, "%f %f %d", "C");
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
79 fclose (gpin);
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
80
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
81 if ([x(k), y(k), button(k)] == [0, 0, -1])
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
82 ## Mousing not active (no plot yet).
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
83 break;
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
84 endif
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
85
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
86 if (nargin > 0)
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
87 ## Input argument n was given => stop when k == n.
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
88 if (k == n)
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
89 break;
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
90 endif
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
91 else
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
92 ## Input argument n not given => stop when hitting a return key.
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
93 ## if (button(k) == 0x0D || button(k) == 0x0A)
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
94 ## ## hit Return or Enter
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
95 if (button(k) == 0x0D)
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
96 ## hit Return
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
97 x(k:end) = [];
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
98 y(k:end) = [];
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
99 button(k:end) = [];
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
100 break;
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
101 endif
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
102 endif
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
103 endwhile
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
104
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
105 unwind_protect_cleanup
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
106 unlink (gpin_name);
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
107 end_unwind_protect
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
108
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
109 endfunction
e0c930dda642 ginput: new function
David Bateman <dbateman@free.fr>
parents:
diff changeset
110