annotate libinterp/corefcn/oct-procbuf.h @ 33617:ec2635a02328 bytecode-interpreter tip

maint: Merge default to bytecode-interpreter.
author Markus Mützel <markus.muetzel@gmx.de>
date Tue, 21 May 2024 18:29:03 +0200
parents 4b601ca024d5
children
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 //
32632
2e484f9f1f18 maint: update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 31837
diff changeset
3 // Copyright (C) 1996-2024 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 ////////////////////////////////////////////////////////////////////////
2094
a23645b0364e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents:
diff changeset
25
a23645b0364e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents:
diff changeset
26 // This class is based on the procbuf class from libg++, written by
a23645b0364e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents:
diff changeset
27 // Per Bothner, Copyright (C) 1993 Free Software Foundation.
a23645b0364e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents:
diff changeset
28
20791
f7084eae3318 maint: Use Octave coding conventions for #if statements.
Rik <rik@octave.org>
parents: 19697
diff changeset
29 #if ! defined (octave_oct_procbuf_h)
17822
ebb3ef964372 maint: Use common #define syntax "octave_filename_h" in h_files.
Rik <rik@octave.org>
parents: 17744
diff changeset
30 #define octave_oct_procbuf_h 1
2094
a23645b0364e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents:
diff changeset
31
21244
1473547f50f5 include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents: 20791
diff changeset
32 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files
John W. Eaton <jwe@octave.org>
parents: 20791
diff changeset
33
2094
a23645b0364e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents:
diff changeset
34 #include <sys/types.h>
a23645b0364e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents:
diff changeset
35
3631
0b6b55fd0a5c [project @ 2000-03-23 09:16:36 by jwe]
jwe
parents: 3560
diff changeset
36 #include "c-file-ptr-stream.h"
0b6b55fd0a5c [project @ 2000-03-23 09:16:36 by jwe]
jwe
parents: 3560
diff changeset
37
31605
e88a07dec498 maint: Use macros to begin/end C++ namespaces.
Rik <rik@octave.org>
parents: 30564
diff changeset
38 OCTAVE_BEGIN_NAMESPACE(octave)
29991
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
39
32628
ae4e19c0a2b1 maint: Place class name and class keyword on one line.
Rik <rik@octave.org>
parents: 31837
diff changeset
40 class procbuf : public c_file_ptr_buf
2094
a23645b0364e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents:
diff changeset
41 {
a23645b0364e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents:
diff changeset
42 public:
a23645b0364e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents:
diff changeset
43
31771
21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations.
Rik <rik@octave.org>
parents: 31707
diff changeset
44 procbuf ()
30124
041dbcd1f93b maint: use "m_" prefix for member variables in class procbuf.
Rik <rik@octave.org>
parents: 29991
diff changeset
45 : c_file_ptr_buf (nullptr), m_wstatus (-1), m_open_p (false),
041dbcd1f93b maint: use "m_" prefix for member variables in class procbuf.
Rik <rik@octave.org>
parents: 29991
diff changeset
46 m_proc_pid (-1), m_next (nullptr)
041dbcd1f93b maint: use "m_" prefix for member variables in class procbuf.
Rik <rik@octave.org>
parents: 29991
diff changeset
47 { }
2094
a23645b0364e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents:
diff changeset
48
29991
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
49 procbuf (const char *command, int mode)
30124
041dbcd1f93b maint: use "m_" prefix for member variables in class procbuf.
Rik <rik@octave.org>
parents: 29991
diff changeset
50 : c_file_ptr_buf (nullptr), m_wstatus (-1), m_open_p (false),
041dbcd1f93b maint: use "m_" prefix for member variables in class procbuf.
Rik <rik@octave.org>
parents: 29991
diff changeset
51 m_proc_pid (-1), m_next (nullptr)
041dbcd1f93b maint: use "m_" prefix for member variables in class procbuf.
Rik <rik@octave.org>
parents: 29991
diff changeset
52 { open (command, mode); }
2094
a23645b0364e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents:
diff changeset
53
31837
febd82d1a8de use new macros to consistently delete copy and move member functions
John W. Eaton <jwe@octave.org>
parents: 31771
diff changeset
54 OCTAVE_DISABLE_COPY_MOVE (procbuf)
22869
f75d289645ec make deleted functions public
John W. Eaton <jwe@octave.org>
parents: 22865
diff changeset
55
31771
21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations.
Rik <rik@octave.org>
parents: 31707
diff changeset
56 ~procbuf () { close (); }
2094
a23645b0364e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents:
diff changeset
57
29991
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
58 procbuf * open (const char *command, int mode);
2094
a23645b0364e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents:
diff changeset
59
31771
21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations.
Rik <rik@octave.org>
parents: 31707
diff changeset
60 procbuf * close ();
2094
a23645b0364e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents:
diff changeset
61
31771
21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations.
Rik <rik@octave.org>
parents: 31707
diff changeset
62 int wait_status () const { return m_wstatus; }
3189
bef7b73c0724 [project @ 1998-10-16 18:05:26 by jwe]
jwe
parents: 3174
diff changeset
63
31771
21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations.
Rik <rik@octave.org>
parents: 31707
diff changeset
64 bool is_open () const { return m_open_p; }
3631
0b6b55fd0a5c [project @ 2000-03-23 09:16:36 by jwe]
jwe
parents: 3560
diff changeset
65
31771
21f9b34eb893 maint: Eliminate "(void)" in C++ function prototypes/declarations.
Rik <rik@octave.org>
parents: 31707
diff changeset
66 pid_t pid () const { return m_proc_pid; }
2094
a23645b0364e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents:
diff changeset
67
a23645b0364e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents:
diff changeset
68 protected:
a23645b0364e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents:
diff changeset
69
30124
041dbcd1f93b maint: use "m_" prefix for member variables in class procbuf.
Rik <rik@octave.org>
parents: 29991
diff changeset
70 int m_wstatus;
3189
bef7b73c0724 [project @ 1998-10-16 18:05:26 by jwe]
jwe
parents: 3174
diff changeset
71
30124
041dbcd1f93b maint: use "m_" prefix for member variables in class procbuf.
Rik <rik@octave.org>
parents: 29991
diff changeset
72 bool m_open_p;
3631
0b6b55fd0a5c [project @ 2000-03-23 09:16:36 by jwe]
jwe
parents: 3560
diff changeset
73
30124
041dbcd1f93b maint: use "m_" prefix for member variables in class procbuf.
Rik <rik@octave.org>
parents: 29991
diff changeset
74 pid_t m_proc_pid;
2094
a23645b0364e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents:
diff changeset
75
30124
041dbcd1f93b maint: use "m_" prefix for member variables in class procbuf.
Rik <rik@octave.org>
parents: 29991
diff changeset
76 procbuf *m_next;
2094
a23645b0364e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents:
diff changeset
77 };
a23645b0364e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents:
diff changeset
78
31605
e88a07dec498 maint: Use macros to begin/end C++ namespaces.
Rik <rik@octave.org>
parents: 30564
diff changeset
79 OCTAVE_END_NAMESPACE(octave)
29991
3988112c7116 move i/o stream classes inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29358
diff changeset
80
2094
a23645b0364e [project @ 1996-04-28 09:00:07 by jwe]
jwe
parents:
diff changeset
81 #endif