build-system/project_tree_builder/file_contents.cpp

/* $Id: file_contents.cpp 485908 2015-11-30 14:28:08Z gouriano $
 * ===========================================================================
 *
 *                            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 <ncbi_pch.hpp>
#include "file_contents.hpp"
#include "proj_builder_app.hpp"
#include "msvc_prj_defines.hpp"
#include "ptb_err_codes.hpp"
#include <corelib/ncbistr.hpp>

BEGIN_NCBI_SCOPE

string MakeFileTypeAsString(EMakeFileType type)
{
    switch (type) {
    case eMakeType_Undefined:  return "";
    case eMakeType_Expendable: return "EXPENDABLE";
    case eMakeType_Potential:  return "POTENTIAL";
    case eMakeType_Excluded:   return "EXCLUDED";
    case eMakeType_ExcludedByReq:   return "EXCLUDEDBYREQ";
    default:                   return "INCORRECT!";
    }
}

//-----------------------------------------------------------------------------
CSimpleMakeFileContents::CSimpleMakeFileContents(void)
    : m_Type( eMakeType_Undefined ), m_Parent(NULL), m_Raw(false)
{
}


CSimpleMakeFileContents::CSimpleMakeFileContents
    (const CSimpleMakeFileContents& contents)
{
    SetFrom(contents);
}


CSimpleMakeFileContents& CSimpleMakeFileContents::operator=
    (const CSimpleMakeFileContents& contents)
{
    if (this != &contents) {
        SetFrom(contents);
    }
    return *this;
}


CSimpleMakeFileContents::CSimpleMakeFileContents(
    const string& file_path, EMakeFileType type)
{
    LoadFrom(file_path, this);
    m_Type = type;
    m_Parent = NULL;
    m_Raw = false;
}

CSimpleMakeFileContents::CSimpleMakeFileContents(const string& file_path)
{
    LoadFrom(file_path, this);
    m_Type = eMakeType_Undefined;
    m_Parent = NULL;
    m_Raw = true;
}


CSimpleMakeFileContents::~CSimpleMakeFileContents(void)
{
}


void CSimpleMakeFileContents::Clear(void)
{
    m_Contents.clear();
    m_Type = eMakeType_Undefined;
    m_Filename.erase();
    m_Parent = NULL;
    m_Raw = false;
}


void CSimpleMakeFileContents::SetFrom(const CSimpleMakeFileContents& contents)
{
    m_Contents = contents.m_Contents;
    m_Type = contents.m_Type;
    m_Filename = contents.m_Filename;
    m_ValueSeparator = contents.m_ValueSeparator;
    m_Parent = contents.m_Parent;
    m_Raw = contents.m_Raw;
}


void CSimpleMakeFileContents::LoadFrom(const string&  file_path,
                                       CSimpleMakeFileContents* fc)
{
    if (fc->m_ValueSeparator.empty()) {
        fc->m_ValueSeparator = LIST_SEPARATOR;
    }
    CSimpleMakeFileContents::SParser parser(fc);
    fc->Clear();

    CNcbiIfstream ifs(file_path.c_str(), IOS_BASE::in | IOS_BASE::binary);
    if ( !ifs )
        NCBI_THROW(CProjBulderAppException, eFileOpen, file_path);

    fc->m_Filename = file_path;
    parser.StartParse();

    string strline;
    while ( NcbiGetlineEOL(ifs, strline) )
	    parser.AcceptLine(strline);

    parser.EndParse();
}

void CSimpleMakeFileContents::AddDefinition(const string& key,
                                            const string& value)
{
    SKeyValue kv;
    kv.m_Key = key;
    kv.m_Value = value;
    AddReadyKV(kv);
}

void CSimpleMakeFileContents::RemoveDefinition( const string& key)
{
    TContents::iterator i = m_Contents.find(key);
    if (i != m_Contents.end()) {
        m_Contents.erase(i);
    }
}

bool CSimpleMakeFileContents::HasDefinition( const string& key) const
{
    return m_Contents.find(key) != m_Contents.end();
}

bool CSimpleMakeFileContents::DoesValueContain(
    const string& key, const string& value, bool ifnokey /*=true*/) const
{
    TContents::const_iterator k = m_Contents.find(key);
    if (k != m_Contents.end()) {
        return find(k->second.begin(), k->second.end(), value) != k->second.end();
    }
    return ifnokey;
}

