---

ICompareDocuments.h

Go to the documentation of this file.

/**
* @file         IDocumentForm.h
* @brief    Interface to compare two documents
*
* @author       Nakashima h
* @date     2022-02-02
*
* $Id: ICompareDocuments.h 32 2022-07-14 03:20:43Z shingo.yoneda $
*
* Copyright (c) 2022 Antenna House, Inc. All rights reserved.
*/

#pragma once
#include <queue>
#include <memory>
#include <string>

//#include <AHOOXMLDocxManagerCppCtl/ChangedRatio.h>
#include "ChangedRatio.h"

/**
 * @brief    Class to compare two documents
 */
class ICompareDocuments {
protected:
    /**
    * @brief    Default constructor
    */
    ICompareDocuments() = default;

    /**
    * @brief    Copy constructor
    */
    ICompareDocuments(const ICompareDocuments&) = delete;

    /**
    * @brief    Copy assignment operator
    */
    ICompareDocuments& operator=(const ICompareDocuments&) = delete;

    /**
    * @brief    Move constructor
    */
    ICompareDocuments(ICompareDocuments&&) = delete;

    /**
    * @brief    Move assignment operator
    */
    ICompareDocuments& operator=(ICompareDocuments&&) = delete;

public:
    /**
    * @brief    Destructor
    */
    virtual ~ICompareDocuments() = default;

    /**
    * @brief    Generate an object to perform document comparison
    */
    static std::unique_ptr<ICompareDocuments> create();

    /**
    * @brief    Perform document comparison
    * @param originalFilePath - Original file path
    * @param revisedFilePath - Revised file path
    * @param outputFilePath - Output path of comparison results
    */
    virtual void CompareDocument(std::string const& originalFilePath, std::string const& revisedFilePath, std::string const& outputFilePath) = 0;

    /**
    * @brief    Create comparison table
    * @param originalFilePath - Original file path
    * @param revisedFilePath - Revised file path
    * @param outputFilePath - Output path of comparison table
    */
    virtual void CreateComparativeTable(std::string const& originalFilePath, std::string const& revisedFilePath, std::string const& outputFilePath) = 0;

    /**
    * @brief    Parsing the document changed ratio
    * @param originalFilePath - Original file path
    * @param revisedFilePath - Revised file path
    * @return Document changed ratio
    */
    virtual ChangedRatio ParseChangedRatio(std::string const& originalFilePath, std::string const& revisedFilePath) = 0;
};

---