1// Protocol Buffers - Google's data interchange format
2// Copyright 2008 Google Inc. All rights reserved.
3// https://developers.google.com/protocol-buffers/
4//
5// Redistribution and use in source and binary forms, with or without
6// modification, are permitted provided that the following conditions are
7// met:
8//
9// * Redistributions of source code must retain the above copyright
10// notice, this list of conditions and the following disclaimer.
11// * Redistributions in binary form must reproduce the above
12// copyright notice, this list of conditions and the following disclaimer
13// in the documentation and/or other materials provided with the
14// distribution.
15// * Neither the name of Google Inc. nor the names of its
16// contributors may be used to endorse or promote products derived from
17// this software without specific prior written permission.
18//
19// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30
31// Author: kenton@google.com (Kenton Varda)
32
33#ifndef GOOGLE_PROTOBUF_COMPILER_SUBPROCESS_H__
34#define GOOGLE_PROTOBUF_COMPILER_SUBPROCESS_H__
35
36#ifdef _WIN32
37#ifndef WIN32_LEAN_AND_MEAN
38#define WIN32_LEAN_AND_MEAN // right...
39#endif
40#include <windows.h>
41#else // _WIN32
42#include <sys/types.h>
43#include <unistd.h>
44#endif // !_WIN32
45#include <google/protobuf/stubs/common.h>
46
47#include <string>
48
49// Must be included last.
50#include <google/protobuf/port_def.inc>
51
52namespace google {
53namespace protobuf {
54
55class Message;
56
57namespace compiler {
58
59// Utility class for launching sub-processes.
60class PROTOC_EXPORT Subprocess {
61 public:
62 Subprocess();
63 ~Subprocess();
64
65 enum SearchMode {
66 SEARCH_PATH, // Use PATH environment variable.
67 EXACT_NAME // Program is an exact file name; don't use the PATH.
68 };
69
70 // Start the subprocess. Currently we don't provide a way to specify
71 // arguments as protoc plugins don't have any.
72 void Start(const std::string& program, SearchMode search_mode);
73
74 // Serialize the input message and pipe it to the subprocess's stdin, then
75 // close the pipe. Meanwhile, read from the subprocess's stdout and parse
76 // the data into *output. All this is done carefully to avoid deadlocks.
77 // Returns true if successful. On any sort of error, returns false and sets
78 // *error to a description of the problem.
79 bool Communicate(const Message& input, Message* output, std::string* error);
80
81#ifdef _WIN32
82 // Given an error code, returns a human-readable error message. This is
83 // defined here so that CommandLineInterface can share it.
84 static std::string Win32ErrorMessage(DWORD error_code);
85#endif
86
87 private:
88#ifdef _WIN32
89 DWORD process_start_error_;
90 HANDLE child_handle_;
91
92 // The file handles for our end of the child's pipes. We close each and
93 // set it to NULL when no longer needed.
94 HANDLE child_stdin_;
95 HANDLE child_stdout_;
96
97#else // _WIN32
98 pid_t child_pid_;
99
100 // The file descriptors for our end of the child's pipes. We close each and
101 // set it to -1 when no longer needed.
102 int child_stdin_;
103 int child_stdout_;
104
105#endif // !_WIN32
106};
107
108} // namespace compiler
109} // namespace protobuf
110} // namespace google
111
112#include <google/protobuf/port_undef.inc>
113
114#endif // GOOGLE_PROTOBUF_COMPILER_SUBPROCESS_H__
115