desktop/source/deployment/inc/dp_identifier.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <sal/config.h>
  23
  24 #include <optional>
  25 #include <string_view>
  26
  27 #include <com/sun/star/uno/Reference.hxx>
  28
  29 #include "dp_misc_api.hxx"
  30
  31 namespace com::sun::star::deployment {
  32     class XPackage;
  33 }
  34
  35 namespace dp_misc {
  36
  37 /**
  38    Generates an identifier from an optional identifier.
  39
  40    @param optional
  41    an optional identifier
  42
  43    @param fileName
  44    a file name
  45
  46    @return
  47    the given optional identifier if present, otherwise a legacy identifier based
  48    on the given file name
  49 */
  50 DESKTOP_DEPLOYMENTMISC_DLLPUBLIC OUString generateIdentifier(
  51     ::std::optional< OUString > const & optional,
  52     std::u16string_view fileName);
  53
  54 /**
  55    Gets the identifier of a package.
  56
  57    @param package
  58    a non-null package
  59
  60    @return
  61    the explicit identifier of the given package if present, otherwise the
  62    implicit legacy identifier of the given package
  63
  64    @throws css::uno::RuntimeException
  65 */
  66 DESKTOP_DEPLOYMENTMISC_DLLPUBLIC OUString getIdentifier(
  67     css::uno::Reference< css::deployment::XPackage >
  68         const & package);
  69
  70 /**
  71    Generates a legacy identifier based on a file name.
  72
  73    @param fileName
  74    a file name
  75
  76    @return
  77    a legacy identifier based on the given file name
  78 */
  79 DESKTOP_DEPLOYMENTMISC_DLLPUBLIC OUString generateLegacyIdentifier(
  80     std::u16string_view fileName);
  81
  82 }
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */