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