bool CSimpleMakeFileContents::GetPathValue(const string& key, string& value) const
{
    if (GetValue(key,value)) {
        string separator;
        separator += CDirEntry::GetPathSeparator();
        NStr::ReplaceInPlace(value,"/",separator);
        return true;
    }
    return false;
}

bool CSimpleMakeFileContents::GetValue(const string& key, list<string>& value) const
{
    value.clear();
    TContents::const_iterator k = m_Contents.find(key);
    if (k == m_Contents.end()) {
        return false;
    }
    value = k->second;
    return true;
}

bool CSimpleMakeFileContents::GetValue(const string& key, string& value) const
{
    value.erase();
    TContents::const_iterator k = m_Contents.find(key);
    if (k == m_Contents.end()) {
        return false;
    }
    value = " ";
    const list<string>& lst = k->second;
    list<string>::const_iterator i = lst.begin();
    if (i != lst.end() && *i != "#") {
        value = *i;
        ++i;
    }
    for (; i != lst.end(); ++i) {
        if (*i == "#") {
            break;
        }
        value += ' ';
        value += *i;
    }
    if (!value.empty() && !m_Raw) {
        string::size_type start, end, done = 0;
        while ((start = value.find("$(", done)) != string::npos) {
            end = value.find(")", start);
            if (end == string::npos) {
                PTB_WARNING_EX(m_Filename, ePTB_MacroInvalid,
                               "Invalid macro definition: " << value);
                break;
            }
            string raw_macro = value.substr(start,end-start+1);
            if (CSymResolver::IsDefine(raw_macro)) {
                string macro = CSymResolver::StripDefine(raw_macro);
                string definition;
                GetValue(macro, definition);
                value = NStr::Replace(value, raw_macro, definition);
            }
        }
#if 0
        value = NStr::Replace(value,"-l",kEmptyStr);
        value = NStr::Replace(value,"-dll",kEmptyStr);
        value = NStr::Replace(value,"-static",kEmptyStr);
#endif
    }
    return true;
}

bool CSimpleMakeFileContents::CollectValues(
    const string& key, list<string>& values, EHowToCollect how) const
{
    TContents::const_iterator k = m_Contents.find(key);
    if (k != m_Contents.end()) {
        copy(k->second.begin(), k->second.end(), back_inserter(values));
    }
    if (m_Parent) {
        m_Parent->CollectValues(key,values,eAsIs);
    }
    if (values.empty()) {
        return false;
    }

    if (how == eSortUnique) {
        values.sort();
        values.unique();
    }
    else if (how == eMergePlusMinus) {
        bool erased = false;
        do {
            erased = false;
            for ( list<string>::iterator i = values.begin(); i != values.end(); ++i) {
                if (i->at(0) == '-') {
                    list<string>::iterator plus;
                    while ((plus = find( i, values.end(), i->c_str()+1)) != values.end()) {
                        values.erase(plus);
                    }
                    values.erase(i);
                    erased = true;
                    break;
                }
            }
        } while (erased);
    }
    else if (how == eFirstNonempty) {
        while ( !values.empty() && values.front().empty()) {
            values.pop_front();
        }
    }
    return !values.empty();
}

void CSimpleMakeFileContents::Save(const string& filename) const
{
    CNcbiOfstream ofs(filename.c_str(), IOS_BASE::out | IOS_BASE::trunc );
    if (ofs.is_open()) {
        Dump(ofs);
    }
}

void CSimpleMakeFileContents::Dump(CNcbiOstream& ostr, const list<string>* skip /*=0*/) const
{
    size_t len=0;
    ITERATE(TContents, p, m_Contents) {
	    if (skip != 0 && find(skip->begin(), skip->end(), p->first) != skip->end()) {
	        continue;
	    }
	    ostr << p->first << " = ";
	    ITERATE(list<string>, m, p->second) {
		    if (len > 60) {
        	    ostr << '\\' << endl << "    ";
		        len = 0;
		    }
		    ostr << NStr::Replace(*m,"\\","/") << " ";
		    len += m->size() + 1;
	    }
	    ostr << endl;
	    len=0;
    }
}


