summaryrefslogtreecommitdiff
path: root/tools/inc/tools/urlobj.hxx
blob: de779c0fa394b573be56e5d64d54d0b3a989a2c6 (plain)
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
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef _URLOBJ_HXX
#define _URLOBJ_HXX

#include "tools/toolsdllapi.h"
#include <tools/string.hxx>
#include "com/sun/star/uno/Reference.hxx"
#include "rtl/string.h"
#include "rtl/ustrbuf.hxx"
#include "rtl/textenc.h"
#include "sal/types.h"

namespace com { namespace sun { namespace star { namespace util {
    class XStringWidth;
} } } }

//============================================================================
// Special tokens:
#define INET_PASS_TOKEN '@'
#define INET_DELIM_TOKEN ':'
#define INET_DELIM_IMAPID ';'
#define INET_ENC_DELIM_TOKEN '|'
#define INET_DELIM_HOST_TOKEN '.'
#define INET_PATH_TOKEN '/'
#define INET_DOSPATH_TOKEN '\\'
#define INET_MARK_TOKEN '#'
#define INET_PARAM_TOKEN '?'
#define INET_HEX_ESCAPE '%'

//============================================================================
// Common URL prefixes for various schemes:
#define INET_FTP_SCHEME "ftp://"
#define INET_HTTP_SCHEME "http://"
#define INET_HTTPS_SCHEME "https://"
#define INET_FILE_SCHEME "file://"
#define INET_GOPHER_SCHEME "gopher://"
#define INET_MAILTO_SCHEME "mailto:"
#define INET_CID_SCHEME "cid:"
#define INET_NEWS_SCHEME "news:"
#define INET_POP3_SCHEME "pop3://"
#define INET_LDAP_SCHEME "ldap://"
#define INET_PRIVATE_SCHEME "private:"
#define INET_BUGDOC_SCHEME "bugdoc:"
#define INET_SLOT_SCHEME "slot:"
#define INET_MACRO_SCHEME "macro:"
#define INET_JAVASCRIPT_SCHEME "javascript:"
#define INET_IMAP_SCHEME "imap://"
#define INET_DOWNPASS_SCHEME ".."
#define INET_DATA_SCHEME "data:"
#define INET_OUT_SCHEME "out://"
#define INET_FIF_SCHEME "fif://"
#define INET_CEPT_SCHEME "cept://"
#define INET_VIM_SCHEME "vim://"
#define INET_UNO_SCHEME ".uno:"
#define INET_COMPONENT_SCHEME ".component:"
#define INET_DB_SCHEME "db:"
#define INET_BUGID_SCHEME "bugid:"
#define INET_TELNET_SCHEME "telnet://"
#define INET_HID_SCHEME "hid:"

#define URL_PREFIX_PRIV_SOFFICE "private:"
enum
{
    URL_PREFIX_PRIV_SOFFICE_LEN
        = RTL_CONSTASCII_LENGTH(URL_PREFIX_PRIV_SOFFICE)
};

#define URL_PREFIX_PRIV_OBSOLETE URL_PREFIX_PRIV_SOFFICE
enum
{
    URL_PREFIX_PRIV_OBSOLETE_LEN
        = RTL_CONSTASCII_LENGTH(URL_PREFIX_PRIV_OBSOLETE)
};

#define URL_PREFIX_PRIV_EXTERN "staroffice:"
enum
{
    URL_PREFIX_PRIV_EXTERN_LEN = RTL_CONSTASCII_LENGTH(URL_PREFIX_PRIV_EXTERN)
};

//============================================================================
// Schemes:
enum INetProtocol
{
    INET_PROT_NOT_VALID = 0,
    INET_PROT_FTP = 1,
    INET_PROT_HTTP = 2,
    INET_PROT_FILE = 3,
    INET_PROT_MAILTO = 4,
    INET_PROT_VND_SUN_STAR_WEBDAV = 5,
    INET_PROT_NEWS = 6,
    INET_PROT_PRIV_SOFFICE = 7,
    INET_PROT_PRIVATE = INET_PROT_PRIV_SOFFICE, // obsolete
    INET_PROT_VND_SUN_STAR_HELP = 8,
    INET_PROT_HTTPS = 9,
    INET_PROT_SLOT = 10,
    INET_PROT_MACRO = 11,
    INET_PROT_JAVASCRIPT = 12,
    INET_PROT_IMAP = 13,
    INET_PROT_POP3 = 14,
    INET_PROT_DATA = 15,
    INET_PROT_CID = 16,
    INET_PROT_OUT = 17,
    INET_PROT_VND_SUN_STAR_HIER = 18,
    INET_PROT_VIM = 19,
    INET_PROT_UNO = 20,
    INET_PROT_COMPONENT = 21,
    INET_PROT_VND_SUN_STAR_PKG = 22,
    INET_PROT_LDAP = 23,
    INET_PROT_DB = 24,
    INET_PROT_VND_SUN_STAR_CMD = 25,
    INET_PROT_VND_SUN_STAR_ODMA = 26,
    INET_PROT_TELNET = 27,
    INET_PROT_VND_SUN_STAR_EXPAND = 28,
    INET_PROT_VND_SUN_STAR_TDOC = 29,
    INET_PROT_GENERIC = 30,
    INET_PROT_SMB = 31,
    INET_PROT_HID = 32,
    INET_PROT_SFTP = 33,
    INET_PROT_END = 34
};

//============================================================================
class TOOLS_DLLPUBLIC INetURLObject
{
public:
    //========================================================================
    // Get- and Set-Methods:

    /** The way input strings that represent (parts of) URIs are interpreted
        in set-methods.

        @descr  Most set-methods accept either a ByteString or a rtl::OUString
        as input.  Using a ByteString, octets in the range 0x80--0xFF are
        replaced by single escape sequences.  Using a rtl::OUString , UTF-32
        characters in the range 0x80--0x10FFFF are replaced by sequences of
        escape sequences, representing the UTF-8 coded characters.

        @descr  Along with an EncodeMechanism parameter, the set-methods all
        take an rtl_TextEncoding parameter, which is ignored unless the
        EncodeMechanism is WAS_ENCODED.
     */
    enum EncodeMechanism
    {
        /** All escape sequences that are already present are ignored, and are
            interpreted as literal sequences of three characters.
         */
        ENCODE_ALL,

        /** Sequences of escape sequences, that represent characters from the
            specified character set and that can be converted to UTF-32
            characters, are first decoded.  If they have to be encoded, they
            are converted to UTF-8 characters and are than translated into
            (sequences of) escape sequences.  Other escape sequences are
            copied verbatim (but using upper case hex digits).
         */
        WAS_ENCODED,

        /** All escape sequences that are already present are copied verbatim
            (but using upper case hex digits).
         */
        NOT_CANONIC
    };

    /** The way strings that represent (parts of) URIs are returned from get-
        methods.

        @descr  Along with a DecodeMechanism parameter, the get-methods all
        take an rtl_TextEncoding parameter, which is ignored unless the
        DecodeMechanism is DECODE_WITH_CHARSET or DECODE_UNAMBIGUOUS.
     */
    enum DecodeMechanism
    {
        /** The (part of the) URI is returned unchanged.  Since URIs are
            written using a subset of US-ASCII, the returned string is
            guaranteed to contain only US-ASCII characters.
         */
        NO_DECODE,

        /** All sequences of escape sequences that represent UTF-8 coded
            UTF-32 characters with a numerical value greater than 0x7F, are
            replaced by the respective UTF-16 characters.  All other escape
            sequences are not decoded.
         */
        DECODE_TO_IURI,

        /** All (sequences of) escape sequences that represent characters from
            the specified character set, and that can be converted to UTF-32,
            are replaced by the respective UTF-16 characters.  All other
            escape sequences are not decoded.
         */
        DECODE_WITH_CHARSET,

        /** All (sequences of) escape sequences that represent characters from
            the specified character set, that can be converted to UTF-32, and
            that (in the case of ASCII characters) can safely be decoded
            without altering the meaning of the (part of the) URI, are
            replaced by the respective UTF-16 characters.  All other escape
            sequences are not decoded.
         */
        DECODE_UNAMBIGUOUS
    };

    //========================================================================
    // General Structure:

    inline INetURLObject():
        m_eScheme(INET_PROT_NOT_VALID), m_eSmartScheme(INET_PROT_HTTP) {}

    inline bool HasError() const { return m_eScheme == INET_PROT_NOT_VALID; }

    inline rtl::OUString GetMainURL(DecodeMechanism eMechanism,
                                rtl_TextEncoding eCharset
                                    = RTL_TEXTENCODING_UTF8) const
    { return decode(m_aAbsURIRef, getEscapePrefix(), eMechanism, eCharset); }

    rtl::OUString GetURLNoPass(DecodeMechanism eMechanism = DECODE_TO_IURI,
                           rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8)
        const;

    rtl::OUString GetURLNoMark(DecodeMechanism eMechanism = DECODE_TO_IURI,
                           rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8)
        const;

