1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef INCLUDED_DESKTOP_SOURCE_DEPLOYMENT_INC_DP_IDENTIFIER_HXX 25*b1cdbd2cSJim Jagielski #define INCLUDED_DESKTOP_SOURCE_DEPLOYMENT_INC_DP_IDENTIFIER_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include "sal/config.h" 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielski #include "boost/optional.hpp" 30*b1cdbd2cSJim Jagielski #include "com/sun/star/uno/Reference.hxx" 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielski #include "dp_misc_api.hxx" 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski namespace com { namespace sun { namespace star { namespace deployment { 35*b1cdbd2cSJim Jagielski class XPackage; 36*b1cdbd2cSJim Jagielski } } } } 37*b1cdbd2cSJim Jagielski namespace rtl { class OUString; } 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski namespace dp_misc { 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski /** 42*b1cdbd2cSJim Jagielski Generates an identifier from an optional identifier. 43*b1cdbd2cSJim Jagielski 44*b1cdbd2cSJim Jagielski @param optional 45*b1cdbd2cSJim Jagielski an optional identifier 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski @param fileName 48*b1cdbd2cSJim Jagielski a file name 49*b1cdbd2cSJim Jagielski 50*b1cdbd2cSJim Jagielski @return 51*b1cdbd2cSJim Jagielski the given optional identifier if present, otherwise a legacy identifier based 52*b1cdbd2cSJim Jagielski on the given file name 53*b1cdbd2cSJim Jagielski */ 54*b1cdbd2cSJim Jagielski DESKTOP_DEPLOYMENTMISC_DLLPUBLIC ::rtl::OUString generateIdentifier( 55*b1cdbd2cSJim Jagielski ::boost::optional< ::rtl::OUString > const & optional, 56*b1cdbd2cSJim Jagielski ::rtl::OUString const & fileName); 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielski /** 59*b1cdbd2cSJim Jagielski Gets the identifier of a package. 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski @param package 62*b1cdbd2cSJim Jagielski a non-null package 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski @return 65*b1cdbd2cSJim Jagielski the explicit identifier of the given package if present, otherwise the 66*b1cdbd2cSJim Jagielski implicit legacy identifier of the given package 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski @throws com::sun::star::uno::RuntimeException 69*b1cdbd2cSJim Jagielski */ 70*b1cdbd2cSJim Jagielski DESKTOP_DEPLOYMENTMISC_DLLPUBLIC ::rtl::OUString getIdentifier( 71*b1cdbd2cSJim Jagielski ::com::sun::star::uno::Reference< ::com::sun::star::deployment::XPackage > 72*b1cdbd2cSJim Jagielski const & package); 73*b1cdbd2cSJim Jagielski 74*b1cdbd2cSJim Jagielski /** 75*b1cdbd2cSJim Jagielski Generates a legacy identifier based on a file name. 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski @param fileName 78*b1cdbd2cSJim Jagielski a file name 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski @return 81*b1cdbd2cSJim Jagielski a legacy identifier based on the given file name 82*b1cdbd2cSJim Jagielski */ 83*b1cdbd2cSJim Jagielski DESKTOP_DEPLOYMENTMISC_DLLPUBLIC ::rtl::OUString generateLegacyIdentifier( 84*b1cdbd2cSJim Jagielski ::rtl::OUString const & fileName); 85*b1cdbd2cSJim Jagielski 86*b1cdbd2cSJim Jagielski } 87*b1cdbd2cSJim Jagielski 88*b1cdbd2cSJim Jagielski #endif 89