cde/programs/dtinfo/DtMmdb/oliasdb/mark_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: mark_base.h /main/4 1996/07/18 14:47:51 drk $
  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 _mark_base_h
  52 #define _mark_base_h 1
  53
  54 #include "oliasdb/user_base.h"
  55
  56 /*************************************/
  57 // The mark class
  58 /*************************************/
  59
  60 class mark_base : public user_base
  61 {
  62
  63 public:
  64    mark_base(const char* base_dir,
  65              const char* base_name,
  66              const char* base_desc,
  67              user_base::rw_flag_t = user_base::READ
  68             );
  69    mark_base(user_base::rw_flag_t = user_base::READ);
  70    virtual ~mark_base();
  71
  72 // return user marks associated with a node locator
  73    oid_list_handler* get_mark_list(const char* node_locator);
  74
  75 // iterate over all user marks
  76    mmdb_pos_t first();
  77    oid_t get_mark_oid(mmdb_pos_t& ind);
  78    void next(mmdb_pos_t& ind);
  79
  80 protected:
  81
  82 protected:
  83    cset_handler* mark_set_hd;
  84
  85 //a16 back compatible
  86    friend class user_mark_smart_ptr;
  87
  88    friend class mark_smart_ptr;
  89    friend class mark_hd;
  90 };
  91
  92 typedef mark_base* mark_basePtr;
  93
  94
  95 #endif