1 /* @include ajtaxread ********************************************************* 2 ** 3 ** AJAX taxonomy reading functions 4 ** 5 ** These functions control all aspects of AJAX taxonomy reading 6 ** 7 ** @author Copyright (C) 2010 Peter Rice 8 ** @version $Revision: 1.10 $ 9 ** @modified Oct 5 pmr First version 10 ** @modified $Date: 2011/10/18 14:23:41 $ by $Author: rice $ 11 ** @@ 12 ** 13 ** This library is free software; you can redistribute it and/or 14 ** modify it under the terms of the GNU Lesser General Public 15 ** License as published by the Free Software Foundation; either 16 ** version 2.1 of the License, or (at your option) any later version. 17 ** 18 ** This library is distributed in the hope that it will be useful, 19 ** but WITHOUT ANY WARRANTY; without even the implied warranty of 20 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 21 ** Lesser General Public License for more details. 22 ** 23 ** You should have received a copy of the GNU Lesser General Public 24 ** License along with this library; if not, write to the Free Software 25 ** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 26 ** MA 02110-1301, USA. 27 ** 28 ******************************************************************************/ 29 30 #ifndef AJTAXREAD_H 31 #define AJTAXREAD_H 32 33 /* ========================================================================= */ 34 /* ============================= include files ============================= */ 35 /* ========================================================================= */ 36 37 #include "ajdefine.h" 38 #include "ajtaxdata.h" 39 40 AJ_BEGIN_DECLS 41 42 43 44 45 /* ========================================================================= */ 46 /* =============================== constants =============================== */ 47 /* ========================================================================= */ 48 49 50 51 52 /* ========================================================================= */ 53 /* ============================== public data ============================== */ 54 /* ========================================================================= */ 55 56 57 58 59 /* ========================================================================= */ 60 /* =========================== public functions ============================ */ 61 /* ========================================================================= */ 62 63 64 65 66 /* 67 ** Prototype definitions 68 */ 69 70 void ajTaxallClear(AjPTaxall thys); 71 void ajTaxallDel(AjPTaxall* pthis); 72 AjPTaxall ajTaxallNew(void); 73 const AjPStr ajTaxallGettaxId(const AjPTaxall thys); 74 75 void ajTaxinClear(AjPTaxin thys); 76 void ajTaxinDel(AjPTaxin* pthis); 77 AjPTaxin ajTaxinNew(void); 78 void ajTaxinQryC(AjPTaxin thys, const char* txt); 79 void ajTaxinQryS(AjPTaxin thys, const AjPStr str); 80 void ajTaxinTrace(const AjPTaxin thys); 81 82 void ajTaxinprintBook(AjPFile outf); 83 void ajTaxinprintHtml(AjPFile outf); 84 void ajTaxinprintText(AjPFile outf, AjBool full); 85 void ajTaxinprintWiki(AjPFile outf); 86 87 AjBool ajTaxallNext(AjPTaxall thys, AjPTax *Ptax); 88 AjBool ajTaxinRead(AjPTaxin taxin, AjPTax thys); 89 90 AjBool ajTaxinformatTest(const AjPStr format); 91 void ajTaxinExit(void); 92 const char* ajTaxinTypeGetFields(void); 93 const char* ajTaxinTypeGetQlinks(void); 94 95 AjPTable ajTaxaccessGetDb(void); 96 const char* ajTaxaccessMethodGetQlinks(const AjPStr method); 97 ajuint ajTaxaccessMethodGetScope(const AjPStr method); 98 AjBool ajTaxaccessMethodTest(const AjPStr method); 99 100 /* 101 ** End of prototype definitions 102 */ 103 104 105 106 107 AJ_END_DECLS 108 109 #endif /* !AJTAXREAD_H */ 110