version.cpp

Go to the documentation of this file.

Go to the SVN repository for this file.

/*  $Id: version.cpp 102709 2024-06-28 14:11:08Z 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.
 *
 * ===========================================================================
 *
 * Authors:  Denis Vakatov, Vladimir Ivanov
 *
 * File Description:
 *   CVersionInfo -- a version info storage class
 *
 */
 
#include <ncbi_pch.hpp>
#include <corelib/version.hpp>
#include <common/ncbi_package_ver.h>
#include <common/ncbi_source_ver.h>
 
#include <utility>
#include <algorithm>
 
BEGIN_NCBI_SCOPE
 
 
CVersionInfo::CVersionInfo(int ver_major,
                           int  ver_minor,
                           int  patch_level, 
                           const string& name) 
    : m_Major(ver_major),
      m_Minor(ver_minor),
      m_PatchLevel(patch_level),
      m_Name(name)
 
{
}
 
 
CVersionInfo::CVersionInfo(const string& version,
                           const string& name)
{
    FromStr(version);
    if (!name.empty()) {
        m_Name = name;
    }
}
 
CVersionInfo::CVersionInfo(EVersionFlags flags)
{
    _ASSERT( flags == kAny || flags == kLatest);
    m_Major = m_Minor = m_PatchLevel = (flags == kAny) ? 0 : -1;
}
 
static
void s_ConvertVersionInfo(CVersionInfo* vi, const char* str)
{
    int major, minor, patch = 0;
    if (!isdigit((unsigned char)(*str))) {
        NCBI_THROW2(CStringException, eFormat, "Invalid version format", 0);
    }
    major = atoi(str);
    if (major < 0) {
        NCBI_THROW2(CStringException, eFormat, "Invalid version format", 0);
    }
    for (; *str && isdigit((unsigned char)(*str)); ++str) {}
    if (*str != '.') {
        NCBI_THROW2(CStringException, eFormat, "Invalid version format", 0);
    }
    ++str;
    if (!isdigit((unsigned char)(*str))) {
        NCBI_THROW2(CStringException, eFormat, "Invalid version format", 0);
    }
 
    minor = atoi(str);
    if (minor < 0) {
        NCBI_THROW2(CStringException, eFormat, "Invalid version format", 0);
    }
    for (; *str && isdigit((unsigned char)(*str)); ++str) {}
 
    if (*str != 0) {
        if (*str != '.') {
            NCBI_THROW2(CStringException, eFormat, "Invalid version format", 0);
        }
        ++str;
        patch = atoi(str);
        if (patch < 0) {
            NCBI_THROW2(CStringException, eFormat, "Invalid version format", 0);
        }
    }
 
    vi->SetVersion(major, minor, patch);
 
}
 
 
void CVersionInfo::FromStr(const string& version)
{
    s_ConvertVersionInfo(this, version.c_str());
}
 
 
string CVersionInfo::Print(void) const
{
    if (m_Major < 0) {
        return kEmptyStr;
    }
    CNcbiOstrstream os;
    os << m_Major << "." << (m_Minor >= 0 ? m_Minor : 0);
    if (m_PatchLevel >= 0) {
        os << "." << m_PatchLevel;
    }
    if ( !m_Name.empty() ) {
        os << " (" << m_Name << ")";
    }
    return CNcbiOstrstreamToString(os);
}
 
 
string CVersionInfo::PrintXml(void) const
{
    CNcbiOstrstream os;
    os << "<version_info";
    if (m_Major >= 0) {
        os << " major=\"" << m_Major <<
            "\" minor=\"" << (m_Minor >= 0 ? m_Minor : 0) << "\"";
        if (m_PatchLevel >= 0) {
            os << " patch_level=\"" << m_PatchLevel << "\"";
        }
    }
    if ( !m_Name.empty() ) {
        os << " name=\"" << NStr::XmlEncode(m_Name) << "\"";
    }
    os << "/>\n";
    return CNcbiOstrstreamToString(os);
}
 
 
string CVersionInfo::PrintJson(void) const
{
    CNcbiOstrstream os;
    os << "{";
    bool need_separator = false;
    if (m_Major >= 0) {
        os << "\"major\": " << m_Major <<
            ", \"minor\": " << (m_Minor >= 0 ? m_Minor : 0);
        if (m_PatchLevel >= 0) {
            os << ", \"patch_level\": " << m_PatchLevel;
        }
        need_separator = true;
    }
    if ( !m_Name.empty() ) {
        if ( need_separator ) os << ", ";
        os << "\"name\": " << NStr::JsonEncode(m_Name, NStr::eJsonEnc_Quoted);
    }
    os << "}";
    return CNcbiOstrstreamToString(os);
}
 
 
CVersionInfo::EMatch 
CVersionInfo::Match(const CVersionInfo& version_info) const
{
    if (GetMajor() != version_info.GetMajor())
        return eNonCompatible;
 
    if (GetMinor() < version_info.GetMinor())
        return eNonCompatible;
 
    if (GetMinor() > version_info.GetMinor())
        return eBackwardCompatible;
 
    // Minor versions are equal.
    
    if (GetPatchLevel() == version_info.GetPatchLevel()) {
        return eFullyCompatible;
    }
 
    if (GetPatchLevel() > version_info.GetPatchLevel()) {
        return eBackwardCompatible;
    }
 
    return eConditionallyCompatible;
 
}
 
