/usr/include/dlib/string/string_abstract.h is in libdlib-dev 18.18-1.
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 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 | // Copyright (C) 2006 Davis E. King (davis@dlib.net)
// License: Boost Software License See LICENSE.txt for the full license.
#undef DLIB_STRINg_ABSTRACT_
#ifdef DLIB_STRINg_ABSTRACT_
#include <string>
#include <iostream>
#include <vector>
#include "../error.h"
namespace dlib
{
// ----------------------------------------------------------------------------------------
class string_cast_error : public error
{
public:
string_cast_error():error(ECAST_TO_STRING) {}
};
template <
typename T,
typename charT,
typename traits,
typename alloc
>
const T string_cast (
const std::basic_string<charT,traits,alloc>& str
);
/*!
requires
- T is not a pointer type
ensures
- returns str converted to T
throws
- string_cast_error
This exception is thrown if string_cast() is unable to convert
str into a T. Also, string_cast_error::info == str
!*/
// ----------------------------------------------------------------------------------------
class string_assign
{
/*!
WHAT THIS OBJECT REPRESENTS
This is a simple tool which provides an alternative syntax for using
the string_cast() function. It can be understood by considering
the following example:
string_assign sa;
int val;
double dval;
val = sa = "1234"; // executes: val = string_cast<int>("1234");
dval = sa = "3.141"; // executes: val = string_cast<double>("3.141");
After executing, val will be equal to 1234 and dval will be 3.141.
Note that you can use string_assign to assign to any type which you could
use with string_cast(), except for std::basic_string, assigning to this
type is ambiguous for boring technical reasons. But there isn't much
point in using this tool to assign from one string to another so it doesn't
matter.
Additionally, note that there is a global instance of this object, dlib::sa.
So you never have to create a string_assign object yourself. Finally, this
object is totally stateless and threadsafe.
!*/
};
const string_assign sa = string_assign();
// ----------------------------------------------------------------------------------------
class cast_to_string_error : public error
{
public:
cast_to_string_error():error(ECAST_TO_STRING) {}
};
template <
typename T
>
const std::string cast_to_string (
const T& item
);
/*!
requires
- T is not a pointer type
ensures
- returns item converted to std::string
throws
- cast_to_string_error
This exception is thrown if cast_to_string() is unable to convert
item into a std::string.
!*/
template <
typename T
>
const std::wstring cast_to_wstring (
const T& item
);
/*!
requires
- T is not a pointer type
ensures
- returns item converted to std::wstring
throws
- cast_to_string_error
This exception is thrown if cast_to_string() is unable to convert
item into a std::string.
!*/
// ----------------------------------------------------------------------------------------
std::string pad_int_with_zeros (
int i,
unsigned long width = 6
);
/*!
ensures
- converts i into a string of at least width characters in length. If
necessary, the string will be padded with leading zeros to get
to width characters.
!*/
// ----------------------------------------------------------------------------------------
template <
typename charT,
typename traits,
typename alloc
>
const std::string narrow (
const std::basic_string<charT,traits,alloc>& str
);
/*!
ensures
- returns str as a std::string by converting every character in it to a char.
Note that any characters that do not have a mapping to type char will be
converted to a space.
!*/
// ----------------------------------------------------------------------------------------
template <
typename charT,
typename traits,
typename alloc
>
const std::basic_string<charT,traits,alloc> wrap_string (
const std::basic_string<charT,traits,alloc>& str,
const unsigned long first_pad = 0,
const unsigned long rest_pad = 0,
const unsigned long max_per_line = 79
);
/*!
requires
- first_pad < max_per_line
- rest_pad < max_per_line
- rest_pad >= first_pad
ensures
- returns a copy of str S such that:
- S is broken up into lines separated by the \n character.
- The first line starts with first_pad space characters.
- The second and all subsequent lines start with rest_pad space characters.
- The first line is no longer than max_per_line - (rest_pad-first_pad) characters.
- The second and all subsequent lines are no longer than max_per_line characters.
!*/
// ----------------------------------------------------------------------------------------
template <
typename traits
typename alloc
>
const std::basic_string<char,traits,alloc> tolower (
const std::basic_string<char,traits,alloc>& str
);
/*!
ensures
- returns a copy of str S such that:
- #S.size() == str.size()
- #S[i] == std::tolower(str[i])
!*/
// ----------------------------------------------------------------------------------------
template <
typename traits,
typename alloc
>
const std::basic_string<char,traits,alloc> toupper (
const std::basic_string<char,traits,alloc>& str
);
/*!
ensures
- returns a copy of str S such that:
- #S.size() == str.size()
- #S[i] == std::toupper(str[i])
!*/
// ----------------------------------------------------------------------------------------
template <
typename traits,
typename alloc
>
bool strings_equal_ignore_case (
const std::basic_string<char,traits,alloc>& str1,
const std::basic_string<char,traits,alloc>& str2
);
/*!
ensures
- returns tolower(str1) == tolower(str2)
!*/
// ----------------------------------------------------------------------------------------
template <
typename traits,
typename alloc
>
bool strings_equal_ignore_case (
const std::basic_string<char,traits,alloc>& str1,
const std::basic_string<char,traits,alloc>& str2,
unsigned long num
);
/*!
ensures
- returns tolower(str1.substr(0,num)) == tolower(str2.substr(0,num))
(i.e. only compares the first num characters)
!*/
// ----------------------------------------------------------------------------------------
template <
typename charT,
typename traits,
typename alloc
>
const std::basic_string<charT,traits,alloc> ltrim (
const std::basic_string<charT,traits,alloc>& str,
const std::basic_string<charT,traits,alloc>& trim_chars
);
/*!
ensures
- returns a copy of str with any leading trim_chars
from the left side of the string removed.
!*/
template <
typename charT,
typename traits,
typename alloc
>
const std::basic_string<charT,traits,alloc> ltrim (
const std::basic_string<charT,traits,alloc>& str,
const charT* trim_chars = _dT(charT," \t\r\n")
);
/*!
requires
- trim_chars == a valid null-terminated C string
ensures
- returns ltrim(str, std::basic_string<charT,traits,alloc>(trim_chars))
!*/
// ----------------------------------------------------------------------------------------
template <
typename charT,
typename traits,
typename alloc
>
const std::basic_string<charT,traits,alloc> rtrim (
const std::basic_string<charT,traits,alloc>& str,
const std::basic_string<charT,traits,alloc>& trim_chars
);
/*!
ensures
- returns a copy of str with any trailing trim_chars
from the right side of the string removed.
!*/
template <
typename charT,
typename traits,
typename alloc
>
const std::basic_string<charT,traits,alloc> rtrim (
const std::basic_string<charT,traits,alloc>& str,
const charT* trim_chars = _dT(charT," \t\r\n")
);
/*!
requires
- trim_chars == a valid null-terminated C string
ensures
- returns rtrim(str, std::basic_string<charT,traits,alloc>(trim_chars))
!*/
// ----------------------------------------------------------------------------------------
template <
typename charT,
typename traits,
typename alloc
>
const std::basic_string<charT,traits,alloc> trim (
const std::basic_string<charT,traits,alloc>& str,
const std::basic_string<charT,traits,alloc>& trim_chars
);
/*!
ensures
- returns a copy of str with any leading or trailing trim_chars
from the ends of the string removed.
!*/
template <
typename charT,
typename traits,
typename alloc
>
const std::basic_string<charT,traits,alloc> trim (
const std::basic_string<charT,traits,alloc>& str,
const charT* trim_chars = _dT(charT," \t\r\n")
);
/*!
requires
- trim_chars == a valid null-terminated C string
ensures
- returns trim(str, std::basic_string<charT,traits,alloc>(trim_chars))
!*/
// ----------------------------------------------------------------------------------------
template <
typename charT,
typename traits,
typename alloc
>
const std::basic_string<charT,traits,alloc> rpad (
const std::basic_string<charT,traits,alloc>& str,
long pad_length,
const std::basic_string<charT,traits,alloc>& pad_string
);
/*!
ensures
- if (pad_length <= str.size()) then
- returns str
- else
- let P be a string defined as follows:
- P.size() == pad_length - str.size()
- P == (pad_string + pad_string + ... + pad_string).substr(0,pad_length - str.size())
(i.e. P == a string with the above specified size that contains just
repitions of the pad_string)
- returns the string str + P
!*/
template <
typename charT,
typename traits,
typename alloc
>
const std::basic_string<charT,traits,alloc> rpad (
const std::basic_string<charT,traits,alloc>& str,
long pad_length,
const charT* pad_string = _dT(charT," ")
);
/*!
requires
- pad_string == a valid null-terminated C string
ensures
- returns rpad(str, pad_length, std::basic_string<charT,traits,alloc>(pad_string))
!*/
// ----------------------------------------------------------------------------------------
template <
typename charT,
typename traits,
typename alloc
>
const std::basic_string<charT,traits,alloc> lpad (
const std::basic_string<charT,traits,alloc>& str,
long pad_length,
const std::basic_string<charT,traits,alloc>& pad_string
);
/*!
ensures
- if (pad_length <= str.size()) then
- returns str
- else
- let P be a string defined as follows:
- P.size() == pad_length - str.size()
- P == (pad_string + pad_string + ... + pad_string).substr(0,pad_length - str.size())
(i.e. P == a string with the above specified size that contains just
repitions of the pad_string)
- returns the string P + str
!*/
template <
typename charT,
typename traits,
typename alloc
>
const std::basic_string<charT,traits,alloc> lpad (
const std::basic_string<charT,traits,alloc>& str,
long pad_length,
const charT* pad_string = _dT(charT," ")
);
/*!
requires
- pad_string == a valid null-terminated C string
ensures
- returns lpad(str, pad_length, std::basic_string<charT,traits,alloc>(pad_string))
!*/
// ----------------------------------------------------------------------------------------
template <
typename charT,
typename traits,
typename alloc
>
const std::basic_string<charT,traits,alloc> pad (
const std::basic_string<charT,traits,alloc>& str,
long pad_length,
const std::basic_string<charT,traits,alloc>& pad_string
);
/*!
ensures
- let str_size == static_cast<long>(str.size())
- returns rpad( lpad(str, (pad_length-str_size)/2 + str_size, pad_string),
pad_length,
pad_string);
!*/
template <
typename charT,
typename traits,
typename alloc
>
const std::basic_string<charT,traits,alloc> pad (
const std::basic_string<charT,traits,alloc>& str,
long pad_length,
const charT* pad_string = _dT(charT," ")
);
/*!
requires
- pad_string == a valid null-terminated C string
ensures
- returns pad(str, pad_length, std::basic_string<charT,traits,alloc>(pad_string))
!*/
// ----------------------------------------------------------------------------------------
template <
typename charT,
typename traits,
typename alloc
>
const std::basic_string<charT,traits,alloc> left_substr (
const std::basic_string<charT,traits,alloc>& str,
const std::basic_string<charT,traits,alloc>& delim
);
/*!
ensures
- let delim_pos = str.find_first_of(delim)
- returns str.substr(0,delim_pos)
!*/
template <
typename charT,
typename traits,
typename alloc
>
const std::basic_string<charT,traits,alloc> left_substr (
const std::basic_string<charT,traits,alloc>& str,
const charT* delim = _dT(charT," \n\r\t")
);
/*!
requires
- delim == a valid null-terminated C string
ensures
- returns left_substr(str, std::basic_string<charT,traits,alloc>(delim))
!*/
// ----------------------------------------------------------------------------------------
template <
typename charT,
typename traits,
typename alloc
>
const std::basic_string<charT,traits,alloc> right_substr (
const std::basic_string<charT,traits,alloc>& str,
const std::basic_string<charT,traits,alloc>& delim
);
/*!
ensures
- let delim_pos = str.find_last_of(delim)
- if (delim_pos == std::string::npos) then
- returns ""
- else
- returns str.substr(delim_pos+1)
!*/
template <
typename charT,
typename traits
typename alloc
>
const std::basic_string<charT,traits,alloc> right_substr (
const std::basic_string<charT,traits,alloc>& str,
const charT* delim = _dT(charT," \n\r\t")
);
/*!
requires
- delim == a valid null-terminated C string
ensures
- returns right_substr(str, std::basic_string<charT,traits,alloc>(delim))
!*/
// ----------------------------------------------------------------------------------------
template <
typename charT,
typename traits,
typename alloc
>
std::pair<std::basic_string<charT,traits,alloc>, std::basic_string<charT,traits,alloc> >
split_on_first (
const std::basic_string<charT,traits,alloc>& str,
const charT* delim = _dT(charT, " \n\r\t")
);
/*!
ensures
- This function splits string into two parts, the split is based on the first
occurrence of any character from delim.
- let delim_pos = str.find_first_of(delim)
- if (delim_pos == std::string::npos) then
- returns make_pair(str,"")
- else
- return make_pair(str.substr(0, delim_pos), str.substr(delim_pos+1));
!*/
template <
typename charT,
typename traits,
typename alloc
>
std::pair<std::basic_string<charT,traits,alloc>, std::basic_string<charT,traits,alloc> >
split_on_first (
const std::basic_string<charT,traits,alloc>& str,
const std::basic_string<charT,traits,alloc>& delim
);
/*!
requires
- delim == a valid null-terminated C string
ensures
- returns split_on_first(str, delim.c_str())
!*/
// ----------------------------------------------------------------------------------------
template <
typename charT,
typename traits,
typename alloc
>
std::pair<std::basic_string<charT,traits,alloc>, std::basic_string<charT,traits,alloc> >
split_on_last (
const std::basic_string<charT,traits,alloc>& str,
const charT* delim = _dT(charT, " \n\r\t")
);
/*!
ensures
- This function splits string into two parts, the split is based on the last
occurrence of any character from delim.
- let delim_pos = str.find_last_of(delim)
- if (delim_pos == std::string::npos) then
- returns make_pair(str,"")
- else
- return make_pair(str.substr(0, delim_pos), str.substr(delim_pos+1));
!*/
template <
typename charT,
typename traits,
typename alloc
>
std::pair<std::basic_string<charT,traits,alloc>, std::basic_string<charT,traits,alloc> >
split_on_last (
const std::basic_string<charT,traits,alloc>& str,
const std::basic_string<charT,traits,alloc>& delim
);
/*!
requires
- delim == a valid null-terminated C string
ensures
- returns split_on_last(str, delim.c_str())
!*/
// ----------------------------------------------------------------------------------------
template <
typename charT,
typename traits,
typename alloc
>
const std::vector<std::basic_string<charT,traits,alloc> > split (
const std::basic_string<charT,traits,alloc>& str,
const std::basic_string<charT,traits,alloc>& delim
);
/*!
ensures
- Breaks the given string str into a sequence of substrings delimited
by characters in delim and returns the results.
- returns a vector V such that:
- V.size() == the number of substrings found in str.
- for all i: V[i] == The ith substring. Note that it will not contain
any delimiter characters (i.e. characters in delim). It will also
never be an empty string.
- V contains the substrings in the order in which they appear in str.
That is, V[0] contains the first substring, V[1] the second, and
so on.
!*/
template <
typename charT,
typename traits,
typename alloc
>
const std::vector<std::basic_string<charT,traits,alloc> > split (
const std::basic_string<charT,traits,alloc>& str,
const charT* delim = _dT(charT," \n\r\t")
);
/*!
requires
- trim_chars == a valid null-terminated C string
ensures
- returns split(str, std::basic_string<charT,traits,alloc>(delim))
!*/
// ----------------------------------------------------------------------------------------
}
#endif // DLIB_STRINg_ABSTRACT_
|