CSimpleMakeFileContents::SParser::SParser(CSimpleMakeFileContents* fc)
    :m_FileContents(fc)
{
}


void CSimpleMakeFileContents::SParser::StartParse(void)
{
    m_Continue  = false;
    m_CurrentKV = SKeyValue();
}


//------------------------------------------------------------------------------
// helpers ---------------------------------------------------------------------

static bool s_WillContinue(const string& line)
{
    return NStr::EndsWith(line, "\\");
}


static void s_StripContinueStr(string* str)
{
    str->erase(str->length() -1, 1); // delete last '\'
    *str += " ";
}


static bool s_SplitKV(const string& line, SKeyValue& kv)
{
    if ( !NStr::SplitInTwo(line, "=", kv.m_Key, kv.m_Value) )
	    return false;

    kv.m_Key = NStr::TruncateSpaces(kv.m_Key); // only for key - preserve sp for vals
    kv.m_Append = NStr::EndsWith(kv.m_Key, "+");
    if (kv.m_Append) {
        kv.m_Append = true;
        NStr::ReplaceInPlace(kv.m_Key, "+", " ");
        kv.m_Key = NStr::TruncateSpaces(kv.m_Key); // only for key - preserve sp for vals
    }
    if ( s_WillContinue(kv.m_Value) )
	    s_StripContinueStr(&kv.m_Value);

    return true;
}


static bool s_IsKVString(const string& str)
{
    size_t eq_pos = str.find("=");
    if (eq_pos == NPOS)
        return false;
    string mb_key = str.substr(0, eq_pos - 1);
    return mb_key.find_first_of("$()") == NPOS;
}


static bool s_IsCommented(const string& str)
{
    return NStr::StartsWith(str, "#");
}


void CSimpleMakeFileContents::SParser::AcceptLine(const string& line)
{
    string strline = NStr::TruncateSpaces(line);
    if ( s_IsCommented(strline) )
	    return;

    if (m_Continue) {
	    m_Continue = s_WillContinue(strline);
	    if ( strline.empty() || strline.find_first_not_of(' ') == string::npos ) {
		    //fix for ill-formed makefiles:
		    m_FileContents->AddReadyKV(m_CurrentKV);
		    return;
#if 0
// this is dangerous "fix"
	    } else if ( s_IsKVString(strline) ) {
		    //fix for ill-formed makefiles:
		    m_FileContents->AddReadyKV(m_CurrentKV);
		    m_Continue = false; // guard
		    AcceptLine(strline.c_str());
#endif
	    }
	    if (m_Continue)
		    s_StripContinueStr(&strline);
	    m_CurrentKV.m_Value += strline;
	    return;

    } else {
        const string include_token("include ");
        if ( NStr::StartsWith(strline, include_token) ) {
            string include = NStr::TruncateSpaces(
                strline.substr(include_token.length()));
            string root;
            string srcdir_token("$(srcdir)");
            if (NStr::StartsWith(include, srcdir_token)) {
                root = CDirEntry( m_FileContents->GetFileName()).GetDir();
            } else {
                srcdir_token = "$(top_srcdir)";
                if (NStr::StartsWith(include, srcdir_token)) {
                    root = GetApp().GetProjectTreeInfo().m_Root;
                }
                else {
#if 0
                    srcdir_token = "$(builddir)";
                    if (NStr::StartsWith(include, srcdir_token)) {
                        root = GetApp().GetBuildRoot();
                        if (root.empty()) {
                            root = CDirEntry(GetApp().m_Solution).GetDir();
                        }
                    }
#endif
                }
            }
            if (!root.empty()) {
                include = CDirEntry::NormalizePath(
                    CDirEntry::ConcatPath( root,
                        NStr::Replace(include, srcdir_token, "")));
                LoadInclude(include);
            }
        } else
        if ( s_IsKVString(strline) ) {
		    m_FileContents->AddReadyKV(m_CurrentKV);
		    m_Continue = s_WillContinue(strline);
		    s_SplitKV(strline, m_CurrentKV);
		    return;
	    }
    }
}