void CVersionInfo::SetVersion(int  ver_major,
                              int  ver_minor,
                              int  patch_level)
{
    m_Major      = ver_major;
    m_Minor      = ver_minor;
    m_PatchLevel = patch_level;
}
 
 
 
bool IsBetterVersion(const CVersionInfo& info, 
                     const CVersionInfo& cinfo,
                     int&  best_major, 
                     int&  best_minor,
                     int&  best_patch_level)
{
    int major = cinfo.GetMajor();
    int minor = cinfo.GetMinor();
    int patch_level = cinfo.GetPatchLevel();
 
    if (info.GetMajor() == -1) {  // best major search
        if (major > best_major) { 
            best_major = major;
            best_minor = minor;
            best_patch_level = patch_level;
            return true;
        }
    } else { // searching for the specific major version
        // Do not chose between major versions.
        // If they are not equal then they are not compatible.
        if (info.GetMajor() != major) {
            return false;
        }
    }
 
    if (info.GetMinor() == -1) {  // best minor search
        if (minor > best_minor) {
            best_major = major;
            best_minor = minor;
            best_patch_level = patch_level;
            return true;
        }
    } else { 
        if (info.GetMinor() > minor) {
            return false;
        }
        if (info.GetMinor() < minor) {
            best_major = major;
            best_minor = minor;
            best_patch_level = patch_level;
            return true;
        }
    }
 
    // Major and minor versions are equal.
    // always looking for the best patch
    if (patch_level > best_patch_level) {
            best_major = major;
            best_minor = minor;
            best_patch_level = patch_level;
            return true;
    }
    return false;    
}
 
 
void ParseVersionString(const string&  vstr, 
                        string*        program_name, 
                        CVersionInfo*  ver)
{
    _ASSERT(program_name);
    _ASSERT(ver);
 
    if (vstr.empty()) {
        NCBI_THROW2(CStringException, eFormat, "Version string is empty", 0);
    }
 
    program_name->erase();
 
 
    string lo_vstr(vstr); NStr::ToLower(lo_vstr);
    string::size_type pos;
 
    const char* vstr_str = vstr.c_str();
 
    // 2.3.4 (program)
 
    pos = lo_vstr.find("(");
    if (pos != string::npos) {
        string::size_type pos2 = lo_vstr.find(")", pos);
        if (pos2 == string::npos) { // not found
            NCBI_THROW2(CStringException, 
                        eFormat, "Version string format error", 0);
        }
        for (++pos; pos < pos2; ++pos) {
            program_name->push_back(vstr.at(pos));
        }
        NStr::TruncateSpacesInPlace(*program_name);
 
        s_ConvertVersionInfo(ver, vstr.c_str());
        return;
 
    }
 
 
    // all other normal formats
 
    static const char* version_patterns[] = {
        "version",
        "v.",
        "ver",
        "v",
        nullptr
    };
    const char* version_pattern = kEmptyCStr;
    for (const char** ppattern = version_patterns;  *ppattern != nullptr;
         ++ppattern) {
        pos = lo_vstr.rfind(*ppattern);
        if (pos != NPOS) {
            // sanity check
            auto pos2
                = lo_vstr.find_first_not_of(" .", pos + strlen(*ppattern));
            if ( !isdigit(lo_vstr[pos2]) ) {
                pos = NPOS;
                continue;
            }
            version_pattern = *ppattern;
            break;
        }
    }
 
    if (pos == string::npos) {
        // find the first space-digit and assume it's version
        const char* ch = vstr_str;
        for (; *ch; ++ch) {
            if (isdigit((unsigned char)(*ch))) {
                if (ch == vstr_str) {
                    // check if it's version
                    const char* ch2 = ch + 1;
                    for (;*ch2; ++ch2) {
                        if (!isdigit((unsigned char)(*ch2))) {
                            break;
                        }
                    } // for
                    if (*ch2 == '.') {
                        pos = ch - vstr_str;
                        break;
                    } else {
                        continue;
                    }
                } else {
                    if (isspace((unsigned char) ch[-1])) {
                        pos = ch - vstr_str;
                        break;
                    }
                }
            } // if digit
                    
        } // for
    }
 
 
    if (pos != string::npos) {
        int pname_end = (int)(pos - 1);
        for (; pname_end >= 0; --pname_end) {
            char ch = vstr[pname_end];
            if (!isspace((unsigned char) ch)) 
                break;
        } // for
        if (pname_end <= 0) {
        } else {
            program_name->append(vstr.c_str(), pname_end + 1);
        }
 
        pos += strlen(version_pattern);
        for(; pos < vstr.length(); ++pos) {
            char ch = vstr[pos];
            if (ch == '.') 
                continue;
            if (!isspace((unsigned char) ch)) 
                break;            
        } // for
 
        const char* ver_str = vstr_str + pos;
        s_ConvertVersionInfo(ver, ver_str);
        return;
    } else {
        *ver = CVersionInfo::kAny;
        *program_name = vstr;
        NStr::TruncateSpacesInPlace(*program_name);
        if (program_name->empty()) {
            NCBI_THROW2(CStringException, eFormat, "Version string is empty", 0);
        }
    }
 
 
}
 
