/* -*- 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 2396 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 2396, Section 5.2, step 3) are not supported; instead, they are interpreted as absolute URI references. @param processSpecialBaseSegments if `TRUE`, special segments (“.” and “..”) within the path of the base URI (except for the last, cut-off segment) are processed as suggested by RFC 2396. If `FALSE`, special segments within the path of the base URI are treated like ordinary segments. @param excessParentSegments details how excess special parent segments (“..”) are handled. @returns a fresh object that supports com::sun::star::uri::XUriReference (and possibly also additional, scheme-specific interfaces), if the given uriReference is either already absolute, or 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, hierarchical URI reference, or if uriReference is `NULL`, then `NULL` is always returned. */ XUriReference makeAbsolute( [in] XUriReference baseUriReference, [in] XUriReference uriReference, [in] boolean processSpecialBaseSegments, [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 is not hierarchical, 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, hierarchical 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: */