QPatternist::CommentConstructor Class Reference

Constructs a comment node. This covers both computed and directly constructed text nodes. More...

#include <qcommentconstructor_p.h>

Inheritance diagram for QPatternist::CommentConstructor:

Public Functions
virtual ExpressionVisitorResult::Ptr	accept (const ExpressionVisitor::Ptr &visitor) const
	CommentConstructor (const Expression::Ptr &operand)
virtual Item	evaluateSingleton (const DynamicContext::Ptr &context) const
virtual void	evaluateToSequenceReceiver (const DynamicContext::Ptr &context) const
virtual SequenceType::List	expectedOperandTypes () const
virtual Properties	properties () const
virtual SequenceType::Ptr	staticType () const
Public Functions inherited from QPatternist::SingleContainer
virtual bool	compressOperands (const StaticContext::Ptr &)
virtual Expression::List	operands () const
virtual void	setOperands (const Expression::List &operands)
Public Functions inherited from QPatternist::Expression
virtual const SourceLocationReflection *	actualReflection () const
	Returns this. More...
virtual void	announceFocusType (const ItemType::Ptr &itemType)
virtual Expression::Ptr	compress (const StaticContext::Ptr &context)
Properties	deepProperties () const
	Computes the union of properties for this Expression and all its descending children. More...
virtual Properties	dependencies () const
virtual QString	description () const
virtual bool	evaluateEBV (const DynamicContext::Ptr &context) const
virtual Item::Iterator::Ptr	evaluateSequence (const DynamicContext::Ptr &context) const
virtual ItemType::Ptr	expectedContextItemType () const
	Expression ()
bool	has (const Property prop) const
bool	hasDependency (const Property prop) const
virtual ID	id () const
bool	is (const ID id) const
bool	isEvaluated () const
virtual ItemType::Ptr	newFocusType () const
virtual QList< QExplicitlySharedDataPointer< OptimizationPass > >	optimizationPasses () const
virtual PatternPriority	patternPriority () const
const Expression::Ptr &	rewrite (const Expression::Ptr &to, const StaticContext::Ptr &context) const
	Rewrites this Expression to to, and return to. More...
virtual Expression::Ptr	typeCheck (const StaticContext::Ptr &context, const SequenceType::Ptr &reqType)
virtual	~Expression ()
Public Functions inherited from QSharedData
	QSharedData ()
	Constructs a QSharedData object with a reference count of 0. More...
	QSharedData (const QSharedData &)
	Constructs a QSharedData object with reference count 0. More...
Public Functions inherited from QPatternist::CppCastingHelper< Expression >
const TCastTarget *	as () const
TCastTarget *	as ()
Public Functions inherited from QPatternist::SourceLocationReflection
virtual QSourceLocation	sourceLocation () const
	SourceLocationReflection ()
virtual	~SourceLocationReflection ()

Private Functions
QString	evaluateContent (const DynamicContext::Ptr &context) const

Additional Inherited Members
Public Types inherited from QPatternist::Expression
typedef QExplicitlySharedDataPointer< const Expression >	ConstPtr
	A smart pointer wrapping const Expression instances. More...
enum	ID {   IDBooleanValue = 1, IDCountFN, IDEmptyFN, IDExistsFN,   IDExpressionSequence, IDGeneralComparison, IDIfThenClause, IDIgnorableExpression,   IDIntegerValue, IDPositionFN, IDStringValue, IDValueComparison,   IDRangeVariableReference, IDContextItem, IDUserFunctionCallsite, IDExpressionVariableReference,   IDAttributeConstructor, IDUpperCaseFN, IDLowerCaseFN, IDFirstItemPredicate,   IDEmptySequence, IDReturnOrderBy, IDLetClause, IDForClause,   IDPath, IDNamespaceConstructor, IDArgumentReference, IDGenericPredicate,   IDAxisStep, IDFloat, IDCombineNodes, IDUnresolvedVariableReference,   IDCardinalityVerifier }
typedef QList< Expression::Ptr >	List
typedef QFlags< Property >	Properties
enum	Property {   UseContextItem = 1, DisableElimination = 1 << 1, IsEvaluated = 1 << 2, DisableTypingDeduction = 1 << 3,   EmptynessFollowsChild = 1 << 4, RewriteToEmptyOnEmpty = 1 << 5, RequiresFocus = 1 << 6, AffectsOrderOnly = 1 << 7,   RequiresContextItem = (1 << 8) | RequiresFocus, CreatesFocusForLast = 1 << 9, LastOperandIsCollation = 1 << 10, DependsOnLocalVariable = (1 << 11) | DisableElimination,   EvaluationCacheRedundant = (1 << 12), IsNodeConstructor = 1 << 13, RequiresCurrentItem = 1 << 14 }
typedef QExplicitlySharedDataPointer< Expression >	Ptr
	A smart pointer wrapping mutable Expression instances. More...
