~ubuntu-branches/ubuntu/precise/ncbi-tools6/precise

« back to all changes in this revision

Viewing changes to api/objmgr.h

  • Committer: Bazaar Package Importer
  • Author(s): Aaron M. Ucko
  • Date: 2005-03-27 12:00:15 UTC
  • mfrom: (2.1.2 hoary)
  • Revision ID: james.westby@ubuntu.com-20050327120015-embhesp32nj73p9r
Tags: 6.1.20041020-3
* Fix FTBFS under GCC 4.0 caused by inconsistent use of "static" on
  functions.  (Closes: #295110.)
* Add a watch file, now that we can.  (Upstream's layout needs version=3.)

Show diffs side-by-side

added added

removed removed

Lines of Context:
29
29
*   
30
30
* Version Creation Date: 9/94
31
31
*
32
 
* $Revision: 6.31 $
 
32
* $Revision: 6.37 $
33
33
*
34
34
* File Description:  Manager for Bioseqs and BioseqSets
35
35
*
40
40
*
41
41
*
42
42
* $Log: objmgr.h,v $
 
43
* Revision 6.37  2004/04/01 13:43:05  lavr
 
44
* Spell "occurred", "occurrence", and "occurring"
 
45
*
 
46
* Revision 6.36  2002/07/30 14:41:45  kans
 
47
* removed omdp->rearranged
 
48
*
 
49
* Revision 6.35  2002/07/29 21:30:17  kans
 
50
* added rearranged flag to omdp
 
51
*
 
52
* Revision 6.34  2002/07/01 14:29:03  kans
 
53
* changed totobj, currobj to Uint4
 
54
*
 
55
* Revision 6.33  2002/05/31 21:53:27  yaschenk
 
56
* changing lookup by EntityID to array[][]
 
57
*
 
58
* Revision 6.32  2001/12/26 20:54:14  kans
 
59
* added defines for OM_OPT_RECORD_SUPPRESSED and OM_OPT_RECORD_DEAD
 
60
*
43
61
* Revision 6.31  2001/11/19 15:26:19  kans
44
62
* added ObjMgrDeleteAllInRecord, still need to bail in ObjMgrDelete if bulkIndexFree, then call from BioseqFree and BioseqSetFree
45
63
*
357
375
 
358
376
        /**** defines for message function return values ******/
359
377
 
360
 
#define OM_MSG_RET_ERROR   0      /* an error occured handling this message */
 
378
#define OM_MSG_RET_ERROR   0      /* an error occurred handling this message */
361
379
#define OM_MSG_RET_OK      1      /* message handled ok */
362
380
#define OM_MSG_RET_DEL     2      /* due to message, remove this handler */
363
381
#define OM_MSG_RET_DONE    3      /* handled, do not send message further */
625
643
 
626
644
        OMDataPtr ncbidata;    /* data needed by NCBI functions */
627
645
        ObjMgrDataPtr PNTR datalist; /* sorted by pointer */
628
 
        Uint2 totobj,                 /* number of elements in ncbidata */
629
 
                 currobj,                /* number of elements in ncbidata occupied */
630
 
                HighestEntityID;
 
646
        Uint4 totobj,                 /* number of elements in ncbidata */
 
647
                 currobj;                /* number of elements in ncbidata occupied */
 
648
        Uint2 HighestEntityID;
631
649
        ObjMgrDataPtr clipboard;
632
650
        SelStructPtr sel;               /* for currently selected data item(s) */
633
651
 
642
660
        Boolean autoclean;           /* if TRUE, reap and free cache if currobj > maxobj */
643
661
        Uint2 maxobj;                /* number of objects that tiggers autocleaning */
644
662
 
 
663
        ObjMgrDataPtr PNTR PNTR entityID_index; /**** two-level array index on Entity ID *****/
 
664
 
645
665
} ObjMgr, PNTR ObjMgrPtr;
646
666
 
647
667
#define DEFAULT_MAXTEMP 5   /* default number of temp entries to keep */
699
719
*      to that entity.
700
720
*
701
721
*****************************************************************************/
702
 
#define OM_OPT_FREE_IF_NO_VIEW 1  /* free entity if no more UserData
703
 
                                            structures are attached to it */
 
722
#define OM_OPT_FREE_IF_NO_VIEW   1  /* free entity if no more UserData
 
723
                                       structures are attached to it */
 
724
#define OM_OPT_RECORD_SUPPRESSED 2  /* removed from distribution, still
 
725
                                       available for retrieval */
 
726
#define OM_OPT_RECORD_DEAD       4
704
727
 
705
728
/*****************************************************************************
706
729
*
1087
1110
*       Frees all cached objects of type and subtypes of type
1088
1111
*               based on ObjMgrMatch()
1089
1112
*       if type == 0, frees all cached objects
1090
 
*       returns TRUE if no errors occured
 
1113
*       returns TRUE if no errors occurred
1091
1114
*
1092
1115
*       if ObjMgrSetHold() has been called but not cleared, nothing will
1093
1116
*         be removed from cache, since it is held, but this function will
1305
1328
NLM_EXTERN void LIBCALL ObjMgrReportFunc (CharPtr filename);
1306
1329
 
1307
1330
 
 
1331
NLM_EXTERN void LIBCALL ObjMgrAddIndexOnEntityID PROTO((ObjMgrPtr omp,Uint2 entityID,ObjMgrDataPtr omdp));
 
1332
NLM_EXTERN void LIBCALL ObjMgrDeleteIndexOnEntityID PROTO((ObjMgrPtr omp,Uint2 entityID));
 
1333
NLM_EXTERN ObjMgrDataPtr LIBCALL ObjMgrLookupIndexOnEntityID PROTO((ObjMgrPtr omp,Uint2 entityID));
1308
1334
 
1309
1335
#ifdef __cplusplus
1310
1336
}