/////////////////////////////////////////////////////////////////////////////
//  CComponentVersionInfoAPI
 
CComponentVersionInfoAPI::CComponentVersionInfoAPI( const string& component_name,
                                              int  ver_major,
                                              int  ver_minor,
                                              int  patch_level,
                                              const string& name, const SBuildInfo& build_info)
    : CVersionInfo(ver_major, ver_minor, patch_level, name),
      m_ComponentName( component_name ), m_BuildInfo(build_info)
{
}
 
CComponentVersionInfoAPI::CComponentVersionInfoAPI( const string& component_name,
                                              const string& version,
                                              const string& name, const SBuildInfo& build_info)
    : CVersionInfo( version, name),
      m_ComponentName( component_name ), m_BuildInfo(build_info)
      
{
}
 
string CComponentVersionInfoAPI::Print(void) const
{
    CNcbiOstrstream os;
    os << GetComponentName() << ": " << CVersionInfo::Print() << endl << m_BuildInfo.Print(2);
    return CNcbiOstrstreamToString(os);
}
 
string CComponentVersionInfoAPI::PrintXml(void) const
{
    CNcbiOstrstream os;
    os << "<component name=\"" << NStr::XmlEncode(GetComponentName()) << "\">\n" <<
        CVersionInfo::PrintXml() << endl <<
        m_BuildInfo.PrintXml() <<
        "</component>" << endl;
    return CNcbiOstrstreamToString(os);
}
 
