proj_builder_app.hpp

Go to the documentation of this file.

Go to the SVN repository for this file.

#ifndef PROJECT_TREE_BULDER__PROJ_BUILDER_APP__HPP
#define PROJECT_TREE_BULDER__PROJ_BUILDER_APP__HPP
 
/* $Id: proj_builder_app.hpp 84663 2018-11-27 18:22:00Z ucko $
 * ===========================================================================
 *
 *                            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:  Viatcheslav Gorelenkov
 *
 */
 
#include <corelib/ncbiapp.hpp>
#include <corelib/ncbienv.hpp>
#include <corelib/ncbiargs.hpp>
#include <corelib/ncbifile.hpp>
#include "proj_utils.hpp"
#include "file_contents.hpp"
#include "resolver.hpp"
#include "msvc_prj_utils.hpp"
#include "msvc_site.hpp"
#include "msvc_makefile.hpp"
#include "msvc_dlls_info.hpp"
#include "proj_tree_builder.hpp"
 
 
BEGIN_NCBI_SCOPE
 
/////////////////////////////////////////////////////////////////////////////
///
/// CProjBulderApp --
///
/// Abstraction of proj_tree_builder application.
///
/// Singleton implementation.
 
class CProjBulderApp : public CNcbiApplication
{
public:
    
 
    /// ShortCut for enums
    int EnumOpt(const string& enum_name, const string& enum_val) const;
 
    /// Singleton
    friend CProjBulderApp& GetApp(void);
 
 
private:
    CProjBulderApp(void);
 
    virtual void Init(void);
    virtual int  Run (void);
    virtual void Exit(void);
 
    /// Parse program arguments.
    void ParseArguments(void);
    void VerifyArguments(void);
 
    //TFiles m_FilesMakeIn;
    //TFiles m_FilesMakeLib;
    //TFiles m_FilesMakeApp;
 
    typedef map<string, CSimpleMakeFileContents> TFiles;
    void DumpFiles(const TFiles& files, const string& filename) const;
    
    unique_ptr<CMsvc7RegSettings> m_MsvcRegSettings;
    unique_ptr<CMsvcSite>         m_MsvcSite;
    unique_ptr<CMsvcMetaMakefile> m_MsvcMetaMakefile;
 
    unique_ptr<SProjectTreeInfo>  m_ProjectTreeInfo;
 
    unique_ptr<CBuildType>        m_BuildType;
 
//    unique_ptr<CMsvcDllsInfo>     m_DllsInfo;
 
    unique_ptr<CProjectItemsTree> m_WholeTree;
 
    unique_ptr<CDllSrcFilesDistr> m_DllSrcFilesDistr;
 
    const CProjectItemsTree*    m_CurrentBuildTree;
    const CProjectItemsTree*    m_IncompleteBuildTree;
 
    set<string>  m_RegisteredProjectTags;
    bool m_ScanningWholeTree;
    int m_ExitCode;
    set<CProjKey> m_SuspiciousProj;
    list<string>  m_AbsDirs;
    list<string>  m_GeneratedFiles;
    list<string>  m_ProjWatchers;
    list<string>  m_CustomMetaData;
    list<string>  m_CustomConfH;
    string m_ConfSrc, m_ConfDest;
 
public:
 
    string m_Root;
    string m_Subtree;
    string m_Solution;
    string m_StatusDir;
    string m_IncDir;
    bool   m_Dll;
    bool m_BuildPtb;
    bool m_AddMissingLibs;
    bool m_ScanWholeTree;
    bool m_TweakVTuneR;
    bool m_TweakVTuneD;
    bool m_AddUnicode;
    string m_BuildRoot;
    string m_ExtSrcRoot;
    string m_ProjTags;
    bool m_ProjTagCmnd;
    bool m_ConfirmCfg;
    bool m_AllDllBuild;
    bool m_InteractiveCfg;
    bool m_Dtdep;
    bool m_AddMissingDep;
    bool m_LibDep;
    int m_Ide;
    string m_Arch;
 
    string m_CustomConfFile;
    CSimpleMakeFileContents m_CustomConfiguration;
    map<string,string>  m_CompositeProjectTags;
 
    map<string, set<string> >  m_GraphDepIncludes;
    map<string, set<string> >  m_GraphDepPrecedes;
    map<string, set<string> >  m_GraphDepFlags;
    set<string>                m_3PartyLibs;
    set<string>                m_Frameworks;
 
    map<string, size_t >       m_GraphDepRank;
    map<string, list<string> > m_LibraryOrder;
    map<string, list<string> > m_3PartyLibraryOrder;
 
public:
    bool UseAbsolutePath(const string& path) const;
    void AddCustomMetaData(const string& file);
    void GetMetaDataFiles(list<string>* files) const;
 
    void AddCustomConfH(const string& file);
    void GetCustomConfH(list<string>* files) const;
 
 
    const CMsvc7RegSettings& GetRegSettings    (void);
    
    const CMsvcSite&         GetSite           (void);
 
    const CMsvcMetaMakefile& GetMetaMakefile   (void);
 
