XdmNode.h

// Copyright (c) 2022 - 2023 Saxonica Limited.
// This Source Code Form is subject to the terms of the Mozilla Public License,
// v. 2.0. If a copy of the MPL was not distributed with this file, You can
// obtain one at http://mozilla.org/MPL/2.0/. This Source Code Form is
// "Incompatible With Secondary Licenses", as defined by the Mozilla Public
// License, v. 2.0.
 
#ifndef SAXON_XDMNODE_h
#define SAXON_XDMNODE_h
 
#include "saxonc_export.h"
#include "saxonc/XdmItem.h"
#include <string.h>
 
typedef enum eXdmNodeKind {
  DOCUMENT = 9,
  ELEMENT = 1,
  ATTRIBUTE = 2,
  TEXT = 3,
  COMMENT = 8,
  PROCESSING_INSTRUCTION = 7,
  NAMESPACE = 13,
  UNKNOWN = 0
} XDM_NODE_KIND;
 
enum class SAXONC_EXPORT EnumXdmAxis {
  ANCESTOR = 0,
  ANCESTOR_OR_SELF = 1,
  ATTRIBUTE = 2,
  CHILD = 3,
  DESCENDANT = 4,
  DESCENDANT_OR_SELF = 5,
  FOLLOWING = 6,
  FOLLOWING_SIBLING = 7,
  NAMESPACE = 8,
  PARENT = 9,
  PRECEDING = 10,
  PRECEDING_SIBLING = 11,
  SELF = 12
};
 
class XdmValue;

class SAXONC_EXPORT XdmNode : public XdmItem {
 
public:
  XdmNode(int64_t objRef);

  XdmNode(XdmNode *parent, int64_t objRef, XDM_NODE_KIND kind);

 bool operator==(const XdmNode& other) const;

  XdmNode(const XdmNode &other);

  virtual ~XdmNode();

  bool isAtomic();

  XdmItem *getHead();

 bool equals(XdmNode * other);
 

  XDM_NODE_KIND getNodeKind();

  const char *getNodeName();

  const char *getLocalName();

  XdmValue *getTypedValue();

  int getLineNumber();
 

  int getColumnNumber();

  const char *getBaseUri();

  const char *getStringValue(const char *encoding = nullptr);
 

  const char *toString(const char *encoding = nullptr);

  XdmNode *getParent();

  const char *getAttributeValue(const char *name);

  int getAttributeCount();

  XdmNode **getAttributeNodes(bool cache = false);

  XdmNode **axisNodes(EnumXdmAxis axis);

  EnumXdmAxis convertEnumXdmAxis(int n) { return static_cast<EnumXdmAxis>(n); }

  int axisNodeCount();

  int64_t getUnderlyingValue() { return XdmItem::getUnderlyingValue(); }

  bool isNode() { return true; }

  XdmNode **getChildren(bool cache = false);

 
  XdmNode *getChild(int i, bool cache = false);

  int getChildCount();

  XDM_TYPE getType() { return XDM_NODE; }
 

    void resetRelinquishedChildren();

    void incrementRefCountForRelinquishedChildren();

 
    bool hasRelinquishedChildren();

  static void deleteChildrenArray(XdmNode **fetchedChildren) {
    if (fetchedChildren != nullptr) {
      delete[] fetchedChildren;
      fetchedChildren = nullptr;
    }
  }
 
 
private:
  const char *baseURI;   
  const char *nodeName;  
  const char *localName; 
  XdmNode **children; 
  int childCount;     
  int axisCount;
  XdmNode **attrValues; 
  int attrCount; 
  XDM_NODE_KIND nodeKind; 
};
 
#endif