    rtl::OUString
    getAbbreviated(com::sun::star::uno::Reference<
                           com::sun::star::util::XStringWidth > const &
                       rStringWidth,
                   sal_Int32 nWidth,
                   DecodeMechanism eMechanism = DECODE_TO_IURI,
                   rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8)
        const;

    bool operator ==(INetURLObject const & rObject) const;

    inline bool operator !=(INetURLObject const & rObject) const
    { return !(*this == rObject); }

    bool operator <(INetURLObject const & rObject) const;

    inline bool operator >(INetURLObject const & rObject) const
    { return rObject < *this; }

    //========================================================================
    // Strict Parsing:

    inline INetURLObject(ByteString const & rTheAbsURIRef,
                         EncodeMechanism eMechanism = WAS_ENCODED,
                         rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8);

    inline INetURLObject(rtl::OUString const & rTheAbsURIRef,
                         EncodeMechanism eMechanism = WAS_ENCODED,
                         rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8);

    inline bool SetURL(ByteString const & rTheAbsURIRef,
                       EncodeMechanism eMechanism = WAS_ENCODED,
                       rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8);

    inline bool SetURL(rtl::OUString const & rTheAbsURIRef,
                       EncodeMechanism eMechanism = WAS_ENCODED,
                       rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8);

    bool ConcatData(INetProtocol eTheScheme, rtl::OUString const & rTheUser,
                    rtl::OUString const & rThePassword,
                    rtl::OUString const & rTheHost, sal_uInt32 nThePort,
                    rtl::OUString const & rThePath,
                    EncodeMechanism eMechanism = WAS_ENCODED,
                    rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8);

    //========================================================================
    // Smart Parsing:

    /** The supported notations for file system paths.
     */
    enum FSysStyle
    {
        /** VOS notation (e.g., "//server/dir/file").
         */
        FSYS_VOS = 0x1,

        /** Unix notation (e.g., "/dir/file").
         */
        FSYS_UNX = 0x2,

        /** DOS notation (e.g., "a:\dir\file" and "\\server\dir\file").
         */
        FSYS_DOS = 0x4,

        /** Mac notation (e.g., "dir:file").
         */
        FSYS_MAC = 0x8,

        /** Detect the used notation.

            @descr  For the following descriptions, please note that
            whereas FSYS_DEFAULT includes all style bits, combinations of only
            a few style bits are also possible, and are also described.

            @descr  When used to translate a file system path to a file URL,
            the subset of the following productions for which the appropriate
            style bit is set are checked in order (using the conventions of
            RFC 2234, RFC 2396, and RFC 2732; UCS4 stands for any UCS4
            character):

             Production T1 (VOS local; FSYS_VOS only):
                "//." ["/" *UCS4]
              becomes
                "file:///" *UCS4

             Production T2 (VOS host; FSYS_VOS only):
                "//" [host] ["/" *UCS4]
              becomes
                "file://" host "/" *UCS4

             Production T3 (UNC; FSYS_DOS only):
                "\\" [host] ["\" *UCS4]
              becomes
                "file://" host "/" *UCS4
              replacing "\" by "/" within <*UCS4>

             Production T4 (Unix-like DOS; FSYS_DOS only):
                ALPHA ":" ["/" *UCS4]
              becomes
                "file:///" ALPHA ":/" *UCS4
              replacing "\" by "/" within <*UCS4>

             Production T5 (DOS; FSYS_DOS only):
                ALPHA ":" ["\" *UCS4]
              becomes
                "file:///" ALPHA ":/" *UCS4
              replacing "\" by "/" within <*UCS4>

             Production T6 (any):
                *UCS4
              becomes
                "file:///" *UCS4
              replacing the delimiter by "/" within <*UCS4>.  The delimiter is
              that character from the set { "/", "\", ":" } which appears most
              often in <*UCS4> (if FSYS_UNX is not among the style bits, "/"
              is removed from the set; if FSYS_DOS is not among the style
              bits, "\" is removed from the set; if FSYS_MAC is not among the
              style bits, ":" is removed from the set).  If two or more
              characters appear the same number of times, the character
              mentioned first in that set is chosen.  If the first character
              of <*UCS4> is the delimiter, that character is not copied.

            @descr  When used to translate a file URL to a file system path,
            the following productions are checked in order (using the
            conventions of RFC 2234, RFC 2396, and RFC 2732):

             Production F1 (VOS; FSYS_VOS):
                "file://" host "/" fpath ["#" fragment]
              becomes
                "//" host "/" fpath

             Production F2 (DOS; FSYS_DOS):
                "file:///" ALPHA ":" ["/" fpath] ["#" fragment]
              becomes
                ALPHA ":" ["\" fpath]
              replacing "/" by "\" in <fpath>

             Production F3 (Unix; FSYS_UNX):
                "file:///" fpath ["#" fragment]
              becomes
                "/" fpath
         */
        FSYS_DETECT = FSYS_VOS | FSYS_UNX | FSYS_DOS
    };

    inline INetURLObject(rtl::OUString const & rTheAbsURIRef,
                         INetProtocol eTheSmartScheme,
                         EncodeMechanism eMechanism = WAS_ENCODED,
                         rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8,
                         FSysStyle eStyle = FSYS_DETECT);

    inline void SetSmartProtocol(INetProtocol eTheSmartScheme)
    { m_eSmartScheme = eTheSmartScheme; }

    inline bool
    SetSmartURL(ByteString const & rTheAbsURIRef,
                EncodeMechanism eMechanism = WAS_ENCODED,
                rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8,
                FSysStyle eStyle = FSYS_DETECT);

    inline bool
    SetSmartURL(rtl::OUString const & rTheAbsURIRef,
                EncodeMechanism eMechanism = WAS_ENCODED,
                rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8,
                FSysStyle eStyle = FSYS_DETECT);

    inline INetURLObject
    smartRel2Abs(ByteString const & rTheRelURIRef,
                 bool & rWasAbsolute,
                 bool bIgnoreFragment = false,
                 EncodeMechanism eMechanism = WAS_ENCODED,
                 rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8,
                 bool bRelativeNonURIs = false,
                 FSysStyle eStyle = FSYS_DETECT) const;

    inline INetURLObject
    smartRel2Abs(rtl::OUString const & rTheRelURIRef,
                 bool & rWasAbsolute,
                 bool bIgnoreFragment = false,
                 EncodeMechanism eMechanism = WAS_ENCODED,
                 rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8,
                 bool bRelativeNonURIs = false,
                 FSysStyle eStyle = FSYS_DETECT) const;

    //========================================================================
    // Relative URLs:

    inline bool
    GetNewAbsURL(ByteString const & rTheRelURIRef,
                 INetURLObject * pTheAbsURIRef,
                 EncodeMechanism eMechanism = WAS_ENCODED,
                 rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8,
                 FSysStyle eStyle = FSYS_DETECT, bool bIgnoreFragment = false)
        const;

    inline bool
    GetNewAbsURL(rtl::OUString const & rTheRelURIRef,
                 INetURLObject * pTheAbsURIRef,
                 EncodeMechanism eMechanism = WAS_ENCODED,
                 rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8,
                 FSysStyle eStyle = FSYS_DETECT, bool bIgnoreFragment = false)
        const;

    /** @descr  If rTheRelURIRef cannot be converted to an absolute URL
        (because of syntactic reasons), either rTheRelURIRef or an empty
        string is returned:  If all of the parameters eEncodeMechanism,
        eDecodeMechanism and eCharset have their respective default values,
        then rTheRelURIRef is returned unmodified; otherwise, an empty string
        is returned.
     */
    static rtl::OUString
    GetAbsURL(rtl::OUString const & rTheBaseURIRef,
              rtl::OUString const & rTheRelURIRef,
              bool bIgnoreFragment = false,
              EncodeMechanism eEncodeMechanism = WAS_ENCODED,
              DecodeMechanism eDecodeMechanism = DECODE_TO_IURI,
              rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8,
              FSysStyle eStyle = FSYS_DETECT);

    static inline rtl::OUString
    GetRelURL(ByteString const & rTheBaseURIRef,
              ByteString const & rTheAbsURIRef,
              EncodeMechanism eEncodeMechanism = WAS_ENCODED,
              DecodeMechanism eDecodeMechanism = DECODE_TO_IURI,
              rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8,
              FSysStyle eStyle = FSYS_DETECT);

    static inline rtl::OUString
    GetRelURL(rtl::OUString const & rTheBaseURIRef,
              rtl::OUString const & rTheAbsURIRef,
              EncodeMechanism eEncodeMechanism = WAS_ENCODED,
              DecodeMechanism eDecodeMechanism = DECODE_TO_IURI,
              rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8,
              FSysStyle eStyle = FSYS_DETECT);

    //========================================================================
    // External URLs:

    rtl::OUString getExternalURL(DecodeMechanism eMechanism = DECODE_TO_IURI,
                             rtl_TextEncoding eCharset
                                 = RTL_TEXTENCODING_UTF8) const;

