DynamicContext.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2001, 2008,
 *     DecisionSoft Limited. All rights reserved.
 * Copyright (c) 2004, 2018 Oracle and/or its affiliates. All rights reserved.
 *     
 *
 * 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.
 */

#ifndef _DYNAMICCONTEXT_HPP
#define _DYNAMICCONTEXT_HPP

#include <xqilla/context/StaticContext.hpp>
#include <xqilla/items/ATDurationOrDerived.hpp>

class Sequence;
class Result;
class Item;
class URIResolver;
class VariableStore;
class SequenceBuilder;
class UpdateFactory;
class RegexGroupStore;
class DebugListener;
class StackFrame;

class XQILLA_API DynamicContext : public StaticContext
{
public:
  virtual ~DynamicContext() {};

  virtual DynamicContext *createModuleDynamicContext(const DynamicContext* moduleCtx, XERCES_CPP_NAMESPACE_QUALIFIER MemoryManager *memMgr =
                                                     XERCES_CPP_NAMESPACE_QUALIFIER XMLPlatformUtils::fgMemoryManager) const = 0;

  virtual void clearDynamicContext() = 0;

  virtual Item::Ptr getContextItem() const = 0;
  virtual void setContextItem(const Item::Ptr &item) = 0;

  virtual size_t getContextPosition() const = 0;
  virtual void setContextPosition(size_t pos) = 0;

  virtual size_t getContextSize() const = 0;
  virtual void setContextSize(size_t size) = 0;
  
  virtual const VariableStore* getVariableStore() const = 0;
  virtual void setVariableStore(const VariableStore *store) = 0;
  virtual const VariableStore* getGlobalVariableStore() const = 0;
  virtual void setGlobalVariableStore(const VariableStore *store) = 0;
  virtual void setExternalVariable(const XMLCh *namespaceURI, const XMLCh *name, const Result &value) = 0;
  virtual void setExternalVariable(const XMLCh *qname, const Result &value) = 0;

  virtual const RegexGroupStore* getRegexGroupStore() const = 0;
  virtual void setRegexGroupStore(const RegexGroupStore *store) = 0;

  virtual time_t getCurrentTime() const = 0;
  virtual void setCurrentTime(time_t newTime) = 0;

  virtual ATDurationOrDerived::Ptr getImplicitTimezone() const = 0;
  virtual void setImplicitTimezone(const ATDurationOrDerived::Ptr &timezoneAsDuration) = 0;

  //  XQilla context specific accessors  //

  virtual void registerURIResolver(URIResolver *resolver, bool adopt) = 0;
  virtual URIResolver *getDefaultURIResolver() const = 0;
  virtual void setDefaultURIResolver(URIResolver *resolver, bool adopt) = 0;

  virtual void setDebugListener(DebugListener *listener) = 0;
  virtual DebugListener *getDebugListener() const = 0;

  virtual void setStackFrame(const StackFrame *frame) = 0;
  virtual const StackFrame *getStackFrame() const = 0;

  virtual Node::Ptr parseDocument(XERCES_CPP_NAMESPACE_QUALIFIER InputSource &srcToUse,
                                  const LocationInfo *location = 0, const QueryPathNode *projection = 0) = 0;
  virtual Sequence resolveDocument(const XMLCh* uri, const LocationInfo *location = 0,
                                   const QueryPathNode *projection = 0) = 0;
  virtual Sequence resolveCollection(const XMLCh* uri, const LocationInfo *location = 0,
                                     const QueryPathNode *projection = 0) = 0;
  virtual Sequence resolveDefaultCollection(const QueryPathNode *projection = 0) = 0;

  virtual bool putDocument(const Node::Ptr &document, const XMLCh *uri) = 0;

  virtual SequenceBuilder *createSequenceBuilder() const = 0;

  virtual UpdateFactory *createUpdateFactory() const = 0;

  virtual void testInterrupt() const = 0;
};

#endif