xercesc/util/XMLFileMgr.hpp

0001 /*
0002  * Licensed to the Apache Software Foundation (ASF) under one or more
0003  * contributor license agreements.  See the NOTICE file distributed with
0004  * this work for additional information regarding copyright ownership.
0005  * The ASF licenses this file to You under the Apache License, Version 2.0
0006  * (the "License"); you may not use this file except in compliance with
0007  * the License.  You may obtain a copy of the License at
0008  *
0009  *      http://www.apache.org/licenses/LICENSE-2.0
0010  *
0011  * Unless required by applicable law or agreed to in writing, software
0012  * distributed under the License is distributed on an "AS IS" BASIS,
0013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0014  * See the License for the specific language governing permissions and
0015  * limitations under the License.
0016  */
0017
0018 /*
0019  * $Id$
0020  */
0021
0022 #if !defined(XERCESC_INCLUDE_GUARD_XMLFILEMGR_HPP)
0023 #define XERCESC_INCLUDE_GUARD_XMLFILEMGR_HPP
0024
0025 #include <xercesc/util/XercesDefs.hpp>
0026 #include <xercesc/util/XMemory.hpp>
0027
0028 XERCES_CPP_NAMESPACE_BEGIN
0029
0030 typedef void* FileHandle;
0031 #define XERCES_Invalid_File_Handle 0
0032
0033 //  Abstract class for files. This is be used to allow multiple file handling implementations.
0034 class XMLFileMgr : public XMemory
0035 {
0036     public:
0037         XMLFileMgr() {}
0038         virtual ~XMLFileMgr() {}
0039
0040         // File access
0041         virtual FileHandle  fileOpen(const XMLCh* path, bool toWrite, MemoryManager* const manager) = 0;
0042         virtual FileHandle  fileOpen(const char* path, bool toWrite, MemoryManager* const manager) = 0;
0043         virtual FileHandle  openStdIn(MemoryManager* const manager) = 0;
0044
0045         virtual void        fileClose(FileHandle f, MemoryManager* const manager) = 0;
0046         virtual void        fileReset(FileHandle f, MemoryManager* const manager) = 0;
0047
0048         virtual XMLFilePos  curPos(FileHandle f, MemoryManager* const manager) = 0;
0049         virtual XMLFilePos  fileSize(FileHandle f, MemoryManager* const manager) = 0;
0050
0051         virtual XMLSize_t   fileRead(FileHandle f, XMLSize_t byteCount, XMLByte* buffer, MemoryManager* const manager) = 0;
0052         virtual void        fileWrite(FileHandle f, XMLSize_t byteCount, const XMLByte* buffer, MemoryManager* const manager) = 0;
0053
0054         // Ancillary path handling routines
0055         virtual XMLCh*      getFullPath(const XMLCh* const srcPath, MemoryManager* const manager) = 0;
0056         virtual XMLCh*      getCurrentDirectory(MemoryManager* const manager) = 0;
0057         virtual bool        isRelative(const XMLCh* const toCheck, MemoryManager* const manager) = 0;
0058 };
0059
0060 XERCES_CPP_NAMESPACE_END
0061
0062 #endif
0063