    static inline bool translateToExternal(ByteString const & rTheIntURIRef,
                                           rtl::OUString & rTheExtURIRef,
                                           DecodeMechanism eDecodeMechanism
                                               = DECODE_TO_IURI,
                                           rtl_TextEncoding eCharset
                                               = RTL_TEXTENCODING_UTF8);

    static inline bool translateToExternal(rtl::OUString const & rTheIntURIRef,
                                           rtl::OUString & rTheExtURIRef,
                                           DecodeMechanism eDecodeMechanism
                                               = DECODE_TO_IURI,
                                           rtl_TextEncoding eCharset
                                               = RTL_TEXTENCODING_UTF8);

    static inline bool translateToInternal(ByteString const & rTheExtURIRef,
                                           rtl::OUString & rTheIntURIRef,
                                           DecodeMechanism eDecodeMechanism
                                               = DECODE_TO_IURI,
                                           rtl_TextEncoding eCharset
                                               = RTL_TEXTENCODING_UTF8);

    static inline bool translateToInternal(rtl::OUString const & rTheExtURIRef,
                                           rtl::OUString & rTheIntURIRef,
                                           DecodeMechanism eDecodeMechanism
                                               = DECODE_TO_IURI,
                                           rtl_TextEncoding eCharset
                                               = RTL_TEXTENCODING_UTF8);

    //========================================================================
    // Scheme:

    struct SchemeInfo;

    inline INetProtocol GetProtocol() const { return m_eScheme; }

    /** Return the URL 'prefix' for a given scheme.

        @param eTheScheme  One of the supported URL schemes.

        @return  The 'prefix' of URLs of the given scheme.
     */
    static rtl::OUString GetScheme(INetProtocol eTheScheme);

    static inline INetProtocol CompareProtocolScheme(ByteString const &
                                                         rTheAbsURIRef)
    { return CompareProtocolScheme(extend(rTheAbsURIRef)); }

    static INetProtocol CompareProtocolScheme(rtl::OUString const &
                                                  rTheAbsURIRef);

    //========================================================================
    // User Info:

    inline bool HasUserData() const { return m_aUser.isPresent(); }

    inline bool IsEmptyUser() const
    { return m_aUser.isPresent() && m_aUser.isEmpty(); }

    bool hasPassword() const;

    inline bool IsEmptyPass() const
    { return hasPassword() && m_aAuth.isEmpty(); }

    inline rtl::OUString GetUser(DecodeMechanism eMechanism = DECODE_TO_IURI,
                             rtl_TextEncoding eCharset
                                 = RTL_TEXTENCODING_UTF8) const
    { return decode(m_aUser, getEscapePrefix(), eMechanism, eCharset); }

    inline rtl::OUString GetPass(DecodeMechanism eMechanism = DECODE_TO_IURI,
                             rtl_TextEncoding eCharset
                                 = RTL_TEXTENCODING_UTF8) const
    { return decode(m_aAuth, getEscapePrefix(), eMechanism, eCharset); }

    inline bool SetUser(ByteString const & rTheUser,
                        EncodeMechanism eMechanism = WAS_ENCODED,
                        rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8)
    { return setUser(extend(rTheUser), true, eMechanism, eCharset); }

    inline bool SetUser(rtl::OUString const & rTheUser,
                        EncodeMechanism eMechanism = WAS_ENCODED,
                        rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8)
    { return setUser(rTheUser, false, eMechanism, eCharset); }

    void makeAuthCanonic();

    inline bool SetPass(ByteString const & rThePassword,
                        EncodeMechanism eMechanism = WAS_ENCODED,
                        rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8);

    inline bool SetPass(rtl::OUString const & rThePassword,
                        EncodeMechanism eMechanism = WAS_ENCODED,
                        rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8);

    inline bool SetUserAndPass(ByteString const & rTheUser,
                               ByteString const & rThePassword,
                               EncodeMechanism eMechanism = WAS_ENCODED,
                               rtl_TextEncoding eCharset
                                   = RTL_TEXTENCODING_UTF8);

    inline bool SetUserAndPass(rtl::OUString const & rTheUser,
                               rtl::OUString const & rThePassword,
                               EncodeMechanism eMechanism = WAS_ENCODED,
                               rtl_TextEncoding eCharset
                                   = RTL_TEXTENCODING_UTF8);

    //========================================================================
    // Host and Port:

    inline bool HasPort() const { return m_aPort.isPresent(); }

    inline rtl::OUString GetHost(DecodeMechanism eMechanism = DECODE_TO_IURI,
                             rtl_TextEncoding eCharset
                                 = RTL_TEXTENCODING_UTF8) const
    { return decode(m_aHost, getEscapePrefix(), eMechanism, eCharset); }

    rtl::OUString GetHostPort(DecodeMechanism eMechanism = DECODE_TO_IURI,
                          rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8);

    sal_uInt32 GetPort() const;

    inline bool SetHost(ByteString const & rTheHost,
                        EncodeMechanism eMechanism = WAS_ENCODED,
                        rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8)
    { return setHost(extend(rTheHost), true, eMechanism, eCharset); }

    inline bool SetHost(rtl::OUString const & rTheHost,
                        EncodeMechanism eMechanism = WAS_ENCODED,
                        rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8)
    { return setHost(rTheHost, false, eMechanism, eCharset); }

    bool SetPort(sal_uInt32 nThePort);

    void makePortCanonic();

    /** Encode the <hostport> part of a URL.

        @ATT  Obsolete, because at the moment the <hostport> part of a URL may
        not contain any escape sequences anyway, and because this method does
        not inform the caller whether the given <hostport> part is legal.

        @param rTheHostPort  The <hostport> part of a URL (for its
        interpretation, see the general discussion for set-methods).

        @param eMechanism  See the general discussion for set-methods.

        @param eCharset  See the general discussion for set-methods.

        @return  The <hostport> part, encoded according to the given mechanism
        and charset ('forbidden' characters replaced by escape sequences).
     */
    static inline rtl::OUString encodeHostPort(ByteString const & rTheHostPort,
                                           EncodeMechanism eMechanism,
                                           rtl_TextEncoding eCharset
                                               = RTL_TEXTENCODING_UTF8);

    /** Encode the <hostport> part of a URL.

        @ATT  Obsolete, because at the moment the <hostport> part of a URL may
        not contain any escape sequences anyway, and because this method does
        not inform the caller whether the given <hostport> part is legal.

        @param rTheHostPort  The <hostport> part of a URL (for its
        interpretation, see the general discussion for set-methods).

        @param eMechanism  See the general discussion for set-methods.

        @param eCharset  See the general discussion for set-methods.

        @return  The <hostport> part, encoded according to the given mechanism
        and charset ('forbidden' characters replaced by escape sequences).
     */
    static inline rtl::OUString encodeHostPort(rtl::OUString const & rTheHostPort,
                                           EncodeMechanism eMechanism,
                                           rtl_TextEncoding eCharset
                                               = RTL_TEXTENCODING_UTF8)
    { return encodeHostPort(rTheHostPort, false, eMechanism, eCharset); }

    //========================================================================
    // Path:

    inline bool HasURLPath() const { return !m_aPath.isEmpty(); }

    inline rtl::OUString GetURLPath(DecodeMechanism eMechanism = DECODE_TO_IURI,
                                rtl_TextEncoding eCharset
                                    = RTL_TEXTENCODING_UTF8) const
    { return decode(m_aPath, getEscapePrefix(), eMechanism, eCharset); }

    inline bool SetURLPath(ByteString const & rThePath,
                           EncodeMechanism eMechanism = WAS_ENCODED,
                           rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8)
    { return setPath(extend(rThePath), true, eMechanism, eCharset); }

    inline bool SetURLPath(rtl::OUString const & rThePath,
                           EncodeMechanism eMechanism = WAS_ENCODED,
                           rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8)
    { return setPath(rThePath, false, eMechanism, eCharset); }

    //========================================================================
    // Hierarchical Path:

    /** A constant to address the last segment in various methods dealing with
        hierarchical paths.

        @descr  It is often more efficient to address the last segment using
        this constant, than to determine its ordinal value using
        getSegmentCount().
     */
    enum { LAST_SEGMENT = -1 };

    /** The number of segments in the hierarchical path.

        @descr  Using RFC 2396 and RFC 2234, a hierarchical path is of the
        form

          hierarchical-path = 1*("/" segment)

          segment = name *(";" param)

          name = [base ["." extension]]

          base = 1*pchar

          extension = *<any pchar except ".">

          param = *pchar

        @param bIgnoreFinalSlash  If true, a final slash at the end of the
        hierarchical path does not denote an empty segment, but is ignored.

        @return  The number of segments in the hierarchical path.  If the path
        is not hierarchical, 0 is returned.
     */
    sal_Int32 getSegmentCount(bool bIgnoreFinalSlash = true) const;

