File: cmStdIoConsole.h

package info (click to toggle)
cmake 4.1.2-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 147,412 kB
  • sloc: ansic: 403,924; cpp: 290,826; sh: 4,091; python: 3,357; yacc: 3,106; lex: 1,189; f90: 532; asm: 471; lisp: 375; cs: 270; java: 266; fortran: 230; perl: 217; objc: 215; xml: 198; makefile: 98; javascript: 83; pascal: 63; tcl: 55; php: 25; ruby: 22
file content (49 lines) | stat: -rw-r--r-- 1,394 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
/* Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
   file LICENSE.rst or https://cmake.org/licensing for details.  */
#pragma once

#include "cmConfigure.h" // IWYU pragma: keep

#include "cmStdIoInit.h"

#ifdef _WIN32
#  include <memory>
#endif

namespace cm {
namespace StdIo {

/**
 * On Windows, enables I/O with `cin`, `cout`, and `cerr` in UTF-8 encoding.
 * On non-Windows platforms, does nothing.
 *
 * Construct an instance of this at the beginning of `main`:
 *
 * * If `cin`, `cout`, or `cerr` is attached to a Windows Console whose
 *   input/output code page is not UTF-8, this replaces its `streambuf`
 *   with one that reads/writes from/to the console using wide-character
 *   Windows APIs to avoid limitations of the code page's narrow encoding.
 *
 * * If `cin`, `cout`, or `cerr` is not attached to a Windows Console,
 *   this sets its stream to binary mode for consistency with the case
 *   that it's attached to a console.
 *
 * Destroy the instance of this to restore the original `streambuf`s.
 */
class Console : private Init
{
#ifdef _WIN32
  class Impl;
  std::unique_ptr<Impl> Impl_;
#endif
public:
  Console();
  ~Console(); // NOLINT(performance-trivially-destructible)
  Console(Console&&) noexcept;
  Console(Console const&) = delete;
  Console& operator=(Console&&) noexcept;
  Console& operator=(Console const&) = delete;
};

}
}