XQilla.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 _XQILLA_07637_HPP
#define _XQILLA_07637_HPP

#include <xqilla/framework/XQillaExport.hpp>

#include <xercesc/framework/MemoryManager.hpp>
#include <xercesc/util/PlatformUtils.hpp>
#include <xercesc/util/XMemory.hpp>

class DynamicContext;
class XPath2MemoryManager;
class XQillaConfiguration;
class Optimizer;
class DelayedFuncFactory;
class XQQuery;

XERCES_CPP_NAMESPACE_BEGIN
class InputSource;
class XMLBuffer;
XERCES_CPP_NAMESPACE_END

namespace CompileDelayedModule {
void compile(const XMLCh *queryFile);
}

class XQILLA_API XQilla : public XERCES_CPP_NAMESPACE_QUALIFIER XMemory
{
public:
  enum Flags {
    NO_STATIC_RESOLUTION = 0x1, 
    NO_ADOPT_CONTEXT     = 0x2, 
    DEBUG_QUERY          = 0x4, 
    NO_OPTIMIZATION      = 0x8, 
    NO_DEFAULT_MODULES   = 0x10 
  };

  enum Language {
    XQUERY     = 0x00,
    XPATH2     = 0x01,
    FULLTEXT   = 0x02,
    UPDATE     = 0x04,
    EXTENSIONS = 0x08,
    XSLT2      = 0x10,
    VERSION3   = 0x20,

    XQUERY_FULLTEXT          = (XQUERY | FULLTEXT),
    XQUERY_UPDATE            = (XQUERY | UPDATE),
    XQUERY_FULLTEXT_UPDATE   = (XQUERY | FULLTEXT | UPDATE),
    XPATH2_FULLTEXT          = (XPATH2 | FULLTEXT),
    XSLT2_FULLTEXT           = (XSLT2 | FULLTEXT),

    XQUERY3                  = (XQUERY | VERSION3),
    XQUERY3_FULLTEXT         = (XQUERY | VERSION3 | FULLTEXT),
    XQUERY3_UPDATE           = (XQUERY | VERSION3 | UPDATE),
    XQUERY3_FULLTEXT_UPDATE  = (XQUERY | VERSION3 | FULLTEXT | UPDATE),
    XPATH3                   = (XPATH2 | VERSION3),
    XPATH3_FULLTEXT          = (XPATH2 | VERSION3 | FULLTEXT),
    XSLT3                    = (XSLT2 | VERSION3),
    XSLT3_FULLTEXT           = (XSLT2 | VERSION3 | FULLTEXT),
  };
                                                                                                                                                              
  XQilla(XERCES_CPP_NAMESPACE_QUALIFIER MemoryManager *memMgr = 0);

  ~XQilla();

        // @{

  static XQQuery* parse(const XMLCh* query,
                        DynamicContext* context = 0,
                        const XMLCh* queryFile = NULL,
                        unsigned int flags = 0,
                        XERCES_CPP_NAMESPACE_QUALIFIER MemoryManager *memMgr =
                        XERCES_CPP_NAMESPACE_QUALIFIER XMLPlatformUtils::fgMemoryManager,
                        XQQuery *result = 0);

  static XQQuery* parse(const XERCES_CPP_NAMESPACE_QUALIFIER InputSource& querySrc,
                        DynamicContext* context = 0,
                        unsigned int flags = 0,
                        XERCES_CPP_NAMESPACE_QUALIFIER MemoryManager *memMgr =
                        XERCES_CPP_NAMESPACE_QUALIFIER XMLPlatformUtils::fgMemoryManager,
                        XQQuery *result = 0);

  static XQQuery* parseFromURI(const XMLCh* queryFile,
                               DynamicContext* context = 0,
                               unsigned int flags = 0,
                               XERCES_CPP_NAMESPACE_QUALIFIER MemoryManager *memMgr =
                               XERCES_CPP_NAMESPACE_QUALIFIER XMLPlatformUtils::fgMemoryManager,
                               XQQuery *result = 0);


  // @{

  static DynamicContext *createContext(Language language = XQUERY,
                                       XQillaConfiguration *conf = 0,
                                       XERCES_CPP_NAMESPACE_QUALIFIER MemoryManager *memMgr =
                                       XERCES_CPP_NAMESPACE_QUALIFIER XMLPlatformUtils::fgMemoryManager);


private:
  static bool readQuery(const XMLCh* queryFile, 
                        XERCES_CPP_NAMESPACE_QUALIFIER MemoryManager* memMgr, 
                        XERCES_CPP_NAMESPACE_QUALIFIER XMLBuffer& queryText);
  static bool readQuery(const XERCES_CPP_NAMESPACE_QUALIFIER InputSource& querySrc, 
                        XERCES_CPP_NAMESPACE_QUALIFIER MemoryManager* memMgr, 
                        XERCES_CPP_NAMESPACE_QUALIFIER XMLBuffer& queryText);
  static Optimizer *createOptimizer(DynamicContext *context, unsigned int flags);

  static void compileDelayedModule(const XMLCh* queryFile, XERCES_CPP_NAMESPACE_QUALIFIER MemoryManager *memMgr =
                                   XERCES_CPP_NAMESPACE_QUALIFIER XMLPlatformUtils::fgMemoryManager);

  friend void CompileDelayedModule::compile(const XMLCh *queryFile);
  friend class DelayedFuncFactory;
};

#endif