string CComponentVersionInfoAPI::PrintJson(void) const
{
    CNcbiOstrstream os;
    os << "{ \"name\": " << NStr::JsonEncode(GetComponentName(),NStr::eJsonEnc_Quoted) <<
            ", \"version_info\": " << CVersionInfo::PrintJson() << ",\n" <<
            "        \"build_info\": " << m_BuildInfo.PrintJson() << "}";
    return CNcbiOstrstreamToString(os);
}
 
/////////////////////////////////////////////////////////////////////////////
//  SBuildInfo
 
SBuildInfo::SBuildInfo(void)
    : date(__DATE__ " " __TIME__) {
}
 
SBuildInfo& SBuildInfo::Extra( EExtra key, const string& value)
{
    if (!value.empty()) {
        m_extra.push_back( make_pair(key, value));
    }
    return *this;
}
 
SBuildInfo& SBuildInfo::Extra( EExtra key, int value)
{
    if (value != 0) {
        m_extra.push_back( make_pair(key, NStr::NumericToString(value)));
    }
    return *this;
}
 
string SBuildInfo::GetExtraValue( EExtra key, const string& default_value) const
{
    if (key == eBuildDate) {
        return date;
    } else if (key == eBuildTag) {
        return tag;
    } else {
        for( const auto& e : m_extra) {
            if (e.first == key) {
                return e.second;
            }
        }
    }
    return default_value;
}
 
string SBuildInfo::ExtraName(EExtra key)
{
    switch (key)
    {
    case eBuildDate:               return "Build-Date";
    case eBuildTag:                return "Build-Tag";
    case eTeamCityProjectName:     return "TeamCity-Project-Name";
    case eTeamCityBuildConf:       return "TeamCity-BuildConf-Name";
    case eTeamCityBuildNumber:     return "TeamCity-Build-Number";
    case eBuildID:                 return "Build-ID";
    case eSubversionRevision:      return "Subversion-Revision";
    case eStableComponentsVersion: return "Stable-Components-Version";
    case eDevelopmentVersion:      return "Development-Version";
    case eProductionVersion:       return "Production-Version";
    case eBuiltAs:                 return "Built-As";
    case eRevision:                return "Revision";
    case eGitBranch:               return "GitBranch";
    }
    return "Unknown";
}
 
string SBuildInfo::ExtraNameAppLog(EExtra key)
{
    switch (key)
    {
    case eBuildDate:               return "ncbi_app_build_date";
    case eBuildTag:                return "ncbi_app_build_tag";
    case eTeamCityProjectName:     return "ncbi_app_tc_project";
    case eTeamCityBuildConf:       return "ncbi_app_tc_conf";
    case eTeamCityBuildNumber:     return "ncbi_app_tc_build";
    case eBuildID:                 return "ncbi_app_build_id";
    case eSubversionRevision:      return "ncbi_app_vcs_revision";
    case eStableComponentsVersion: return "ncbi_app_sc_version";
    case eDevelopmentVersion:      return "ncbi_app_dev_version";
    case eProductionVersion:       return "ncbi_app_prod_version";
    case eBuiltAs:                 return "ncbi_app_built_as";
    case eRevision:                return "ncbi_app_revision";
    case eGitBranch:               return "ncbi_app_gitbranch";
    }
    return "ncbi_app_unk";
}
 
string SBuildInfo::ExtraNameXml(EExtra key)
{
    if (key == eBuildDate) {
        return "date";
    } else if (key == eBuildTag) {
        return "tag";
    }
    string s(ExtraName(key));
    return NStr::ReplaceInPlace(NStr::ToLower(s),"-", "_");
}
 
string SBuildInfo::ExtraNameJson(EExtra key)
{
    return ExtraNameXml(key);
}
 
