blob: c44fed4cd422a3d47742044a4197bfb09f8c1a7f [file] [log] [blame]
Davide Pesavento5ee8ec02018-09-01 19:06:12 -04001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2013-2018 Regents of the University of California.
4 *
5 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6 *
7 * 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.
20 */
21
22#ifndef NDN_UTIL_CF_STRING_OSX_HPP
23#define NDN_UTIL_CF_STRING_OSX_HPP
24
25#include "../common.hpp"
26
27#ifndef NDN_CXX_HAVE_OSX_FRAMEWORKS
28#error "This file should not be included ..."
29#endif
30
31#include "cf-releaser-osx.hpp"
32
33/**
34 * @file
35 *
36 * This file contains utilities to deal with Apple Core Foundation's CFString and related types.
37 */
38
39namespace ndn {
40namespace util {
41namespace cfstring {
42
43/**
44 * @brief Create a CFString by copying bytes from a raw buffer
45 * @throw std::runtime_error creation failed
46 */
47CFReleaser<CFStringRef>
48fromBuffer(const uint8_t* buf, size_t buflen);
49
50/**
51 * @brief Create a CFString by copying characters from a std::string
52 * @throw std::runtime_error creation failed
53 */
54CFReleaser<CFStringRef>
55fromStdString(const std::string& str);
56
57/**
58 * @brief Convert a CFString to a std::string
59 * @throw std::runtime_error conversion failed
60 */
61std::string
62toStdString(CFStringRef cfStr);
63
64} // namespace cfstring
65} // namespace util
66} // namespace ndn
67
68#endif // NDN_UTIL_CF_STRING_OSX_HPP