StaticContext.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2001-2006
 *     DecisionSoft Limited. All rights reserved.
 * Copyright (c) 2004-2006
 *     Progress Software Corporation. All rights reserved.
 * Copyright (c) 2004-2006
 *     Oracle. All rights reserved.
 *
 * See the file LICENSE for redistribution information.
 *
 * $Id: StaticContext.hpp,v 1.21 2007/07/10 16:28:57 jpcs Exp $
 */

#ifndef _STATICCONTEXT_HPP
#define _STATICCONTEXT_HPP

#include <xqilla/framework/XQillaExport.hpp>
#include <xqilla/simple-api/XQilla.hpp>
#include <time.h>
#include <xqilla/schema/DocumentCache.hpp>
#include <xercesc/util/PlatformUtils.hpp>
#include <xercesc/util/XMemory.hpp>

// Copied from ASTNode.hpp
typedef std::vector<ASTNode*,XQillaAllocator<ASTNode*> > VectorOfASTNodes;

class DynamicContext;
class XPath2MemoryManager;
class FuncFactory;
class DatatypeFactory;
class Collation;
class VariableTypeStore;
class ItemFactory;
class StaticType;
class ModuleResolver;
class MessageListener;
class ExternalFunction;
class XQillaConfiguration;

XERCES_CPP_NAMESPACE_BEGIN
class DOMDocument;
class DOMXPathNSResolver;
class XMLEntityResolver;
XERCES_CPP_NAMESPACE_END

class XQILLA_API StaticContext : public XERCES_CPP_NAMESPACE_QUALIFIER XMemory
{
public:
  typedef enum {
      ORDERING_ORDERED,
      ORDERING_UNORDERED
  } NodeSetOrdering;

  typedef enum {
    CONSTRUCTION_MODE_PRESERVE,
    CONSTRUCTION_MODE_STRIP
  } ConstructionMode;

  typedef enum {
    FLWOR_ORDER_EMPTY_GREATEST,
    FLWOR_ORDER_EMPTY_LEAST
  } FLWOROrderingMode;

  virtual ~StaticContext() {};

  virtual DynamicContext *createModuleContext(XERCES_CPP_NAMESPACE_QUALIFIER MemoryManager *memMgr =
                                              XERCES_CPP_NAMESPACE_QUALIFIER XMLPlatformUtils::fgMemoryManager) const = 0;
  virtual DynamicContext *createDynamicContext(XERCES_CPP_NAMESPACE_QUALIFIER MemoryManager *memMgr =
                                               XERCES_CPP_NAMESPACE_QUALIFIER XMLPlatformUtils::fgMemoryManager) const = 0;

  virtual XQillaConfiguration *getConfiguration() const = 0;

  virtual XQilla::Language getLanguage() const = 0;
  
  virtual ItemFactory *getItemFactory() const = 0;
  virtual void setItemFactory(ItemFactory *factory) = 0;

  virtual const StaticType &getContextItemType() const = 0;
  virtual void setContextItemType(const StaticType &st) = 0;

  virtual bool getXPath1CompatibilityMode() const = 0;
  virtual void setXPath1CompatibilityMode(bool newMode) = 0;

  virtual const XERCES_CPP_NAMESPACE_QUALIFIER DOMXPathNSResolver* getNSResolver() const = 0;
  virtual const XMLCh* getUriBoundToPrefix(const XMLCh* prefix, const LocationInfo *location) const = 0;
  virtual const XMLCh* getPrefixBoundToUri(const XMLCh* uri) const = 0;
  virtual void setNSResolver(const XERCES_CPP_NAMESPACE_QUALIFIER DOMXPathNSResolver* resolver) = 0;
  virtual void setNamespaceBinding(const XMLCh* prefix, const XMLCh* uri) = 0;

  virtual const XMLCh* getDefaultElementAndTypeNS() const = 0;
  virtual void setDefaultElementAndTypeNS(const XMLCh* newNS) = 0;

  virtual const XMLCh* getDefaultFuncNS() const = 0;
  virtual void setDefaultFuncNS(const XMLCh* newNS) = 0;

  virtual const DocumentCache* getDocumentCache() const = 0;
  virtual void setDocumentCache(DocumentCache* docCache) = 0;

  virtual bool isTypeOrDerivedFromType(const XMLCh* const uri, const XMLCh* const typeName, const XMLCh* const uriToCheck, const XMLCh* const typeNameToCheck) const = 0;
  virtual void setXMLEntityResolver(XERCES_CPP_NAMESPACE_QUALIFIER XMLEntityResolver* const handler) = 0;
  virtual XERCES_CPP_NAMESPACE_QUALIFIER XMLEntityResolver* getXMLEntityResolver() const = 0;

  virtual void setModuleResolver(ModuleResolver *resolver) = 0;
  virtual ModuleResolver *getModuleResolver() const = 0;
  /* Retrieve a list of locations for the given module URI */
  virtual VectorOfStrings* resolveModuleURI(const XMLCh* uri) const = 0;

  virtual void addSchemaLocation(const XMLCh* uri, VectorOfStrings* locations, const LocationInfo *location) = 0;
  
  virtual VariableTypeStore* getVariableTypeStore() = 0;

  virtual void addCustomFunction(FuncFactory *func) = 0;
  virtual ASTNode *lookUpFunction(const XMLCh *uri, const XMLCh* name, const VectorOfASTNodes &v) const = 0;

  virtual void addExternalFunction(const ExternalFunction *func) = 0;
  virtual const ExternalFunction *lookUpExternalFunction(const XMLCh *uri, const XMLCh *name, unsigned int numArgs) const = 0;

  virtual Collation* getCollation(const XMLCh* const URI, const LocationInfo *location) const = 0;
  virtual void addCollation(Collation* collation) = 0;
  
  virtual Collation* getDefaultCollation(const LocationInfo *location) const = 0;
  virtual void setDefaultCollation(const XMLCh* const URI) = 0;

  virtual const XMLCh* getBaseURI() const = 0;
  virtual void setBaseURI(const XMLCh* newURI) = 0;

  virtual NodeSetOrdering getNodeSetOrdering() const = 0;
  virtual void setNodeSetOrdering(NodeSetOrdering newOrder) = 0;

  virtual ConstructionMode getConstructionMode() const = 0;
  virtual void setConstructionMode(ConstructionMode newMode) = 0;

  virtual void setPreserveBoundarySpace(bool value) = 0;
  virtual bool getPreserveBoundarySpace() const = 0;

  virtual FLWOROrderingMode getDefaultFLWOROrderingMode() const = 0;
  virtual void setDefaultFLWOROrderingMode(FLWOROrderingMode newMode) = 0;

  virtual void setInheritNamespaces(bool value) = 0;
  virtual bool getInheritNamespaces() const = 0;

  virtual void setPreserveNamespaces(bool value) = 0;
  virtual bool getPreserveNamespaces() const = 0;

  virtual void setRevalidationMode(DocumentCache::ValidationMode mode) = 0;
  virtual DocumentCache::ValidationMode getRevalidationMode() const = 0;

  virtual void setMessageListener(MessageListener *listener) = 0;
  virtual MessageListener *getMessageListener() const = 0;

  //  XQilla context specific accessors  //

  virtual const XMLCh *allocateTempVarName() = 0;

  virtual XPath2MemoryManager* getMemoryManager() const = 0;
  virtual void setMemoryManager(XPath2MemoryManager* memMgr) = 0;
};

#endif

---