string SBuildInfo::Print(size_t offset) const
{
    string prefix(offset+1, ' ');
    CNcbiOstrstream os;
    if (!date.empty()) {
        os << prefix << ExtraName(eBuildDate) << ":  " << date << endl;
    }
 
    if (!tag.empty()) {
        os << prefix << ExtraName(eBuildDate) << ":  " << tag << endl;
    }
    for( const auto& e : m_extra) {
        os << prefix << ExtraName(e.first) << ":  " << e.second << endl;
    }
    return CNcbiOstrstreamToString(os);
}
 
string SBuildInfo::PrintXml(void) const
{
    CNcbiOstrstream os;
    os << "<build_info";
    if ( !date.empty() ) {
        os << ' ' << ExtraNameXml(eBuildDate) << "=\"" << NStr::XmlEncode(date) << '\"';
    }
    if ( !tag.empty() ) {
        os << ' ' << ExtraNameXml(eBuildTag) << "=\"" << NStr::XmlEncode(tag) << '\"';
    }
    os << ">" << endl;
    for( const auto& e : m_extra) {
      os << '<' << ExtraNameXml(e.first) << '>' << NStr::XmlEncode(e.second) << "</" << ExtraNameXml(e.first) << '>' << endl;
    }
    os << "</build_info>" << endl;
    return CNcbiOstrstreamToString(os);
}
 
string SBuildInfo::PrintJson(void) const
{
    CNcbiOstrstream os;
    bool need_separator = false;
    os << '{';
    if ( !date.empty() ) {
        os << "\"" << ExtraNameJson(eBuildDate) << "\": " << NStr::JsonEncode(date, NStr::eJsonEnc_Quoted);
        need_separator = true;
    }
    if ( !tag.empty() ) {
        if ( need_separator ) os << ", ";
        os << '\"' << ExtraNameJson(eBuildTag) << "\": " << NStr::JsonEncode(tag, NStr::eJsonEnc_Quoted);
        need_separator = true;
    }
    for( const auto& e : m_extra) {
        if ( need_separator ) os << ", ";
        os << '\"' << ExtraNameJson(e.first) << "\": " << NStr::JsonEncode(e.second, NStr::eJsonEnc_Quoted);
        need_separator = true;
    }
    os << '}';
    return CNcbiOstrstreamToString(os);
}
 
CTime SBuildInfo::GetBuildTime(void) const
{
    // According to the documentation, if the compiler cannot get the time of day 
    // it will give you question marks for __DATE__ and __TIME__. 
    try {
        return CTime(date, "b D Y h:m:s");
    }
    catch (CTimeException&) {}
    return CTime();
}
 
 
/////////////////////////////////////////////////////////////////////////////
//  CVersion
 
CVersionAPI::CVersionAPI(const SBuildInfo& build_info)
    : m_VersionInfo(new CVersionInfo(0,0)),
      m_BuildInfo(build_info)
{
    m_VersionInfo->SetVersion(m_VersionInfo->GetMajor(), m_VersionInfo->GetMinor(),
        NStr::StringToInt(build_info.GetExtraValue(SBuildInfo::eTeamCityBuildNumber, "0")));
}
 
CVersionAPI::CVersionAPI(const CVersionInfo& version, const SBuildInfo& build_info)
    : m_VersionInfo(new CVersionInfo(version)),
      m_BuildInfo(build_info)
{
}
 
void CVersionAPI::x_Copy(CVersionAPI& to, const CVersionAPI& from)
{
    to.m_VersionInfo.reset(new CVersionInfo(*from.m_VersionInfo));
    to.m_BuildInfo = from.m_BuildInfo;
 
    for (const auto& c : from.m_Components) {
        to.m_Components.emplace_back(new CComponentVersionInfoAPI(*c));
    }
}
 
CVersionAPI::CVersionAPI(const CVersionAPI& version)
    : CObject(version)
{
    x_Copy(*this, version);
}
 
