aboutsummaryrefslogtreecommitdiff
path: root/bpkg/help.cxx
blob: 16ef4e886252d829b9635c20bb8c1ff69b846472 (plain)
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
// file      : bpkg/help.cxx -*- C++ -*-
// copyright : Copyright (c) 2014-2015 Code Synthesis Ltd
// license   : MIT; see accompanying LICENSE file

#include <bpkg/help>

#ifndef _WIN32
#  include <unistd.h>    // close(), STDOUT_FILENO
#  include <sys/ioctl.h> // ioctl()
#else
#  ifndef WIN32_LEAN_AND_MEAN
#    define WIN32_LEAN_AND_MEAN
#  endif
#  include <windows.h>   // GetConsoleScreenBufferInfo(), GetStdHandle()
#  include <io.h>        // _close()
#endif

#include <chrono>
#include <thread>    // this_thread::sleep_for()
#include <iostream>

#include <butl/process>
#include <butl/fdstream>

#include <bpkg/types>
#include <bpkg/utility>
#include <bpkg/diagnostics>

#include <bpkg/bpkg-options>

using namespace std;
using namespace butl;

namespace bpkg
{
  struct pager: protected streambuf
  {
    pager (const common_options& co, const string& name)
    {
      bool up (co.pager_specified ()); // User's pager.

      // If we are using the default pager, try to get the terminal width
      // so that we can center the output.
      //
      if (!up)
      {
        size_t col (0);

#ifndef _WIN32
#  ifdef TIOCGWINSZ
        struct winsize w;
        if (ioctl (STDOUT_FILENO, TIOCGWINSZ, &w) == 0)
          col = static_cast<size_t> (w.ws_col);
#  endif
#else
#error  TODO: needs testing
        CONSOLE_SCREEN_BUFFER_INFO w;
        if (GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE), &w))
          col = static_cast<size_t> (w.srWindow.Right - w.srWindow.Left + 1);
#endif
        if (col > 80)
          indent_.assign ((col - 80) / 2, ' ');
      }

      cstrings args;
      string prompt;

      if (up)
      {
        if (co.pager ().empty ())
          return; // No pager should be used.

        args.push_back (co.pager ().c_str ());
      }
      else
      {
        // By default try less.
        //
        prompt = "-Ps" + name + " (press q to quit, h for help)";

        args.push_back ("less");
        args.push_back ("-R");            // Handle ANSI color.
        args.push_back (prompt.c_str ());
      }

      // Add extra pager options.
      //
      for (const string& o: co.pager_option ())
        args.push_back (o.c_str ());

      args.push_back (nullptr);

      if (verb >= 2)
        print_process (args);

      // Ignore errors and go without a pager unless the pager was specified
      // by the user.
      //
      try
      {
        p_ = process (args.data (), -1); // Redirect child's stdin to a pipe.

        // Wait a bit and see if the pager has exited before reading
        // anything (e.g., because exec() couldn't find the program).
        // If you know a cleaner way to handle this, let me know (no,
        // a select()-based approach doesn't work; the pipe is buffered
        // and therefore is always ready for writing).
        //
        this_thread::sleep_for (chrono::milliseconds (50));

        bool r;
        if (p_.try_wait (r))
        {
#ifndef _WIN32
          ::close (p_.out_fd);
#else
          _close (p_.out_fd);
#endif
          if (up)
            fail << "pager " << args[0] << " exited unexpectedly";
        }
        else
          os_.open (p_.out_fd);
      }
      catch (const process_error& e)
      {
        // Ignore unless it was a user-specified pager.
        //
        if (up)
          error << "unable to execute " << args[0] << ": " << e.what ();

        if (e.child ())
          exit (1);

        if (up)
          throw failed ();
      }

      // Setup the indentation machinery.
      //
      if (!indent_.empty ())
        buf_ = stream ().rdbuf (this);
    }

    ostream&
    stream ()
    {
      return os_.is_open () ? os_ : cout;
    }

    bool
    wait ()
    {
      // Teardown the indentation machinery.
      //
      if (buf_ != nullptr)
      {
        stream ().rdbuf (buf_);
        buf_ = nullptr;
      }

      os_.close ();
      return p_.wait ();
    }

    ~pager () {wait ();}

    // streambuf output interface.
    //
  protected:
    using int_type = streambuf::int_type;
    using traits_type = streambuf::traits_type;

    virtual int_type
    overflow (int_type c)
    {
      if (prev_ == '\n' && c != '\n') // Don't indent blanks.
      {
        auto n (static_cast<streamsize> (indent_.size ()));

        if (buf_->sputn (indent_.c_str (), n) != n)
          return traits_type::eof ();
      }

      prev_ = c;
      return buf_->sputc (c);
    }

    virtual int
    sync ()
    {
      return buf_->pubsync ();
    }

  private:
    process p_;
    ofdstream os_;

    string indent_;
    int_type prev_ = '\n'; // Previous character.
    streambuf* buf_ = nullptr;
  };

  int
  help (const help_options& o, const string& t, usage_function* usage)
  {
    if (usage == nullptr) // Not a command.
    {
      if (t.empty ())             // General help.
        usage = &print_bpkg_usage;
      else if (t == "common-options")  // Help topics.
        usage = &print_bpkg_common_options_long_usage;
      else
        fail << "unknown bpkg command/help topic '" << t << "'" <<
          info << "run 'bpkg help' for more information";
    }

    pager p (o, "bpkg " + (t.empty () ? "help" : t));
    usage (p.stream (), cli::usage_para::none);

    // If the pager failed, assume it has issued some diagnostics.
    //
    return p.wait () ? 0 : 1;
  }
}