1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
|
/* -*- 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_UCB_SOURCE_UCP_FILE_FILTASK_HXX
#define INCLUDED_UCB_SOURCE_UCP_FILE_FILTASK_HXX
#endif
#include <boost/unordered_map.hpp>
#include <rtl/ustring.hxx>
#include "osl/mutex.hxx"
#include <com/sun/star/ucb/DuplicateCommandIdentifierException.hpp>
#include <com/sun/star/ucb/XCommandEnvironment.hpp>
#include <com/sun/star/ucb/XProgressHandler.hpp>
#include <com/sun/star/task/XInteractionHandler.hpp>
#include <com/sun/star/task/XInteractionRequest.hpp>
#include "filerror.hxx"
namespace fileaccess
{
class BaseContent;
/*
* This implementation is inherited by class fileaccess::shell.
* The relevant methods in this class all have as first argument the CommandId,
* so if necessary, every method has access to its relevant XInteractionHandler and
* XProgressHandler.
*/
class TaskManager
{
protected:
class TaskHandling
{
private:
bool m_bAbort,m_bHandled;
sal_Int32 m_nErrorCode,m_nMinorCode;
com::sun::star::uno::Reference< com::sun::star::task::XInteractionHandler > m_xInteractionHandler;
com::sun::star::uno::Reference< com::sun::star::ucb::XProgressHandler > m_xProgressHandler;
com::sun::star::uno::Reference< com::sun::star::ucb::XCommandEnvironment > m_xCommandEnvironment;
public:
TaskHandling(
const com::sun::star::uno::Reference< com::sun::star::ucb::XCommandEnvironment >& xCommandEnv
= com::sun::star::uno::Reference< com::sun::star::ucb::XCommandEnvironment >( 0 ) )
: m_bAbort( false ),
m_bHandled( false ),
m_nErrorCode( TASKHANDLER_NO_ERROR ),
m_nMinorCode( TASKHANDLER_NO_ERROR ),
m_xInteractionHandler( 0 ),
m_xProgressHandler( 0 ),
m_xCommandEnvironment( xCommandEnv )
{
}
void SAL_CALL abort()
{
m_bAbort = true;
}
void setHandled()
{
m_bHandled = true;
}
bool isHandled() const
{
return true;
}
void clearError()
{
m_nErrorCode = TASKHANDLER_NO_ERROR;
m_nMinorCode = TASKHANDLER_NO_ERROR;
}
void SAL_CALL installError( sal_Int32 nErrorCode,
sal_Int32 nMinorCode = TASKHANDLER_NO_ERROR )
{
m_nErrorCode = nErrorCode;
m_nMinorCode = nMinorCode;
}
sal_Int32 SAL_CALL getInstalledError()
{
return m_nErrorCode;
}
sal_Int32 SAL_CALL getMinorErrorCode()
{
return m_nMinorCode;
}
com::sun::star::uno::Reference< com::sun::star::ucb::XProgressHandler > SAL_CALL
getProgressHandler()
{
if( ! m_xProgressHandler.is() && m_xCommandEnvironment.is() )
m_xProgressHandler = m_xCommandEnvironment->getProgressHandler();
return m_xProgressHandler;
}
com::sun::star::uno::Reference< com::sun::star::task::XInteractionHandler > SAL_CALL
getInteractionHandler()
{
if( ! m_xInteractionHandler.is() && m_xCommandEnvironment.is() )
m_xInteractionHandler = m_xCommandEnvironment->getInteractionHandler();
return m_xInteractionHandler;
}
com::sun::star::uno::Reference< com::sun::star::ucb::XCommandEnvironment > SAL_CALL
getCommandEnvironment()
{
return m_xCommandEnvironment;
}
}; // end class TaskHandling
typedef boost::unordered_map< sal_Int32,TaskHandling,boost::hash< sal_Int32 > > TaskMap;
private:
osl::Mutex m_aMutex;
sal_Int32 m_nCommandId;
TaskMap m_aTaskMap;
public:
TaskManager();
virtual ~TaskManager();
void SAL_CALL startTask(
sal_Int32 CommandId,
const com::sun::star::uno::Reference< com::sun::star::ucb::XCommandEnvironment >& xCommandEnv )
throw( com::sun::star::ucb::DuplicateCommandIdentifierException );
sal_Int32 SAL_CALL getCommandId( void );
void SAL_CALL abort( sal_Int32 CommandId );
/**
* The error code may be one of the error codes defined in
* filerror.hxx.
* The minor code refines the information given in ErrorCode.
*/
void SAL_CALL clearError();
void SAL_CALL installError( sal_Int32 CommandId,
sal_Int32 ErrorCode,
sal_Int32 minorCode = TASKHANDLER_NO_ERROR );
void SAL_CALL retrieveError( sal_Int32 CommandId,
sal_Int32 &ErrorCode,
sal_Int32 &minorCode);
/**
* Deinstalls the task and evaluates a possibly set error code.
* "endTask" throws in case an error code is set the corresponding exception.
*/
void SAL_CALL endTask( sal_Int32 CommandId,
// the physical URL of the object
const OUString& aUnqPath,
BaseContent* pContent);
/**
* Handles an interactionrequest
*/
void SAL_CALL handleTask( sal_Int32 CommandId,
const com::sun::star::uno::Reference< com::sun::star::task::XInteractionRequest >& request );
/**
* Clears any error which are set on the commandid
*/
void SAL_CALL clearError( sal_Int32 );
};
} // end namespace TaskHandling
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|