src/xmlpatterns/functions/qtracefn.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #include "qcommonsequencetypes_p.h"
  43 #include "qcommonvalues_p.h"
  44 #include "qitemmappingiterator_p.h"
  45 #include "qpatternistlocale_p.h"
  46
  47 #include "qtracefn_p.h"
  48
  49 QT_BEGIN_NAMESPACE
  50
  51 using namespace QPatternist;
  52
  53 namespace QPatternist
  54 {
  55     /**
  56      * @short TraceCallback is a MappingCallback and takes care of
  57      * the tracing of each individual item.
  58      *
  59      * Because Patternist must be thread safe, TraceFN creates a TraceCallback
  60      * each time the function is evaluated. In other words, TraceFN, which is
  61      * an Expression sub class, can't modify its members, but MappingCallback
  62      * does not have this limitation since it's created on a per evaluation basis.
  63      *
  64      * @author Frans Englich <frans.englich@nokia.com>
  65      */
  66     class TraceCallback : public QSharedData
  67     {
  68     public:
  69         typedef QExplicitlySharedDataPointer<TraceCallback> Ptr;
  70
  71         inline TraceCallback(const QString &msg) : m_position(0),
  72                                                    m_msg(msg)
  73         {
  74         }
  75
  76         /**
  77          * Performs the actual tracing.
  78          */
  79         Item mapToItem(const Item &item,
  80                             const DynamicContext::Ptr &context)
  81         {
  82             QTextStream out(stderr);
  83             ++m_position;
  84             if(m_position == 1)
  85             {
  86                 if(item)
  87                 {
  88                     out << qPrintable(m_msg)
  89                         << " : "
  90                         << qPrintable(item.stringValue());
  91                 }
  92                 else
  93                 {
  94                     out << qPrintable(m_msg)
  95                         << " : ("
  96                         << qPrintable(formatType(context->namePool(), CommonSequenceTypes::Empty))
  97                         << ")\n";
  98                     return Item();
  99                 }
 100             }
 101             else
 102             {
 103                 out << qPrintable(item.stringValue())
 104                     << '['
 105                     << m_position
 106                     << "]\n";
 107             }
 108
 109             return item;
 110         }
 111
 112     private:
 113         xsInteger m_position;
 114         const QString m_msg;
 115     };
 116 }
 117
 118 Item::Iterator::Ptr TraceFN::evaluateSequence(const DynamicContext::Ptr &context) const
 119 {
 120     const QString msg(m_operands.last()->evaluateSingleton(context).stringValue());
 121
 122     return makeItemMappingIterator<Item>(TraceCallback::Ptr(new TraceCallback(msg)),
 123                                               m_operands.first()->evaluateSequence(context),
 124                                               context);
 125 }
 126
 127 Item TraceFN::evaluateSingleton(const DynamicContext::Ptr &context) const
 128 {
 129     const QString msg(m_operands.last()->evaluateSingleton(context).stringValue());
 130     const Item item(m_operands.first()->evaluateSingleton(context));
 131
 132     return TraceCallback::Ptr(new TraceCallback(msg))->mapToItem(item, context);
 133 }
 134
 135 SequenceType::Ptr TraceFN::staticType() const
 136 {
 137     return m_operands.first()->staticType();
 138 }
 139
 140 QT_END_NAMESPACE