blob: a4f61e34a82b79f6246729303ff188134adb8cac [file] [log] [blame]
Alexander Afanasyevc169a812014-05-20 20:37:29 -04001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
Jeff Thompson47eecfc2013-07-07 22:56:46 -07002/**
Alexander Afanasyevc169a812014-05-20 20:37:29 -04003 * Copyright (c) 2013-2014 Regents of the University of California.
Alexander Afanasyevdfa52c42014-04-24 21:10:11 -07004 *
5 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
Alexander Afanasyevdfa52c42014-04-24 21:10:11 -07006 *
Alexander Afanasyevc169a812014-05-20 20:37:29 -04007 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8 * terms of the GNU Lesser General Public License as published by the Free Software
9 * Foundation, either version 3 of the License, or (at your option) any later version.
10 *
11 * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14 *
15 * You should have received copies of the GNU General Public License and GNU Lesser
16 * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17 * <http://www.gnu.org/licenses/>.
18 *
19 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
Jeff Thompson571f3522013-07-07 22:39:31 -070020 */
21
Junxiao Shib8901b22014-12-13 23:29:10 -070022/** \file
23 * \brief import common constructs for ndn-cxx library internal use
24 * \warning This file is implementation detail of ndn-cxx library.
25 * Aliases imported in this file SHOULD NOT be used outside of ndn-cxx.
26 */
27
Jeff Thompson571f3522013-07-07 22:39:31 -070028#ifndef NDN_COMMON_HPP
29#define NDN_COMMON_HPP
30
Alexander Afanasyev766cea72014-04-24 19:16:42 -070031#include "ndn-cxx-config.hpp"
Alexander Afanasyev258ec2b2014-05-14 16:15:37 -070032
Junxiao Shi99848502014-10-13 19:22:22 -070033// ndn-cxx specific macros declared in this and other headers must have NDN_CXX_ prefix
34// to avoid conflicts with other projects that include ndn-cxx headers.
Jiewen Tan99135962014-09-20 02:18:53 -070035#ifdef NDN_CXX_HAVE_TESTS
Junxiao Shi99848502014-10-13 19:22:22 -070036#define NDN_CXX_VIRTUAL_WITH_TESTS virtual
37#define NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PROTECTED public
38#define NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE public
39#define NDN_CXX_PROTECTED_WITH_TESTS_ELSE_PRIVATE protected
Jiewen Tan99135962014-09-20 02:18:53 -070040#else
Junxiao Shi99848502014-10-13 19:22:22 -070041#define NDN_CXX_VIRTUAL_WITH_TESTS
42#define NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PROTECTED protected
43#define NDN_CXX_PUBLIC_WITH_TESTS_ELSE_PRIVATE private
44#define NDN_CXX_PROTECTED_WITH_TESTS_ELSE_PRIVATE private
Jiewen Tan99135962014-09-20 02:18:53 -070045#endif
46
Junxiao Shi895395f2015-03-03 22:38:56 -070047/** \def NDN_CXX_DECL_OVERRIDE
48 * \brief expands to 'override' if compiler supports this feature, otherwise expands to nothing
49 */
50/** \def NDN_CXX_DECL_FINAL
51 * \brief expands to 'final' if compiler supports this feature, otherwise expands to nothing
52 */
53#ifdef NDN_CXX_HAVE_CXX_OVERRIDE_FINAL
54#define NDN_CXX_DECL_OVERRIDE override
Junxiao Shiac1a6532015-04-30 17:34:31 -070055#define NDN_CXX_DECL_FINAL final
Junxiao Shi895395f2015-03-03 22:38:56 -070056#else
57#define NDN_CXX_DECL_OVERRIDE
58#define NDN_CXX_DECL_FINAL
59#endif
60
Davide Pesaventodfe9c6b2014-08-25 21:17:10 +020061// require C++11
62#if __cplusplus < 201103L && !defined(__GXX_EXPERIMENTAL_CXX0X__)
63# error "ndn-cxx applications must be compiled using the C++11 standard"
64#endif
65
66#include <cstddef>
67#include <cstdint>
68#include <cstring>
69#include <functional>
70#include <limits>
71#include <memory>
72#include <stdexcept>
73#include <string>
Junxiao Shic2b8d242014-11-04 08:35:29 -070074#include <type_traits>
Alexander Afanasyeve2dcdfd2014-02-07 15:53:28 -080075#include <unistd.h>
76
Steve DiBenedettoc145d492014-03-11 16:35:45 -060077#if defined(__GNUC__) || defined(__clang__)
Davide Pesaventodfe9c6b2014-08-25 21:17:10 +020078# define DEPRECATED(func) func __attribute__ ((deprecated))
Steve DiBenedettoc145d492014-03-11 16:35:45 -060079#elif defined(_MSC_VER)
Davide Pesaventodfe9c6b2014-08-25 21:17:10 +020080# define DEPRECATED(func) __declspec(deprecated) func
Steve DiBenedettoc145d492014-03-11 16:35:45 -060081#else
Davide Pesaventodfe9c6b2014-08-25 21:17:10 +020082# pragma message("DEPRECATED not implemented")
83# define DEPRECATED(func) func
Steve DiBenedettoc145d492014-03-11 16:35:45 -060084#endif
85
Alexander Afanasyev49bb1fb2014-07-21 12:54:01 -070086namespace ndn {
87
Alexander Afanasyev19508852014-01-29 01:01:51 -080088using std::shared_ptr;
Davide Pesaventodfe9c6b2014-08-25 21:17:10 +020089using std::unique_ptr;
Alexander Afanasyevb78bc4d2014-04-09 21:20:52 -070090using std::weak_ptr;
Alexander Afanasyev6a05b4b2014-07-18 17:23:00 -070091using std::bad_weak_ptr;
Alexander Afanasyev19508852014-01-29 01:01:51 -080092using std::make_shared;
93using std::enable_shared_from_this;
94
Alexander Afanasyev15151312014-02-16 00:53:51 -080095using std::static_pointer_cast;
96using std::dynamic_pointer_cast;
97using std::const_pointer_cast;
98
Alexander Afanasyev19508852014-01-29 01:01:51 -080099using std::function;
100using std::bind;
Alexander Afanasyevb67090a2014-04-29 22:31:01 -0700101using std::ref;
102using std::cref;
Alexander Afanasyev19508852014-01-29 01:01:51 -0800103
104} // namespace ndn
105
Junxiao Shi95fdebe2014-11-08 23:45:03 -0700106// Bug 2109 workaround
107using namespace std::placeholders;
108#define BOOST_BIND_NO_PLACEHOLDERS
109#include <boost/is_placeholder.hpp>
110namespace boost {
111#define NDN_CXX_SPECIALIZE_BOOST_IS_PLACEHOLDER_FOR_STD_PLACEHOLDER(N) \
112 template<> \
113 struct is_placeholder<typename std::remove_const<decltype(_##N)>::type> \
114 { \
115 enum _vt { \
116 value = N \
117 }; \
118 };
119NDN_CXX_SPECIALIZE_BOOST_IS_PLACEHOLDER_FOR_STD_PLACEHOLDER(1)
120NDN_CXX_SPECIALIZE_BOOST_IS_PLACEHOLDER_FOR_STD_PLACEHOLDER(2)
121NDN_CXX_SPECIALIZE_BOOST_IS_PLACEHOLDER_FOR_STD_PLACEHOLDER(3)
122NDN_CXX_SPECIALIZE_BOOST_IS_PLACEHOLDER_FOR_STD_PLACEHOLDER(4)
123NDN_CXX_SPECIALIZE_BOOST_IS_PLACEHOLDER_FOR_STD_PLACEHOLDER(5)
124NDN_CXX_SPECIALIZE_BOOST_IS_PLACEHOLDER_FOR_STD_PLACEHOLDER(6)
125NDN_CXX_SPECIALIZE_BOOST_IS_PLACEHOLDER_FOR_STD_PLACEHOLDER(7)
126NDN_CXX_SPECIALIZE_BOOST_IS_PLACEHOLDER_FOR_STD_PLACEHOLDER(8)
127NDN_CXX_SPECIALIZE_BOOST_IS_PLACEHOLDER_FOR_STD_PLACEHOLDER(9)
128#undef NDN_CXX_SPECIALIZE_BOOST_IS_PLACEHOLDER_FOR_STD_PLACEHOLDER
129} // namespace boost
130
Davide Pesaventodfe9c6b2014-08-25 21:17:10 +0200131#include <boost/assert.hpp>
Junxiao Shic2b8d242014-11-04 08:35:29 -0700132#include <boost/concept_check.hpp>
Davide Pesaventodfe9c6b2014-08-25 21:17:10 +0200133#include <boost/noncopyable.hpp>
Alexander Afanasyev19508852014-01-29 01:01:51 -0800134
135namespace ndn {
Alexander Afanasyev233750e2014-02-16 00:50:07 -0800136using boost::noncopyable;
Jeff Thompson51dd5fd2013-07-10 19:27:18 -0700137}
138
Alexander Afanasyev258ec2b2014-05-14 16:15:37 -0700139#endif // NDN_COMMON_HPP