| /************************************************************** |
| * |
| * 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 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #ifndef INCLUDED_DESKTOP_SOURCE_DEPLOYMENT_INC_DP_IDENTIFIER_HXX |
| #define INCLUDED_DESKTOP_SOURCE_DEPLOYMENT_INC_DP_IDENTIFIER_HXX |
| |
| #include "sal/config.h" |
| |
| #include "boost/optional.hpp" |
| #include "com/sun/star/uno/Reference.hxx" |
| |
| #include "dp_misc_api.hxx" |
| |
| namespace com { namespace sun { namespace star { namespace deployment { |
| class XPackage; |
| } } } } |
| namespace rtl { class OUString; } |
| |
| namespace dp_misc { |
| |
| /** |
| Generates an identifier from an optional identifier. |
| |
| @param optional |
| an optional identifier |
| |
| @param fileName |
| a file name |
| |
| @return |
| the given optional identifier if present, otherwise a legacy identifier based |
| on the given file name |
| */ |
| DESKTOP_DEPLOYMENTMISC_DLLPUBLIC ::rtl::OUString generateIdentifier( |
| ::boost::optional< ::rtl::OUString > const & optional, |
| ::rtl::OUString const & fileName); |
| |
| /** |
| Gets the identifier of a package. |
| |
| @param package |
| a non-null package |
| |
| @return |
| the explicit identifier of the given package if present, otherwise the |
| implicit legacy identifier of the given package |
| |
| @throws com::sun::star::uno::RuntimeException |
| */ |
| DESKTOP_DEPLOYMENTMISC_DLLPUBLIC ::rtl::OUString getIdentifier( |
| ::com::sun::star::uno::Reference< ::com::sun::star::deployment::XPackage > |
| const & package); |
| |
| /** |
| Generates a legacy identifier based on a file name. |
| |
| @param fileName |
| a file name |
| |
| @return |
| a legacy identifier based on the given file name |
| */ |
| DESKTOP_DEPLOYMENTMISC_DLLPUBLIC ::rtl::OUString generateLegacyIdentifier( |
| ::rtl::OUString const & fileName); |
| |
| } |
| |
| #endif |