File: pager.h

package info (click to toggle)
octave 6.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 124,192 kB
  • sloc: cpp: 322,665; ansic: 68,088; fortran: 20,980; objc: 8,121; sh: 7,719; yacc: 4,266; lex: 4,123; perl: 1,530; java: 1,366; awk: 1,257; makefile: 424; xml: 147
file content (317 lines) | stat: -rw-r--r-- 7,009 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 1993-2021 The Octave Project Developers
//
// See the file COPYRIGHT.md in the top-level directory of this
// distribution or <https://octave.org/copyright/>.
//
// This file is part of Octave.
//
// Octave is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Octave is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Octave; see the file COPYING.  If not, see
// <https://www.gnu.org/licenses/>.
//
////////////////////////////////////////////////////////////////////////

#if ! defined (octave_pager_h)
#define octave_pager_h 1

#include "octave-config.h"

#include <fstream>
#include <iosfwd>
#include <sstream>
#include <string>

class octave_value;
class octave_value_list;
class oprocstream;

namespace octave
{
  class interpreter;

  class
  OCTINTERP_API
  pager_buf : public std::stringbuf
  {
  public:

    pager_buf (void) : std::stringbuf (), diary_skip (0) { }

    void flush_current_contents_to_diary (void);

    void set_diary_skip (void);

  protected:

    int sync (void);

  private:

    size_t diary_skip;
  };

  class
  OCTINTERP_API
  pager_stream : public std::ostream
  {
  public:

    pager_stream (void);

    // No copying!

    pager_stream (const pager_stream&) = delete;

    pager_stream& operator = (const pager_stream&) = delete;

    ~pager_stream (void);

    void flush_current_contents_to_diary (void);

    void set_diary_skip (void);

    std::ostream& stream (void);

    void reset (void);

  private:

    pager_buf *pb;
  };

  class
  OCTINTERP_API
  diary_buf : public std::stringbuf
  {
  public:

    diary_buf (void) : std::stringbuf () { }

  protected:

    int sync (void);
  };

  class
  OCTINTERP_API
  diary_stream : public std::ostream
  {
  public:

    diary_stream (void);

    // No copying!

    diary_stream (const diary_stream&) = delete;

    diary_stream& operator = (const diary_stream&) = delete;

    ~diary_stream (void);

    std::ostream& stream (void);

    void reset (void);

  private:

    diary_buf *db;
  };

  extern OCTAVE_API void flush_stdout (void);

  class output_system
  {
  public:

    output_system (interpreter& interp);

    output_system (const output_system&) = delete;

    output_system& operator = (const output_system&) = delete;

    ~output_system (void) = default;

    pager_stream& pager (void) { return m_pager_stream; }

    diary_stream& diary (void) { return m_diary_stream; }

    std::string diary_file_name (void) const { return m_diary_file_name; }

    std::string diary_file_name (const std::string& nm)
    {
      std::string val = m_diary_file_name;
      m_diary_file_name = nm.empty () ? "diary" : nm;
      return val;
    }

    octave_value PAGER (const octave_value_list& args, int nargout);

    std::string PAGER (void) const { return m_PAGER; }

    std::string PAGER (const std::string& s)
    {
      std::string val = m_PAGER;
      m_PAGER = s;
      return val;
    }

    octave_value PAGER_FLAGS (const octave_value_list& args, int nargout);

    std::string PAGER_FLAGS (void) const { return m_PAGER_FLAGS; }

    std::string PAGER_FLAGS (const std::string& s)
    {
      std::string val = m_PAGER_FLAGS;
      m_PAGER_FLAGS = s;
      return val;
    }

    octave_value page_output_immediately (const octave_value_list& args,
                                          int nargout);

    bool page_output_immediately (void) const
    {
      return m_page_output_immediately;
    }

    bool page_output_immediately (bool flag)
    {
      bool val = m_page_output_immediately;
      m_page_output_immediately = flag;
      return val;
    }

    octave_value page_screen_output (const octave_value_list& args,
                                     int nargout);

    bool page_screen_output (void) const { return m_page_screen_output; }

    bool page_screen_output (bool flag)
    {
      bool val = m_page_screen_output;
      m_page_screen_output = flag;
      return val;
    }

    bool write_to_diary_file (void) const
    {
      return m_write_to_diary_file;
    }

    bool write_to_diary_file (bool flag)
    {
      bool val = m_write_to_diary_file;
      m_write_to_diary_file = flag;
      return val;
    }

    bool really_flush_to_pager (void) const
    {
      return m_really_flush_to_pager;
    }

    bool really_flush_to_pager (bool flag)
    {
      bool val = m_really_flush_to_pager;
      m_really_flush_to_pager = flag;
      return val;
    }

    bool flushing_output_to_pager (void) const
    {
      return m_flushing_output_to_pager;
    }

    bool flushing_output_to_pager (bool flag)
    {
      bool val = m_flushing_output_to_pager;
      m_flushing_output_to_pager = flag;
      return val;
    }

    std::string pager_command (void) const;

    std::ofstream& external_diary_file (void) { return m_external_diary_file; }

    void reset (void);

    void flush_stdout (void);

    bool sync (const char *msg, int len);

    void clear_external_pager (void);

    void open_diary (void);

    void close_diary (void);

    std::ostream& __stdout__ (void) { return m_pager_stream.stream (); }

    std::ostream& __diary__ (void) { return m_diary_stream.stream (); }

  private:

    interpreter& m_interpreter;

    pager_stream m_pager_stream;

    diary_stream m_diary_stream;

    // Our actual connection to the external pager.
    oprocstream *m_external_pager = nullptr;

    // The diary file.
    std::ofstream m_external_diary_file;

    // The name of the current diary file.
    std::string m_diary_file_name;

    // The shell command to run as the pager.
    std::string m_PAGER;

    // The options to pass to the pager.
    std::string m_PAGER_FLAGS;

    // TRUE means that if output is going to the pager, it is sent as soon
    // as it is available.  Otherwise, it is buffered and only sent to the
    // pager when it is time to print another prompt.
    bool m_page_output_immediately;

    // TRUE means all output intended for the screen should be passed
    // through the pager.
    bool m_page_screen_output;

    // TRUE means we write to the diary file.
    bool m_write_to_diary_file;

    bool m_really_flush_to_pager;

    bool m_flushing_output_to_pager;

    void start_external_pager (void);

    void do_sync (const char *msg, int len, bool bypass_pager);
  };

  extern std::ostream& __stdout__ (void);

  extern std::ostream& __diary__ (void);
}

#define octave_stdout (octave::__stdout__ ())

#define octave_diary (octave::__diary__ ())

#endif