summaryrefslogtreecommitdiffstats
path: root/dom/xslt/xslt/txExecutionState.h
blob: 7a314cf8a4b801c84769fff49eede9fd9741c1fd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef TRANSFRMX_TXEXECUTIONSTATE_H
#define TRANSFRMX_TXEXECUTIONSTATE_H

#include "txCore.h"
#include "txStack.h"
#include "txXMLUtils.h"
#include "txIXPathContext.h"
#include "txVariableMap.h"
#include "nsTHashtable.h"
#include "nsHashKeys.h"
#include "txKey.h"
#include "txStylesheet.h"
#include "txXPathTreeWalker.h"
#include "nsTArray.h"
#include "mozilla/Result.h"

class txAOutputHandlerFactory;
class txAXMLEventHandler;
class txInstruction;

class txLoadedDocumentEntry : public nsStringHashKey {
 public:
  explicit txLoadedDocumentEntry(KeyTypePointer aStr)
      : nsStringHashKey(aStr), mLoadResult(NS_OK) {}
  txLoadedDocumentEntry(txLoadedDocumentEntry&& aOther)
      : nsStringHashKey(std::move(aOther)),
        mDocument(std::move(aOther.mDocument)),
        mLoadResult(std::move(aOther.mLoadResult)) {
    NS_ERROR("We're horked.");
  }
  ~txLoadedDocumentEntry() {
    if (mDocument) {
      txXPathNodeUtils::release(mDocument.get());
    }
  }
  bool LoadingFailed() {
    NS_ASSERTION(NS_SUCCEEDED(mLoadResult) || !mDocument,
                 "Load failed but we still got a document?");

    return NS_FAILED(mLoadResult);
  }

  mozilla::UniquePtr<txXPathNode> mDocument;
  nsresult mLoadResult;
};

class txLoadedDocumentsHash : public nsTHashtable<txLoadedDocumentEntry> {
 public:
  txLoadedDocumentsHash() : nsTHashtable<txLoadedDocumentEntry>(4) {}
  ~txLoadedDocumentsHash();
  [[nodiscard]] nsresult init(const txXPathNode& aSource);

 private:
  friend class txExecutionState;
  mozilla::UniquePtr<txXPathNode> mSourceDocument;
};

class txExecutionState : public txIMatchContext {
 public:
  txExecutionState(txStylesheet* aStylesheet, bool aDisableLoads);
  ~txExecutionState();
  nsresult init(const txXPathNode& aNode,
                txOwningExpandedNameMap<txIGlobalParameter>* aGlobalParams);
  nsresult end(nsresult aResult);

  TX_DECL_MATCH_CONTEXT;

  /**
   * Struct holding information about a current template rule
   */
  class TemplateRule {
   public:
    txStylesheet::ImportFrame* mFrame;
    int32_t mModeNsId;
    RefPtr<nsAtom> mModeLocalName;
    RefPtr<txParameterMap> mParams;
  };

  // Stack functions
  void pushEvalContext(txIEvalContext* aContext);
  txIEvalContext* popEvalContext();

  /**
   * Helper that deletes all entries before |aContext| and then
   * pops it off the stack. The caller must delete |aContext| if
   * desired.
   */
  void popAndDeleteEvalContextUntil(txIEvalContext* aContext);

  void pushBool(bool aBool);
  bool popBool();
  void pushResultHandler(txAXMLEventHandler* aHandler);
  txAXMLEventHandler* popResultHandler();
  void pushTemplateRule(txStylesheet::ImportFrame* aFrame,
                        const txExpandedName& aMode, txParameterMap* aParams);
  void popTemplateRule();
  void pushParamMap(txParameterMap* aParams);
  already_AddRefed<txParameterMap> popParamMap();

  // state-getting functions
  txIEvalContext* getEvalContext();
  const txXPathNode* retrieveDocument(const nsAString& aUri);
  nsresult getKeyNodes(const txExpandedName& aKeyName, const txXPathNode& aRoot,
                       const nsAString& aKeyValue, bool aIndexIfNotFound,
                       txNodeSet** aResult);
  TemplateRule* getCurrentTemplateRule();
  const txXPathNode& getSourceDocument() {
    NS_ASSERTION(mLoadedDocuments.mSourceDocument, "Need a source document!");

    return *mLoadedDocuments.mSourceDocument;
  }

  // state-modification functions
  mozilla::Result<txInstruction*, nsresult> getNextInstruction();
  nsresult runTemplate(txInstruction* aInstruction);
  nsresult runTemplate(txInstruction* aInstruction, txInstruction* aReturnTo);
  void gotoInstruction(txInstruction* aNext);
  void returnFromTemplate();
  nsresult bindVariable(const txExpandedName& aName, txAExprResult* aValue);
  void removeVariable(const txExpandedName& aName);
  void stopProcessing() { mStopProcessing = true; }

  txAXMLEventHandler* mOutputHandler;
  txAXMLEventHandler* mResultHandler;
  mozilla::UniquePtr<txAXMLEventHandler> mObsoleteHandler;
  txAOutputHandlerFactory* mOutputHandlerFactory;

  RefPtr<txParameterMap> mTemplateParams;

  RefPtr<txStylesheet> mStylesheet;

 private:
  txStack mReturnStack;
  txStack mLocalVarsStack;
  txStack mEvalContextStack;
  nsTArray<bool> mBoolStack;
  txStack mResultHandlerStack;
  nsTArray<RefPtr<txParameterMap>> mParamStack;
  txInstruction* mNextInstruction;
  txVariableMap* mLocalVariables;
  txVariableMap mGlobalVariableValues;
  RefPtr<txAExprResult> mGlobalVarPlaceholderValue;
  int32_t mRecursionDepth;

  AutoTArray<TemplateRule, 10> mTemplateRules;

  txIEvalContext* mEvalContext;
  txIEvalContext* mInitialEvalContext;
  // Document* mRTFDocument;
  txOwningExpandedNameMap<txIGlobalParameter>* mGlobalParams;

  txLoadedDocumentsHash mLoadedDocuments;
  txKeyHash mKeyHash;
  RefPtr<txResultRecycler> mRecycler;
  bool mDisableLoads;
  bool mStopProcessing = false;

  static const int32_t kMaxRecursionDepth;
};

#endif