| /* |
| * 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_WRAPPER4INPUTSOURCE_HPP) |
| #define XERCESC_INCLUDE_GUARD_WRAPPER4INPUTSOURCE_HPP |
| |
| #include <xercesc/dom/DOMLSInput.hpp> |
| #include <xercesc/util/PlatformUtils.hpp> |
| |
| namespace XERCES_CPP_NAMESPACE { |
| |
| class InputSource; |
| |
| |
| /** |
| * Wrap a SAX InputSource object and make it behave like DOMLSInput. |
| */ |
| class XMLPARSER_EXPORT Wrapper4InputSource: public DOMLSInput |
| { |
| public: |
| /** @name Constructors and Destructor */ |
| //@{ |
| |
| /** |
| * Constructor |
| * |
| * Wrap a SAX InputSource and make it behave like a DOMLSInput. |
| * By default, the wrapper will adopt the SAX InputSource that is wrapped. |
| * |
| * @param inputSource The SAX InputSource to be wrapped |
| * @param adoptFlag Indicates if the wrapper should adopt the wrapped |
| * SAX InputSource. Default is true. |
| * @param manager The MemoryManager to use to allocate objects |
| */ |
| Wrapper4InputSource(InputSource* const inputSource |
| , const bool adoptFlag = true |
| , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager); |
| |
| /** |
| * Destructor |
| * |
| */ |
| virtual ~Wrapper4InputSource(); |
| //@} |
| |
| |
| // ----------------------------------------------------------------------- |
| /** @name Virtual input source interface */ |
| //@{ |
| /** |
| * This wrapper doesn't support string data |
| * |
| */ |
| virtual const XMLCh* getStringData() const; |
| |
| /** |
| * Makes the byte stream for this input source. |
| * |
| * <p>The function will call the makeStream of the wrapped input source. |
| * The returned stream becomes the parser's property.</p> |
| * |
| * @see InputSource |
| */ |
| virtual InputSource* getByteStream() const; |
| //@} |
| |
| // ----------------------------------------------------------------------- |
| /** @name Getter methods */ |
| //@{ |
| /** |
| * An input source can be set to force the parser to assume a particular |
| * encoding for the data that input source represents, via the setEncoding() |
| * method. This method will delegate to the wrapped input source to return |
| * name of the encoding that is to be forced. If the encoding has never |
| * been forced, it returns a null pointer. |
| * |
| * @return The forced encoding, or null if none was supplied. |
| * @see #setEncoding |
| */ |
| virtual const XMLCh* getEncoding() const; |
| |
| |
| /** |
| * Get the public identifier for this input source. Delegated to the |
| * wrapped input source object. |
| * |
| * @return The public identifier, or null if none was supplied. |
| * @see #setPublicId |
| */ |
| const XMLCh* getPublicId() const; |
| |
| |
| /** |
| * Get the system identifier for this input source. Delegated to the |
| * wrapped input source object. |
| * |
| * <p>If the system ID is a URL, it will be fully resolved.</p> |
| * |
| * @return The system identifier. |
| * @see #setSystemId |
| */ |
| const XMLCh* getSystemId() const; |
| |
| /** |
| * Get the base URI to be used for resolving relative URIs to absolute |
| * URIs. If the baseURI is itself a relative URI, the behavior is |
| * implementation dependent. Delegated to the wrapped intput source |
| * object. |
| * |
| * @return The base URI. |
| * @see #setBaseURI |
| * @since DOM Level 3 |
| */ |
| const XMLCh* getBaseURI() const; |
| |
| /** |
| * Get the flag that indicates if the parser should issue fatal error if this input source |
| * is not found. Delegated to the wrapped input source object. |
| * |
| * @return True if the parser should issue fatal error if this input source is not found. |
| * False if the parser issue warning message instead. |
| * @see #setIssueFatalErrorIfNotFound |
| */ |
| bool getIssueFatalErrorIfNotFound() const; |
| |
| //@} |
| |
| |
| // ----------------------------------------------------------------------- |
| /** @name Setter methods */ |
| //@{ |
| /** |
| * This wrapper only exposes the given InputSource, no setting allowed |
| * |
| */ |
| virtual void setStringData(const XMLCh* data); |
| |
| /** |
| * This wrapper only exposes the given InputSource, no setting allowed |
| * |
| */ |
| virtual void setByteStream(InputSource* stream); |
| |
| /** |
| * Set the encoding which will be required for use with the XML text read |
| * via a stream opened by this input source. This will update the wrapped |
| * input source object. |
| * |
| * <p>This is usually not set, allowing the encoding to be sensed in the |
| * usual XML way. However, in some cases, the encoding in the file is known |
| * to be incorrect because of intermediate transcoding, for instance |
| * encapsulation within a MIME document. |
| * |
| * @param encodingStr The name of the encoding to force. |
| */ |
| void setEncoding(const XMLCh* const encodingStr); |
| |
| |
| /** |
| * Set the public identifier for this input source. This will update the |
| * wrapped input source object. |
| * |
| * <p>The public identifier is always optional: if the application writer |
| * includes one, it will be provided as part of the location information.</p> |
| * |
| * @param publicId The public identifier as a string. |
| * @see Locator#getPublicId |
| * @see SAXParseException#getPublicId |
| * @see #getPublicId |
| */ |
| void setPublicId(const XMLCh* const publicId); |
| |
| /** |
| * Set the system identifier for this input source. This will update the |
| * wrapped input source object. |
| * |
| * <p>The system id is always required. The public id may be used to map |
| * to another system id, but the system id must always be present as a fall |
| * back.</p> |
| * |
| * <p>If the system ID is a URL, it must be fully resolved.</p> |
| * |
| * @param systemId The system identifier as a string. |
| * @see #getSystemId |
| * @see Locator#getSystemId |
| * @see SAXParseException#getSystemId |
| */ |
| void setSystemId(const XMLCh* const systemId); |
| |
| /** |
| * Set the base URI to be used for resolving relative URIs to absolute |
| * URIs. If the baseURI is itself a relative URI, the behavior is |
| * implementation dependent. This will update the wrapped input source |
| * object. |
| * |
| * @param baseURI The base URI. |
| * @see #getBaseURI |
| * @since DOM Level 3 |
| */ |
| void setBaseURI(const XMLCh* const baseURI); |
| |
| /** |
| * Indicates if the parser should issue fatal error if this input source |
| * is not found. If set to false, the parser issue warning message |
| * instead. This will update the wrapped input source object. |
| * |
| * @param flag True if the parser should issue fatal error if this input |
| * source is not found. |
| * If set to false, the parser issue warning message instead. |
| * (Default: true) |
| * |
| * @see #getIssueFatalErrorIfNotFound |
| */ |
| void setIssueFatalErrorIfNotFound(bool flag); |
| |
| /** |
| * Called to indicate that this DOMInputSource is no longer in use |
| * and that the implementation may relinquish any resources associated with it. |
| * |
| * Access to a released object will lead to unexpected result. |
| */ |
| void release(); |
| |
| //@} |
| |
| |
| private: |
| // ----------------------------------------------------------------------- |
| // Unimplemented constructors and operators |
| // ----------------------------------------------------------------------- |
| Wrapper4InputSource(const Wrapper4InputSource&); |
| Wrapper4InputSource& operator=(const Wrapper4InputSource&); |
| |
| // ----------------------------------------------------------------------- |
| // Private data members |
| // ----------------------------------------------------------------------- |
| bool fAdoptInputSource; |
| InputSource* fInputSource; |
| }; |
| |
| |
| // --------------------------------------------------------------------------- |
| // Wrapper4InputSource: Getter methods |
| // --------------------------------------------------------------------------- |
| inline const XMLCh* Wrapper4InputSource::getBaseURI() const |
| { |
| return 0; // REVISIT - should we return an empty string? |
| } |
| |
| inline const XMLCh* Wrapper4InputSource::getStringData() const |
| { |
| return 0; |
| } |
| |
| // --------------------------------------------------------------------------- |
| // Wrapper4InputSource: Setter methods |
| // --------------------------------------------------------------------------- |
| inline void Wrapper4InputSource::setBaseURI(const XMLCh* const) |
| { |
| } |
| |
| inline void Wrapper4InputSource::setStringData(const XMLCh*) |
| { |
| } |
| |
| inline void Wrapper4InputSource::setByteStream(InputSource*) |
| { |
| } |
| |
| } |
| |
| #endif |