typedef ::QAbstractXmlForwardIterator< Expression::Ptr >	QAbstractXmlForwardIterator
typedef QVector< Expression::Ptr >	Vector
Static Public Functions inherited from QPatternist::Expression
static void	rewrite (Expression::Ptr &old, const Expression::Ptr &New, const StaticContext::Ptr &context)
Public Variables inherited from QSharedData
QAtomicInt	ref
Protected Functions inherited from QPatternist::SingleContainer
	SingleContainer (const Expression::Ptr &operand)
Protected Functions inherited from QPatternist::Expression
void	typeCheckOperands (const StaticContext::Ptr &context)
Protected Functions inherited from QPatternist::CppCastingHelper< Expression >
	CppCastingHelper ()
Protected Variables inherited from QPatternist::SingleContainer
Expression::Ptr	m_operand

Detailed Description

Constructs a comment node. This covers both computed and directly constructed text nodes.

See also

XQuery 1.0: An XML Query Language, 3.7 Constructors

Author

Frans Englich frans.nosp@m..eng.nosp@m.lich@.nosp@m.noki.nosp@m.a.com

Definition at line 72 of file qcommentconstructor_p.h.

Constructors and Destructors

CommentConstructor()

CommentConstructor::CommentConstructor

(

const Expression::Ptr &

operand

)

Definition at line 52 of file qcommentconstructor.cpp.

                                                              : SingleContainer(op)
{
}

Functions

accept()

ExpressionVisitorResult::Ptr CommentConstructor::accept ( const ExpressionVisitor::Ptr &  visitor ) const

virtual

Implements QPatternist::Expression.

Definition at line 119 of file qcommentconstructor.cpp.

{
    return visitor->visit(this);
}

evaluateContent()

QString CommentConstructor::evaluateContent ( const DynamicContext::Ptr &  context ) const

inlineprivate

Definition at line 56 of file qcommentconstructor.cpp.

Referenced by evaluateSingleton(), and evaluateToSequenceReceiver().

{
    const Item item(m_operand->evaluateSingleton(context));

    if(!item)
        return QString();

    const QString content(item.stringValue());

    if(content.contains(QLatin1String("--")))
    {
        context->error(QtXmlPatterns::tr("A comment cannot contain %1")
                       .arg(formatData("--")),
                       ReportContext::XQDY0072, this);
    }
    else if(content.endsWith(QLatin1Char('-')))
    {
        context->error(QtXmlPatterns::tr("A comment cannot end with a %1.")
                       .arg(formatData(QLatin1Char('-'))),
                       ReportContext::XQDY0072, this);
    }

    return content;
}

evaluateSingleton()

Item CommentConstructor::evaluateSingleton ( const DynamicContext::Ptr &  context ) const

virtual

Reimplemented from QPatternist::Expression.

Definition at line 81 of file qcommentconstructor.cpp.

{
    const QString content(evaluateContent(context));
    const NodeBuilder::Ptr nodeBuilder(context->nodeBuilder(QUrl()));
    nodeBuilder->comment(content);

    const QAbstractXmlNodeModel::Ptr nm(nodeBuilder->builtDocument());
    context->addNodeModel(nm);

    return nm->root(QXmlNodeModelIndex());
}

evaluateToSequenceReceiver()

void CommentConstructor::evaluateToSequenceReceiver ( const DynamicContext::Ptr &  context ) const

virtual

Evaluates this Expression by sending its output to DynamicContext::outputReceiver().

Reimplemented from QPatternist::Expression.

Definition at line 93 of file qcommentconstructor.cpp.

{
    const QString content(evaluateContent(context));
    QAbstractXmlReceiver *const receiver = context->outputReceiver();

    receiver->comment(content);
}

expectedOperandTypes()

SequenceType::List CommentConstructor::expectedOperandTypes ( ) const

virtual

The first operand must be exactly one xs:string.

Implements QPatternist::Expression.

Definition at line 106 of file qcommentconstructor.cpp.

{
    SequenceType::List result;
    result.append(CommonSequenceTypes::ZeroOrOneString);
    return result;
}

properties()

Expression::Properties CommentConstructor::properties ( ) const

virtual

Returns

a bitwise OR'd value of properties, describing the characteristics of the expression. These properties affects how this Expression is treated in for example type checking stages.

The default implementation returns 0. Override and let the function return a different value, if that's of interest.

An important decision when re-implementing properties() is whether to OR in the properties() of ones operands. For instance, if an operand has RequiresFocus set, that flag nost likely applies to the apparent as well, since it depends on its operand.

See also

deepProperties()

Returns

Expression::None, meaning no special properties

Reimplemented from QPatternist::Expression.

Definition at line 113 of file qcommentconstructor.cpp.

{
    return DisableElimination | IsNodeConstructor;
}

staticType()

SequenceType::Ptr CommentConstructor::staticType ( ) const

virtual

Returns

the static type of this Expression. For example, an 'and' expression have as static type xs:boolean

Implements QPatternist::Expression.

Definition at line 101 of file qcommentconstructor.cpp.

{
    return CommonSequenceTypes::ExactlyOneComment;
}

---

The documentation for this class was generated from the following files:

• /src/xmlpatterns/expr/qcommentconstructor_p.h
• /src/xmlpatterns/expr/qcommentconstructor.cpp