    /** Remove a segment from the hierarchical path.

        @param nIndex  The non-negative index of the segment, or LAST_SEGMENT
        if addressing the last segment.

        @param bIgnoreFinalSlash  If true, a final slash at the end of the
        hierarchical path does not denote an empty segment, but is ignored.

        @return  True if the segment has successfully been removed (and the
        resulting URI is still valid).  If the path is not hierarchical, or
        the specified segment does not exist, false is returned.  If false is
        returned, the object is not modified.
     */
    bool removeSegment(sal_Int32 nIndex = LAST_SEGMENT,
                       bool bIgnoreFinalSlash = true);

    /** Insert a new segment into the hierarchical path.

        @param rTheName  The name part of the new segment.  The new segment
        will contain no parameters.

        @param bAppendFinalSlash  If the new segment is appended at the end of
        the hierarchical path, this parameter specifies whether to add a final
        slash after it or not.

        @param nIndex  The non-negative index of the segment before which
        to insert the new segment.  LAST_SEGMENT or an nIndex that equals
        getSegmentCount() inserts the new segment at the end of the
        hierarchical path.

        @param bIgnoreFinalSlash  If true, a final slash at the end of the
        hierarchical path does not denote an empty segment, but is ignored.

        @param eMechanism  See the general discussion for set-methods.

        @param eCharset  See the general discussion for set-methods.

        @return  True if the segment has successfully been inserted (and the
        resulting URI is still valid).  If the path is not hierarchical, or
        the specified place to insert the new segment does not exist, false is
        returned.  If false is returned, the object is not modified.
     */
    inline bool insertName(rtl::OUString const & rTheName,
                           bool bAppendFinalSlash = false,
                           sal_Int32 nIndex = LAST_SEGMENT,
                           bool bIgnoreFinalSlash = true,
                           EncodeMechanism eMechanism = WAS_ENCODED,
                           rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8);

    /** Get the name of a segment of the hierarchical path.

        @param nIndex  The non-negative index of the segment, or LAST_SEGMENT
        if addressing the last segment.

        @param bIgnoreFinalSlash  If true, a final slash at the end of the
        hierarchical path does not denote an empty segment, but is ignored.

        @param eMechanism  See the general discussion for get-methods.

        @param eCharset  See the general discussion for get-methods.

        @return  The name part of the specified segment.  If the path is not
        hierarchical, or the specified segment does not exits, an empty string
        is returned.
     */
    rtl::OUString getName(sal_Int32 nIndex = LAST_SEGMENT,
                      bool bIgnoreFinalSlash = true,
                      DecodeMechanism eMechanism = DECODE_TO_IURI,
                      rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8)
        const;

    /** Set the name of a segment (preserving any parameters and any query or
        fragment part).

        @param rTheName  The new name.

        @param nIndex  The non-negative index of the segment, or LAST_SEGMENT
        if addressing the last segment.

        @param bIgnoreFinalSlash  If true, a final slash at the end of the
        hierarchical path does not denote an empty segment, but is ignored.

        @param eMechanism  See the general discussion for set-methods.

        @param eCharset  See the general discussion for set-methods.

        @return  True if the name has successfully been modified (and the
        resulting URI is still valid).  If the path is not hierarchical, or
        the specified segment does not exist, false is returned.  If false is
        returned, the object is not modified.
     */
    bool setName(rtl::OUString const & rTheName,
                 sal_Int32 nIndex = LAST_SEGMENT,
                 bool bIgnoreFinalSlash = true,
                 EncodeMechanism eMechanism = WAS_ENCODED,
                 rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8);

    /** Get the base of the name of a segment.

        @param nIndex  The non-negative index of the segment, or LAST_SEGMENT
        if addressing the last segment.

        @param bIgnoreFinalSlash  If true, a final slash at the end of the
        hierarchical path does not denote an empty segment, but is ignored.

        @param eMechanism  See the general discussion for get-methods.

        @param eCharset  See the general discussion for get-methods.

        @return  The base part of the specified segment.  If the path is
        not hierarchical, or the specified segment does not exits, an empty
        string is returned.
     */
    rtl::OUString getBase(sal_Int32 nIndex = LAST_SEGMENT,
                      bool bIgnoreFinalSlash = true,
                      DecodeMechanism eMechanism = DECODE_TO_IURI,
                      rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8)
        const;

    /** Set the base of the name of a segment (preserving the extension).

        @param rTheBase  The new base.

        @param nIndex  The non-negative index of the segment, or LAST_SEGMENT
        if addressing the last segment.

        @param bIgnoreFinalSlash  If true, a final slash at the end of the
        hierarchical path does not denote an empty segment, but is ignored.

        @param eMechanism  See the general discussion for set-methods.

        @param eCharset  See the general discussion for set-methods.

        @return  True if the base has successfully been modified (and the
        resulting URI is still valid).  If the path is not hierarchical, or
        the specified segment does not exist, false is returned.  If false is
        returned, the object is not modified.
     */
    bool setBase(rtl::OUString const & rTheBase,
                 sal_Int32 nIndex = LAST_SEGMENT,
                 bool bIgnoreFinalSlash = true,
                 EncodeMechanism eMechanism = WAS_ENCODED,
                 rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8);

    /** Determine whether the name of a segment has an extension.

        @param nIndex  The non-negative index of the segment, or LAST_SEGMENT
        if addressing the last segment.

        @param bIgnoreFinalSlash  If true, a final slash at the end of the
        hierarchical path does not denote an empty segment, but is ignored.

        @return  True if the name of the specified segment has an extension.
        If the path is not hierarchical, or the specified segment does not
        exist, false is returned.
     */
    bool hasExtension(sal_Int32 nIndex = LAST_SEGMENT,
                      bool bIgnoreFinalSlash = true) const;

    /** Get the extension of the name of a segment.

        @param nIndex  The non-negative index of the segment, or LAST_SEGMENT
        if addressing the last segment.

        @param bIgnoreFinalSlash  If true, a final slash at the end of the
        hierarchical path does not denote an empty segment, but is ignored.

        @param eMechanism  See the general discussion for get-methods.

        @param eCharset  See the general discussion for get-methods.

        @return  The extension part of the specified segment.  If the path is
        not hierarchical, or the specified segment does not exits, an empty
        string is returned.
     */
    rtl::OUString getExtension(sal_Int32 nIndex = LAST_SEGMENT,
                           bool bIgnoreFinalSlash = true,
                           DecodeMechanism eMechanism = DECODE_TO_IURI,
                           rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8)
        const;

    /** Set the extension of the name of a segment (replacing an already
        existing extension).

        @param rTheExtension  The new extension.

        @param nIndex  The non-negative index of the segment, or LAST_SEGMENT
        if addressing the last segment.

        @param bIgnoreFinalSlash  If true, a final slash at the end of the
        hierarchical path does not denote an empty segment, but is ignored.

        @param eMechanism  See the general discussion for set-methods.

        @param eCharset  See the general discussion for set-methods.

        @return  True if the extension has successfully been modified (and the
        resulting URI is still valid).  If the path is not hierarchical, or
        the specified segment does not exist, false is returned.  If false is
        returned, the object is not modified.
     */
    bool setExtension(rtl::OUString const & rTheExtension,
                      sal_Int32 nIndex = LAST_SEGMENT,
                      bool bIgnoreFinalSlash = true,
                      EncodeMechanism eMechanism = WAS_ENCODED,
                      rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8);

    /** Remove the extension of the name of a segment.

        @param nIndex  The non-negative index of the segment, or LAST_SEGMENT
        if addressing the last segment.

        @param bIgnoreFinalSlash  If true, a final slash at the end of the
        hierarchical path does not denote an empty segment, but is ignored.

        @return  True if the extension has successfully been removed (and the
        resulting URI is still valid), or if the name did not have an
        extension.  If the path is not hierarchical, or the specified segment
        does not exist, false is returned.  If false is returned, the object
        is not modified.
     */
    bool removeExtension(sal_Int32 nIndex = LAST_SEGMENT,
                         bool bIgnoreFinalSlash = true);

    /** Determine whether the hierarchical path ends in a final slash.

        @return  True if the hierarchical path ends in a final slash.  If the
        path is not hierarchical, false is returned.
     */
    bool hasFinalSlash() const;

    /** Make the hierarchical path end in a final slash (if it does not
        already do so).

        @return  True if a final slash has successfully been appended (and the
        resulting URI is still valid), or if the hierarchical path already
        ended in a final slash.  If the path is not hierarchical, false is
        returned.  If false is returned, the object is not modified.
     */
    bool setFinalSlash();

    /** Remove a final slash from the hierarchical path.

        @return  True if a final slash has successfully been removed (and the
        resulting URI is still valid), or if the hierarchical path already did
        not end in a final slash.  If the path is not hierarchical, false is
        returned.  If false is returned, the object is not modified.
     */
    bool removeFinalSlash();

    //========================================================================
    // Query:

    inline bool HasParam() const { return m_aQuery.isPresent(); }

    inline rtl::OUString GetParam(DecodeMechanism eMechanism = DECODE_TO_IURI,
                              rtl_TextEncoding eCharset
                                  = RTL_TEXTENCODING_UTF8) const
    { return decode(m_aQuery, getEscapePrefix(), eMechanism, eCharset); }

