#ifndef OBJECTS_GENERAL___CLEANUP_FIX_PUB_AUX__HPP
#define OBJECTS_GENERAL___CLEANUP_FIX_PUB_AUX__HPP

/* $Id: pub_fix_aux.hpp 676166 2023-12-11 15:35:44Z stakhovv $
 * ===========================================================================
 *
 *                            PUBLIC DOMAIN NOTICE
 *               National Center for Biotechnology Information
 *
 *  This software/database is a "United States Government Work" under the
 *  terms of the United States Copyright Act.  It was written as part of
 *  the author's official duties as a United States Government employee and
 *  thus cannot be copyrighted.  This software/database is freely available
 *  to the public for use. The National Library of Medicine and the U.S.
 *  Government have not placed any restriction on its use or reproduction.
 *
 *  Although all reasonable efforts have been taken to ensure the accuracy
 *  and reliability of the software and data, the NLM and the U.S.
 *  Government do not and cannot warrant the performance or results that
 *  may be obtained by using this software or data. The NLM and the U.S.
 *  Government disclaim all warranties, express or implied, including
 *  warranties of performance, merchantability or fitness for any particular
 *  purpose.
 *
 *  Please cite the author in any work or product based on this material.
 *
 * ===========================================================================
 *
 * Author:  Alexey Dobronadezhdin
 *
 * File Description:
 *   Auxiliary code for fixing up publications. All function declarations are here
 * to make unit testing possible.
 *
 * ===========================================================================
 */
#include <corelib/ncbistd.hpp>

#include <objects/pub/Pub_equiv.hpp>
#include <objects/biblio/Auth_list.hpp>

BEGIN_NCBI_SCOPE

class IMessageListener;

BEGIN_SCOPE(objects)

class CPub;
class CCit_art;

BEGIN_SCOPE(edit)

namespace fix_pub
{

enum EFixPubErrorCategory
{
    err_Reference = 1,
    err_Print,
    err_AuthList
};

enum EFixPubReferenceError
{
    err_Reference_MuidNotFound = 1,
    err_Reference_SuccessfulMuidLookup,
    err_Reference_OldInPress,
    err_Reference_No_reference,
    err_Reference_Multiple_ref,
    err_Reference_Multiple_muid,
    err_Reference_MedlineMatchIgnored,
    err_Reference_MuidMissmatch,
    err_Reference_NoConsortAuthors,
    err_Reference_DiffConsortAuthors,
    err_Reference_PmidMissmatch,
    err_Reference_Multiple_pmid,
    err_Reference_FailedToGetPub,
    err_Reference_MedArchMatchIgnored,
    err_Reference_SuccessfulPmidLookup,
    err_Reference_PmidNotFound,
    err_Reference_NoPmidJournalNotInPubMed,
    err_Reference_PmidNotFoundInPress,
    err_Reference_NoPmidJournalNotInPubMedInPress
};


enum EFixPubPrintError
{
    err_Print_Failed = 1
};

enum EFixPubAuthListError
{
    err_AuthList_SignificantDrop = 1,
    err_AuthList_PreserveGB,
    err_AuthList_LowMatch
};


NCBI_XOBJEDIT_EXPORT void MedlineToISO(CCit_art& cit_art);
NCBI_DEPRECATED inline void MedlineToISO(CCit_art& cit_art, void*) { MedlineToISO(cit_art); }
NCBI_XOBJEDIT_EXPORT void SplitMedlineEntry(CPub_equiv::Tdata& medlines);
NCBI_DEPRECATED inline void SplitMedlineEntry(CPub_equiv::Tdata& medlines, void*) { SplitMedlineEntry(medlines); }
NCBI_XOBJEDIT_EXPORT bool IsInpress(const CCit_art& cit_art);
NCBI_XOBJEDIT_EXPORT bool NeedToPropagateInJournal(const CCit_art& cit_art);
NCBI_XOBJEDIT_EXPORT bool MULooksLikeISSN(const string& str);
NCBI_XOBJEDIT_EXPORT bool MUIsJournalIndexed(const string& journal);
NCBI_XOBJEDIT_EXPORT void PrintPub(const CCit_art& cit_art, bool found, bool auth, long muid, IMessageListener* err_log);
NCBI_XOBJEDIT_EXPORT bool IsFromBook(const CCit_art& art);
NCBI_XOBJEDIT_EXPORT bool TenAuthorsCompare(CCit_art& cit_old, CCit_art& cit_new);
NCBI_XOBJEDIT_EXPORT size_t ExtractConsortiums(const CAuth_list::C_Names::TStd& names, CAuth_list::C_Names::TStr& extracted);
NCBI_XOBJEDIT_EXPORT void GetFirstTenNames(const CAuth_list::C_Names::TStd& names, list<CTempString>& res);
NCBI_XOBJEDIT_EXPORT bool TenAuthorsProcess(CCit_art& cit, CCit_art& new_cit, IMessageListener* err_log);
NCBI_XOBJEDIT_EXPORT void MergeNonPubmedPubIds(const CCit_art& cit_old, CCit_art& cit_new);
NCBI_XOBJEDIT_EXPORT void PropagateInPress(bool inpress, CCit_art& cit_art);
}

END_SCOPE(edit)
END_SCOPE(objects)
END_NCBI_SCOPE

#endif  // OBJECTS_GENERAL___CLEANUP_FIX_PUB_AUX__HPP
