summaryrefslogtreecommitdiff
path: root/source/libs/asura-lib-utils/io/file.h
blob: 56077e005decfe38d87ea3a8e9c203233be56699 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
#ifndef __ASURA_ENGINE_FILE_H__
#define __ASURA_ENGINE_FILE_H__

#include "physfs/physfs.h"

#include "../scripting/portable.hpp"
#include "../threading/thread.h"

#include "file_data.h"

namespace AsuraEngine
{
	namespace IO
	{

		///
		/// ��������ʽ���ļ�������ָ����д��㡢��С��������ʹ������ȡʱʹ�ñ��࣬����ʹ��Filesystem.read()ֱ�Ӷ�ȡ�ļ�ȫ��
		/// ���ݣ�������һ��FileData����
		///
		class File ASURA_FINAL
			: public AEScripting::Portable<File>
		{
		public:

			LUAX_DECL_FACTORY(File);

			///
			/// �ļ���дģʽ
			///
			enum FileMode
			{
				FILE_MODE_CLOSED,
				FILE_MODE_READ,
				FILE_MODE_WRITE,
				FILE_MODE_APPEND,
			};

			///
			/// �ļ�д��ʱ��������Ϊ
			///
			enum BufferMode
			{
				BUFFER_MODE_NONE, ///< ��ʹ�û��壬����д���ļ�
				BUFFER_MODE_LINE, ///< �л��壬�������з����ߴﵽ��������Сʱд���ļ�
				BUFFER_MODE_FULL, ///< ��ȫ���壬��������ʱд���ļ�
			};

			File(const std::string& filename);
			~File();

			bool Open(FileMode mode); 
			bool Close();
			bool IsOpen();
			FileMode GetMode();
			size_t GetSize(); 

			///
			/// ��ȡ��data buffer������ض��������
			///
			size_t Read(ASURA_OUT DataBuffer* dst, size_t length);
			size_t ReadAll(ASURA_OUT DataBuffer* dst);
			size_t ReadAsync(ASURA_OUT DataBuffer* dst);

			///
			/// �Ƿ�������ļ���β
			///
			bool IsEOF();

			///
			/// ��data buffer�е�����д�룬�������Ƿ�ɹ�
			///
			bool Write(ASURA_REF DataBuffer* src);

			///
			/// �첽д�ļ�����д�ļ�task����thread�Ķ��С�
			///
			bool WriteAsync(ASURA_REF DataBuffer* src, AEThreading::Thread* thread);

			///
			/// ��������˻��壬ǿ����ջ�������д���ļ���
			///
			bool Flush();

			///
			/// ���ص�ǰ��дλ��
			///
			size_t Tell();

			///
			/// ������Ӧλ��
			///
			bool Seek(size_t pos);

			///
			/// ���û�������С��ģʽ
			///
			bool SetBuffer(BufferMode mode, size_t size);

			///
			/// ��ȡ��������С��ģʽ
			///
			BufferMode GetBuffer(ASURA_OUT size_t& size);

			const std::string& GetFileName();
			const std::string& GetName();
			const std::string& GetExtension();

		private:

			PHYSFS_File* mFileHandle; ///< physfs �ļ�
			std::string  mFileName;   ///< ���
			std::string  mExtension;  ///< �����������չ��
			std::string  mName;       ///< �����������չ�����ļ���
			FileMode     mMode;       ///< �ļ���ģʽ
			BufferMode   mBufferMode;	///< д�뻺����ģʽ
			size_t       mBufferSize;	///< д�뻺������С

			LUAX_DECL_ENUM(FileMode);
			LUAX_DECL_ENUM(BufferMode);

			LUAX_DECL_METHOD(_New);
			LUAX_DECL_METHOD(_Open);
			LUAX_DECL_METHOD(_Close);
			LUAX_DECL_METHOD(_IsOpen);
			LUAX_DECL_METHOD(_GetMode);
			LUAX_DECL_METHOD(_GetSize);
			LUAX_DECL_METHOD(_Read);
			LUAX_DECL_METHOD(_Write);
			LUAX_DECL_METHOD(_ReadAsync);
			LUAX_DECL_METHOD(_WriteAsync);
			LUAX_DECL_METHOD(_IsEOF);
			LUAX_DECL_METHOD(_Flush);
			LUAX_DECL_METHOD(_Tell);
			LUAX_DECL_METHOD(_Seek);
			LUAX_DECL_METHOD(_SetBuffer);
			LUAX_DECL_METHOD(_GetBuffer);
			LUAX_DECL_METHOD(_GetFileName);
			LUAX_DECL_METHOD(_GetExtension);
			LUAX_DECL_METHOD(_GetName);

		};

	}
}

#endif