    inline bool SetParam(ByteString const & rTheQuery,
                         EncodeMechanism eMechanism = WAS_ENCODED,
                         rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8);

    inline bool SetParam(rtl::OUString const & rTheQuery,
                         EncodeMechanism eMechanism = WAS_ENCODED,
                         rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8);

    //========================================================================
    // Fragment:

    inline bool HasMark() const { return m_aFragment.isPresent(); }

    inline rtl::OUString GetMark(DecodeMechanism eMechanism = DECODE_TO_IURI,
                             rtl_TextEncoding eCharset
                                 = RTL_TEXTENCODING_UTF8) const
    { return decode(m_aFragment, getEscapePrefix(), eMechanism, eCharset); }

    inline bool SetMark(ByteString const & rTheFragment,
                        EncodeMechanism eMechanism = WAS_ENCODED,
                        rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8);

    inline bool SetMark(rtl::OUString const & rTheFragment,
                        EncodeMechanism eMechanism = WAS_ENCODED,
                        rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8);

    static rtl::OUString createFragment(rtl::OUString const & rText);

    //========================================================================
    // File URLs:

    /** Create an INetURLObject from a file system path.

        @param rFSysPath  A file system path.  An URL is not allowed here!

        @param eStyle  The notation of rFSysPath.
     */
    inline INetURLObject(rtl::OUString const & rFSysPath, FSysStyle eStyle);

    /** Set this INetURLObject to a file URL constructed from a file system
        path.

        @param rFSysPath  A file system path.  An URL is not allowed here!

        @param eStyle  The notation of rFSysPath.

        @return  True if this INetURLObject has successfully been changed.  If
        false is returned, this INetURLObject has not been modified.
     */
    bool setFSysPath(rtl::OUString const & rFSysPath, FSysStyle eStyle);

    /** Return the file system path represented by a file URL (ignoring any
        fragment part).

        @param eStyle  The notation of the returned file system path.

        @param pDelimiter  Upon successful return, this parameter can return
        the character that is the 'main' delimiter within the returned file
        system path (e.g., "/" for Unix, "\" for DOS, ":" for Mac).  This is
        especially useful for routines that later try to shorten the returned
        file system path at a 'good' position, e.g. to fit it into some
        limited display space.

        @return  The file system path represented by this file URL.  If this
        file URL does not represent a file system path according to the
        specified notation, or if this is not a file URL at all, an empty
        string is returned.
     */
    rtl::OUString getFSysPath(FSysStyle eStyle, sal_Unicode * pDelimiter = 0)
        const;

    //========================================================================
    // POP3 and URLs:

    rtl::OUString GetMsgId(DecodeMechanism eMechanism = DECODE_TO_IURI,
                       rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8)
        const;

    //========================================================================
    // Coding:

    enum Part
    {
        PART_OBSOLETE_NORMAL = 0x001, // Obsolete, do not use!
        PART_OBSOLETE_FILE = 0x002, // Obsolete, do not use!
        PART_OBSOLETE_PARAM = 0x004, // Obsolete, do not use!
        PART_USER_PASSWORD = 0x008,
        PART_IMAP_ACHAR = 0x010,
        PART_VIM = 0x020,
        PART_HOST_EXTRA = 0x040,
        PART_FPATH = 0x080,
        PART_AUTHORITY = 0x100,
        PART_PATH_SEGMENTS_EXTRA = 0x200,
        PART_REL_SEGMENT_EXTRA = 0x400,
        PART_URIC = 0x800,
        PART_HTTP_PATH = 0x1000,
        PART_FILE_SEGMENT_EXTRA = 0x2000, // Obsolete, do not use!
        PART_MESSAGE_ID = 0x4000,
        PART_MESSAGE_ID_PATH = 0x8000,
        PART_MAILTO = 0x10000,
        PART_PATH_BEFORE_QUERY = 0x20000,
        PART_PCHAR = 0x40000,
        PART_FRAGMENT = 0x80000, // Obsolete, do not use!
        PART_VISIBLE = 0x100000,
        PART_VISIBLE_NONSPECIAL = 0x200000,
        PART_CREATEFRAGMENT = 0x400000,
        PART_UNO_PARAM_VALUE = 0x800000,
        PART_UNAMBIGUOUS = 0x1000000,
        PART_URIC_NO_SLASH = 0x2000000,
        PART_HTTP_QUERY = 0x4000000, //TODO! unused?
        PART_NEWS_ARTICLE_LOCALPART = 0x8000000,
        max_part = 0x80000000
            // Do not use!  Only there to allow compatible changes in the
            // future.
    };

    enum EscapeType
    {
        ESCAPE_NO,
        ESCAPE_OCTET,
        ESCAPE_UTF32
    };

    /** Encode some text as part of a URI.

        @param rText  Some text (for its interpretation, see the general
        discussion for set-methods).

        @param ePart  The part says which characters are 'forbidden' and must
        be encoded (replaced by escape sequences).  Characters outside the US-
        ASCII range are always 'forbidden.'

        @param cEscapePrefix  The first character in an escape sequence
        (normally '%').

        @param eMechanism  See the general discussion for set-methods.

        @param eCharset  See the general discussion for set-methods.

        @return  The encoded representation of the text ('forbidden'
        characters replaced by escape sequences).
     */
    static inline rtl::OUString encode(ByteString const & rText, Part ePart,
                                   sal_Char cEscapePrefix,
                                   EncodeMechanism eMechanism,
                                   rtl_TextEncoding eCharset
                                       = RTL_TEXTENCODING_UTF8);

    /** Encode some text as part of a URI.

        @param rText  Some text (for its interpretation, see the general
        discussion for set-methods).

        @param ePart  The part says which characters are 'forbidden' and must
        be encoded (replaced by escape sequences).  Characters outside the US-
        ASCII range are always 'forbidden.'

        @param cEscapePrefix  The first character in an escape sequence
        (normally '%').

        @param eMechanism  See the general discussion for set-methods.

        @param eCharset  See the general discussion for set-methods.

        @return  The text, encoded according to the given mechanism and
        charset ('forbidden' characters replaced by escape sequences).
     */
    static inline rtl::OUString encode(rtl::OUString const & rText, Part ePart,
                                   sal_Char cEscapePrefix,
                                   EncodeMechanism eMechanism,
                                   rtl_TextEncoding eCharset
                                       = RTL_TEXTENCODING_UTF8);

    /** Decode some text.

        @param rText  Some (encoded) text.

        @param cEscapePrefix  The first character in an escape sequence
        (normally '%').

        @param eMechanism  See the general discussion for get-methods.

        @param eCharset  See the general discussion for get-methods.

        @return  The text, decoded according to the given mechanism and
        charset (escape sequences replaced by 'raw' characters).
     */
    static inline rtl::OUString decode(rtl::OUString const & rText,
                                   sal_Char cEscapePrefix,
                                   DecodeMechanism eMechanism,
                                   rtl_TextEncoding eCharset
                                       = RTL_TEXTENCODING_UTF8);

    static inline rtl::OUString decode(rtl::OUStringBuffer const & rText,
                                   sal_Char cEscapePrefix,
                                   DecodeMechanism eMechanism,
                                   rtl_TextEncoding eCharset
                                       = RTL_TEXTENCODING_UTF8);

    static void appendUCS4Escape(rtl::OUStringBuffer & rTheText,
                                 sal_Char cEscapePrefix,
                                 sal_uInt32 nUCS4);

    static void appendUCS4(rtl::OUStringBuffer & rTheText, sal_uInt32 nUCS4,
                           EscapeType eEscapeType, bool bOctets, Part ePart,
                           sal_Char cEscapePrefix, rtl_TextEncoding eCharset,
                           bool bKeepVisibleEscapes);

    static sal_uInt32 getUTF32(sal_Unicode const *& rBegin,
                               sal_Unicode const * pEnd, bool bOctets,
                               sal_Char cEscapePrefix,
                               EncodeMechanism eMechanism,
                               rtl_TextEncoding eCharset,
                               EscapeType & rEscapeType);

    //========================================================================
    // Specialized helpers:

    static sal_uInt32 scanDomain(sal_Unicode const *& rBegin,
                                 sal_Unicode const * pEnd,
                                 bool bEager = true);

    //========================================================================
    // OBSOLETE Hierarchical Path:

    rtl::OUString GetPartBeforeLastName(DecodeMechanism eMechanism
                                        = DECODE_TO_IURI,
                                    rtl_TextEncoding eCharset
                                        = RTL_TEXTENCODING_UTF8) const;

    /** Get the last segment in the path.

        @param eMechanism  See the general discussion for get-methods.

        @param eCharset  See the general discussion for get-methods.

        @return  For a hierarchical URL, the last segment (everything after
        the last unencoded '/').  Not that this last segment may be empty.  If
        the URL is not hierarchical, an empty string is returned.
     */
    rtl::OUString GetLastName(DecodeMechanism eMechanism = DECODE_TO_IURI,
                          rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8)
        const;