CVersionAPI& CVersionAPI::operator=(const CVersionAPI& version)
{
    CObject::operator=(version);
    x_Copy(*this, version);
    return *this;
}
 
void CVersionAPI::SetVersionInfo( int  ver_major, int  ver_minor,
                               int  patch_level, const string& ver_name)
{
    m_VersionInfo.reset( new CVersionInfo(
        ver_major, ver_minor, patch_level, ver_name) );
}
 
void CVersionAPI::SetVersionInfo( int  ver_major, int  ver_minor,
                               int  patch_level, const string& ver_name,
                               const SBuildInfo& build_info)
{
    m_VersionInfo.reset( new CVersionInfo(
        ver_major, ver_minor, patch_level, ver_name) );
    m_BuildInfo = build_info;
}
 
void CVersionAPI::SetVersionInfo(CVersionInfo* version)
{
    m_VersionInfo.reset( version );
}
 
void CVersionAPI::SetVersionInfo(CVersionInfo* version,
        const SBuildInfo& build_info)
{
    m_VersionInfo.reset( version );
    m_BuildInfo = build_info;
}
 
const CVersionInfo& CVersionAPI::GetVersionInfo(void) const
{
    return *m_VersionInfo;
}
 
void CVersionAPI::AddComponentVersion(
    const string& component_name, int  ver_major, int  ver_minor,
    int  patch_level, const string& ver_name, const SBuildInfo& build_info)
{
    m_Components.emplace_back(
        new CComponentVersionInfoAPI(component_name, ver_major, ver_minor,
                                  patch_level, ver_name, build_info));
}
 
void CVersionAPI::AddComponentVersion( CComponentVersionInfoAPI* component)
{
    m_Components.emplace_back(component);
}
 
const SBuildInfo& CVersionAPI::GetBuildInfo() const
{
    return m_BuildInfo;
}
 
string CVersionAPI::GetPackageName(void)
{
    return NCBI_PACKAGE_NAME;
}
 
CVersionInfo CVersionAPI::GetPackageVersion(void)
{
    return CVersionInfo(NCBI_PACKAGE_VERSION_MAJOR,
                        NCBI_PACKAGE_VERSION_MINOR,
                        NCBI_PACKAGE_VERSION_PATCH);
}
 