    const SProjectTreeInfo&  GetProjectTreeInfo(void);
 
    const CBuildType&        GetBuildType      (void);
 
    const string&            GetBuildRoot      (void) const
    {
        return m_BuildRoot;
    }
    const string&            GetExtSrcRoot     (void) const
    {
        return m_ExtSrcRoot;
    }
    const CProjectItemsTree& GetWholeTree      (void);
    const CProjectItemsTree* GetCurrentBuildTree(void) const
    {
        return m_CurrentBuildTree;
    }
    const CProjectItemsTree* GetIncompleteBuildTree(void) const
    {
        return m_IncompleteBuildTree;
    }
 
    CDllSrcFilesDistr&       GetDllFilesDistr  (void);
 
    string GetDataspecProjId      (void) const;
    string GetDatatoolId          (void) const;
    string GetDatatoolPathForApp  (void) const;
    string GetDatatoolPathForLib  (void) const;
    string GetDatatoolCommandLine (void) const;
 
    string GetProjectTreeRoot(void) const;
    bool   IsAllowedProjectTag(const CProjItem& project, const string* filter = NULL) const;
    string ProcessLocationMacros(string data);
    string GetConfigureMacro(string data);
    bool IsScanningWholeTree(void) const {return m_ScanningWholeTree;}
    void SetFail(int exit_code=1) {m_ExitCode=exit_code;}
    void RegisterSuspiciousProject(const CProjKey& proj);
    void RegisterGeneratedFile( const string& file);
    void RegisterProjectWatcher(
        const string& project, const string& dir,  const string& watcher);
    void ExcludeProjectsByTag(CProjectItemsTree& tree) const;
    void ExcludeUnrequestedProjects(CProjectItemsTree& tree) const;
 
    string GetUtilityProjectsDir(void) const;
    string GetUtilityProjectsSrcDir(void);
    void SetConfFileData(const string& src, const string& dest);
 
    string GetBuildDir(void);
    
    void  UpdateDepGraph( CProjectTreeBuilder::TFiles& files);
private:
    void    LoadProjectTags(const string& filename);
    bool    FindDepGraph(const string& root, list<string>& found) const;
    void    LoadDepGraph(const string& filename);
    void    CollectDep(const string& libname, const string& depname);
    void    RankDepGraph(void);
    bool    InsertDep(vector< set<string> >& graph, const string& dep, list<string>& done);
 
    void    GetBuildConfigs     (list<SConfigInfo>* configs);
    void    GenerateMsvcProjects(CProjectItemsTree& projects_tree);
    void    GenerateMacProjects(CProjectItemsTree& projects_tree);
    void    CollectLibToLibDependencies(CProjectItemsTree& projects_tree,
                set<string>& dep, set<string>& visited,
                CProjectItemsTree::TProjects::const_iterator& lib,
                CProjectItemsTree::TProjects::const_iterator& lib_dep);
    void    GenerateUnixProjects(CProjectItemsTree& projects_tree);
    void    CreateFeaturesAndPackagesFiles(const list<SConfigInfo>* configs,
                list<string>& enabled, list<string>& disabled);
    void    GenerateSummary(const list<SConfigInfo> configs,
        const list<string>& enabled, const list<string>& disabled);
    void    CreateCheckList(const list<SConfigInfo>* configs,
                            CProjectItemsTree& projects_tree);
    void    ReportGeneratedFiles(void);
    void    ReportProjectWatchers(void);
 
    bool    ConfirmConfiguration(void);
    bool    Gui_ConfirmConfiguration(void);
 
public:
    bool    Gui_ConfirmProjects(CProjectItemsTree& projects_tree);
};
 
 
/// access to App singleton
 
CProjBulderApp& GetApp(void);
 
 
/////////////////////////////////////////////////////////////////////////////
///
/// CProjBulderAppException --
///
/// Exception class.
///
/// proj_tree_builder specific exceptions.
 
class CProjBulderAppException : public CException
{
public:
    enum EErrCode {
        eFileCreation,
        eEnumValue,
        eFileOpen,
        eProjectType,
        eBuildConfiguration,
        eMetaMakefile,
        eConfigureDefinesPath,
        eUnknownProjectTag
    };
    virtual const char* GetErrCodeString(void) const override {
        switch ( GetErrCode() ) {
        case eFileCreation:
            return "Can not create file";
        case eEnumValue:
            return "Bad or missing enum value";
        case eFileOpen:
            return "Can not open file";
        case eProjectType:
            return "Unknown project type";
        case eBuildConfiguration:
            return "Unknown build configuration";
        case eMetaMakefile:
            return "Bad or missed metamakefile";
        case eConfigureDefinesPath:
            return "Path to configure defines file is empty";
        case eUnknownProjectTag:
            return "Unregistered project tag";
        default:
            return CException::GetErrCodeString();
        }
    }
    NCBI_EXCEPTION_DEFAULT(CProjBulderAppException, CException);
};
 
 
END_NCBI_SCOPE
 
#endif //PROJECT_TREE_BULDER__PROJ_BUILDER_APP__HPP