annotate libinterp/corefcn/oct-process.cc @ 27919:1891570abac8

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.
author John W. Eaton <jwe@octave.org>
date Mon, 06 Jan 2020 22:29:51 -0500
parents b442ec6dda5c
children bd51beb6205e
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
27919
1891570abac8 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27918
diff changeset
3 Copyright (C) 2019-2020 The Octave Project Developers
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 27102
diff changeset
4
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 27102
diff changeset
5 See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 27102
diff changeset
6 or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 27102
diff changeset
7
27002
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
8
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
9 This file is part of Octave.
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
10
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
11 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
12 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
13 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
14 (at your option) any later version.
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
15
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
16 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
17 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
18 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
19 GNU General Public License for more details.
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 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
22 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
23 <https://www.gnu.org/licenses/>.
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
24
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
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
27 #include <iostream>
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
28 #include <sstream>
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
29
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
30 #include "oct-process.h"
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
31 #include "procstream.h"
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
32 #include "sysdep.h"
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
33 #include "oct-syscalls.h"
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
34
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
35 namespace octave
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
36 {
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
37 OCTINTERP_API
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
38 process_execution_result
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
39 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
40 const std::string& stdout_output)
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
41 {
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
42 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
43 }
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 OCTINTERP_API
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
46 process_execution_result
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
47 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
48 {
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
49 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
50 }
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
51
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
52 // 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
53 OCTINTERP_API
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
54 process_execution_result
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
55 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
56 {
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
57 iprocstream cmd (cmd_str.c_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 if (! cmd)
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 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
62
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
63 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
64 }
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 std::ostringstream output_buf;
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 char ch;
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
69
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
70 for (;;)
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.get (ch))
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
73 output_buf.put (ch);
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 {
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
76 if (! cmd.eof () && errno == EAGAIN)
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
77 cmd.clear ();
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
78 else
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
79 break;
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 }
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
82
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
83 int cmd_status = cmd.close ();
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
84
27102
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27002
diff changeset
85 if (sys::wifexited (cmd_status))
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27002
diff changeset
86 cmd_status = sys::wexitstatus (cmd_status);
27002
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
87 else
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
88 cmd_status = 127;
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
89
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
90 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
91 }
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
92 }