void CSimpleMakeFileContents::SParser::LoadInclude(const string& file_path)
{
    EndParse();
    CNcbiIfstream ifs(file_path.c_str(), IOS_BASE::in | IOS_BASE::binary);
    if ( !ifs ) {
        PTB_WARNING_EX(m_FileContents->GetFileName(),
            ePTB_FileNotFound, "Include file not found: " << file_path);
        return;
    }
    StartParse();
    string strline;
    while ( NcbiGetlineEOL(ifs, strline) ) {
	    AcceptLine(strline);
    }
    EndParse();
    StartParse();
}

void CSimpleMakeFileContents::SParser::EndParse(void)
{
    m_FileContents->AddReadyKV(m_CurrentKV);
    m_Continue = false;
    m_CurrentKV = SKeyValue();
}


void CSimpleMakeFileContents::AddReadyKV(const SKeyValue& kv)
{
    if ( kv.m_Key.empty() )
	    return;

    if (kv.m_Key == "CHECK_CMD") {
        m_Contents[kv.m_Key].push_back( kv.m_Value);
    } else {
        list<string> values;
//        if (NStr::EndsWith(kv.m_Key,"LIBS")) {
        if (NStr::FindCase(kv.m_Key,"LIB") != NPOS ||
            NStr::FindCase(kv.m_Value," -l") != NPOS ||
            NStr::FindCase(kv.m_Value,"-rpath") != NPOS ||
            NStr::FindCase(kv.m_Value,"-framework") != NPOS) {
            NStr::Split(kv.m_Value, LIST_SEPARATOR_LIBS, values, NStr::fSplit_MergeDelimiters | NStr::fSplit_Truncate);
        } else {
            if (m_ValueSeparator.empty()) {
                m_ValueSeparator = LIST_SEPARATOR;
            }
            NStr::Split(kv.m_Value, m_ValueSeparator, values, NStr::fSplit_MergeDelimiters | NStr::fSplit_Truncate);
        }
// change '{' into '(', because I rely on that in many places
        NON_CONST_ITERATE(list<string>, v, values) {
            string::size_type start, end;
            while ((start = v->find("${")) != string::npos) {
                v->replace(start+1, 1, 1, '(');
            }
            while ((end = v->find("}")) != string::npos) {
                v->replace(    end, 1, 1, ')');
            }
        }
        list<string>& dest = m_Contents[kv.m_Key];
        if (!kv.m_Append) {
            dest.clear();
        }
        string value;
        size_t start_count=0, end_count=0;
        ITERATE(list<string>, v, values) {
            string::size_type start, end;
            if (!value.empty()) {
                value += ' ';
            }
            value += *v;
            for (start=0; (start = v->find("$(", start)) != string::npos; ++start)
                ++start_count;
            for (end=0; (end = v->find(")", end)) != string::npos; ++end)
                ++end_count;
            if (start_count == end_count) {
// very primitive  GNU make  built-in expansion functions
                if (NStr::StartsWith(value, "$(addsuffix")) {
                    string first, second;
                    string func, arg;
                    NStr::SplitInTwo(CSymResolver::StripDefine(value), ",", first, second);
                    NStr::SplitInTwo(first, " ", func, arg);
                    list<string> tmp;
                    NStr::Split(second, " ", tmp, NStr::fSplit_MergeDelimiters | NStr::fSplit_Truncate);
                    ITERATE(list<string>, t, tmp) {
                        dest.push_back(*t+arg);
                    }
                } else {
                    if (kv.m_Key == "SRC" && CSymResolver::IsDefine(value)) {
                        value = FilterDefine(value);
                    }
                    dest.push_back(value);
                }
                start_count = end_count = 0;
                value.clear();
            }
        }
    }
}


END_NCBI_SCOPE