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 // emulates google3/file/base/file.h 33 34 #ifndef GOOGLE_PROTOBUF_TESTING_FILE_H__ 35 #define GOOGLE_PROTOBUF_TESTING_FILE_H__ 36 37 #include <google/protobuf/stubs/common.h> 38 39 namespace google { 40 namespace protobuf { 41 42 const int DEFAULT_FILE_MODE = 0777; 43 44 // Protocol buffer code only uses a couple static methods of File, and only 45 // in tests. 46 class File { 47 public: 48 // Check if the file exists. 49 static bool Exists(const std::string& name); 50 51 // Read an entire file to a string. Return true if successful, false 52 // otherwise. 53 static bool ReadFileToString(const std::string& name, std::string* output, 54 bool text_mode = false); 55 56 // Same as above, but crash on failure. 57 static void ReadFileToStringOrDie(const std::string& name, 58 std::string* output); 59 60 // Create a file and write a string to it. 61 static bool WriteStringToFile(const std::string& contents, 62 const std::string& name); 63 64 // Same as above, but crash on failure. 65 static void WriteStringToFileOrDie(const std::string& contents, 66 const std::string& name); 67 68 // Create a directory. 69 static bool CreateDir(const std::string& name, int mode); 70 71 // Create a directory and all parent directories if necessary. 72 static bool RecursivelyCreateDir(const std::string& path, int mode); 73 74 // If "name" is a file, we delete it. If it is a directory, we 75 // call DeleteRecursively() for each file or directory (other than 76 // dot and double-dot) within it, and then delete the directory itself. 77 // The "dummy" parameters have a meaning in the original version of this 78 // method but they are not used anywhere in protocol buffers. 79 static void DeleteRecursively(const std::string& name, void* dummy1, 80 void* dummy2); 81 82 // Change working directory to given directory. 83 static bool ChangeWorkingDirectory(const std::string& new_working_directory); 84 GetContents(const std::string & name,std::string * output,bool)85 static bool GetContents(const std::string& name, std::string* output, 86 bool /*is_default*/) { 87 return ReadFileToString(name, output); 88 } 89 GetContentsAsText(const std::string & name,std::string * output,bool)90 static bool GetContentsAsText(const std::string& name, std::string* output, 91 bool /*is_default*/) { 92 return ReadFileToString(name, output, true); 93 } 94 SetContents(const std::string & name,const std::string & contents,bool)95 static bool SetContents(const std::string& name, const std::string& contents, 96 bool /*is_default*/) { 97 return WriteStringToFile(contents, name); 98 } 99 100 private: 101 GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(File); 102 }; 103 104 } // namespace protobuf 105 } // namespace google 106 107 #endif // GOOGLE_PROTOBUF_TESTING_FILE_H__ 108