    /** Get the 'extension' of the last segment in the path.

        @param eMechanism  See the general discussion for get-methods.

        @param eCharset  See the general discussion for get-methods.

        @return  For a hierarchical URL, everything after the first unencoded
        '.' in the last segment of the path.  Note that this 'extension' may
        be empty.  If the URL is not hierarchical, or if the last segment does
        not contain an unencoded '.', an empty string is returned.
     */
    rtl::OUString GetFileExtension(DecodeMechanism eMechanism = DECODE_TO_IURI,
                               rtl_TextEncoding eCharset
                                   = RTL_TEXTENCODING_UTF8) const;

    inline bool Append(ByteString const & rTheSegment,
                       EncodeMechanism eMechanism = WAS_ENCODED,
                       rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8)
    { return appendSegment(extend(rTheSegment), true, eMechanism, eCharset); }

    inline bool Append(rtl::OUString const & rTheSegment,
                       EncodeMechanism eMechanism = WAS_ENCODED,
                       rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8)
    { return appendSegment(rTheSegment, false, eMechanism, eCharset); }

    bool CutLastName();

    //========================================================================
    // OBSOLETE File URLs:

    rtl::OUString PathToFileName() const;

    rtl::OUString GetFull() const;

    rtl::OUString GetPath() const;

    void SetBase(rtl::OUString const & rTheBase);

    rtl::OUString GetBase() const;

    void SetName(rtl::OUString const & rTheName,
                 EncodeMechanism eMechanism = WAS_ENCODED,
                 rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8);

    inline rtl::OUString GetName(DecodeMechanism eMechanism = DECODE_TO_IURI,
                             rtl_TextEncoding eCharset
                                 = RTL_TEXTENCODING_UTF8) const
    { return GetLastName(eMechanism, eCharset); }

    void SetExtension(rtl::OUString const & rTheExtension,
                      EncodeMechanism eMechanism = WAS_ENCODED,
                      rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8);

    inline rtl::OUString GetExtension(
                                  DecodeMechanism eMechanism = DECODE_TO_IURI,
                                  rtl_TextEncoding eCharset
                                      = RTL_TEXTENCODING_UTF8) const
    { return GetFileExtension(eMechanism, eCharset); }

    rtl::OUString CutExtension(DecodeMechanism eMechanism = DECODE_TO_IURI,
                           rtl_TextEncoding eCharset = RTL_TEXTENCODING_UTF8);

    bool IsCaseSensitive() const;

    //========================================================================

private:
    // General Structure:

    class SubString
    {
        sal_Int32 m_nBegin;
        sal_Int32 m_nLength;

    public:
        explicit inline SubString(sal_Int32 nTheBegin = -1,
                                  sal_Int32 nTheLength = 0):
            m_nBegin(nTheBegin), m_nLength(nTheLength) {}

        inline bool isPresent() const { return m_nBegin != -1; }

        inline bool isEmpty() const { return m_nLength == 0; }

        inline sal_Int32 getBegin() const { return m_nBegin; }

        inline sal_Int32 getLength() const { return m_nLength; }

        inline sal_Int32 getEnd() const { return m_nBegin + m_nLength; }

        inline sal_Int32 clear();

        inline sal_Int32 set(rtl::OUStringBuffer & rString,
                             rtl::OUString const & rSubString,
                             sal_Int32 nTheBegin);

        inline sal_Int32 set(rtl::OUString & rString,
                             rtl::OUString const & rSubString);

        inline sal_Int32 set(rtl::OUStringBuffer & rString,
                             rtl::OUString const & rSubString);

        inline void operator +=(sal_Int32 nDelta);

        int compare(SubString const & rOther,
            rtl::OUStringBuffer const & rThisString,
            rtl::OUStringBuffer const & rOtherString) const;
    };

    rtl::OUStringBuffer m_aAbsURIRef;
    SubString m_aScheme;
    SubString m_aUser;
    SubString m_aAuth;
    SubString m_aHost;
    SubString m_aPort;
    SubString m_aPath;
    SubString m_aQuery;
    SubString m_aFragment;
    INetProtocol m_eScheme;
    INetProtocol m_eSmartScheme;

    TOOLS_DLLPRIVATE void setInvalid();

    bool setAbsURIRef(
        rtl::OUString const & rTheAbsURIRef, bool bOctets,
        EncodeMechanism eMechanism, rtl_TextEncoding eCharset, bool bSmart,
        FSysStyle eStyle);

    // Relative URLs:

    bool convertRelToAbs(
        rtl::OUString const & rTheRelURIRef, bool bOctets,
        INetURLObject & rTheAbsURIRef, bool & rWasAbsolute,
        EncodeMechanism eMechanism, rtl_TextEncoding eCharset,
        bool bIgnoreFragment, bool bSmart, bool bRelativeNonURIs,
        FSysStyle eStyle) const;

    bool convertAbsToRel(
        rtl::OUString const & rTheAbsURIRef, bool bOctets,
        rtl::OUString & rTheRelURIRef, EncodeMechanism eEncodeMechanism,
        DecodeMechanism eDecodeMechanism, rtl_TextEncoding eCharset,
        FSysStyle eStyle) const;

    // External URLs:

    static bool convertIntToExt(
        rtl::OUString const & rTheIntURIRef, bool bOctets,
        rtl::OUString & rTheExtURIRef, DecodeMechanism eDecodeMechanism,
        rtl_TextEncoding eCharset);

    static bool convertExtToInt(
        rtl::OUString const & rTheExtURIRef, bool bOctets,
        rtl::OUString & rTheIntURIRef, DecodeMechanism eDecodeMechanism,
        rtl_TextEncoding eCharset);

    // Scheme:

    struct PrefixInfo;

    TOOLS_DLLPRIVATE static inline SchemeInfo const & getSchemeInfo(
        INetProtocol eTheScheme);

    TOOLS_DLLPRIVATE inline SchemeInfo const & getSchemeInfo() const;

    TOOLS_DLLPRIVATE static PrefixInfo const * getPrefix(
        sal_Unicode const *& rBegin, sal_Unicode const * pEnd);

    // Authority:

    TOOLS_DLLPRIVATE sal_Int32 getAuthorityBegin() const;

    TOOLS_DLLPRIVATE SubString getAuthority() const;

    // User Info:

    bool setUser(
        rtl::OUString const & rTheUser, bool bOctets,
        EncodeMechanism eMechanism, rtl_TextEncoding eCharset);

    bool clearPassword();

    bool setPassword(
        rtl::OUString const & rThePassword, bool bOctets,
        EncodeMechanism eMechanism, rtl_TextEncoding eCharset);

    // Host and Port:

    TOOLS_DLLPRIVATE static bool parseHost(
        sal_Unicode const *& rBegin, sal_Unicode const * pEnd,
        rtl::OUString & rCanonic);

    TOOLS_DLLPRIVATE static bool parseHostOrNetBiosName(
        sal_Unicode const * pBegin, sal_Unicode const * pEnd, bool bOctets,
        EncodeMechanism eMechanism, rtl_TextEncoding eCharset,
        bool bNetBiosName, rtl::OUStringBuffer* pCanonic);

    static rtl::OUString encodeHostPort(
        rtl::OUString const & rTheHostPort, bool bOctets,
        EncodeMechanism eMechanism, rtl_TextEncoding eCharset);

    bool setHost(
        rtl::OUString const & rTheHost, bool bOctets,
        EncodeMechanism eMechanism, rtl_TextEncoding eCharset);

    // Path:

    TOOLS_DLLPRIVATE static bool parsePath(
        INetProtocol eScheme, sal_Unicode const ** pBegin,
        sal_Unicode const * pEnd, bool bOctets, EncodeMechanism eMechanism,
        rtl_TextEncoding eCharset, bool bSkippedInitialSlash,
        sal_uInt32 nSegmentDelimiter, sal_uInt32 nAltSegmentDelimiter,
        sal_uInt32 nQueryDelimiter, sal_uInt32 nFragmentDelimiter,
        rtl::OUStringBuffer &rSynPath);

    bool setPath(
        rtl::OUString const & rThePath, bool bOctets,
        EncodeMechanism eMechanism, rtl_TextEncoding eCharset);

    // Hierarchical Path:

    TOOLS_DLLPRIVATE bool checkHierarchical() const;

    bool appendSegment(
        rtl::OUString const & rTheSegment, bool bOctets,
        EncodeMechanism eMechanism, rtl_TextEncoding eCharset);

    TOOLS_DLLPRIVATE SubString getSegment(
        sal_Int32 nIndex, bool bIgnoreFinalSlash) const;

    bool insertName(
        rtl::OUString const & rTheName, bool bOctets, bool bAppendFinalSlash,
        sal_Int32 nIndex, bool bIgnoreFinalSlash, EncodeMechanism eMechanism,
        rtl_TextEncoding eCharset);

    // Query:

    bool clearQuery();

