/* * The Apache Software License, Version 1.1 * * Copyright (c) 1999-2000 The Apache Software Foundation. All rights * reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3. The end-user documentation included with the redistribution, * if any, must include the following acknowledgment: * "This product includes software developed by the * Apache Software Foundation (http://www.apache.org/)." * Alternately, this acknowledgment may appear in the software itself, * if and wherever such third-party acknowledgments normally appear. * * 4. The names "Xerces" and "Apache Software Foundation" must * not be used to endorse or promote products derived from this * software without prior written permission. For written * permission, please contact apache\@apache.org. * * 5. Products derived from this software may not be called "Apache", * nor may "Apache" appear in their name, without prior written * permission of the Apache Software Foundation. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * ==================================================================== * * This software consists of voluntary contributions made by many * individuals on behalf of the Apache Software Foundation, and was * originally based on software copyright (c) 1999, International * Business Machines, Inc., http://www.ibm.com . For more information * on the Apache Software Foundation, please see * . */ /* * $Log: XMLRefInfo.hpp,v $ * Revision 1.1.1.1 2002/02/01 22:21:52 peiyongz * sane_include * * Revision 1.5 2000/07/07 22:23:38 jpolast * remove useless getKey() functions. * * Revision 1.4 2000/02/24 20:00:23 abagchi * Swat for removing Log from API docs * * Revision 1.3 2000/02/15 01:21:31 roddey * Some initial documentation improvements. More to come... * * Revision 1.2 2000/02/06 07:47:49 rahulj * Year 2K copyright swat. * * Revision 1.1.1.1 1999/11/09 01:08:37 twl * Initial checkin * * Revision 1.2 1999/11/08 20:44:40 rahul * Swat for adding in Product name and CVS comment log variable. * */ #if !defined(XMLIDREFINFO_HPP) #define XMLIDREFINFO_HPP /** * This class provides a simple means to track ID Ref usage. Since id/idref * semamatics are part of XML 1.0, any validator will likely to be able to * track them. Instances of this class represent a reference and two markers, * one for its being declared and another for its being used. When the * document is done, one can look at each instance and, if used but not * declared, its an error. * * The getKey() method allows it to support keyed collection semantics. It * returns the referenced name, so these objects will be stored via the hash * of the name. This name will either be a standard QName if namespaces are * not enabled/supported by the validator, or it will be in the form * {url}name if namespace processing is enabled. */ class XMLPARSER_EXPORT XMLRefInfo { public : // ----------------------------------------------------------------------- // Constructors and Destructor // ----------------------------------------------------------------------- /** @name Constructor */ //@{ XMLRefInfo ( const XMLCh* const refName , const bool fDeclared = false , const bool fUsed = false ); //@} /** @name Destructor */ //@{ ~XMLRefInfo(); //@} // ----------------------------------------------------------------------- // Getter methods // ----------------------------------------------------------------------- bool getDeclared() const; const XMLCh* getRefName() const; bool getUsed() const; // ----------------------------------------------------------------------- // Setter methods // ----------------------------------------------------------------------- void setDeclared(const bool newValue); void setUsed(const bool newValue); private : // ----------------------------------------------------------------------- // Unimplemented constructors and operators // ----------------------------------------------------------------------- XMLRefInfo(); XMLRefInfo(const XMLRefInfo&); void operator=(XMLRefInfo&); // ----------------------------------------------------------------------- // Private data members // // fDeclared // The name was declared somewhere as an ID attribute. // // fRefName // The name of the ref that this object represents. This is not a // name of the attribute, but of the value of an ID or IDREF attr // in content. // // fUsed // The name was used somewhere in an IDREF/IDREFS attribute. If this // is true, but fDeclared is false, then the ref does not refer to // a declared ID. // ----------------------------------------------------------------------- bool fDeclared; XMLCh* fRefName; bool fUsed; }; // --------------------------------------------------------------------------- // XMLRefInfo: Constructors and Destructor // --------------------------------------------------------------------------- inline XMLRefInfo::XMLRefInfo( const XMLCh* const refName , const bool declared , const bool used) : fDeclared(declared) , fRefName(XMLString::replicate(refName)) , fUsed(used) { } inline XMLRefInfo::~XMLRefInfo() { delete [] fRefName; } // --------------------------------------------------------------------------- // XMLRefInfo: Getter methods // --------------------------------------------------------------------------- inline bool XMLRefInfo::getDeclared() const { return fDeclared; } inline const XMLCh* XMLRefInfo::getRefName() const { return fRefName; } inline bool XMLRefInfo::getUsed() const { return fUsed; } // --------------------------------------------------------------------------- // XMLRefInfo: Setter methods // --------------------------------------------------------------------------- inline void XMLRefInfo::setDeclared(const bool newValue) { fDeclared = newValue; } inline void XMLRefInfo::setUsed(const bool newValue) { fUsed = newValue; } #endif