1
0
Fork 0
arangodb/arangod/Aql/WalkerWorker.h

128 lines
3.4 KiB
C++

////////////////////////////////////////////////////////////////////////////////
/// @brief recursive execution plan walker
///
/// @file
///
/// DISCLAIMER
///
/// Copyright 2010-2014 triagens GmbH, Cologne, Germany
///
/// 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.
///
/// Copyright holder is triAGENS GmbH, Cologne, Germany
///
/// @author Max Neunhoeffer
/// @author Copyright 2014, triagens GmbH, Cologne, Germany
////////////////////////////////////////////////////////////////////////////////
#ifndef ARANGODB_AQL_WALKER_WORKER_H
#define ARANGODB_AQL_WALKER_WORKER_H 1
#include "Basics/Common.h"
namespace triagens {
namespace aql {
////////////////////////////////////////////////////////////////////////////////
/// @brief functionality to walk an execution plan recursively
////////////////////////////////////////////////////////////////////////////////
template<class T> class WalkerWorker {
// -----------------------------------------------------------------------------
// --SECTION-- constructors / destructors
// -----------------------------------------------------------------------------
public:
WalkerWorker () {
}
virtual ~WalkerWorker () {
}
// -----------------------------------------------------------------------------
// --SECTION-- public functions
// -----------------------------------------------------------------------------
virtual bool before (T*) {
return false; // true to abort the whole walking process
}
virtual void after (T*) {
}
virtual bool enterSubquery (T*, T*) { // super, sub
return true;
}
virtual void leaveSubquery (T*, // super,
T* // sub
) {
}
#ifdef TRI_ENABLE_FAILURE_TESTS
bool done (T* en) {
// make sure a node is only processed once
if (_done.find(en) == _done.end()) {
_done.emplace(en);
return false;
}
TRI_ASSERT(false);
return true;
}
void reset () {
_done.clear();
}
#else
// this is a no-op in non-failure mode
bool done (T*) {
return false;
}
// this is a no-op in non-failure mode
void reset () {
}
#endif
// -----------------------------------------------------------------------------
// --SECTION-- private variables
// -----------------------------------------------------------------------------
private:
#ifdef TRI_ENABLE_FAILURE_TESTS
std::unordered_set<T*> _done;
#endif
};
}
}
#endif
// Local Variables:
// mode: outline-minor
// outline-regexp: "^\\(/// @brief\\|/// {@inheritDoc}\\|/// @addtogroup\\|// --SECTION--\\|/// @\\}\\)"
// End: