/usr/include/boost/log/utility/string_literal.hpp is in libboost1.55-dev 1.55.0+dfsg-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 | /*
* Copyright Andrey Semashev 2007 - 2013.
* Distributed under the Boost Software License, Version 1.0.
* (See accompanying file LICENSE_1_0.txt or copy at
* http://www.boost.org/LICENSE_1_0.txt)
*/
/*!
* \file string_literal.hpp
* \author Andrey Semashev
* \date 24.06.2007
*
* The header contains implementation of a constant string literal wrapper.
*/
#ifndef BOOST_LOG_UTILITY_STRING_LITERAL_HPP_INCLUDED_
#define BOOST_LOG_UTILITY_STRING_LITERAL_HPP_INCLUDED_
#include <cstddef>
#include <stdexcept>
#include <iosfwd>
#include <string>
#include <iterator>
#include <boost/operators.hpp>
#include <boost/throw_exception.hpp>
#include <boost/type_traits/is_same.hpp>
#include <boost/utility/enable_if.hpp>
#include <boost/log/detail/config.hpp>
#include <boost/log/utility/string_literal_fwd.hpp>
#include <boost/log/detail/header.hpp>
#ifdef BOOST_HAS_PRAGMA_ONCE
#pragma once
#endif
namespace boost {
BOOST_LOG_OPEN_NAMESPACE
/*!
* \brief String literal wrapper
*
* The \c basic_string_literal is a thin wrapper around a constant string literal.
* It provides interface similar to STL strings, but because of read-only nature
* of string literals, lacks ability to modify string contents. However,
* \c basic_string_literal objects can be assigned to and cleared.
*
* The main advantage of this class comparing to other string classes is that
* it doesn't dynamically allocate memory and therefore is fast, thin and exception safe.
*/
template< typename CharT, typename TraitsT >
class basic_string_literal
//! \cond
: public totally_ordered1< basic_string_literal< CharT, TraitsT >,
totally_ordered2< basic_string_literal< CharT, TraitsT >, const CharT*,
totally_ordered2<
basic_string_literal< CharT, TraitsT >,
std::basic_string< CharT, TraitsT >
>
>
>
//! \endcond
{
//! Self type
typedef basic_string_literal< CharT, TraitsT > this_type;
public:
typedef CharT value_type;
typedef TraitsT traits_type;
typedef std::size_t size_type;
typedef std::ptrdiff_t difference_type;
typedef const value_type* const_pointer;
typedef value_type const& const_reference;
typedef const value_type* const_iterator;
typedef std::reverse_iterator< const_iterator > const_reverse_iterator;
//! Corresponding STL string type
typedef std::basic_string< value_type, traits_type > string_type;
private:
//! Pointer to the beginning of the literal
const_pointer m_pStart;
//! Length
size_type m_Len;
//! Empty string literal to support clear
static const value_type g_EmptyString[1];
public:
/*!
* Constructor
*
* \post <tt>empty() == true</tt>
*/
basic_string_literal() BOOST_NOEXCEPT { clear(); }
/*!
* Constructor from a string literal
*
* \post <tt>*this == p</tt>
* \param p A zero-terminated constant sequence of characters
*/
template< typename T, size_type LenV >
basic_string_literal(T(&p)[LenV]
//! \cond
, typename enable_if< is_same< T, const value_type >, int >::type = 0
//! \endcond
) BOOST_NOEXCEPT
: m_pStart(p), m_Len(LenV - 1)
{
}
/*!
* Copy constructor
*
* \post <tt>*this == that</tt>
* \param that Source literal to copy string from
*/
basic_string_literal(basic_string_literal const& that) BOOST_NOEXCEPT : m_pStart(that.m_pStart), m_Len(that.m_Len) {}
/*!
* Assignment operator
*
* \post <tt>*this == that</tt>
* \param that Source literal to copy string from
*/
this_type& operator= (this_type const& that) BOOST_NOEXCEPT
{
return assign(that);
}
/*!
* Assignment from a string literal
*
* \post <tt>*this == p</tt>
* \param p A zero-terminated constant sequence of characters
*/
template< typename T, size_type LenV >
#ifndef BOOST_LOG_DOXYGEN_PASS
typename enable_if<
is_same< T, const value_type >,
this_type&
>::type
#else
this_type&
#endif // BOOST_LOG_DOXYGEN_PASS
operator= (T(&p)[LenV]) BOOST_NOEXCEPT
{
return assign(p);
}
/*!
* Lexicographical comparison (equality)
*
* \param that Comparand
* \return \c true if the comparand string equals to this string, \c false otherwise
*/
bool operator== (this_type const& that) const BOOST_NOEXCEPT
{
return (compare_internal(m_pStart, m_Len, that.m_pStart, that.m_Len) == 0);
}
/*!
* Lexicographical comparison (equality)
*
* \param str Comparand. Must point to a zero-terminated sequence of characters, must not be NULL.
* \return \c true if the comparand string equals to this string, \c false otherwise
*/
bool operator== (const_pointer str) const BOOST_NOEXCEPT
{
return (compare_internal(m_pStart, m_Len, str, traits_type::length(str)) == 0);
}
/*!
* Lexicographical comparison (equality)
*
* \param that Comparand
* \return \c true if the comparand string equals to this string, \c false otherwise
*/
bool operator== (string_type const& that) const
{
return (compare_internal(m_pStart, m_Len, that.c_str(), that.size()) == 0);
}
/*!
* Lexicographical comparison (less ordering)
*
* \param that Comparand
* \return \c true if this string is less than the comparand, \c false otherwise
*/
bool operator< (this_type const& that) const BOOST_NOEXCEPT
{
return (compare_internal(m_pStart, m_Len, that.m_pStart, that.m_Len) < 0);
}
/*!
* Lexicographical comparison (less ordering)
*
* \param str Comparand. Must point to a zero-terminated sequence of characters, must not be NULL.
* \return \c true if this string is less than the comparand, \c false otherwise
*/
bool operator< (const_pointer str) const BOOST_NOEXCEPT
{
return (compare_internal(m_pStart, m_Len, str, traits_type::length(str)) < 0);
}
/*!
* Lexicographical comparison (less ordering)
*
* \param that Comparand
* \return \c true if this string is less than the comparand, \c false otherwise
*/
bool operator< (string_type const& that) const
{
return (compare_internal(m_pStart, m_Len, that.c_str(), that.size()) < 0);
}
/*!
* Lexicographical comparison (greater ordering)
*
* \param that Comparand
* \return \c true if this string is greater than the comparand, \c false otherwise
*/
bool operator> (this_type const& that) const BOOST_NOEXCEPT
{
return (compare_internal(m_pStart, m_Len, that.m_pStart, that.m_Len) > 0);
}
/*!
* Lexicographical comparison (greater ordering)
*
* \param str Comparand. Must point to a zero-terminated sequence of characters, must not be NULL.
* \return \c true if this string is greater than the comparand, \c false otherwise
*/
bool operator> (const_pointer str) const BOOST_NOEXCEPT
{
return (compare_internal(m_pStart, m_Len, str, traits_type::length(str)) > 0);
}
/*!
* Lexicographical comparison (greater ordering)
*
* \param that Comparand
* \return \c true if this string is greater than the comparand, \c false otherwise
*/
bool operator> (string_type const& that) const
{
return (compare_internal(m_pStart, m_Len, that.c_str(), that.size()) > 0);
}
/*!
* Subscript operator
*
* \pre <tt>i < size()</tt>
* \param i Requested character index
* \return Constant reference to the requested character
*/
const_reference operator[] (size_type i) const BOOST_NOEXCEPT
{
return m_pStart[i];
}
/*!
* Checked subscript
*
* \param i Requested character index
* \return Constant reference to the requested character
*
* \b Throws: An <tt>std::exception</tt>-based exception if index \a i is out of string boundaries
*/
const_reference at(size_type i) const
{
if (i >= m_Len)
BOOST_THROW_EXCEPTION(std::out_of_range("basic_string_literal::at: the index value is out of range"));
return m_pStart[i];
}
/*!
* \return Pointer to the beginning of the literal
*/
const_pointer c_str() const BOOST_NOEXCEPT { return m_pStart; }
/*!
* \return Pointer to the beginning of the literal
*/
const_pointer data() const BOOST_NOEXCEPT { return m_pStart; }
/*!
* \return Length of the literal
*/
size_type size() const BOOST_NOEXCEPT { return m_Len; }
/*!
* \return Length of the literal
*/
size_type length() const BOOST_NOEXCEPT { return m_Len; }
/*!
* \return \c true if the literal is an empty string, \c false otherwise
*/
bool empty() const BOOST_NOEXCEPT
{
return (m_Len == 0);
}
/*!
* \return Iterator that points to the first character of the literal
*/
const_iterator begin() const BOOST_NOEXCEPT { return m_pStart; }
/*!
* \return Iterator that points after the last character of the literal
*/
const_iterator end() const BOOST_NOEXCEPT { return m_pStart + m_Len; }
/*!
* \return Reverse iterator that points to the last character of the literal
*/
const_reverse_iterator rbegin() const BOOST_NOEXCEPT { return const_reverse_iterator(end()); }
/*!
* \return Reverse iterator that points before the first character of the literal
*/
const_reverse_iterator rend() const BOOST_NOEXCEPT { return const_reverse_iterator(begin()); }
/*!
* \return STL string constructed from the literal
*/
string_type str() const
{
return string_type(m_pStart, m_Len);
}
/*!
* The method clears the literal
*
* \post <tt>empty() == true</tt>
*/
void clear() BOOST_NOEXCEPT
{
m_pStart = g_EmptyString;
m_Len = 0;
}
/*!
* The method swaps two literals
*/
void swap(this_type& that) BOOST_NOEXCEPT
{
register const_pointer p = m_pStart;
m_pStart = that.m_pStart;
that.m_pStart = p;
register size_type l = m_Len;
m_Len = that.m_Len;
that.m_Len = l;
}
/*!
* Assignment from another literal
*
* \post <tt>*this == that</tt>
* \param that Source literal to copy string from
*/
this_type& assign(this_type const& that) BOOST_NOEXCEPT
{
m_pStart = that.m_pStart;
m_Len = that.m_Len;
return *this;
}
/*!
* Assignment from another literal
*
* \post <tt>*this == p</tt>
* \param p A zero-terminated constant sequence of characters
*/
template< typename T, size_type LenV >
#ifndef BOOST_LOG_DOXYGEN_PASS
typename enable_if<
is_same< T, const value_type >,
this_type&
>::type
#else
this_type&
#endif // BOOST_LOG_DOXYGEN_PASS
assign(T(&p)[LenV]) BOOST_NOEXCEPT
{
m_pStart = p;
m_Len = LenV - 1;
return *this;
}
/*!
* The method copies the literal or its portion to an external buffer
*
* \pre <tt>pos <= size()</tt>
* \param str Pointer to the external buffer beginning. Must not be NULL.
* The buffer must have enough capacity to accommodate the requested number of characters.
* \param n Maximum number of characters to copy
* \param pos Starting position to start copying from
* \return Number of characters copied
*
* \b Throws: An <tt>std::exception</tt>-based exception if \a pos is out of range.
*/
size_type copy(value_type* str, size_type n, size_type pos = 0) const
{
if (pos > m_Len)
BOOST_THROW_EXCEPTION(std::out_of_range("basic_string_literal::copy: the position is out of range"));
register size_type len = m_Len - pos;
if (len > n)
len = n;
traits_type::copy(str, m_pStart + pos, len);
return len;
}
/*!
* Lexicographically compares the argument string to a part of this string
*
* \pre <tt>pos <= size()</tt>
* \param pos Starting position within this string to perform comparison to
* \param n Length of the substring of this string to perform comparison to
* \param str Comparand. Must point to a sequence of characters, must not be NULL.
* \param len Number of characters in the sequence \a str.
* \return Zero if the comparand equals this string, a negative value if this string is less than the comparand,
* a positive value if this string is greater than the comparand.
*
* \b Throws: An <tt>std::exception</tt>-based exception if \a pos is out of range.
*/
int compare(size_type pos, size_type n, const_pointer str, size_type len) const
{
if (pos > m_Len)
BOOST_THROW_EXCEPTION(std::out_of_range("basic_string_literal::compare: the position is out of range"));
register size_type compare_size = m_Len - pos;
if (compare_size > len)
compare_size = len;
if (compare_size > n)
compare_size = n;
return compare_internal(m_pStart + pos, compare_size, str, compare_size);
}
/*!
* Lexicographically compares the argument string to a part of this string
*
* \pre <tt>pos <= size()</tt>
* \param pos Starting position within this string to perform comparison to
* \param n Length of the substring of this string to perform comparison to
* \param str Comparand. Must point to a zero-terminated sequence of characters, must not be NULL.
* \return Zero if the comparand equals this string, a negative value if this string is less than the comparand,
* a positive value if this string is greater than the comparand.
*
* \b Throws: An <tt>std::exception</tt>-based exception if \a pos is out of range.
*/
int compare(size_type pos, size_type n, const_pointer str) const BOOST_NOEXCEPT
{
return compare(pos, n, str, traits_type::length(str));
}
/*!
* Lexicographically compares the argument string literal to a part of this string
*
* \pre <tt>pos <= size()</tt>
* \param pos Starting position within this string to perform comparison to
* \param n Length of the substring of this string to perform comparison to
* \param that Comparand
* \return Zero if the comparand equals this string, a negative value if this string is less than the comparand,
* a positive value if this string is greater than the comparand.
*
* \b Throws: An <tt>std::exception</tt>-based exception if \a pos is out of range.
*/
int compare(size_type pos, size_type n, this_type const& that) const BOOST_NOEXCEPT
{
return compare(pos, n, that.c_str(), that.size());
}
/*!
* Lexicographically compares the argument string to this string
*
* \param str Comparand. Must point to a sequence of characters, must not be NULL.
* \param len Number of characters in the sequence \a str.
* \return Zero if the comparand equals this string, a negative value if this string is less than the comparand,
* a positive value if this string is greater than the comparand.
*/
int compare(const_pointer str, size_type len) const BOOST_NOEXCEPT
{
return compare(0, m_Len, str, len);
}
/*!
* Lexicographically compares the argument string to this string
*
* \param str Comparand. Must point to a zero-terminated sequence of characters, must not be NULL.
* \return Zero if the comparand equals this string, a negative value if this string is less than the comparand,
* a positive value if this string is greater than the comparand.
*/
int compare(const_pointer str) const BOOST_NOEXCEPT
{
return compare(0, m_Len, str, traits_type::length(str));
}
/*!
* Lexicographically compares the argument string to this string
*
* \param that Comparand
* \return Zero if the comparand equals this string, a negative value if this string is less than the comparand,
* a positive value if this string is greater than the comparand.
*/
int compare(this_type const& that) const BOOST_NOEXCEPT
{
return compare(0, m_Len, that.c_str(), that.size());
}
private:
#ifndef BOOST_LOG_DOXYGEN_PASS
//! Internal comparison implementation
static int compare_internal(const_pointer pLeft, size_type LeftLen, const_pointer pRight, size_type RightLen) BOOST_NOEXCEPT
{
if (pLeft != pRight)
{
register const int result = traits_type::compare(
pLeft, pRight, (LeftLen < RightLen ? LeftLen : RightLen));
if (result != 0)
return result;
}
return LeftLen < RightLen ? -1 : (LeftLen > RightLen ? 1 : 0);
}
#endif // BOOST_LOG_DOXYGEN_PASS
};
template< typename CharT, typename TraitsT >
typename basic_string_literal< CharT, TraitsT >::value_type const
basic_string_literal< CharT, TraitsT >::g_EmptyString[1] = { 0 };
namespace aux {
template< typename CharT, typename TraitsT >
inline void insert_fill_chars(std::basic_ostream< CharT, TraitsT >& strm, std::size_t n)
{
enum { chunk_size = 8 };
CharT fill_chars[chunk_size];
const CharT filler = strm.fill();
for (unsigned int i = 0; i < chunk_size; ++i)
fill_chars[i] = filler;
for (; n >= chunk_size && strm.good(); n -= chunk_size)
strm.write(fill_chars, static_cast< std::size_t >(chunk_size));
if (n > 0 && strm.good())
strm.write(fill_chars, n);
}
template< typename CharT, typename TraitsT >
void insert_aligned(std::basic_ostream< CharT, TraitsT >& strm, const CharT* p, std::size_t size)
{
const std::size_t alignment_size = static_cast< std::size_t >(strm.width()) - size;
const bool align_left = (strm.flags() & std::basic_ostream< CharT, TraitsT >::adjustfield) == std::basic_ostream< CharT, TraitsT >::left;
if (align_left)
{
strm.write(p, size);
if (strm.good())
aux::insert_fill_chars(strm, alignment_size);
}
else
{
aux::insert_fill_chars(strm, alignment_size);
if (strm.good())
strm.write(p, size);
}
}
} // namespace aux
//! Output operator
template< typename CharT, typename StrmTraitsT, typename LitTraitsT >
inline std::basic_ostream< CharT, StrmTraitsT >& operator<< (
std::basic_ostream< CharT, StrmTraitsT >& strm, basic_string_literal< CharT, LitTraitsT > const& lit)
{
if (strm.good())
{
const std::size_t size = lit.size();
const std::size_t w = static_cast< std::size_t >(strm.width());
if (w <= size)
strm.write(lit.c_str(), static_cast< std::streamsize >(size));
else
aux::insert_aligned(strm, lit.c_str(), lit.size());
strm.width(0);
}
return strm;
}
//! External swap
template< typename CharT, typename TraitsT >
inline void swap(basic_string_literal< CharT, TraitsT >& left, basic_string_literal< CharT, TraitsT >& right) BOOST_NOEXCEPT
{
left.swap(right);
}
//! Creates a string literal wrapper from a constant string literal
#ifdef BOOST_LOG_USE_CHAR
template< typename T, std::size_t LenV >
inline
#ifndef BOOST_LOG_DOXYGEN_PASS
typename enable_if<
is_same< T, const char >,
string_literal
>::type
#else
basic_string_literal< T >
#endif // BOOST_LOG_DOXYGEN_PASS
str_literal(T(&p)[LenV])
{
return string_literal(p);
}
#endif
#ifndef BOOST_LOG_DOXYGEN_PASS
#ifdef BOOST_LOG_USE_WCHAR_T
template< typename T, std::size_t LenV >
inline typename enable_if<
is_same< T, const wchar_t >,
wstring_literal
>::type
str_literal(T(&p)[LenV])
{
return wstring_literal(p);
}
#endif
#endif // BOOST_LOG_DOXYGEN_PASS
BOOST_LOG_CLOSE_NAMESPACE // namespace log
} // namespace boost
#include <boost/log/detail/footer.hpp>
#endif // BOOST_LOG_UTILITY_STRING_LITERAL_HPP_INCLUDED_
|