/*

* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description: 

*

*/

/*

 * 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: BinFileInputStream.hpp 568078 2007-08-21 11:43:25Z amassari $

 */

#if !defined(BINFILEINPUTSTREAM_HPP)

#define 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;

    unsigned int getSize() const;

    void reset();

    // -----------------------------------------------------------------------

    //  Implementation of the input stream interface

    // -----------------------------------------------------------------------

    virtual unsigned int curPos() const;

    virtual unsigned int readBytes

    (

                XMLByte* const      toFill

        , const unsigned int        maxToRead

    );

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