string CVersionAPI::GetPackageConfig(void)
{
    return NCBI_PACKAGE_CONFIG;
}
 
 
string CVersionAPI::Print(const string& appname, TPrintFlags flags) const
{
    CNcbiOstrstream os;
 
    if (flags & fVersionInfo) {
        os << appname << ": " << m_VersionInfo->Print() << endl;
    }
 
#if NCBI_PACKAGE
    if (flags & ( fPackageShort | fPackageFull )) {
        os << " Package: " << GetPackageName() << ' '
           << GetPackageVersion().Print() << ", build "
           << NCBI_SBUILDINFO_DEFAULT().date
           << endl;
    }
    if (flags & fPackageFull) {
        os << " Package-Config: " << ' ' << GetPackageConfig() << endl;
    }
#endif
 
#ifdef NCBI_SIGNATURE
    if (flags & fBuildSignature) {
        os << " Build-Signature: " << ' ' << NCBI_SIGNATURE << endl;
    }
#endif
    if (flags & fGI64bit) {
#ifdef NCBI_INT8_GI
        os << " GI-64bit:  TRUE" << endl;
#else
        os << " GI-64bit:  FALSE" << endl;
#endif
    }
 
    if (flags & fBuildInfo) {
        os << m_BuildInfo.Print();
    }
 
    if (flags & fComponents) {
        for (const auto& c : m_Components) {
            os << endl << ' ' <<  c->Print() << endl;
        }
    }
    return CNcbiOstrstreamToString(os);
}
 
 
string CVersionAPI::PrintXml(const string& appname, TPrintFlags flags) const
{
    CNcbiOstrstream os;
 
    os << "<?xml version=\"1.0\"?>\n"
        "<ncbi_version xmlns=\"ncbi:version\"\n"
        "  xmlns:xs=\"http://www.w3.org/2001/XMLSchema-instance\"\n"
        "  xs:schemaLocation=\"ncbi:version ncbi_version.xsd\">\n";
 
    if (flags & fVersionInfo) {
        if ( !appname.empty() ) {
            os << "<appname>" << NStr::XmlEncode(appname) << "</appname>\n";
        }
        os << m_VersionInfo->PrintXml();
    }
 
    if (flags & fComponents) {
        for (const auto& c : m_Components) {
            os << c->PrintXml();
        }
    }
 
#if NCBI_PACKAGE
    if (flags & ( fPackageShort | fPackageFull )) {
        os << "<package name=\"" << NStr::XmlEncode(GetPackageName()) << "\">\n" <<
            GetPackageVersion().PrintXml() <<
            NCBI_SBUILDINFO_DEFAULT().PrintXml();
        if (flags & fPackageFull) {
            os << "<config>" << NStr::XmlEncode(GetPackageConfig()) << "</config>\n";
        }
        os << "</package>\n";
    }
#endif
 
#ifdef NCBI_SIGNATURE
    if (flags & fBuildSignature) {
        os << "<build_signature>" << NStr::XmlEncode(NCBI_SIGNATURE) << "</build_signature>\n";
    }
#endif
 
    if (flags & fBuildInfo) {
        os << m_BuildInfo.PrintXml();
    }
 
    os << "</ncbi_version>\n";
 
    return CNcbiOstrstreamToString(os);
}
 
 
string CVersionAPI::PrintJson(const string& appname, TPrintFlags flags) const
{
    CNcbiOstrstream os;
    bool need_separator = false;
 
    os << "{\n  \"ncbi_version\": {\n";
 
    if (flags & fVersionInfo) {
        if ( !appname.empty() ) {
            os << "    \"appname\": " << NStr::JsonEncode(appname, NStr::eJsonEnc_Quoted) << ",\n";
        }
        os << "    \"version_info\": " << m_VersionInfo->PrintJson();
        need_separator = true;
    }
 
    if (flags & fComponents) {
        if ( need_separator ) os << ",\n";
        os << "    \"component\": [";
        need_separator = false;
        for (const auto& c : m_Components) {
            if ( need_separator ) os << ",";
            os << "\n      " << c->PrintJson();
            need_separator = true;
        }
        os << "]";
        need_separator = true;
    }
 
#if NCBI_PACKAGE
    if (flags & ( fPackageShort | fPackageFull )) {
        if ( need_separator ) os << ",\n";
        os << "    \"package\": {\n" <<
            "      \"name\": " << NStr::JsonEncode(GetPackageName(), NStr::eJsonEnc_Quoted) << ",\n" <<
            "      \"version_info\": " << GetPackageVersion().PrintJson() << ",\n" <<
            "      \"build_info\": " << NCBI_SBUILDINFO_DEFAULT().PrintJson();
        if (flags & fPackageFull) {
            os << ",\n      \"config\": " << NStr::JsonEncode(GetPackageConfig(), NStr::eJsonEnc_Quoted);
        }
        os << "}";
        need_separator = true;
    }
#endif
 
#ifdef NCBI_SIGNATURE
    if (flags & fBuildSignature) {
        if ( need_separator ) os << ",\n";
        os << "    \"build_signature\": " << NStr::JsonEncode(NCBI_SIGNATURE, NStr::eJsonEnc_Quoted);
        need_separator = true;
    }
#endif
 
    if (flags & fBuildInfo) {
        if ( need_separator ) os << ",\n";
        os << "    \"build_info\": " << m_BuildInfo.PrintJson();
        need_separator = true;
    }
 
    os << "\n  }\n}\n";
    return CNcbiOstrstreamToString(os);
}
 
 
END_NCBI_SCOPE