From ed5640d8b587fbcfed7dd7967f3de04b37a76f26 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 11:06:44 +0200 Subject: Adding upstream version 4:7.4.7. Signed-off-by: Daniel Baumann --- udkapi/com/sun/star/uri/XUriReferenceFactory.idl | 160 +++++++++++++++++++++++ 1 file changed, 160 insertions(+) create mode 100644 udkapi/com/sun/star/uri/XUriReferenceFactory.idl (limited to 'udkapi/com/sun/star/uri/XUriReferenceFactory.idl') diff --git a/udkapi/com/sun/star/uri/XUriReferenceFactory.idl b/udkapi/com/sun/star/uri/XUriReferenceFactory.idl new file mode 100644 index 000000000..e87542aa4 --- /dev/null +++ b/udkapi/com/sun/star/uri/XUriReferenceFactory.idl @@ -0,0 +1,160 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef __com_sun_star_uri_XUriReferenceFactory_idl__ +#define __com_sun_star_uri_XUriReferenceFactory_idl__ + +#include +#include +#include + +module com { module sun { module star { module uri { + +/** + creates URI references. + +

See RFC 3986 for a + description of URI references and related terms.

+ + @since OOo 2.0 + */ +published interface XUriReferenceFactory: com::sun::star::uno::XInterface { + /** + parses the textual representation of a URI reference. + + @param uriReference + the textual representation of a URI reference. + + @returns + an object that supports + com::sun::star::uri::XUriReference (and possibly also + additional, scheme-specific interfaces), if the given input can be parsed + into a URI reference; otherwise, `NULL` is returned. + */ + XUriReference parse([in] string uriReference); + + /** + resolves a relative URI reference to absolute form. + + @param baseUriReference + the base URI reference. If the given uriReference is a + same-document reference, baseUriReference is used as a + reference to the current document. + + @param uriReference + any URI reference. Backwards-compatible relative URI references starting + with a scheme component (see RFC 3986, Sections 5.2.2 and 5.4,2) + are not supported; instead, they are interpreted as absolute + URI references. + + @param processAdditionalSpecialSegments + if `TRUE`, special segments (“.” and + “..”) within the path of the base URI (except + for the last, cut-off segment), and within an already absolute uriReference, are + processed as required by + RFC 3986. If `FALSE`, such special segments + are treated like ordinary segments. + Conformance with RFC 3986 requires `TRUE` to be passed. + + @param excessParentSegments + details how excess special parent segments + (“..”) are handled. + Conformance with RFC 3986 requires REMOVE to be passed. + + @returns + a fresh object that supports + com::sun::star::uri::XUriReference (and possibly also + additional, scheme-specific interfaces), if the given + uriReference can be resolved + to an absolute URI reference, relative to the given + baseUriReference; otherwise, `NULL` is returned. + Especially, if baseUriReference is `NULL`, or is not an + absolute URI reference, or if uriReference is + `NULL`, then `NULL` is always returned. + */ + XUriReference makeAbsolute( + [in] XUriReference baseUriReference, [in] XUriReference uriReference, + [in] boolean processAdditionalSpecialSegments, + [in] RelativeUriExcessParentSegments excessParentSegments); + + /** + changes an absolute URI reference to relative form. + + @param baseUriReference + the base URI reference. + + @param uriReference + any URI reference. + + @param preferAuthorityOverRelativePath + controls how a relative URI reference is generated when both + baseUriReference (e.g., + “scheme://auth/a/b”) and + uriReference (e.g., + “scheme://auth//c/d”) have the same scheme and + authority components, and the path component of uriReference + starts with “//”. If `TRUE`, the generated + relative URI reference includes an authority component (e.g., + “//auth//c/d”); if `FALSE`, the generated + relative URI reference has a relative path (e.g., + “..//c/d”). + + @param preferAbsoluteOverRelativePath + controls how a relative URI reference is generated when both + baseUriReference (e.g., + “scheme://auth/a/b”) and + uriReference (e.g., + “scheme://auth/c/d”) have the same scheme and + authority components (if present), but share no common path segments. If + `TRUE`, the generated relative URI reference has an absolute path (e.g., + “/c/d”); if `FALSE`, the generated relative URI + reference has a relative path (e.g., “../c/d”). + + @param encodeRetainedSpecialSegments + if `TRUE`, special segments (“.” and + “..”) that are already present in the path + component of the given uriReference and which end up in a + relative path returned from this method, are encoded (as + “%2E” and “%2E%2E”, + respectively). + + @returns + a fresh object that supports + com::sun::star::uri::XUriReference, if the given + uriReference is either already relative, or has a relative + path, or is of a different scheme than the given + baseUriReference, or can be changed to a relative URI + reference, relative to the given baseUriReference; + otherwise, `NULL` is returned. Especially, if + baseUriReference is `NULL`, or is not an absolute + URI reference, or if uriReference is `NULL`, + then `NULL` is always returned. + */ + XUriReference makeRelative( + [in] XUriReference baseUriReference, [in] XUriReference uriReference, + [in] boolean preferAuthorityOverRelativePath, + [in] boolean preferAbsoluteOverRelativePath, + [in] boolean encodeRetainedSpecialSegments); +}; + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ -- cgit v1.2.3