BinFileInputStream.hpp
Go to the documentation of this file.
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* $Id$
*/
#if !defined(XERCESC_INCLUDE_GUARD_BINFILEINPUTSTREAM_HPP)
#define XERCESC_INCLUDE_GUARD_BINFILEINPUTSTREAM_HPP
#include <xercesc/util/BinInputStream.hpp>
#include <xercesc/util/PlatformUtils.hpp>
XERCES_CPP_NAMESPACE_BEGIN
class XMLUTIL_EXPORT BinFileInputStream : public BinInputStream
{
public :
// -----------------------------------------------------------------------
// Constructors and Destructor
// -----------------------------------------------------------------------
BinFileInputStream
(
const XMLCh* const fileName
, MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
);
BinFileInputStream
(
const char* const fileName
, MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
);
BinFileInputStream
(
const FileHandle toUse
, MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
);
virtual ~BinFileInputStream();
// -----------------------------------------------------------------------
// Getter methods
// -----------------------------------------------------------------------
bool getIsOpen() const;
XMLFilePos getSize() const;
void reset();
// -----------------------------------------------------------------------
// Implementation of the input stream interface
// -----------------------------------------------------------------------
virtual XMLFilePos curPos() const;
virtual XMLSize_t readBytes
(
XMLByte* const toFill
, const XMLSize_t maxToRead
);
virtual const XMLCh* getContentType() const;
private :
// -----------------------------------------------------------------------
// Unimplemented constructors and operators
// -----------------------------------------------------------------------
BinFileInputStream(const BinFileInputStream&);
BinFileInputStream& operator=(const BinFileInputStream&);
// -----------------------------------------------------------------------
// Private data members
//
// fSource
// The source file that we represent. The FileHandle type is defined
// per platform.
// -----------------------------------------------------------------------
FileHandle fSource;
MemoryManager* const fMemoryManager;
};
// ---------------------------------------------------------------------------
// BinFileInputStream: Getter methods
// ---------------------------------------------------------------------------
inline bool BinFileInputStream::getIsOpen() const
{
return (fSource != (FileHandle) XERCES_Invalid_File_Handle);
}
XERCES_CPP_NAMESPACE_END
#endif
BinInputStream.hpp
PlatformUtils.hpp
FileHandle
XERCES_CPP_NAMESPACE_BEGIN typedef void * FileHandle
Definition XMLFileMgr.hpp:30
XERCES_Invalid_File_Handle
#define XERCES_Invalid_File_Handle
Definition XMLFileMgr.hpp:31
XERCES_CPP_NAMESPACE_BEGIN
#define XERCES_CPP_NAMESPACE_BEGIN
Definition XercesDefs.hpp:112
XMLByte
unsigned char XMLByte
Definition XercesDefs.hpp:65
XMLUTIL_EXPORT
#define XMLUTIL_EXPORT
Definition XercesDefs.hpp:162
XERCES_CPP_NAMESPACE_END
#define XERCES_CPP_NAMESPACE_END
Definition XercesDefs.hpp:113
XMLSize_t
size_t XMLSize_t
Definition Xerces_autoconf_config.hpp:112
XMLCh
char16_t XMLCh
Definition Xerces_autoconf_config.hpp:120
XMLFilePos
XMLUInt64 XMLFilePos
Definition Xerces_autoconf_config.hpp:139
BinFileInputStream
Definition BinFileInputStream.hpp:31
BinFileInputStream::readBytes
virtual XMLSize_t readBytes(XMLByte *const toFill, const XMLSize_t maxToRead)
BinFileInputStream::BinFileInputStream
BinFileInputStream(const char *const fileName, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)
BinFileInputStream::getContentType
virtual const XMLCh * getContentType() const
Return the "out-of-band" content type for the data supplied by this input stream in the form of the m...
BinFileInputStream::getIsOpen
bool getIsOpen() const
Definition BinFileInputStream.hpp:100
BinFileInputStream::BinFileInputStream
BinFileInputStream(const FileHandle toUse, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)
BinFileInputStream::BinFileInputStream
BinFileInputStream(const XMLCh *const fileName, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)
BinFileInputStream::curPos
virtual XMLFilePos curPos() const
BinFileInputStream::~BinFileInputStream
virtual ~BinFileInputStream()
BinFileInputStream::reset
void reset()
BinFileInputStream::getSize
XMLFilePos getSize() const
BinInputStream
Definition BinInputStream.hpp:30
MemoryManager
Configurable memory manager.
Definition MemoryManager.hpp:40
XMLPlatformUtils::fgMemoryManager
static MemoryManager * fgMemoryManager
The configurable memory manager.
Definition PlatformUtils.hpp:121