message_forward.h

00001 /*
00002  * Copyright (C) 2009, Willow Garage, Inc.
00003  *
00004  * Redistribution and use in source and binary forms, with or without
00005  * modification, are permitted provided that the following conditions are met:
00006  *   * Redistributions of source code must retain the above copyright notice,
00007  *     this list of conditions and the following disclaimer.
00008  *   * Redistributions in binary form must reproduce the above copyright
00009  *     notice, this list of conditions and the following disclaimer in the
00010  *     documentation and/or other materials provided with the distribution.
00011  *   * Neither the names of Willow Garage, Inc. nor the names of its
00012  *     contributors may be used to endorse or promote products derived from
00013  *     this software without specific prior written permission.
00014  *
00015  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00016  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00017  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00018  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00019  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00020  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00021  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00022  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00023  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00024  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00025  * POSSIBILITY OF SUCH DAMAGE.
00026  */
00027 
00028 #ifndef ROSLIB_MESSAGE_FORWARD_H
00029 #define ROSLIB_MESSAGE_FORWARD_H
00030 
00031 // Make sure that either __GLIBCXX__ or _LIBCPP_VERSION is defined.
00032 #include <cstddef>
00033 
00034 // C++ standard section 17.4.3.1/1 states that forward declarations of STL types
00035 // that aren't specializations involving user defined types results in undefined
00036 // behavior. Apparently only libc++ has a problem with this and won't compile it.
00037 #ifndef _LIBCPP_VERSION
00038 namespace std
00039 {
00040 template<typename T> class allocator;
00041 }
00042 #else
00043 #include <memory>
00044 #endif
00045 
00046 namespace boost
00047 {
00048 template<typename T> class shared_ptr;
00049 }
00050 
00051 /**
00052  * \brief Forward-declare a message, including Ptr and ConstPtr types, with an allocator
00053  *
00054  * \param msg The "base" message type, i.e., the name of the .msg file
00055  * \param new_name The name you'd like the message to have
00056  * \param alloc The allocator to use, e.g. std::allocator
00057  */
00058 #define ROS_DECLARE_MESSAGE_WITH_ALLOCATOR(msg, new_name, alloc) \
00059   template<class Allocator> struct msg##_; \
00060   typedef msg##_<alloc<void> > new_name; \
00061   typedef boost::shared_ptr<new_name> new_name##Ptr; \
00062   typedef boost::shared_ptr<new_name const> new_name##ConstPtr;
00063 
00064 /**
00065  * \brief Forward-declare a message, including Ptr and ConstPtr types, using std::allocator
00066  * \param msg The "base" message type, i.e. the name of the .msg file
00067  */
00068 #define ROS_DECLARE_MESSAGE(msg) ROS_DECLARE_MESSAGE_WITH_ALLOCATOR(msg, msg, std::allocator)
00069 
00070 #endif // ROSLIB_MESSAGE_FORWARD_H