1/* 2 * Copyright 2019 Haiku, Inc. All rights reserved. 3 * Distributed under the terms of the MIT License. 4 * 5 * Authors: 6 * Name, email@email.com 7 * 8 * Corresponds to: 9 * headers/os/support/Url.h hrev52332 10 * src/kits/support/Url.cpp hrev52332 11 */ 12 13 14/*! 15 \file Url.h 16 \ingroup support 17 \brief Undocumented file. 18 19 \since Haiku R1 20*/ 21 22 23/*! 24 \class BUrl 25 \ingroup support 26 \ingroup libbe 27 \brief Undocumented class. 28 29 \since Haiku R1 30*/ 31 32 33/*! 34 \fn BUrl::BUrl(const char *url) 35 \brief Undocumented public method 36 37 \param url Undocumented 38 39 \return Undocumented 40 \retval <value> Undocumented 41 42 \since Haiku R1 43*/ 44 45 46/*! 47 \fn BUrl::BUrl(BMessage *archive) 48 \brief Undocumented public method 49 50 \param archive Undocumented 51 52 \return Undocumented 53 \retval <value> Undocumented 54 55 \since Haiku R1 56*/ 57 58 59/*! 60 \fn BUrl::BUrl(const BUrl &other) 61 \brief Undocumented public method 62 63 \param other Undocumented 64 65 \return Undocumented 66 \retval <value> Undocumented 67 68 \since Haiku R1 69*/ 70 71 72/*! 73 \fn BUrl::BUrl(const BUrl &base, const BString &relative) 74 \brief Undocumented public method 75 76 \param base Undocumented 77 \param relative Undocumented 78 79 \return Undocumented 80 \retval <value> Undocumented 81 82 \since Haiku R1 83*/ 84 85 86/*! 87 \fn BUrl::BUrl(const BPath &path) 88 \brief Undocumented public method 89 90 \param path Undocumented 91 92 \return Undocumented 93 \retval <value> Undocumented 94 95 \since Haiku R1 96*/ 97 98 99/*! 100 \fn BUrl::BUrl() 101 \brief Undocumented public method 102 103 \return Undocumented 104 \retval <value> Undocumented 105 106 \since Haiku R1 107*/ 108 109 110/*! 111 \fn virtual virtual BUrl::~BUrl() 112 \brief Undocumented public method 113 114 \return Undocumented 115 \retval <value> Undocumented 116 117 \since Haiku R1 118*/ 119 120 121/*! 122 \fn BUrl& BUrl::SetUrlString(const BString &url) 123 \brief Undocumented public method 124 125 \param url Undocumented 126 127 \return Undocumented 128 \retval <value> Undocumented 129 130 \since Haiku R1 131*/ 132 133 134/*! 135 \fn BUrl& BUrl::SetProtocol(const BString &scheme) 136 \brief Undocumented public method 137 138 \param scheme Undocumented 139 140 \return Undocumented 141 \retval <value> Undocumented 142 143 \since Haiku R1 144*/ 145 146 147/*! 148 \fn BUrl& BUrl::SetUserName(const BString &user) 149 \brief Undocumented public method 150 151 \param user Undocumented 152 153 \return Undocumented 154 \retval <value> Undocumented 155 156 \since Haiku R1 157*/ 158 159 160/*! 161 \fn BUrl& BUrl::SetPassword(const BString &password) 162 \brief Undocumented public method 163 164 \param password Undocumented 165 166 \return Undocumented 167 \retval <value> Undocumented 168 169 \since Haiku R1 170*/ 171 172 173/*! 174 \fn void BUrl::SetAuthority(const BString &authority) 175 \brief Undocumented public method 176 177 \param authority Undocumented 178 179 \since Haiku R1 180*/ 181 182 183/*! 184 \fn BUrl& BUrl::SetHost(const BString &host) 185 \brief Undocumented public method 186 187 \param host Undocumented 188 189 \return Undocumented 190 \retval <value> Undocumented 191 192 \since Haiku R1 193*/ 194 195 196/*! 197 \fn BUrl& BUrl::SetPort(int port) 198 \brief Undocumented public method 199 200 \param port Undocumented 201 202 \return Undocumented 203 \retval <value> Undocumented 204 205 \since Haiku R1 206*/ 207 208 209/*! 210 \fn BUrl& BUrl::SetPath(const BString &path) 211 \brief Undocumented public method 212 213 \param path Undocumented 214 215 \return Undocumented 216 \retval <value> Undocumented 217 218 \since Haiku R1 219*/ 220 221 222/*! 223 \fn BUrl& BUrl::SetRequest(const BString &request) 224 \brief Undocumented public method 225 226 \param request Undocumented 227 228 \return Undocumented 229 \retval <value> Undocumented 230 231 \since Haiku R1 232*/ 233 234 235/*! 236 \fn BUrl& BUrl::SetFragment(const BString &fragment) 237 \brief Undocumented public method 238 239 \param fragment Undocumented 240 241 \return Undocumented 242 \retval <value> Undocumented 243 244 \since Haiku R1 245*/ 246 247 248/*! 249 \fn const BString& BUrl::UrlString() const 250 \brief Undocumented public method 251 252 \return Undocumented 253 \retval <value> Undocumented 254 255 \since Haiku R1 256*/ 257 258 259/*! 260 \fn const BString& BUrl::Protocol() const 261 \brief Undocumented public method 262 263 \return Undocumented 264 \retval <value> Undocumented 265 266 \since Haiku R1 267*/ 268 269 270/*! 271 \fn const BString& BUrl::UserName() const 272 \brief Undocumented public method 273 274 \return Undocumented 275 \retval <value> Undocumented 276 277 \since Haiku R1 278*/ 279 280 281/*! 282 \fn const BString& BUrl::Password() const 283 \brief Undocumented public method 284 285 \return Undocumented 286 \retval <value> Undocumented 287 288 \since Haiku R1 289*/ 290 291 292/*! 293 \fn const BString& BUrl::UserInfo() const 294 \brief Undocumented public method 295 296 \return Undocumented 297 \retval <value> Undocumented 298 299 \since Haiku R1 300*/ 301 302 303/*! 304 \fn const BString& BUrl::Host() const 305 \brief Undocumented public method 306 307 \return Undocumented 308 \retval <value> Undocumented 309 310 \since Haiku R1 311*/ 312 313 314/*! 315 \fn int BUrl::Port() const 316 \brief Undocumented public method 317 318 \return Undocumented 319 \retval <value> Undocumented 320 321 \since Haiku R1 322*/ 323 324 325/*! 326 \fn const BString& BUrl::Authority() const 327 \brief Undocumented public method 328 329 \return Undocumented 330 \retval <value> Undocumented 331 332 \since Haiku R1 333*/ 334 335 336/*! 337 \fn const BString& BUrl::Path() const 338 \brief Undocumented public method 339 340 \return Undocumented 341 \retval <value> Undocumented 342 343 \since Haiku R1 344*/ 345 346 347/*! 348 \fn const BString& BUrl::Request() const 349 \brief Undocumented public method 350 351 \return Undocumented 352 \retval <value> Undocumented 353 354 \since Haiku R1 355*/ 356 357 358/*! 359 \fn const BString& BUrl::Fragment() const 360 \brief Undocumented public method 361 362 \return Undocumented 363 \retval <value> Undocumented 364 365 \since Haiku R1 366*/ 367 368 369/*! 370 \fn bool BUrl::IsValid() const 371 \brief Undocumented public method 372 373 \return Undocumented 374 \retval <value> Undocumented 375 376 \since Haiku R1 377*/ 378 379 380/*! 381 \fn bool BUrl::HasProtocol() const 382 \brief Undocumented public method 383 384 \return Undocumented 385 \retval <value> Undocumented 386 387 \since Haiku R1 388*/ 389 390 391/*! 392 \fn bool BUrl::HasUserName() const 393 \brief Undocumented public method 394 395 \return Undocumented 396 \retval <value> Undocumented 397 398 \since Haiku R1 399*/ 400 401 402/*! 403 \fn bool BUrl::HasPassword() const 404 \brief Undocumented public method 405 406 \return Undocumented 407 \retval <value> Undocumented 408 409 \since Haiku R1 410*/ 411 412 413/*! 414 \fn bool BUrl::HasUserInfo() const 415 \brief Undocumented public method 416 417 \return Undocumented 418 \retval <value> Undocumented 419 420 \since Haiku R1 421*/ 422 423 424/*! 425 \fn bool BUrl::HasHost() const 426 \brief Undocumented public method 427 428 \return Undocumented 429 \retval <value> Undocumented 430 431 \since Haiku R1 432*/ 433 434 435/*! 436 \fn bool BUrl::HasPort() const 437 \brief Undocumented public method 438 439 \return Undocumented 440 \retval <value> Undocumented 441 442 \since Haiku R1 443*/ 444 445 446/*! 447 \fn bool BUrl::HasAuthority() const 448 \brief Undocumented public method 449 450 \return Undocumented 451 \retval <value> Undocumented 452 453 \since Haiku R1 454*/ 455 456 457/*! 458 \fn bool BUrl::HasPath() const 459 \brief Undocumented public method 460 461 \return Undocumented 462 \retval <value> Undocumented 463 464 \since Haiku R1 465*/ 466 467 468/*! 469 \fn bool BUrl::HasRequest() const 470 \brief Undocumented public method 471 472 \return Undocumented 473 \retval <value> Undocumented 474 475 \since Haiku R1 476*/ 477 478 479/*! 480 \fn bool BUrl::HasFragment() const 481 \brief Undocumented public method 482 483 \return Undocumented 484 \retval <value> Undocumented 485 486 \since Haiku R1 487*/ 488 489 490/*! 491 \fn void BUrl::UrlEncode(bool strict=false) 492 \brief Undocumented public method 493 494 \param strict Undocumented 495 496 \since Haiku R1 497*/ 498 499 500/*! 501 \fn void BUrl::UrlDecode(bool strict=false) 502 \brief Undocumented public method 503 504 \param strict Undocumented 505 506 \since Haiku R1 507*/ 508 509 510/*! 511 \fn status_t BUrl::IDNAToAscii() 512 \brief Undocumented public method 513 514 \return Undocumented 515 \retval <value> Undocumented 516 517 \since Haiku R1 518*/ 519 520 521/*! 522 \fn status_t BUrl::IDNAToUnicode() 523 \brief Undocumented public method 524 525 \return Undocumented 526 \retval <value> Undocumented 527 528 \since Haiku R1 529*/ 530 531 532/*! 533 \fn bool BUrl::HasPreferredApplication() const 534 \brief Undocumented public method 535 536 \return Undocumented 537 \retval <value> Undocumented 538 539 \since Haiku R1 540*/ 541 542 543/*! 544 \fn BString BUrl::PreferredApplication() const 545 \brief Undocumented public method 546 547 \return Undocumented 548 \retval <value> Undocumented 549 550 \since Haiku R1 551*/ 552 553 554/*! 555 \fn status_t BUrl::OpenWithPreferredApplication(bool onProblemAskUser=true) const 556 \brief Undocumented public method 557 558 \param onProblemAskUser Undocumented 559 560 \return Undocumented 561 \retval <value> Undocumented 562 563 \since Haiku R1 564*/ 565 566 567/*! 568 \fn bool BUrl::operator==(BUrl &other) const 569 \brief Undocumented public method 570 571 \param other Undocumented 572 573 \return Undocumented 574 \retval <value> Undocumented 575 576 \since Haiku R1 577*/ 578 579 580/*! 581 \fn bool BUrl::operator!=(BUrl &other) const 582 \brief Undocumented public method 583 584 \param other Undocumented 585 586 \return Undocumented 587 \retval <value> Undocumented 588 589 \since Haiku R1 590*/ 591 592 593/*! 594 \fn const BUrl& BUrl::operator=(const BUrl &other) 595 \brief Undocumented public method 596 597 \param other Undocumented 598 599 \return Undocumented 600 \retval <value> Undocumented 601 602 \since Haiku R1 603*/ 604 605 606/*! 607 \fn const BUrl& BUrl::operator=(const BString &string) 608 \brief Undocumented public method 609 610 \param string Undocumented 611 612 \return Undocumented 613 \retval <value> Undocumented 614 615 \since Haiku R1 616*/ 617 618 619/*! 620 \fn const BUrl& BUrl::operator=(const char *string) 621 \brief Undocumented public method 622 623 \param string Undocumented 624 625 \return Undocumented 626 \retval <value> Undocumented 627 628 \since Haiku R1 629*/ 630 631 632/*! 633 \fn BUrl::operator const char *() const 634 \brief Undocumented public method 635 636 \return Undocumented 637 \retval <value> Undocumented 638 639 \since Haiku R1 640*/ 641 642 643/*! 644 \fn static static BString BUrl::UrlEncode(const BString &url, bool strict=false, bool directory=false) 645 \brief Undocumented public method 646 647 \param url Undocumented 648 \param strict Undocumented 649 \param directory Undocumented 650 651 \return Undocumented 652 \retval <value> Undocumented 653 654 \since Haiku R1 655*/ 656 657 658/*! 659 \fn static static BString BUrl::UrlDecode(const BString &url, bool strict=false) 660 \brief Undocumented public method 661 662 \param url Undocumented 663 \param strict Undocumented 664 665 \return Undocumented 666 \retval <value> Undocumented 667 668 \since Haiku R1 669*/ 670 671 672/*! 673 \fn static static BArchivable* BUrl::Instantiate(BMessage *archive) 674 \brief Undocumented public method 675 676 \param archive Undocumented 677 678 \return Undocumented 679 \retval <value> Undocumented 680 681 \since Haiku R1 682*/ 683