Ninja
line_printer.h
Go to the documentation of this file.
1 // Copyright 2013 Google Inc. All Rights Reserved.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #ifndef NINJA_LINE_PRINTER_H_
16 #define NINJA_LINE_PRINTER_H_
17 
18 #include <stddef.h>
19 #include <string>
20 using namespace std;
21 
22 /// Prints lines of text, possibly overprinting previously printed lines
23 /// if the terminal supports it.
24 struct LinePrinter {
25  LinePrinter();
26 
27  bool is_smart_terminal() const { return smart_terminal_; }
28  void set_smart_terminal(bool smart) { smart_terminal_ = smart; }
29 
30  enum LineType {
32  ELIDE
33  };
34  /// Overprints the current line. If type is ELIDE, elides to_print to fit on
35  /// one line.
36  void Print(string to_print, LineType type);
37 
38  /// Prints a string on a new line, not overprinting previous output.
39  void PrintOnNewLine(const string& to_print);
40 
41  /// Lock or unlock the console. Any output sent to the LinePrinter while the
42  /// console is locked will not be printed until it is unlocked.
43  void SetConsoleLocked(bool locked);
44 
45  private:
46  /// Whether we can do fancy terminal control codes.
48 
49  /// Whether the caret is at the beginning of a blank line.
51 
52  /// Whether console is locked.
54 
55  /// Buffered current line while console is locked.
56  string line_buffer_;
57 
58  /// Buffered line type while console is locked.
60 
61  /// Buffered console output while console is locked.
63 
64 #ifdef _WIN32
65  void* console_;
66 #endif
67 
68  /// Print the given data to the console, or buffer it if it is locked.
69  void PrintOrBuffer(const char *data, size_t size);
70 };
71 
72 #endif // NINJA_LINE_PRINTER_H_
bool have_blank_line_
Whether the caret is at the beginning of a blank line.
Definition: line_printer.h:50
bool is_smart_terminal() const
Definition: line_printer.h:27
bool console_locked_
Whether console is locked.
Definition: line_printer.h:53
LineType line_type_
Buffered line type while console is locked.
Definition: line_printer.h:59
void set_smart_terminal(bool smart)
Definition: line_printer.h:28
string line_buffer_
Buffered current line while console is locked.
Definition: line_printer.h:56
Prints lines of text, possibly overprinting previously printed lines if the terminal supports it...
Definition: line_printer.h:24
bool smart_terminal_
Whether we can do fancy terminal control codes.
Definition: line_printer.h:47
string output_buffer_
Buffered console output while console is locked.
Definition: line_printer.h:62