    bool setQuery(
        rtl::OUString const & rTheQuery, bool bOctets,
        EncodeMechanism eMechanism, rtl_TextEncoding eCharset);

    // Fragment:

    bool clearFragment();

    bool setFragment(
        rtl::OUString const & rTheMark, bool bOctets,
        EncodeMechanism eMechanism, rtl_TextEncoding eCharset);

    // FTP URLs:

    enum FTPType { FTP_TYPE_NONE, FTP_TYPE_A, FTP_TYPE_I, FTP_TYPE_D };

    TOOLS_DLLPRIVATE FTPType getFTPType() const;

    // FILE URLs:

    TOOLS_DLLPRIVATE bool hasDosVolume(FSysStyle eStyle) const;

    // IMAP URLs:

    TOOLS_DLLPRIVATE sal_uInt32 getIMAPUID() const;

    // Coding:

    static inline rtl::OUString extend(ByteString const & rOctets)
    {
        return rtl::OUString(rOctets.GetBuffer(), rOctets.Len(),
            RTL_TEXTENCODING_ISO_8859_1);
    }

    static inline sal_Char getEscapePrefix(INetProtocol eTheScheme)
    { return eTheScheme == INET_PROT_VIM ? '=' : '%'; }

    inline sal_Char getEscapePrefix() const
    { return getEscapePrefix(m_eScheme); }

    TOOLS_DLLPRIVATE static inline void appendEscape(
        rtl::OUStringBuffer & rTheText, sal_Char cEscapePrefix,
        sal_uInt32 nOctet);

    static rtl::OUString encodeText(
        sal_Unicode const * pBegin, sal_Unicode const * pEnd, bool bOctets,
        Part ePart, sal_Char cEscapePrefix, EncodeMechanism eMechanism,
        rtl_TextEncoding eCharset, bool bKeepVisibleEscapes);

    static inline rtl::OUString encodeText(
        rtl::OUString const & rTheText, bool bOctets, Part ePart,
        sal_Char cEscapePrefix, EncodeMechanism eMechanism,
        rtl_TextEncoding eCharset, bool bKeepVisibleEscapes);

    static rtl::OUString decode(
        sal_Unicode const * pBegin, sal_Unicode const * pEnd,
        sal_Char cEscapePrefix, DecodeMechanism, rtl_TextEncoding eCharset);

    inline rtl::OUString decode(
        SubString const & rSubString, sal_Char cEscapePrefix,
        DecodeMechanism eMechanism, rtl_TextEncoding eCharset) const;

    // Specialized helpers:

    TOOLS_DLLPRIVATE static bool scanIPv6reference(
        sal_Unicode const *& rBegin, sal_Unicode const * pEnd);

private:
    void changeScheme(INetProtocol eTargetScheme);
};

// static
inline rtl::OUString INetURLObject::encodeText(rtl::OUString const & rTheText,
                                           bool bOctets, Part ePart,
                                           sal_Char cEscapePrefix,
                                           EncodeMechanism eMechanism,
                                           rtl_TextEncoding eCharset,
                                           bool bKeepVisibleEscapes)
{
    return encodeText(rTheText.getStr(),
                      rTheText.getStr() + rTheText.getLength(), bOctets, ePart,
                      cEscapePrefix, eMechanism, eCharset,
                      bKeepVisibleEscapes);
}

inline rtl::OUString INetURLObject::decode(SubString const & rSubString,
                                       sal_Char cEscapePrefix,
                                       DecodeMechanism eMechanism,
                                       rtl_TextEncoding eCharset) const
{
    return rSubString.isPresent() ?
               decode(m_aAbsURIRef.getStr() + rSubString.getBegin(),
                      m_aAbsURIRef.getStr() + rSubString.getEnd(),
                      cEscapePrefix, eMechanism, eCharset) :
               rtl::OUString();
}

inline INetURLObject::INetURLObject(ByteString const & rTheAbsURIRef,
                                    EncodeMechanism eMechanism,
                                    rtl_TextEncoding eCharset):
    m_eScheme(INET_PROT_NOT_VALID), m_eSmartScheme(INET_PROT_HTTP)
{
    setAbsURIRef(extend(rTheAbsURIRef), true, eMechanism, eCharset, false,
                 FSysStyle(0));
}

inline INetURLObject::INetURLObject(rtl::OUString const & rTheAbsURIRef,
                                    EncodeMechanism eMechanism,
                                    rtl_TextEncoding eCharset):
    m_eScheme(INET_PROT_NOT_VALID), m_eSmartScheme(INET_PROT_HTTP)
{
    setAbsURIRef(rTheAbsURIRef, false, eMechanism, eCharset, false,
                 FSysStyle(0));
}

inline bool INetURLObject::SetURL(ByteString const & rTheAbsURIRef,
                                  EncodeMechanism eMechanism,
                                  rtl_TextEncoding eCharset)
{
    return setAbsURIRef(extend(rTheAbsURIRef), true, eMechanism, eCharset,
                        false, FSysStyle(0));
}

inline bool INetURLObject::SetURL(rtl::OUString const & rTheAbsURIRef,
                                  EncodeMechanism eMechanism,
                                  rtl_TextEncoding eCharset)
{
    return setAbsURIRef(rTheAbsURIRef, false, eMechanism, eCharset, false,
                        FSysStyle(0));
}

inline INetURLObject::INetURLObject(rtl::OUString const & rTheAbsURIRef,
                                    INetProtocol eTheSmartScheme,
                                    EncodeMechanism eMechanism,
                                    rtl_TextEncoding eCharset,
                                    FSysStyle eStyle):
    m_eScheme(INET_PROT_NOT_VALID), m_eSmartScheme(eTheSmartScheme)
{
    setAbsURIRef(rTheAbsURIRef, false, eMechanism, eCharset, true, eStyle);
}

inline bool INetURLObject::SetSmartURL(ByteString const & rTheAbsURIRef,
                                       EncodeMechanism eMechanism,
                                       rtl_TextEncoding eCharset,
                                       FSysStyle eStyle)
{
    return setAbsURIRef(extend(rTheAbsURIRef), true, eMechanism, eCharset,
                        true, eStyle);
}

inline bool INetURLObject::SetSmartURL(rtl::OUString const & rTheAbsURIRef,
                                       EncodeMechanism eMechanism,
                                       rtl_TextEncoding eCharset,
                                       FSysStyle eStyle)
{
    return setAbsURIRef(rTheAbsURIRef, false, eMechanism, eCharset, true,
                        eStyle);
}

inline INetURLObject
INetURLObject::smartRel2Abs(ByteString const & rTheRelURIRef,
                            bool & rWasAbsolute,
                            bool bIgnoreFragment,
                            EncodeMechanism eMechanism,
                            rtl_TextEncoding eCharset,
                            bool bRelativeNonURIs,
                            FSysStyle eStyle) const
{
    INetURLObject aTheAbsURIRef;
    convertRelToAbs(extend(rTheRelURIRef), true, aTheAbsURIRef, rWasAbsolute,
                    eMechanism, eCharset, bIgnoreFragment, true,
                    bRelativeNonURIs, eStyle);
    return aTheAbsURIRef;
}

inline INetURLObject
INetURLObject::smartRel2Abs(rtl::OUString const & rTheRelURIRef,
                            bool & rWasAbsolute,
                            bool bIgnoreFragment,
                            EncodeMechanism eMechanism,
                            rtl_TextEncoding eCharset,
                            bool bRelativeNonURIs,
                            FSysStyle eStyle) const
{
    INetURLObject aTheAbsURIRef;
    convertRelToAbs(rTheRelURIRef, false, aTheAbsURIRef, rWasAbsolute,
                    eMechanism, eCharset, bIgnoreFragment, true,
                    bRelativeNonURIs, eStyle);
    return aTheAbsURIRef;
}

inline bool INetURLObject::GetNewAbsURL(ByteString const & rTheRelURIRef,
                                        INetURLObject * pTheAbsURIRef,
                                        EncodeMechanism eMechanism,
                                        rtl_TextEncoding eCharset,
                                        FSysStyle eStyle, bool bIgnoreFragment)
    const
{
    INetURLObject aTheAbsURIRef;
    bool bWasAbsolute;
    if (!convertRelToAbs(extend(rTheRelURIRef), true, aTheAbsURIRef,
                         bWasAbsolute, eMechanism, eCharset, bIgnoreFragment,
                         false, false, eStyle))
        return false;
    if (pTheAbsURIRef)
        *pTheAbsURIRef = aTheAbsURIRef;
    return true;
}

inline bool INetURLObject::GetNewAbsURL(rtl::OUString const & rTheRelURIRef,
                                        INetURLObject * pTheAbsURIRef,
                                        EncodeMechanism eMechanism,
                                        rtl_TextEncoding eCharset,
                                        FSysStyle eStyle, bool bIgnoreFragment)
    const
{
    INetURLObject aTheAbsURIRef;
    bool bWasAbsolute;
    if (!convertRelToAbs(rTheRelURIRef, false, aTheAbsURIRef, bWasAbsolute,
                         eMechanism, eCharset, bIgnoreFragment, false, false,
                         eStyle))
        return false;
    if (pTheAbsURIRef)
        *pTheAbsURIRef = aTheAbsURIRef;
    return true;
}

