XSECNameSpaceExpander.hpp

Go to the documentation of this file.

/*
 * Copyright 2002-2005 The Apache Software Foundation.
 *
 * Licensed 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.
 */

/*
 * XSEC
 *
 * XSECNameSpaceHolder := Container class for holding and managing the name space stack
 *                        Used when running through a DOM document
 *
 * $Id: XSECNameSpaceExpander.hpp,v 1.8 2005/02/03 13:53:54 milan Exp $
 *
 */

#ifndef XSECNAMESPACEEXPANDER_HEADER
#define XSECNAMESPACEEXPANDER_HEADER

// XSEC Includes
#include <xsec/framework/XSECDefs.hpp>
#include <xsec/utils/XSECSafeBuffer.hpp>
#include <xsec/utils/XSECSafeBufferFormatter.hpp>

// Xerces Includes
XSEC_DECLARE_XERCES_CLASS(DOMDocument);
XSEC_DECLARE_XERCES_CLASS(DOMNode);
XSEC_DECLARE_XERCES_CLASS(DOMElement);

#include <vector>

// --------------------------------------------------------------------------------
//           Structure Definition for the nodes within the list of nodes
// --------------------------------------------------------------------------------

struct XSECNameSpaceEntry {

    // Variables
    safeBuffer                                  m_name;         // The name for this name space
    XERCES_CPP_NAMESPACE_QUALIFIER DOMElement   * mp_node;      // The Element Node owner
    XERCES_CPP_NAMESPACE_QUALIFIER DOMNode      * mp_att;       // The added attribute node
            
};

// --------------------------------------------------------------------------------
//           Class definition for the list
// --------------------------------------------------------------------------------

/*\@{*/

class CANON_EXPORT XSECNameSpaceExpander {


#if defined(XALAN_NO_NAMESPACES)
    typedef vector<XSECNameSpaceEntry *>            NameSpaceEntryListVectorType;
#else
    typedef std::vector<XSECNameSpaceEntry *>       NameSpaceEntryListVectorType;
#endif


public:

    
    XSECNameSpaceExpander(XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *d);           // Constructor

    XSECNameSpaceExpander(XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *f);            // frag Constructor

    ~XSECNameSpaceExpander();                       // Default destructor


    // Operate 

    void expandNameSpaces(void);

    void deleteAddedNamespaces(void);

    // Check if a node is an added node
    bool nodeWasAdded(XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *n);

private:  // Functions

    XSECNameSpaceExpander(void);                    // No default constructor
    void recurse(XERCES_CPP_NAMESPACE_QUALIFIER DOMElement *n);

    // data
    
    NameSpaceEntryListVectorType    m_lst;          // List of added name spaces
    XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument                      
                                    * mp_doc;       // The owner document
    XERCES_CPP_NAMESPACE_QUALIFIER DOMElement                      
                                    * mp_fragment;  // If we are doing a fragment
    bool                            m_expanded;     // Have we expanded already?
    XSECSafeBufferFormatter         * mp_formatter;

};

#endif /* XSECNAMESPACEEXPANDER_HEADER */

---