1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 #ifndef INCLUDED_DESKTOP_SOURCE_DEPLOYMENT_INC_DP_IDENTIFIER_HXX
29 #define INCLUDED_DESKTOP_SOURCE_DEPLOYMENT_INC_DP_IDENTIFIER_HXX
30 
31 #include "sal/config.h"
32 
33 #include "boost/optional.hpp"
34 #include "com/sun/star/uno/Reference.hxx"
35 
36 #include "dp_misc_api.hxx"
37 
38 namespace com { namespace sun { namespace star { namespace deployment {
39     class XPackage;
40 } } } }
41 namespace rtl { class OUString; }
42 
43 namespace dp_misc {
44 
45 /**
46    Generates an identifier from an optional identifier.
47 
48    @param optional
49    an optional identifier
50 
51    @param fileName
52    a file name
53 
54    @return
55    the given optional identifier if present, otherwise a legacy identifier based
56    on the given file name
57 */
58 DESKTOP_DEPLOYMENTMISC_DLLPUBLIC ::rtl::OUString generateIdentifier(
59     ::boost::optional< ::rtl::OUString > const & optional,
60     ::rtl::OUString const & fileName);
61 
62 /**
63    Gets the identifier of a package.
64 
65    @param package
66    a non-null package
67 
68    @return
69    the explicit identifier of the given package if present, otherwise the
70    implicit legacy identifier of the given package
71 
72    @throws com::sun::star::uno::RuntimeException
73 */
74 DESKTOP_DEPLOYMENTMISC_DLLPUBLIC ::rtl::OUString getIdentifier(
75     ::com::sun::star::uno::Reference< ::com::sun::star::deployment::XPackage >
76         const & package);
77 
78 /**
79    Generates a legacy identifier based on a file name.
80 
81    @param fileName
82    a file name
83 
84    @return
85    a legacy identifier based on the given file name
86 */
87 DESKTOP_DEPLOYMENTMISC_DLLPUBLIC ::rtl::OUString generateLegacyIdentifier(
88     ::rtl::OUString const & fileName);
89 
90 }
91 
92 #endif
93