cde/programs/dtinfo/DtMmdb/api/info_base.h

   1 /*
   2  * CDE - Common Desktop Environment
   3  *
   4  * Copyright (c) 1993-2012, The Open Group. All rights reserved.
   5  *
   6  * These libraries and programs are free software; you can
   7  * redistribute them and/or modify them under the terms of the GNU
   8  * Lesser General Public License as published by the Free Software
   9  * Foundation; either version 2 of the License, or (at your option)
  10  * any later version.
  11  *
  12  * These libraries and programs are distributed in the hope that
  13  * they will be useful, but WITHOUT ANY WARRANTY; without even the
  14  * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE. See the GNU Lesser General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with these librararies and programs; if not, write
  20  * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
  21  * Floor, Boston, MA 02110-1301 USA
  22  */
  23 /*
  24  * $XConsortium: info_base.h /main/6 1996/09/04 01:37:17 cde-hal $
  25  *
  26  * Copyright (c) 1992 HAL Computer Systems International, Ltd.
  27  * All rights reserved.  Unpublished -- rights reserved under
  28  * the Copyright Laws of the United States.  USE OF A COPYRIGHT
  29  * NOTICE IS PRECAUTIONARY ONLY AND DOES NOT IMPLY PUBLICATION
  30  * OR DISCLOSURE.
  31  *
  32  * THIS SOFTWARE CONTAINS CONFIDENTIAL INFORMATION AND TRADE
  33  * SECRETS OF HAL COMPUTER SYSTEMS INTERNATIONAL, LTD.  USE,
  34  * DISCLOSURE, OR REPRODUCTION IS PROHIBITED WITHOUT THE
  35  * PRIOR EXPRESS WRITTEN PERMISSION OF HAL COMPUTER SYSTEMS
  36  * INTERNATIONAL, LTD.
  37  *
  38  *                         RESTRICTED RIGHTS LEGEND
  39  * Use, duplication, or disclosure by the Government is subject
  40  * to the restrictions as set forth in subparagraph (c)(l)(ii)
  41  * of the Rights in Technical Data and Computer Software clause
  42  * at DFARS 252.227-7013.
  43  *
  44  *          HAL COMPUTER SYSTEMS INTERNATIONAL, LTD.
  45  *                  1315 Dell Avenue
  46  *                  Campbell, CA  95008
  47  *
  48  */
  49
  50
  51 #ifndef _info_base_h
  52 #define _info_base_h 1
  53
  54 #include "utility/macro.h"
  55 #include "storage/version.h"
  56 #include "api/base.h"
  57 #include "mgrs/managers.h"
  58 #include "schema/object_dict.h"
  59 #include "object/cset.h"
  60 #include "object/dl_list.h"
  61
  62 class Iterator
  63 {
  64 public:
  65    Iterator( handler*, c_code_t );
  66    ~Iterator();
  67
  68    operator void*();
  69
  70 protected:
  71    handler* collection_hd;
  72    c_code_t instance_c_code;
  73    mmdb_pos_t ind;
  74
  75    friend class info_base;
  76 };
  77
  78 /*************************************/
  79 // The info_base class
  80 /*************************************/
  81
  82 class info_base : public base
  83 {
  84
  85 public:
  86    info_base( object_dict& dict,
  87               char** set_nms, char** list_nms,
  88               const char* base_dir, const char* base_name,
  89               const char* base_desc, const char* base_uid,
  90               const char* base_locale,
  91               const mm_version& v
  92             );
  93    virtual ~info_base();
  94
  95 // export funcs
  96    cset_handlerPtr get_set( const char* set_name );
  97    cset_handlerPtr get_set( int set_position );
  98
  99    dl_list_handlerPtr get_list( const char* list_name );
 100    dl_list_handlerPtr get_list( int list_position );
 101
 102    void add_composite(char* new_db_path, char* def_spec_path);
 103
 104 // query functions
 105    int num_of_docs();
 106    mm_version& data_version() { return f_v; };
 107
 108 // iterate over all instances with 'c_code' in a set or a list
 109    Iterator* first(char* col_nm, c_code_t c_code);
 110    oid_t get_oid(const Iterator& ind);
 111    void next(Iterator&);
 112
 113 #ifdef C_API
 114 // an integer id within the infolib
 115    int index_id() { return f_index_id; };
 116    void set_index_id(int x) { f_index_id = x; };
 117 #endif
 118
 119 // build compression dicts. data is from stdin
 120    void build_dict(char* compress_agent_name);
 121
 122    const char* get_info_base_locale() const { return info_base_locale; }
 123
 124 protected:
 125
 126    cset_handlerPtr* info_base_set_ptrs;
 127    dl_list_handlerPtr* info_base_list_ptrs;
 128
 129 #ifdef C_API
 130    int f_index_id;
 131 #endif
 132
 133    mm_version f_v;
 134
 135    int get_set_pos( const char* set_name );
 136    int get_list_pos( const char* list_name );
 137
 138    friend class info_lib;
 139
 140    char info_base_locale[PATHSIZ];
 141 };
 142
 143 typedef info_base* info_basePtr;
 144
 145 #endif