// static
inline rtl::OUString INetURLObject::GetRelURL(ByteString const & rTheBaseURIRef,
                                          ByteString const & rTheAbsURIRef,
                                          EncodeMechanism eEncodeMechanism,
                                          DecodeMechanism eDecodeMechanism,
                                          rtl_TextEncoding eCharset,
                                          FSysStyle eStyle)
{
    rtl::OUString aTheRelURIRef;
    INetURLObject(rTheBaseURIRef, eEncodeMechanism, eCharset).
        convertAbsToRel(extend(rTheAbsURIRef), true, aTheRelURIRef,
                        eEncodeMechanism, eDecodeMechanism, eCharset, eStyle);
    return aTheRelURIRef;
}

// static
inline rtl::OUString INetURLObject::GetRelURL(rtl::OUString const & rTheBaseURIRef,
                                          rtl::OUString const & rTheAbsURIRef,
                                          EncodeMechanism eEncodeMechanism,
                                          DecodeMechanism eDecodeMechanism,
                                          rtl_TextEncoding eCharset,
                                          FSysStyle eStyle)
{
    rtl::OUString aTheRelURIRef;
    INetURLObject(rTheBaseURIRef, eEncodeMechanism, eCharset).
        convertAbsToRel(rTheAbsURIRef, false, aTheRelURIRef, eEncodeMechanism,
                        eDecodeMechanism, eCharset, eStyle);
    return aTheRelURIRef;
}

// static
inline bool INetURLObject::translateToExternal(ByteString const &
                                                   rTheIntURIRef,
                                               rtl::OUString & rTheExtURIRef,
                                               DecodeMechanism
                                                   eDecodeMechanism,
                                               rtl_TextEncoding eCharset)
{
    rtl::OUString aTheExtURIRef;
    bool bRet = convertIntToExt(extend(rTheIntURIRef), true, aTheExtURIRef,
                                eDecodeMechanism, eCharset);
    rTheExtURIRef = aTheExtURIRef;
    return bRet;
}

// static
inline bool INetURLObject::translateToExternal(rtl::OUString const &
                                                   rTheIntURIRef,
                                               rtl::OUString & rTheExtURIRef,
                                               DecodeMechanism
                                                   eDecodeMechanism,
                                               rtl_TextEncoding eCharset)
{
    return convertIntToExt(rTheIntURIRef, false, rTheExtURIRef,
                           eDecodeMechanism, eCharset);
}

// static
inline bool INetURLObject::translateToInternal(ByteString const &
                                                   rTheExtURIRef,
                                               rtl::OUString & rTheIntURIRef,
                                               DecodeMechanism
                                                   eDecodeMechanism,
                                               rtl_TextEncoding eCharset)
{
    rtl::OUString aTheIntURIRef;
    bool bRet = convertExtToInt(extend(rTheExtURIRef), true, aTheIntURIRef,
                           eDecodeMechanism, eCharset);
    rTheIntURIRef = aTheIntURIRef;
    return bRet;
}

// static
inline bool INetURLObject::translateToInternal(rtl::OUString const &
                                                   rTheExtURIRef,
                                               rtl::OUString & rTheIntURIRef,
                                               DecodeMechanism
                                                   eDecodeMechanism,
                                               rtl_TextEncoding eCharset)
{
    return convertExtToInt(rTheExtURIRef, false, rTheIntURIRef,
                           eDecodeMechanism, eCharset);
}

inline bool INetURLObject::SetPass(ByteString const & rThePassword,
                                   EncodeMechanism eMechanism,
                                   rtl_TextEncoding eCharset)
{
    return rThePassword.Len() == 0 ?
               clearPassword() :
               setPassword(extend(rThePassword), true, eMechanism, eCharset);
}

inline bool INetURLObject::SetPass(rtl::OUString const & rThePassword,
                                   EncodeMechanism eMechanism,
                                   rtl_TextEncoding eCharset)
{
    return rThePassword.getLength() == 0 ?
               clearPassword() :
               setPassword(rThePassword, false, eMechanism, eCharset);
}

inline bool INetURLObject::SetUserAndPass(ByteString const & rTheUser,
                                          ByteString const & rThePassword,
                                          EncodeMechanism eMechanism,
                                          rtl_TextEncoding eCharset)
{
    return setUser(extend(rTheUser), true, eMechanism, eCharset)
           && (rThePassword.Len() == 0 ?
                   clearPassword() :
                   setPassword(extend(rThePassword), true, eMechanism,
                               eCharset));
}

inline bool INetURLObject::SetUserAndPass(rtl::OUString const & rTheUser,
                                          rtl::OUString const & rThePassword,
                                          EncodeMechanism eMechanism,
                                          rtl_TextEncoding eCharset)
{
    return setUser(rTheUser, false, eMechanism, eCharset)
           && (rThePassword.getLength() == 0 ?
                   clearPassword() :
                   setPassword(rThePassword, false, eMechanism, eCharset));
}

// static
inline rtl::OUString INetURLObject::encodeHostPort(ByteString const &
                                                   rTheHostPort,
                                               EncodeMechanism eMechanism,
                                               rtl_TextEncoding eCharset)
{
    return encodeHostPort(extend(rTheHostPort), true, eMechanism, eCharset);
}

inline bool INetURLObject::insertName(rtl::OUString const & rTheName,
                                      bool bAppendFinalSlash,
                                      sal_Int32 nIndex,
                                      bool bIgnoreFinalSlash,
                                      EncodeMechanism eMechanism,
                                      rtl_TextEncoding eCharset)
{
    return insertName(rTheName, false, bAppendFinalSlash, nIndex,
                      bIgnoreFinalSlash, eMechanism, eCharset);
}

inline bool INetURLObject::SetParam(ByteString const & rTheQuery,
                                    EncodeMechanism eMechanism,
                                    rtl_TextEncoding eCharset)
{
    return rTheQuery.Len() == 0 ?
               clearQuery() :
               setQuery(extend(rTheQuery), true, eMechanism, eCharset);
}

inline bool INetURLObject::SetParam(rtl::OUString const & rTheQuery,
                                    EncodeMechanism eMechanism,
                                    rtl_TextEncoding eCharset)
{
    return rTheQuery.getLength() == 0 ?
               clearQuery() :
               setQuery(rTheQuery, false, eMechanism, eCharset);
}

inline bool INetURLObject::SetMark(ByteString const & rTheFragment,
                                   EncodeMechanism eMechanism,
                                   rtl_TextEncoding eCharset)
{
    return rTheFragment.Len() == 0 ?
               clearFragment() :
               setFragment(extend(rTheFragment), true, eMechanism, eCharset);
}

inline bool INetURLObject::SetMark(rtl::OUString const & rTheFragment,
                                   EncodeMechanism eMechanism,
                                   rtl_TextEncoding eCharset)
{
    return rTheFragment.getLength() == 0 ?
               clearFragment() :
               setFragment(rTheFragment, false, eMechanism, eCharset);
}

inline INetURLObject::INetURLObject(rtl::OUString const & rFSysPath,
                                    FSysStyle eStyle):
    m_eScheme(INET_PROT_NOT_VALID), m_eSmartScheme(INET_PROT_HTTP)
{
    setFSysPath(rFSysPath, eStyle);
}

// static
inline rtl::OUString INetURLObject::encode(ByteString const & rText, Part ePart,
                                       sal_Char cEscapePrefix,
                                       EncodeMechanism eMechanism,
                                       rtl_TextEncoding eCharset)
{
    return encodeText(extend(rText), true, ePart, cEscapePrefix, eMechanism,
                      eCharset, false);
}

// static
inline rtl::OUString INetURLObject::encode(rtl::OUString const & rText, Part ePart,
                                       sal_Char cEscapePrefix,
                                       EncodeMechanism eMechanism,
                                       rtl_TextEncoding eCharset)
{
    return encodeText(rText, false, ePart, cEscapePrefix, eMechanism,
                      eCharset, false);
}

// static
inline rtl::OUString INetURLObject::decode(rtl::OUString const & rText,
                                       sal_Char cEscapePrefix,
                                       DecodeMechanism eMechanism,
                                       rtl_TextEncoding eCharset)
{
    return decode(rText.getStr(), rText.getStr() + rText.getLength(),
                  cEscapePrefix, eMechanism, eCharset);
}

inline rtl::OUString INetURLObject::decode(rtl::OUStringBuffer const & rText,
                                       sal_Char cEscapePrefix,
                                       DecodeMechanism eMechanism,
                                       rtl_TextEncoding eCharset)
{
    return decode(rText.getStr(), rText.getStr() + rText.getLength(),
                  cEscapePrefix, eMechanism, eCharset);
}

#endif // _URLOBJ_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */