annotate libinterp/corefcn/oct-process.cc @ 29359:7854d5752dd2

maint: merge stable to default.
author John W. Eaton <jwe@octave.org>
date Wed, 10 Feb 2021 10:10:40 -0500
parents 665c9ed14c97 0a5b15007766
children 796f54d4ddbf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
2 //
29358
0a5b15007766 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27923
diff changeset
3 // Copyright (C) 2019-2021 The Octave Project Developers
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
4 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
7 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
9 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
14 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
19 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
23 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
24 ////////////////////////////////////////////////////////////////////////
27002
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 <iostream>
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
27 #include <sstream>
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
28
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
29 #include "oct-process.h"
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
30 #include "procstream.h"
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
31 #include "sysdep.h"
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
32 #include "oct-syscalls.h"
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
33
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
34 namespace octave
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
35 {
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
36 process_execution_result
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
37 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
38 const std::string& 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 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
41 }
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
42
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
43 process_execution_result
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
44 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
45 {
c04329ead503 new class for executing commands and getting result
Andrew Janke <andrew@apjanke.net>
parents:
diff changeset
46 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
47 }
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 // 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
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
27102
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 27002
diff changeset
81 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
82 cmd_status = sys::wexitstatus (cmd_status);
27002
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 }