1 /*
2  * Copyright (C) 2009 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef ART_RUNTIME_OS_H_
18 #define ART_RUNTIME_OS_H_
19 
20 namespace unix_file {
21 class FdFile;
22 }  // namespace unix_file
23 
24 namespace art {
25 
26 typedef ::unix_file::FdFile File;
27 
28 // Interface to the underlying OS platform.
29 
30 class OS {
31  public:
32   // Open an existing file with read only access.
33   static File* OpenFileForReading(const char* name);
34 
35   // Open an existing file with read/write access.
36   static File* OpenFileReadWrite(const char* name);
37 
38   // Create an empty file with read/write access. This is a *new* file, that is, if the file
39   // already exists, it is *not* overwritten, but unlinked, and a new inode will be used.
40   static File* CreateEmptyFile(const char* name);
41 
42   // Create an empty file with write access. This is a *new* file, that is, if the file
43   // already exists, it is *not* overwritten, but unlinked, and a new inode will be used.
44   static File* CreateEmptyFileWriteOnly(const char* name);
45 
46   // Open a file with the specified open(2) flags.
47   static File* OpenFileWithFlags(const char* name, int flags, bool auto_flush = true);
48 
49   // Check if a file exists.
50   static bool FileExists(const char* name);
51 
52   // Check if a directory exists.
53   static bool DirectoryExists(const char* name);
54 };
55 
56 }  // namespace art
57 
58 #endif  // ART_RUNTIME_OS_H_
59