xref: /aosp_15_r20/frameworks/av/drm/common/include/ReadWriteUtils.h (revision ec779b8e0859a360c3d303172224686826e6e0e1)
1*ec779b8eSAndroid Build Coastguard Worker /*
2*ec779b8eSAndroid Build Coastguard Worker  * Copyright (C) 2010 The Android Open Source Project
3*ec779b8eSAndroid Build Coastguard Worker  *
4*ec779b8eSAndroid Build Coastguard Worker  * Licensed under the Apache License, Version 2.0 (the "License");
5*ec779b8eSAndroid Build Coastguard Worker  * you may not use this file except in compliance with the License.
6*ec779b8eSAndroid Build Coastguard Worker  * You may obtain a copy of the License at
7*ec779b8eSAndroid Build Coastguard Worker  *
8*ec779b8eSAndroid Build Coastguard Worker  *      http://www.apache.org/licenses/LICENSE-2.0
9*ec779b8eSAndroid Build Coastguard Worker  *
10*ec779b8eSAndroid Build Coastguard Worker  * Unless required by applicable law or agreed to in writing, software
11*ec779b8eSAndroid Build Coastguard Worker  * distributed under the License is distributed on an "AS IS" BASIS,
12*ec779b8eSAndroid Build Coastguard Worker  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*ec779b8eSAndroid Build Coastguard Worker  * See the License for the specific language governing permissions and
14*ec779b8eSAndroid Build Coastguard Worker  * limitations under the License.
15*ec779b8eSAndroid Build Coastguard Worker  */
16*ec779b8eSAndroid Build Coastguard Worker 
17*ec779b8eSAndroid Build Coastguard Worker #ifndef __READ_WRITE_UTILS_H__
18*ec779b8eSAndroid Build Coastguard Worker #define __READ_WRITE_UTILS_H__
19*ec779b8eSAndroid Build Coastguard Worker 
20*ec779b8eSAndroid Build Coastguard Worker #include <utils/FileMap.h>
21*ec779b8eSAndroid Build Coastguard Worker #include <drm/drm_framework_common.h>
22*ec779b8eSAndroid Build Coastguard Worker 
23*ec779b8eSAndroid Build Coastguard Worker namespace android {
24*ec779b8eSAndroid Build Coastguard Worker 
25*ec779b8eSAndroid Build Coastguard Worker /**
26*ec779b8eSAndroid Build Coastguard Worker  * This is an utility class which performs IO operations.
27*ec779b8eSAndroid Build Coastguard Worker  *
28*ec779b8eSAndroid Build Coastguard Worker  */
29*ec779b8eSAndroid Build Coastguard Worker class ReadWriteUtils {
30*ec779b8eSAndroid Build Coastguard Worker public:
31*ec779b8eSAndroid Build Coastguard Worker     /**
32*ec779b8eSAndroid Build Coastguard Worker      * Constructor for ReadWriteUtils
33*ec779b8eSAndroid Build Coastguard Worker      */
ReadWriteUtils()34*ec779b8eSAndroid Build Coastguard Worker     ReadWriteUtils() {}
35*ec779b8eSAndroid Build Coastguard Worker 
36*ec779b8eSAndroid Build Coastguard Worker     /**
37*ec779b8eSAndroid Build Coastguard Worker      * Destructor for ReadWriteUtils
38*ec779b8eSAndroid Build Coastguard Worker      */
39*ec779b8eSAndroid Build Coastguard Worker     virtual ~ReadWriteUtils();
40*ec779b8eSAndroid Build Coastguard Worker 
41*ec779b8eSAndroid Build Coastguard Worker public:
42*ec779b8eSAndroid Build Coastguard Worker     /**
43*ec779b8eSAndroid Build Coastguard Worker      * Reads the data from the file path provided
44*ec779b8eSAndroid Build Coastguard Worker      *
45*ec779b8eSAndroid Build Coastguard Worker      * @param[in] filePath Path of the file
46*ec779b8eSAndroid Build Coastguard Worker      * @return Data read from the file
47*ec779b8eSAndroid Build Coastguard Worker      */
48*ec779b8eSAndroid Build Coastguard Worker     static String8 readBytes(const String8& filePath);
49*ec779b8eSAndroid Build Coastguard Worker     /**
50*ec779b8eSAndroid Build Coastguard Worker      * Reads the data into the given buffer from the file path provided
51*ec779b8eSAndroid Build Coastguard Worker      *
52*ec779b8eSAndroid Build Coastguard Worker      * @param[in] filePath Path of the file
53*ec779b8eSAndroid Build Coastguard Worker      * @param[out] buffer Data read from the file
54*ec779b8eSAndroid Build Coastguard Worker      * @return Length of the data read from the file
55*ec779b8eSAndroid Build Coastguard Worker      */
56*ec779b8eSAndroid Build Coastguard Worker     static int readBytes(const String8& filePath, char** buffer);
57*ec779b8eSAndroid Build Coastguard Worker     /**
58*ec779b8eSAndroid Build Coastguard Worker      * Writes the data into the file path provided
59*ec779b8eSAndroid Build Coastguard Worker      *
60*ec779b8eSAndroid Build Coastguard Worker      * @param[in] filePath Path of the file
61*ec779b8eSAndroid Build Coastguard Worker      * @param[in] dataBuffer Data to write
62*ec779b8eSAndroid Build Coastguard Worker      */
63*ec779b8eSAndroid Build Coastguard Worker     static void writeToFile(const String8& filePath, const String8& data);
64*ec779b8eSAndroid Build Coastguard Worker     /**
65*ec779b8eSAndroid Build Coastguard Worker      * Appends the data into the file path provided
66*ec779b8eSAndroid Build Coastguard Worker      *
67*ec779b8eSAndroid Build Coastguard Worker      * @param[in] filePath Path of the file
68*ec779b8eSAndroid Build Coastguard Worker      * @param[in] dataBuffer Data to append
69*ec779b8eSAndroid Build Coastguard Worker      */
70*ec779b8eSAndroid Build Coastguard Worker     static void appendToFile(const String8& filePath, const String8& data);
71*ec779b8eSAndroid Build Coastguard Worker 
72*ec779b8eSAndroid Build Coastguard Worker private:
73*ec779b8eSAndroid Build Coastguard Worker     FileMap* mFileMap;
74*ec779b8eSAndroid Build Coastguard Worker };
75*ec779b8eSAndroid Build Coastguard Worker 
76*ec779b8eSAndroid Build Coastguard Worker };
77*ec779b8eSAndroid Build Coastguard Worker 
78*ec779b8eSAndroid Build Coastguard Worker #endif /* __READ_WRITE_UTILS_H__ */
79*ec779b8eSAndroid Build Coastguard Worker 
80