开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 数值算法/人工智能 > 生物技术 > 查看源码
context.cpp
资源名称：ncbi_cxx_win--Jul_08_2004.zip　[点击查看]
上传用户：yhdzpy8989
上传日期：2007-06-13
资源大小：13604k
文件大小：16k
源码类别：

生物技术

开发平台：

C/C++

context.cpp：源码内容
  1. /*
  2.  * ===========================================================================
  3.  * PRODUCTION $Log: context.cpp,v $
  4.  * PRODUCTION Revision 1000.1  2004/06/01 19:43:52  gouriano
  5.  * PRODUCTION PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.18
  6.  * PRODUCTION
  7.  * ===========================================================================
  8.  */
  10. /*  $Id: context.cpp,v 1000.1 2004/06/01 19:43:52 gouriano Exp $
  11. * ===========================================================================
  12. *
  13. *                            PUBLIC DOMAIN NOTICE
  14. *               National Center for Biotechnology Information
  15. *
  16. *  This software/database is a "United States Government Work" under the
  17. *  terms of the United States Copyright Act.  It was written as part of
  18. *  the author's official duties as a United States Government employee and
  19. *  thus cannot be copyrighted.  This software/database is freely available
  20. *  to the public for use. The National Library of Medicine and the U.S.
  21. *  Government have not placed any restriction on its use or reproduction.
  22. *
  23. *  Although all reasonable efforts have been taken to ensure the accuracy
  24. *  and reliability of the software and data, the NLM and the U.S.
  25. *  Government do not and cannot warrant the performance or results that
  26. *  may be obtained by using this software or data. The NLM and the U.S.
  27. *  Government disclaim all warranties, express or implied, including
  28. *  warranties of performance, merchantability or fitness for any particular
  29. *  purpose.
  30. *
  31. *  Please cite the author in any work or product based on this material.
  32. *
  33. * ===========================================================================
  34. *
  35. * Author:  Aaron Ucko, NCBI
  36. *          Mati Shomrat
  37. *
  38. * File Description:
  39. *   new (early 2003) flat-file generator -- context needed when (pre)formatting
  40. *
  41. * ===========================================================================
  42. */
  43. #include <ncbi_pch.hpp>
  44. #include <corelib/ncbistd.hpp>
  46. #include <objects/seq/Bioseq.hpp>
  47. #include <objects/seq/Seq_ext.hpp>
  48. #include <objects/seq/Seg_ext.hpp>
  49. #include <objects/seq/Delta_ext.hpp>
  50. #include <objects/seq/Delta_seq.hpp>
  51. #include <objects/seqset/Bioseq_set.hpp>
  52. #include <objects/seqloc/Textseq_id.hpp>
  53. #include <objects/general/Dbtag.hpp>
  55. #include <objmgr/scope.hpp>
  56. #include <objmgr/bioseq_handle.hpp>
  57. #include <objmgr/seq_entry_handle.hpp>
  58. #include <objmgr/seq_entry_ci.hpp>
  59. #include <objmgr/seqdesc_ci.hpp>
  60. #include <objmgr/util/sequence.hpp>
  61. #include <objmgr/seq_loc_mapper.hpp>
  63. #include <objtools/format/context.hpp>
  66. BEGIN_NCBI_SCOPE
  67. BEGIN_SCOPE(objects)
  68. USING_SCOPE(sequence);
  71. /////////////////////////////////////////////////////////////////////////////
  72. //
  73. // CBioseqContext
  75. // constructor
  76. CBioseqContext::CBioseqContext
  77. (const CBioseq_Handle& seq,
  78.  CFlatFileContext& ffctx,
  79.  CMasterContext* mctx) :
  80.     m_Handle(seq),
  81.     m_Repr(CSeq_inst::eRepr_not_set),
  82.     m_Mol(CSeq_inst::eMol_not_set),
  83.     m_HasParts(false),
  84.     m_IsPart(false),
  85.     m_PartNumber(0),
  86.     m_IsDeltaLitOnly(false),
  87.     m_IsProt(false),
  88.     m_IsInGPS(false),
  89.     m_IsInNucProt(false),
  90.     m_IsGED(false),
  91.     m_IsEMBL(false),
  92.     m_IsPDB(false),
  93.     m_IsSP(false),
  94.     m_IsTPA(false),
  95.     m_IsRefSeq(false),
  96.     m_RefseqInfo(0),
  97.     m_IsGbGenomeProject(false),  // GenBank Genome project data (AE)
  98.     m_IsNcbiCONDiv(false),       // NCBI CON division (CH)
  99.     m_IsPatent(false),
  100.     m_IsGI(false),
  101.     m_IsWGS(false),
  102.     m_IsWGSMaster(false),
  103.     m_IsHup(false),
  104.     m_Gi(0),
  105.     m_ShowGBBSource(false),
  106.     m_FFCtx(ffctx),
  107.     m_Master(mctx)
  108. {
  109.     x_Init(seq, m_FFCtx.GetLocation());
  110. }
  113. // destructor
  114. CBioseqContext::~CBioseqContext(void)
  115. {
  116. }
  119. const CSeq_id& CBioseqContext::GetPreferredSynonym(const CSeq_id& id) const
  120. {
  121.     if ( id.IsGi()  &&  id.GetGi() == m_Gi ) {
  122.         return *m_PrimaryId;
  123.     }
  125.     CBioseq_Handle h = m_Handle.GetScope().GetBioseqHandleFromTSE(id, m_Handle);
  126.     if ( h ) {
  127.         if ( h == m_Handle ) {
  128.             return *m_PrimaryId;
  129.         } else if ( h.GetSeqId().NotEmpty() ) {
  130.             return *FindBestChoice(h.GetBioseqCore()->GetId(), CSeq_id::Score);
  131.         }
  132.     }
  134.     return id;
  135. }
  139. // initialization
  140. void CBioseqContext::x_Init(const CBioseq_Handle& seq, const CSeq_loc* user_loc)
  141. {
  142.     _ASSERT(seq);
  143.     _ASSERT(seq.IsSetInst());
  145.     // NB: order of execution is important
  146.     x_SetId();
  147.     m_Repr = x_GetRepr();
  148.     m_Mol  = seq.GetInst_Mol();
  149.     m_Molinfo.Reset(x_GetMolInfo());
  151.     if ( IsSegmented() ) {
  152.         m_HasParts = x_HasParts();
  153.     }
  154.     m_IsPart = x_IsPart();
  155.     if ( m_IsPart ) {
  156.         _ASSERT(m_Master);
  157.         m_PartNumber = x_GetPartNumber();
  158.     }
  159.     if ( IsDelta() ) {
  160.         m_IsDeltaLitOnly = x_IsDeltaLitOnly();
  161.     }
  163.     m_IsProt = CSeq_inst::IsAa(seq.GetInst_Mol());
  165.     m_IsInGPS     = x_IsInGPS();
  166.     m_IsInNucProt = x_IsInNucProt();
  168.     x_SetLocation(user_loc);
  169.     
  170. }
  173. void CBioseqContext::x_SetLocation(const CSeq_loc* user_loc)
  174. {
  175.     _ASSERT(user_loc == 0  ||  user_loc->IsInt()  ||  user_loc->IsWhole());
  176.     CRef<CSeq_loc> source;
  178.     if ( user_loc != 0 ) {
  179.         // map the location to the current bioseq
  180.         CSeq_loc_Mapper mapper(m_Handle);
  181.         mapper.SetMergeAll();  // just to be safe
  182.         source.Reset(mapper.Map(*user_loc));
  183.         
  184.         // no need to map if doing the entire bioseq
  185.         if ( source->IsWhole()  ||
  186.              source->GetStart(kInvalidSeqPos) == 0  &&
  187.              source->GetEnd(kInvalidSeqPos) == m_Handle.GetInst_Length() - 1) {
  188.             source.Reset();
  189.         }
  190.         _ASSERT(!source  ||  source->IsInt());
  192.         if ( source ) {
  193.             CScope& scope = GetScope();
  195.             CSeq_loc target;
  196.             target.SetInt().SetFrom(0);
  197.             target.SetInt().SetTo(GetLength(*source, &scope) - 1);
  198.             target.SetId(*m_PrimaryId);
  200.             m_Mapper.Reset(new CSeq_loc_Mapper(*source, target, &scope));
  201.             m_Mapper->SetMergeAbutting();
  202.             m_Mapper->PreserveDestinationLocs();  // ???
  203.             m_Mapper->KeepNonmappingRanges();
  204.         }
  205.     }
  206.     // if no location is specified do the entire sequence
  207.     if ( !source ) {
  208.         source.Reset(new CSeq_loc);
  209.         source->SetWhole(*m_PrimaryId);
  210.     }
  211.     _ASSERT(source);
  212.     m_Location = source;
  214.     
  215. }
  218. void CBioseqContext::x_SetId(void)
  219. {
  220.     m_PrimaryId.Reset(new CSeq_id);
  221.     m_PrimaryId->Assign(sequence::GetId(m_Handle, sequence::eGetId_Best));
  223.     m_Accession.erase();
  224.     m_PrimaryId->GetLabel(&m_Accession, CSeq_id::eContent);
  226.     ITERATE (CBioseq::TId, id_iter, m_Handle.GetBioseqCore()->GetId()) {
  227.         const CSeq_id& id = **id_iter;
  228.         const CTextseq_id* tsip = id.GetTextseq_Id();
  229.         const string& acc = (tsip != 0  &&  tsip->CanGetAccession()) ?
  230.             tsip->GetAccession() : kEmptyStr;
  232.         CSeq_id::EAccessionInfo acc_info = id.IdentifyAccession();
  233.         unsigned int acc_type = acc_info & CSeq_id::eAcc_type_mask;
  234.         unsigned int acc_div =  acc_info & CSeq_id::eAcc_division_mask;
  236.         switch ( id.Which() ) {
  237.         // Genbank, Embl or Ddbj
  238.         case CSeq_id::e_Embl:
  239.             m_IsEMBL = true;
  240.             // intentional fall through
  241.         case CSeq_id::e_Genbank:
  242.         case CSeq_id::e_Ddbj:
  243.             m_IsGED = true;
  244.             m_IsGbGenomeProject = m_IsGbGenomeProject  ||
  245.                 ((acc_type & CSeq_id::eAcc_gb_genome) != 0);
  246.             m_IsNcbiCONDiv = m_IsNcbiCONDiv  ||
  247.                 ((acc_type & CSeq_id::eAcc_gb_con) != 0);
  248.             break;
  249.         // Patent
  250.         case CSeq_id::e_Patent:
  251.             m_IsPatent = true;
  252.             break;
  253.         // RefSeq
  254.         case CSeq_id::e_Other:
  255.             m_IsRefSeq = true;
  256.             m_RefseqInfo = acc_info;
  257.             break;
  258.         // Gi
  259.         case CSeq_id::e_Gi:
  260.             m_IsGI = true;
  261.             m_Gi = id.GetGi();
  262.             break;
  263.         // PDB
  264.         case CSeq_id::e_Pdb:
  265.             m_IsPDB = true;
  266.             break;
  267.         // TPA
  268.         case CSeq_id::e_Tpg:
  269.         case CSeq_id::e_Tpe:
  270.         case CSeq_id::e_Tpd:
  271.             m_IsTPA = true;
  272.             break;
  273.         case CSeq_id::e_General:
  274.             if ( id.GetGeneral().CanGetDb() ) {
  275.                 if ( !NStr::CompareCase(id.GetGeneral().GetDb(), "BankIt") ) {
  276.                     m_IsTPA = true;
  277.                 }
  278.             }
  279.             break;
  280.         // nothing special
  281.         case CSeq_id::e_not_set:
  282.         case CSeq_id::e_Local:
  283.         case CSeq_id::e_Gibbsq:
  284.         case CSeq_id::e_Gibbmt:
  285.         case CSeq_id::e_Giim:
  286.         case CSeq_id::e_Pir:
  287.         case CSeq_id::e_Swissprot:
  288.             m_IsSP = true;
  289.             break;
  290.         case CSeq_id::e_Prf:
  291.         default:
  292.             break;
  293.         }
  295.         // WGS
  296.         m_IsWGS = m_IsWGS  ||  (acc_div == CSeq_id::eAcc_wgs);
  297.         
  298.         if ( m_IsWGS  &&  !acc.empty() ) {
  299.             size_t len = acc.length();
  300.             m_IsWGSMaster = 
  301.                 ((len == 12  ||  len == 15)  &&  NStr::EndsWith(acc, "000000"))  ||
  302.                 (len == 13  &&  NStr::EndsWith(acc, "0000000"));
  303.             if ( m_IsWGSMaster ) {
  304.                 m_WGSMasterAccn = acc;
  305.                 m_WGSMasterName = tsip->CanGetName() ? tsip->GetName() : kEmptyStr;
  306.             }
  307.         } 
  309.         // GBB source
  310.         m_ShowGBBSource = m_ShowGBBSource  ||  
  311.                           ((acc_type & CSeq_id::eAcc_gsdb_dirsub) != 0);
  312.     }
  313. }
  316. CSeq_inst::TRepr CBioseqContext::x_GetRepr(void) const
  317. {
  318.     return m_Handle.IsSetInst_Repr() ?
  319.         m_Handle.GetInst_Repr() : CSeq_inst::eRepr_not_set;
  320. }
  323. const CMolInfo* CBioseqContext::x_GetMolInfo(void) const
  324. {
  325.     CSeqdesc_CI desc(m_Handle, CSeqdesc::e_Molinfo);
  326.     return desc ? &desc->GetMolinfo() : 0;
  327. }
  330. bool CBioseqContext::x_IsPart() const
  331. {
  332.     if ( m_Repr == CSeq_inst::eRepr_raw    ||
  333.          m_Repr == CSeq_inst::eRepr_const  ||
  334.          m_Repr == CSeq_inst::eRepr_delta  ||
  335.          m_Repr == CSeq_inst::eRepr_virtual ) {
  336.         CSeq_entry_Handle eh = m_Handle.GetParentEntry();
  337.         _ASSERT(eh  &&  eh.IsSeq());
  339.         eh = eh.GetParentEntry();
  340.         if ( eh  &&  eh.IsSet() ) {
  341.             CBioseq_set_Handle bsst = eh.GetSet();
  342.             if ( bsst.IsSetClass()  &&  
  343.                  bsst.GetClass() == CBioseq_set::eClass_parts ) {
  344.                 return true;
  345.             }
  346.         }
  347.     }
  348.     return false;
  349. }
  352. bool CBioseqContext::x_HasParts(void) const
  353. {
  354.     _ASSERT(IsSegmented());
  356.     CSeq_entry_Handle h =
  357.         m_Handle.GetExactComplexityLevel(CBioseq_set::eClass_segset);
  358.     if ( !h ) {
  359.         return false;
  360.     }
  361.     
  362.     // make sure the segmented set contains our bioseq
  363.     {{
  364.         bool has_seq = false;
  365.         for ( CSeq_entry_CI it(h); it; ++it ) {
  366.             if ( it->IsSeq()  &&  it->GetSeq() == m_Handle ) {
  367.                 has_seq = true;
  368.                 break;
  369.             }
  370.         }
  371.         if ( !has_seq ) {
  372.             return false;
  373.         }
  374.     }}
  376.     // find the parts set
  377.     {{
  378.         for ( CSeq_entry_CI it(h); it; ++it ) {
  379.             if ( it->IsSet()  &&  it->GetSet().IsSetClass()  &&
  380.                 it->GetSet().GetClass() == CBioseq_set::eClass_parts ) {
  381.                 return true;
  382.             }
  383.         }
  384.     }}
  386.     return false;
  387. }
  390. bool CBioseqContext::x_IsDeltaLitOnly(void) const
  391. {
  392.     _ASSERT(IsDelta());
  394.     if ( m_Handle.IsSetInst_Ext() ) {
  395.         const CBioseq_Handle::TInst_Ext& ext = m_Handle.GetInst_Ext();
  396.         if ( ext.IsDelta() ) {
  397.             ITERATE (CDelta_ext::Tdata, it, ext.GetDelta().Get()) {
  398.                 if ( (*it)->IsLoc() ) {
  399.                     return false;
  400.                 }
  401.             }
  402.         }
  403.     }
  404.     return true;
  405. }
  408. SIZE_TYPE CBioseqContext::x_GetPartNumber(void)
  409. {
  410.     return m_Master ? m_Master->GetPartNumber(m_Handle) : 0;
  411. }
  414. bool CBioseqContext::x_IsInGPS(void) const
  415. {
  416.     CSeq_entry_Handle e = 
  417.         m_Handle.GetExactComplexityLevel(CBioseq_set::eClass_gen_prod_set);
  418.     return e;
  419. }
  422. bool CBioseqContext::x_IsInNucProt(void) const
  423. {
  424.     CSeq_entry_Handle e = 
  425.         m_Handle.GetExactComplexityLevel(CBioseq_set::eClass_nuc_prot);
  426.     return e;
  427. }
  430. bool CBioseqContext::DoContigStyle(void) const
  431. {
  432.     const CFlatFileConfig& cfg = Config();
  433.     if ( cfg.IsStyleContig() ) {
  434.         return true;
  435.     } else if ( cfg.IsStyleNormal() ) {
  436.         if ( (IsSegmented()  &&  !HasParts())  ||
  437.              (IsDelta()  &&  !IsDeltaLitOnly()) ) {
  438.             return true;
  439.         }
  440.     }
  442.     return false;
  443. }
  446. /////////////////////////////////////////////////////////////////////////////
  447. //
  448. // CMasterContext
  451. CMasterContext::CMasterContext(const CBioseq_Handle& seq) :
  452.     m_Handle(seq)
  453. {
  454.     _ASSERT(seq);
  455.     _ASSERT(seq.GetInst_Ext().IsSeg());
  457.     x_SetNumParts();
  458.     x_SetBaseName();
  459. }
  462. CMasterContext::~CMasterContext(void)
  463. {
  464. }
  467. SIZE_TYPE CMasterContext::GetPartNumber(const CBioseq_Handle& part)
  468. {
  469.     if ( !part ) {
  470.         return 0;
  471.     }
  472.     CScope& scope = m_Handle.GetScope();
  474.     SIZE_TYPE serial = 1;
  475.     ITERATE (CSeg_ext::Tdata, it, m_Handle.GetInst_Ext().GetSeg().Get()) {
  476.         if ( (*it)->IsNull() ) {
  477.             continue;
  478.         }
  479.         const CSeq_id& id = GetId(**it);
  480.         CBioseq_Handle bsh = scope.GetBioseqHandleFromTSE(id, m_Handle);
  481.         if ( bsh   &&  bsh == part ) {
  482.             return serial;
  483.         }
  484.         ++serial;
  485.     }
  487.     return 0;
  488. }
  491. void CMasterContext::x_SetNumParts(void)
  492. {
  493.     SIZE_TYPE count = 0;
  494.     // count only non-gap parts
  495.     ITERATE (CSeg_ext::Tdata, it, m_Handle.GetInst_Ext().GetSeg().Get()) {
  496.         if ( (*it)->IsNull() ) {
  497.             continue;
  498.         }
  499.         ++count;
  500.     }
  501.     m_NumParts = count;
  502. }
  505. void CMasterContext::x_SetBaseName(void)
  506. {
  507.     // !!!
  508. }
  511. END_SCOPE(objects)
  512. END_NCBI_SCOPE
  514. /*
  515. * ===========================================================================
  516. *
  517. * $Log: context.cpp,v $
  518. * Revision 1000.1  2004/06/01 19:43:52  gouriano
  519. * PRODUCTION: UPGRADED [GCC34_MSVC7] Dev-tree R1.18
  520. *
  521. * Revision 1.18  2004/05/21 21:42:54  gorelenk
  522. * Added PCH ncbi_pch.hpp
  523. *
  524. * Revision 1.17  2004/05/08 12:11:39  dicuccio
  525. * Use CSeq_id::GetLabel() instead of GetSeqIdString()
  526. *
  527. * Revision 1.16  2004/05/06 17:48:49  shomrat
  528. * + IsEMBL and IsInNucProt
  529. *
  530. * Revision 1.15  2004/04/27 15:12:24  shomrat
  531. * Added logic for partial range formatting
  532. *
  533. * Revision 1.14  2004/04/22 15:52:00  shomrat
  534. * Refactring of context
  535. *
  536. * Revision 1.13  2004/03/31 17:15:09  shomrat
  537. * name changes
  538. *
  539. * Revision 1.12  2004/03/26 17:23:38  shomrat
  540. * fixed initialization of m_IsWGS
  541. *
  542. * Revision 1.11  2004/03/25 20:36:02  shomrat
  543. * Use handles
  544. *
  545. * Revision 1.10  2004/03/24 18:57:04  vasilche
  546. * CBioseq_Handle::GetComplexityLevel() now returns CSeq_entry_Handle.
  547. *
  548. * Revision 1.9  2004/03/18 15:36:26  shomrat
  549. * + new flag ShowFtableRefs
  550. *
  551. * Revision 1.8  2004/03/10 21:25:42  shomrat
  552. * Fix m_RefseqInfo initialization
  553. *
  554. * Revision 1.7  2004/03/05 18:46:26  shomrat
  555. * Added customization flags
  556. *
  557. * Revision 1.6  2004/02/19 18:03:29  shomrat
  558. * changed implementation of GetPreferredSynonym
  559. *
  560. * Revision 1.5  2004/02/11 22:49:04  shomrat
  561. * using types in flag file
  562. *
  563. * Revision 1.4  2004/02/11 16:49:16  shomrat
  564. * added user customization flags
  565. *
  566. * Revision 1.3  2004/01/14 16:09:04  shomrat
  567. * multiple changes (work in progress)
  568. *
  569. * Revision 1.2  2003/12/18 17:43:31  shomrat
  570. * context.hpp moved
  571. *
  572. * Revision 1.1  2003/12/17 20:18:44  shomrat
  573. * Initial Revision (adapted from flat lib)
  574. *
  575. * Revision 1.4  2003/06/02 16:06:42  dicuccio
  576. * Rearranged src/objects/ subtree.  This includes the following shifts:
  577. *     - src/objects/asn2asn --> arc/app/asn2asn
  578. *     - src/objects/testmedline --> src/objects/ncbimime/test
  579. *     - src/objects/objmgr --> src/objmgr
  580. *     - src/objects/util --> src/objmgr/util
  581. *     - src/objects/alnmgr --> src/objtools/alnmgr
  582. *     - src/objects/flat --> src/objtools/flat
  583. *     - src/objects/validator --> src/objtools/validator
  584. *     - src/objects/cddalignview --> src/objtools/cddalignview
  585. * In addition, libseq now includes six of the objects/seq... libs, and libmmdb
  586. * replaces the three libmmdb? libs.
  587. *
  588. * Revision 1.3  2003/03/21 18:49:17  ucko
  589. * Turn most structs into (accessor-requiring) classes; replace some
  590. * formerly copied fields with pointers to the original data.
  591. *
  592. * Revision 1.2  2003/03/11 15:37:51  kuznets
  593. * iterate -> ITERATE
  594. *
  595. * Revision 1.1  2003/03/10 16:39:09  ucko
  596. * Initial check-in of new flat-file generator
  597. *
  598. *
  599. * ===========================================================================
  600. */