diff options
Diffstat (limited to 'dbaccess/source/ext/macromigration/migrationlog.hxx')
-rw-r--r-- | dbaccess/source/ext/macromigration/migrationlog.hxx | 110 |
1 files changed, 0 insertions, 110 deletions
diff --git a/dbaccess/source/ext/macromigration/migrationlog.hxx b/dbaccess/source/ext/macromigration/migrationlog.hxx deleted file mode 100644 index d4e757c4c281..000000000000 --- a/dbaccess/source/ext/macromigration/migrationlog.hxx +++ /dev/null @@ -1,110 +0,0 @@ -/* -*- 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_DBACCESS_SOURCE_EXT_MACROMIGRATION_MIGRATIONLOG_HXX -#define INCLUDED_DBACCESS_SOURCE_EXT_MACROMIGRATION_MIGRATIONLOG_HXX - -#include "dbmm_types.hxx" - -#include <rtl/ustring.hxx> - -#include <memory> - -namespace dbmm -{ - - typedef sal_Int16 DocumentID; - struct MigrationError; - - // MigrationLog - struct MigrationLog_Data; - class MigrationLog - { - public: - MigrationLog(); - ~MigrationLog(); - - //- event logging - - /** logs an unrecoverable error during the migration process - */ - void logFailure( const MigrationError& _rError ); - - /** logs a recoverable (or at least ignorable) error during the migration process - */ - void logRecoverable( const MigrationError& _rError ); - - /// checks whether logFailure has been called - bool hadFailure() const; - - /// logs the fact that the database document has been backed up - void backedUpDocument( const OUString& _rNewDocumentLocation ); - - /** logs that the migration for a certain sub document has been started, returns - a unique ID for this sub document which is to be used in later calls - */ - DocumentID startedDocument( const SubDocumentType _eType, const OUString& _rName ); - - /** logs the event that a macro or script library has been moved from within a - sub document to the database document - */ - void movedLibrary( - const DocumentID _nDocID, - const ScriptType _eScriptType, - const OUString& _rOriginalLibName, - const OUString& _rNewLibName - ); - - /** logs that the migration for a certain document has been finished - */ - void finishedDocument( const DocumentID _nDocID ); - - //- information retrieval - - /** retrieves the new name of a library - - The new library name must previously have been logger by calling - <member>movedLibrary</member>. If not, an assertion will be raised in - the non-product builds, and an empty string will be returned. - */ - OUString getNewLibraryName( - DocumentID _nDocID, - ScriptType _eScriptType, - const OUString& _rOriginalLibName - ) const; - - /** determines whether for the given document, any library needed to be (and was) moved - */ - bool movedAnyLibrary( const DocumentID ); - - /** provides a human-readable version of the log, explaining a user what happened during - the migration. - */ - OUString - getCompleteLog() const; - - private: - std::unique_ptr< MigrationLog_Data > m_pData; - }; - -} // namespace dbmm - -#endif // INCLUDED_DBACCESS_SOURCE_EXT_MACROMIGRATION_MIGRATIONLOG_HXX - -/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |