automated-tests/src/dali-toolkit/dali-toolkit-test-utils/test-trace-call-stack.h

   1 #ifndef __TEST_TRACE_CALL_STACK_H__
   2 #define __TEST_TRACE_CALL_STACK_H__
   3
   4 /*
   5  * Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 #include <string>
  22 #include <vector>
  23
  24 namespace Dali
  25 {
  26
  27 /**
  28  * Helper class to track method calls in the abstraction and search for them in test cases
  29  */
  30 class TraceCallStack
  31 {
  32 public:
  33   /**
  34    * Constructor
  35    */
  36   TraceCallStack();
  37
  38   /**
  39    * Destructor
  40    */
  41   ~TraceCallStack();
  42
  43   /**
  44    * Turn on / off tracing
  45    */
  46   void Enable(bool enable);
  47
  48   bool IsEnabled();
  49
  50   /**
  51    * Push a call onto the stack if the trace is active
  52    * @param[in] method The name of the method
  53    * @param[in] params A comma separated list of parameter values
  54    */
  55   void PushCall(std::string method, std::string params);
  56
  57
  58   /**
  59    * Search for a method in the stack
  60    * @param[in] method The name of the method
  61    * @return true if the method was in the stack
  62    */
  63   bool FindMethod(std::string method) const;
  64
  65   /**
  66    * Count how many times a method was called
  67    * @param[in] method The name of the method
  68    * @return The number of times it was called
  69    */
  70   int CountMethod(std::string method) const;
  71
  72   /**
  73    * Search for a method in the stack with the given parameter list
  74    * @param[in] method The name of the method
  75    * @param[in] params A comma separated list of parameter values
  76    * @return true if the method was in the stack
  77    */
  78   bool FindMethodAndParams(std::string method, std::string params) const;
  79
  80   /**
  81    * Test if the given method and parameters are at a given index in the stack
  82    * @param[in] index Index in the call stack
  83    * @param[in] method Name of method to test
  84    * @param[in] params A comma separated list of parameter values to test
  85    */
  86   bool TestMethodAndParams(int index, std::string method, std::string params) const;
  87
  88   /**
  89    * Reset the call stack
  90    */
  91   void Reset();
  92
  93   /**
  94    * Get the call stack
  95    * @return The call stack object (Vector of vector[2] of method/paramlist strings)
  96    */
  97   inline const std::vector< std::vector< std::string > >& GetCallStack() { return mCallStack; }
  98
  99 private:
 100   bool mTraceActive; ///< True if the trace is active
 101   std::vector< std::vector< std::string > > mCallStack; ///< The call stack
 102 };
 103
 104 } // namespace dali
 105
 106 #endif //__TEST_TRACE_CALL_STACK_H__