1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef COMPILE_HXX
29*cdf0e10cSrcweir #define COMPILE_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include "sal/types.h"
32*cdf0e10cSrcweir 
33*cdf0e10cSrcweir #if defined(HELPLINKER_DLLIMPLEMENTATION)
34*cdf0e10cSrcweir #define HELPLINKER_DLLPUBLIC  SAL_DLLPUBLIC_EXPORT
35*cdf0e10cSrcweir #else
36*cdf0e10cSrcweir #define HELPLINKER_DLLPUBLIC  SAL_DLLPUBLIC_IMPORT
37*cdf0e10cSrcweir #endif
38*cdf0e10cSrcweir #define HELPLINKER_DLLPRIVATE SAL_DLLPRIVATE
39*cdf0e10cSrcweir 
40*cdf0e10cSrcweir 
41*cdf0e10cSrcweir //#include <helplinkerdllapi.h>
42*cdf0e10cSrcweir #include <rtl/ustring.hxx>
43*cdf0e10cSrcweir 
44*cdf0e10cSrcweir enum HelpProcessingErrorClass
45*cdf0e10cSrcweir {
46*cdf0e10cSrcweir 	HELPPROCESSING_NO_ERROR,
47*cdf0e10cSrcweir 	HELPPROCESSING_GENERAL_ERROR,		// Missing files, options etc.
48*cdf0e10cSrcweir 	HELPPROCESSING_INTERNAL_ERROR,		// Unexpected problems
49*cdf0e10cSrcweir 	HELPPROCESSING_XMLPARSING_ERROR		// Errors thrown by libxml
50*cdf0e10cSrcweir };
51*cdf0e10cSrcweir 
52*cdf0e10cSrcweir struct HelpProcessingErrorInfo
53*cdf0e10cSrcweir {
54*cdf0e10cSrcweir 	HelpProcessingErrorClass		m_eErrorClass;
55*cdf0e10cSrcweir 	rtl::OUString					m_aErrorMsg;
56*cdf0e10cSrcweir 	rtl::OUString					m_aXMLParsingFile;
57*cdf0e10cSrcweir 	sal_Int32						m_nXMLParsingLine;
58*cdf0e10cSrcweir 
59*cdf0e10cSrcweir 	HelpProcessingErrorInfo( void )
60*cdf0e10cSrcweir 		: m_eErrorClass( HELPPROCESSING_NO_ERROR )
61*cdf0e10cSrcweir 		, m_nXMLParsingLine( -1 )
62*cdf0e10cSrcweir 	{}
63*cdf0e10cSrcweir 
64*cdf0e10cSrcweir 	HelpProcessingErrorInfo& operator=( const struct HelpProcessingException& e );
65*cdf0e10cSrcweir };
66*cdf0e10cSrcweir 
67*cdf0e10cSrcweir 
68*cdf0e10cSrcweir // Returns true in case of success, false in case of error
69*cdf0e10cSrcweir HELPLINKER_DLLPUBLIC bool compileExtensionHelp
70*cdf0e10cSrcweir (
71*cdf0e10cSrcweir  	const rtl::OUString& aOfficeHelpPath,
72*cdf0e10cSrcweir 	const rtl::OUString& aExtensionName,
73*cdf0e10cSrcweir 	const rtl::OUString& aExtensionLanguageRoot,
74*cdf0e10cSrcweir 	sal_Int32 nXhpFileCount, const rtl::OUString* pXhpFiles,
75*cdf0e10cSrcweir     const rtl::OUString& aDestination,
76*cdf0e10cSrcweir 	HelpProcessingErrorInfo& o_rHelpProcessingErrorInfo
77*cdf0e10cSrcweir );
78*cdf0e10cSrcweir 
79*cdf0e10cSrcweir #endif
80