Files
libreoffice/xmlhelp/source/cxxhelp/provider/provider.hxx
Caolán McNamara acad8441cc cppcheck: noExplicitConstructor
Change-Id: I62076450ab77472bfd09b3fb9824f54b6ea1e0f7
2015-05-25 12:32:54 +01:00

185 lines
7.2 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* 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 .
*/
#ifndef INCLUDED_XMLHELP_SOURCE_CXXHELP_PROVIDER_PROVIDER_HXX
#define INCLUDED_XMLHELP_SOURCE_CXXHELP_PROVIDER_PROVIDER_HXX
#include <rtl/ustring.hxx>
#include <osl/mutex.hxx>
#include <ucbhelper/providerhelper.hxx>
#include <com/sun/star/container/XHierarchicalNameAccess.hpp>
#include <com/sun/star/container/XContainerListener.hpp>
#include <com/sun/star/container/XContainer.hpp>
#include <com/sun/star/lang/XComponent.hpp>
namespace chelp {
// UNO service name for the provider. This name will be used by the UCB to
// create instances of the provider.
#define MYUCP_CONTENT_PROVIDER_SERVICE_NAME1 "com.sun.star.help.XMLHelp"
#define MYUCP_CONTENT_PROVIDER_SERVICE_NAME2 "com.sun.star.ucb.HelpContentProvider"
// URL scheme. This is the scheme the provider will be able to create
// contents for. The UCB will select the provider ( i.e. in order to create
// contents ) according to this scheme.
#define MYUCP_URL_SCHEME "vnd.sun.star.help"
#define MYUCP_CONTENT_TYPE "application/vnd.sun.star.xmlhelp" // UCB Content Type.
class Databases;
class ContentProvider :
public ::ucbhelper::ContentProviderImplHelper,
public ::com::sun::star::container::XContainerListener,
public ::com::sun::star::lang::XComponent
{
public:
explicit ContentProvider(
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& rxContext );
virtual ~ContentProvider();
// XInterface
virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type & rType )
throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
virtual void SAL_CALL acquire()
throw() SAL_OVERRIDE;
virtual void SAL_CALL release()
throw() SAL_OVERRIDE;
// XTypeProvider
virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId()
throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes()
throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
// XServiceInfo
virtual OUString SAL_CALL getImplementationName()
throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName )
throw( css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames()
throw( css::uno::RuntimeException,
std::exception ) SAL_OVERRIDE;
static OUString getImplementationName_Static();
static css::uno::Sequence< OUString > getSupportedServiceNames_Static();
static css::uno::Reference< css::lang::XSingleServiceFactory > createServiceFactory(
const css::uno::Reference< css::lang::XMultiServiceFactory >& rxServiceMgr );
// XContentProvider
virtual css::uno::Reference< css::ucb::XContent > SAL_CALL queryContent(
const css::uno::Reference< css::ucb::XContentIdentifier >& Identifier )
throw( css::ucb::IllegalIdentifierException,
css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
// Additional interfaces
// XComponent
virtual void SAL_CALL
dispose( )
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL
addEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& xListener )
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE
{
(void)xListener;
}
virtual void SAL_CALL
removeEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& aListener )
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE
{
(void)aListener;
}
// XConainerListener ( deriver from XEventListener )
virtual void SAL_CALL
disposing( const ::com::sun::star::lang::EventObject& Source )
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE
{
(void)Source;
m_xContainer = com::sun::star::uno::Reference<com::sun::star::container::XContainer>(0);
}
virtual void SAL_CALL
elementInserted( const ::com::sun::star::container::ContainerEvent& Event )
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE
{
(void)Event;
}
virtual void SAL_CALL
elementRemoved( const ::com::sun::star::container::ContainerEvent& Event )
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE
{
(void)Event;
}
virtual void SAL_CALL
elementReplaced( const ::com::sun::star::container::ContainerEvent& Event )
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// Non-interface methods.
private:
osl::Mutex m_aMutex;
bool isInitialized;
OUString m_aScheme;
Databases* m_pDatabases;
com::sun::star::uno::Reference<com::sun::star::container::XContainer> m_xContainer;
// private methods
void init();
::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >
getConfiguration() const;
static ::com::sun::star::uno::Reference< ::com::sun::star::container::XHierarchicalNameAccess >
getHierAccess( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& sProvider,
const char* file );
static OUString
getKey( const ::com::sun::star::uno::Reference< ::com::sun::star::container::XHierarchicalNameAccess >& xHierAccess,
const char* key );
static bool
getBooleanKey(
const ::com::sun::star::uno::Reference<
::com::sun::star::container::XHierarchicalNameAccess >& xHierAccess,
const char* key);
static void subst( OUString& instpath );
};
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */