octave: libinterp/corefcn/oct-process.h annotate

annotate libinterp/corefcn/oct-process.h @ 29358:0a5b15007766 stable

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2021.

author	John W. Eaton <jwe@octave.org>
date	Wed, 10 Feb 2021 09:52:15 -0500
parents	bd51beb6205e
children	7854d5752dd2

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 #if ! defined (oct_process_h)
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	27 #define oct_process_h 1
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 "octave-config.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 #include <string>
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 namespace octave
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 OCTINTERP_API
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	36 class
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	37 process_execution_result
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	38 {
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	39 public:
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 process_execution_result (void)
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	42 : m_status (-1), m_err_msg (), m_exit_status (-1), m_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 process_execution_result (int status, int exit_status,
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	46 const std::string& stdout_output,
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	47 const std::string& err_msg)
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	48 : m_status (status), m_err_msg (err_msg), m_exit_status (exit_status),
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	49 m_stdout_output (stdout_output)
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 static process_execution_result
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	53 of_success (int exit_status, const std::string& stdout_output);
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 static process_execution_result
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	56 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	57
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	58 int status (void) const { return m_status; }
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	59
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	60 int exit_status (void) const { return m_exit_status; }
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::string err_msg (void) const { return m_err_msg; }
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 std::string stdout_output (void) const { return m_stdout_output; }
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 private:
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 // Launch status of the process, 0 for success, nonzero for error.
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	69 int m_status;
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	70
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	71 // Error message if executing command failed.
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	72 std::string m_err_msg;
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	73
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	74 // Exit status of the process.
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	75 int m_exit_status;
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 // Collected stdout output of the process.
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	78 std::string m_stdout_output;
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	79 };
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 extern OCTINTERP_API process_execution_result
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	82 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	83 }
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	84
c04329ead503 new class for executing commands and getting result Andrew Janke <andrew@apjanke.net> parents: diff changeset	85 #endif

Mercurial > octave

annotate libinterp/corefcn/oct-process.h @ 29358:0a5b15007766 stable