.. _program_listing_file__tmp_ws_src_osrf_testing_tools_cpp_osrf_testing_tools_cpp_include_osrf_testing_tools_cpp_memory_tools_testing_helpers.hpp:

Program Listing for File testing_helpers.hpp
============================================

|exhale_lsh| :ref:`Return to documentation for file <file__tmp_ws_src_osrf_testing_tools_cpp_osrf_testing_tools_cpp_include_osrf_testing_tools_cpp_memory_tools_testing_helpers.hpp>` (``/tmp/ws/src/osrf_testing_tools_cpp/osrf_testing_tools_cpp/include/osrf_testing_tools_cpp/memory_tools/testing_helpers.hpp``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   // Copyright 2018 Open Source Robotics Foundation, Inc.
   //
   // 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.
   
   #ifndef OSRF_TESTING_TOOLS_CPP__MEMORY_TOOLS__TESTING_HELPERS_HPP_
   #define OSRF_TESTING_TOOLS_CPP__MEMORY_TOOLS__TESTING_HELPERS_HPP_
   
   #include "./register_hooks.hpp"
   #include "./visibility_control.hpp"
   
   namespace osrf_testing_tools_cpp
   {
   namespace memory_tools
   {
   
   
   OSRF_TESTING_TOOLS_CPP_MEMORY_TOOLS_PUBLIC
   void
   on_unexpected_malloc(AnyMemoryToolsCallback callback);
   
   #define EXPECT_NO_MALLOC(statements) \
     osrf_testing_tools_cpp::memory_tools::expect_no_malloc_begin(); \
     statements; \
     osrf_testing_tools_cpp::memory_tools::expect_no_malloc_end()
   
   OSRF_TESTING_TOOLS_CPP_MEMORY_TOOLS_PUBLIC
   bool
   malloc_expected();
   
   OSRF_TESTING_TOOLS_CPP_MEMORY_TOOLS_PUBLIC
   void
   expect_no_malloc_begin();
   
   OSRF_TESTING_TOOLS_CPP_MEMORY_TOOLS_PUBLIC
   void
   expect_no_malloc_end();
   
   
   OSRF_TESTING_TOOLS_CPP_MEMORY_TOOLS_PUBLIC
   void
   on_unexpected_realloc(AnyMemoryToolsCallback callback);
   
   #define EXPECT_NO_REALLOC(statements) \
     osrf_testing_tools_cpp::memory_tools::expect_no_realloc_begin(); \
     statements; \
     osrf_testing_tools_cpp::memory_tools::expect_no_realloc_end()
   
   OSRF_TESTING_TOOLS_CPP_MEMORY_TOOLS_PUBLIC
   bool
   realloc_expected();
   
   OSRF_TESTING_TOOLS_CPP_MEMORY_TOOLS_PUBLIC
   void
   expect_no_realloc_begin();
   
   OSRF_TESTING_TOOLS_CPP_MEMORY_TOOLS_PUBLIC
   void
   expect_no_realloc_end();
   
   
   OSRF_TESTING_TOOLS_CPP_MEMORY_TOOLS_PUBLIC
   void
   on_unexpected_calloc(AnyMemoryToolsCallback callback);
   
   #define EXPECT_NO_CALLOC(statements) \
     osrf_testing_tools_cpp::memory_tools::expect_no_calloc_begin(); \
     statements; \
     osrf_testing_tools_cpp::memory_tools::expect_no_calloc_end()
   
   OSRF_TESTING_TOOLS_CPP_MEMORY_TOOLS_PUBLIC
   bool
   calloc_expected();
   
   OSRF_TESTING_TOOLS_CPP_MEMORY_TOOLS_PUBLIC
   void
   expect_no_calloc_begin();
   
   OSRF_TESTING_TOOLS_CPP_MEMORY_TOOLS_PUBLIC
   void
   expect_no_calloc_end();
   
   
   OSRF_TESTING_TOOLS_CPP_MEMORY_TOOLS_PUBLIC
   void
   on_unexpected_free(AnyMemoryToolsCallback callback);
   
   #define EXPECT_NO_FREE(statements) \
     osrf_testing_tools_cpp::memory_tools::expect_no_free_begin(); \
     statements; \
     osrf_testing_tools_cpp::memory_tools::expect_no_free_end()
   
   OSRF_TESTING_TOOLS_CPP_MEMORY_TOOLS_PUBLIC
   bool
   free_expected();
   
   OSRF_TESTING_TOOLS_CPP_MEMORY_TOOLS_PUBLIC
   void
   expect_no_free_begin();
   
   OSRF_TESTING_TOOLS_CPP_MEMORY_TOOLS_PUBLIC
   void
   expect_no_free_end();
   
   #define EXPECT_NO_MEMORY_OPERATIONS_BEGIN() \
     osrf_testing_tools_cpp::memory_tools::expect_no_malloc_begin(); \
     osrf_testing_tools_cpp::memory_tools::expect_no_realloc_begin(); \
     osrf_testing_tools_cpp::memory_tools::expect_no_calloc_begin(); \
     osrf_testing_tools_cpp::memory_tools::expect_no_free_begin()
   
   #define EXPECT_NO_MEMORY_OPERATIONS_END() \
     osrf_testing_tools_cpp::memory_tools::expect_no_malloc_end(); \
     osrf_testing_tools_cpp::memory_tools::expect_no_realloc_end(); \
     osrf_testing_tools_cpp::memory_tools::expect_no_calloc_end(); \
     osrf_testing_tools_cpp::memory_tools::expect_no_free_end()
   
   #define EXPECT_NO_MEMORY_OPERATIONS(statements) \
     EXPECT_NO_MEMORY_OPERATIONS_BEGIN(); \
     statements; \
     EXPECT_NO_MEMORY_OPERATIONS_END()
   
   }  // namespace memory_tools
   }  // namespace osrf_testing_tools_cpp
   
   #endif  // OSRF_TESTING_TOOLS_CPP__MEMORY_TOOLS__TESTING_HELPERS_HPP_