Initial copy from dali-adaptor repository
[platform/core/uifw/dali-adaptor-legacy.git] / dali / internal / system / common / shared-file.h
1 #ifndef DALI_INTERNAL_ADAPTOR_SHARED_FILE_H
2 #define DALI_INTERNAL_ADAPTOR_SHARED_FILE_H
3
4 /*
5  * Copyright (c) 2019 Samsung Electronics Co., Ltd.
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  *
19  */
20
21 // EXTERNAL INCLUDES
22 #include <string>
23 #include <sys/types.h>
24
25 namespace Dali
26 {
27 namespace Internal
28 {
29 namespace Adaptor
30 {
31
32 class SharedFile
33 {
34 public:
35   /**
36    * Open an existing shared file for read/write
37    * @return The shared file, or NULL if a file could not be opened and mapped.
38    */
39   static SharedFile* New( const char* filename, int size, bool isSystem );
40
41   /**
42    * Constructor
43    */
44   SharedFile();
45
46   /**
47    * Destructor
48    */
49   virtual ~SharedFile();
50
51   /**
52    * Opens a file descriptor to shared memory segment
53    * @return The file descriptor
54    */
55   int Open( const char* filename, int size, int oflag, mode_t mode );
56
57   /**
58    * Opens a file for read/write
59    * @return true if opened, false on error.
60    */
61   bool OpenFile( const char* filename, int size, bool isSystem );
62
63   /**
64    * Close the shared file
65    */
66   void Close();
67
68   /**
69    * Get the memory address of the shared file
70    * @return the memory address
71    */
72   unsigned char* GetAddress();
73
74 private:
75   int         mFileDescriptor;
76   int         mSize;
77   void*       mAddress;
78   std::string mFilename;
79 };
80
81 } // Adaptor
82 } // Internal
83 } // Dali
84
85 #endif // DALI_INTERNAL_ADAPTOR_SHARED_FILE_H