dom/xslt/xslt/txInstructions.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef TRANSFRMX_TXINSTRUCTIONS_H
   7 #define TRANSFRMX_TXINSTRUCTIONS_H
   8
   9 #include "mozilla/UniquePtr.h"
  10 #include "nsCOMPtr.h"
  11 #include "txCore.h"
  12 #include "nsString.h"
  13 #include "txXMLUtils.h"
  14 #include "txExpandedName.h"
  15 #include "txNamespaceMap.h"
  16 #include "txXSLTNumber.h"
  17 #include "nsTArray.h"
  18
  19 class nsAtom;
  20 class txExecutionState;
  21
  22 class txInstruction : public txObject {
  23  public:
  24   MOZ_COUNTED_DEFAULT_CTOR(txInstruction)
  25
  26   ~txInstruction() override {
  27     MOZ_COUNT_DTOR(txInstruction);
  28
  29     mozilla::UniquePtr<txInstruction> next(std::move(mNext));
  30     while (next) {
  31       mozilla::UniquePtr<txInstruction> destroy(std::move(next));
  32       next = std::move(destroy->mNext);
  33     }
  34   }
  35
  36   virtual nsresult execute(txExecutionState& aEs) = 0;
  37
  38   mozilla::UniquePtr<txInstruction> mNext;
  39 };
  40
  41 #define TX_DECL_TXINSTRUCTION \
  42   virtual nsresult execute(txExecutionState& aEs) override;
  43
  44 class txApplyDefaultElementTemplate : public txInstruction {
  45  public:
  46   TX_DECL_TXINSTRUCTION
  47 };
  48
  49 class txApplyImportsEnd : public txInstruction {
  50  public:
  51   TX_DECL_TXINSTRUCTION
  52 };
  53
  54 class txApplyImportsStart : public txInstruction {
  55  public:
  56   TX_DECL_TXINSTRUCTION
  57 };
  58
  59 class txApplyTemplates : public txInstruction {
  60  public:
  61   explicit txApplyTemplates(const txExpandedName& aMode);
  62
  63   TX_DECL_TXINSTRUCTION
  64
  65   txExpandedName mMode;
  66 };
  67
  68 class txAttribute : public txInstruction {
  69  public:
  70   txAttribute(mozilla::UniquePtr<Expr>&& aName,
  71               mozilla::UniquePtr<Expr>&& aNamespace, txNamespaceMap* aMappings);
  72
  73   TX_DECL_TXINSTRUCTION
  74
  75   mozilla::UniquePtr<Expr> mName;
  76   mozilla::UniquePtr<Expr> mNamespace;
  77   RefPtr<txNamespaceMap> mMappings;
  78 };
  79
  80 class txCallTemplate : public txInstruction {
  81  public:
  82   explicit txCallTemplate(const txExpandedName& aName);
  83
  84   TX_DECL_TXINSTRUCTION
  85
  86   txExpandedName mName;
  87 };
  88
  89 class txCheckParam : public txInstruction {
  90  public:
  91   explicit txCheckParam(const txExpandedName& aName);
  92
  93   TX_DECL_TXINSTRUCTION
  94
  95   txExpandedName mName;
  96   txInstruction* mBailTarget;
  97 };
  98
  99 class txConditionalGoto : public txInstruction {
 100  public:
 101   txConditionalGoto(mozilla::UniquePtr<Expr>&& aCondition,
 102                     txInstruction* aTarget);
 103
 104   TX_DECL_TXINSTRUCTION
 105
 106   mozilla::UniquePtr<Expr> mCondition;
 107   txInstruction* mTarget;
 108 };
 109
 110 class txComment : public txInstruction {
 111  public:
 112   TX_DECL_TXINSTRUCTION
 113 };
 114
 115 class txCopyBase : public txInstruction {
 116  protected:
 117   nsresult copyNode(const txXPathNode& aNode, txExecutionState& aEs);
 118 };
 119
 120 class txCopy : public txCopyBase {
 121  public:
 122   txCopy();
 123
 124   TX_DECL_TXINSTRUCTION
 125
 126   txInstruction* mBailTarget;
 127 };
 128
 129 class txCopyOf : public txCopyBase {
 130  public:
 131   explicit txCopyOf(mozilla::UniquePtr<Expr>&& aSelect);
 132
 133   TX_DECL_TXINSTRUCTION
 134
 135   mozilla::UniquePtr<Expr> mSelect;
 136 };
 137
 138 class txEndElement : public txInstruction {
 139  public:
 140   TX_DECL_TXINSTRUCTION
 141 };
 142
 143 class txErrorInstruction : public txInstruction {
 144  public:
 145   TX_DECL_TXINSTRUCTION
 146 };
 147
 148 class txGoTo : public txInstruction {
 149  public:
 150   explicit txGoTo(txInstruction* aTarget);
 151
 152   TX_DECL_TXINSTRUCTION
 153
 154   txInstruction* mTarget;
 155 };
 156
 157 class txInsertAttrSet : public txInstruction {
 158  public:
 159   explicit txInsertAttrSet(const txExpandedName& aName);
 160
 161   TX_DECL_TXINSTRUCTION
 162
 163   txExpandedName mName;
 164 };
 165
 166 class txLoopNodeSet : public txInstruction {
 167  public:
 168   explicit txLoopNodeSet(txInstruction* aTarget);
 169
 170   TX_DECL_TXINSTRUCTION
 171
 172   txInstruction* mTarget;
 173 };
 174
 175 class txLREAttribute : public txInstruction {
 176  public:
 177   txLREAttribute(int32_t aNamespaceID, nsAtom* aLocalName, nsAtom* aPrefix,
 178                  mozilla::UniquePtr<Expr>&& aValue);
 179
 180   TX_DECL_TXINSTRUCTION
 181
 182   int32_t mNamespaceID;
 183   RefPtr<nsAtom> mLocalName;
 184   RefPtr<nsAtom> mLowercaseLocalName;
 185   RefPtr<nsAtom> mPrefix;
 186   mozilla::UniquePtr<Expr> mValue;
 187 };
 188
 189 class txMessage : public txInstruction {
 190  public:
 191   explicit txMessage(bool aTerminate);
 192
 193   TX_DECL_TXINSTRUCTION
 194
 195   bool mTerminate;
 196 };
 197
 198 class txNumber : public txInstruction {
 199  public:
 200   txNumber(txXSLTNumber::LevelType aLevel,
 201            mozilla::UniquePtr<txPattern>&& aCount,
 202            mozilla::UniquePtr<txPattern>&& aFrom,
 203            mozilla::UniquePtr<Expr>&& aValue,
 204            mozilla::UniquePtr<Expr>&& aFormat,
 205            mozilla::UniquePtr<Expr>&& aGroupingSeparator,
 206            mozilla::UniquePtr<Expr>&& aGroupingSize);
 207
 208   TX_DECL_TXINSTRUCTION
 209
 210   txXSLTNumber::LevelType mLevel;
 211   mozilla::UniquePtr<txPattern> mCount;
 212   mozilla::UniquePtr<txPattern> mFrom;
 213   mozilla::UniquePtr<Expr> mValue;
 214   mozilla::UniquePtr<Expr> mFormat;
 215   mozilla::UniquePtr<Expr> mGroupingSeparator;
 216   mozilla::UniquePtr<Expr> mGroupingSize;
 217 };
 218
 219 class txPopParams : public txInstruction {
 220  public:
 221   TX_DECL_TXINSTRUCTION
 222 };
 223
 224 class txProcessingInstruction : public txInstruction {
 225  public:
 226   explicit txProcessingInstruction(mozilla::UniquePtr<Expr>&& aName);
 227
 228   TX_DECL_TXINSTRUCTION
 229
 230   mozilla::UniquePtr<Expr> mName;
 231 };
 232
 233 class txPushNewContext : public txInstruction {
 234  public:
 235   explicit txPushNewContext(mozilla::UniquePtr<Expr>&& aSelect);
 236   ~txPushNewContext();
 237
 238   TX_DECL_TXINSTRUCTION
 239
 240   void addSort(mozilla::UniquePtr<Expr>&& aSelectExpr,
 241                mozilla::UniquePtr<Expr>&& aLangExpr,
 242                mozilla::UniquePtr<Expr>&& aDataTypeExpr,
 243                mozilla::UniquePtr<Expr>&& aOrderExpr,
 244                mozilla::UniquePtr<Expr>&& aCaseOrderExpr);
 245
 246   struct SortKey {
 247     mozilla::UniquePtr<Expr> mSelectExpr;
 248     mozilla::UniquePtr<Expr> mLangExpr;
 249     mozilla::UniquePtr<Expr> mDataTypeExpr;
 250     mozilla::UniquePtr<Expr> mOrderExpr;
 251     mozilla::UniquePtr<Expr> mCaseOrderExpr;
 252   };
 253
 254   nsTArray<SortKey> mSortKeys;
 255   mozilla::UniquePtr<Expr> mSelect;
 256   txInstruction* mBailTarget;
 257 };
 258
 259 class txPushNullTemplateRule : public txInstruction {
 260  public:
 261   TX_DECL_TXINSTRUCTION
 262 };
 263
 264 class txPushParams : public txInstruction {
 265  public:
 266   TX_DECL_TXINSTRUCTION
 267 };
 268
 269 class txPushRTFHandler : public txInstruction {
 270  public:
 271   TX_DECL_TXINSTRUCTION
 272 };
 273
 274 class txPushStringHandler : public txInstruction {
 275  public:
 276   explicit txPushStringHandler(bool aOnlyText);
 277
 278   TX_DECL_TXINSTRUCTION
 279
 280   bool mOnlyText;
 281 };
 282
 283 class txRemoveVariable : public txInstruction {
 284  public:
 285   explicit txRemoveVariable(const txExpandedName& aName);
 286
 287   TX_DECL_TXINSTRUCTION
 288
 289   txExpandedName mName;
 290 };
 291
 292 class txReturn : public txInstruction {
 293  public:
 294   TX_DECL_TXINSTRUCTION
 295 };
 296
 297 class txSetParam : public txInstruction {
 298  public:
 299   txSetParam(const txExpandedName& aName, mozilla::UniquePtr<Expr>&& aValue);
 300
 301   TX_DECL_TXINSTRUCTION
 302
 303   txExpandedName mName;
 304   mozilla::UniquePtr<Expr> mValue;
 305 };
 306
 307 class txSetVariable : public txInstruction {
 308  public:
 309   txSetVariable(const txExpandedName& aName, mozilla::UniquePtr<Expr>&& aValue);
 310
 311   TX_DECL_TXINSTRUCTION
 312
 313   txExpandedName mName;
 314   mozilla::UniquePtr<Expr> mValue;
 315 };
 316
 317 class txStartElement : public txInstruction {
 318  public:
 319   txStartElement(mozilla::UniquePtr<Expr>&& aName,
 320                  mozilla::UniquePtr<Expr>&& aNamespace,
 321                  txNamespaceMap* aMappings);
 322
 323   TX_DECL_TXINSTRUCTION
 324
 325   mozilla::UniquePtr<Expr> mName;
 326   mozilla::UniquePtr<Expr> mNamespace;
 327   RefPtr<txNamespaceMap> mMappings;
 328 };
 329
 330 class txStartLREElement : public txInstruction {
 331  public:
 332   txStartLREElement(int32_t aNamespaceID, nsAtom* aLocalName, nsAtom* aPrefix);
 333
 334   TX_DECL_TXINSTRUCTION
 335
 336   int32_t mNamespaceID;
 337   RefPtr<nsAtom> mLocalName;
 338   RefPtr<nsAtom> mLowercaseLocalName;
 339   RefPtr<nsAtom> mPrefix;
 340 };
 341
 342 class txText : public txInstruction {
 343  public:
 344   txText(const nsAString& aStr, bool aDOE);
 345
 346   TX_DECL_TXINSTRUCTION
 347
 348   nsString mStr;
 349   bool mDOE;
 350 };
 351
 352 class txValueOf : public txInstruction {
 353  public:
 354   txValueOf(mozilla::UniquePtr<Expr>&& aExpr, bool aDOE);
 355
 356   TX_DECL_TXINSTRUCTION
 357
 358   mozilla::UniquePtr<Expr> mExpr;
 359   bool mDOE;
 360 };
 361
 362 #endif  // TRANSFRMX_TXINSTRUCTIONS_H