annotate libinterp/corefcn/oct-process.cc @ 27002:c04329ead503

new class for executing commands and getting result * oct-process.h, oct-process.cc: New files. * libinterp/corefcn/module.mk: Update.
author Andrew Janke <andrew@apjanke.net>
date Fri, 11 Jan 2019 21:24:26 -0500
parents
children 84ff9953faa1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27002
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
1 /*
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
2
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
3 Copyright (C) 2019 Andrew Janke
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
4
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
5 This file is part of Octave.
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
6
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
7 Octave is free software: you can redistribute it and/or modify it
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
8 under the terms of the GNU General Public License as published by
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
9 the Free Software Foundation, either version 3 of the License, or
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
10 (at your option) any later version.
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
11
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
13 WITHOUT ANY WARRANTY; without even the implied warranty of
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
15 GNU General Public License for more details.
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
16
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, see
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
19 <https://www.gnu.org/licenses/>.
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
20
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
21 */
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
22
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
23 #include <iostream>
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
24 #include <sstream>
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
25
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
26 #include "oct-process.h"
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
27 #include "procstream.h"
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
28 #include "sysdep.h"
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
29 #include "oct-syscalls.h"
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
30
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
31 namespace octave
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
32 {
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
33 OCTINTERP_API
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
34 process_execution_result
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
35 process_execution_result::of_success (int exit_status,
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
36 const std::string& stdout_output)
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
37 {
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
38 return process_execution_result (0, exit_status, stdout_output, "");
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
39 }
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
40
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
41 OCTINTERP_API
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
42 process_execution_result
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
43 process_execution_result::of_error (int status, const std::string& err_msg)
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
44 {
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
45 return process_execution_result (status, -1, "", err_msg);
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
46 }
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
47
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
48 // Execute a shell command, returning results as a C++ object
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
49 OCTINTERP_API
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
50 process_execution_result
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
51 run_command_and_return_output (const std::string& cmd_str)
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
52 {
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
53 iprocstream cmd (cmd_str.c_str ());
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
54
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
55 if (! cmd)
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
56 {
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
57 std::string msg = "unable to start subprocess for '" + cmd_str + "'";
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
58
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
59 return process_execution_result::of_error (-1, msg);
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
60 }
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
61
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
62 std::ostringstream output_buf;
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
63
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
64 char ch;
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
65
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
66 for (;;)
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
67 {
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
68 if (cmd.get (ch))
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
69 output_buf.put (ch);
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
70 else
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
71 {
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
72 if (! cmd.eof () && errno == EAGAIN)
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
73 cmd.clear ();
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
74 else
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
75 break;
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
76 }
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
77 }
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
78
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
79 int cmd_status = cmd.close ();
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
80
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
81 if (octave::sys::wifexited (cmd_status))
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
82 cmd_status = octave::sys::wexitstatus (cmd_status);
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
83 else
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
84 cmd_status = 127;
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
85
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
86 return process_execution_result::of_success (cmd_status, output_buf.str ());
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
87 }
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
88 }