cde/programs/dtinfo/DtMmdb/oliasdb/node_hd.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: node_hd.h /main/4 1996/06/11 17:29:56 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 _node_hd_h
  52 #define _node_hd_h 1
  53
  54 #include "object/tuple.h"
  55 #include "object/pstring.h"
  56 #include "object/compressed_pstring.h"
  57 #include "object/oid.h"
  58 #include "oliasdb/olias_consts.h"
  59 #include "api/smart_ptr.h"
  60
  61 // A16 back compatible
  62 #ifdef A16_BROWSER
  63 #define long_title title
  64 #endif
  65
  66 /*************************************/
  67 // The node class
  68 /*************************************/
  69
  70 class olias_node : public tuple
  71 {
  72
  73 public:
  74    olias_node() : tuple(NUM_OLIAS_NODE_FIELDS, OLIAS_NODE_CODE) {};
  75    virtual ~olias_node() {};
  76
  77    MMDB_SIGNATURES(olias_node);
  78
  79 protected:
  80 };
  81
  82 typedef olias_node* nodePtr;
  83
  84
  85
  86 class node_smart_ptr : public smart_ptr
  87 {
  88 public:
  89    node_smart_ptr(info_lib* lib_ptr, const char* info_base_name, const char* locator);
  90    node_smart_ptr(info_base* base_ptr, const char* locator);
  91
  92    node_smart_ptr(info_lib* lib_ptr, const char* ibase_name, const oid_t& node_id);
  93    node_smart_ptr(info_base* ibase_ptr, const oid_t& node_id);
  94    virtual ~node_smart_ptr() {};
  95
  96    const char* locator();
  97    const char* long_title();
  98    const char* short_title();
  99    const char* data();
 100    int data_size();
 101    const char* toc_node_loc();
 102    oid_t doc_id();
 103
 104    oid_t stylesheet_id();
 105    //const char* stylesheet_name();
 106
 107 /////////////////////////////////////////////////////////////
 108 // this function (update_data()) is for clustering SGML data
 109 // portion to a set of centeralized pages
 110 /////////////////////////////////////////////////////////////
 111    Boolean update_data(istream&);
 112
 113 /////////////////////////////////////////////////////////////
 114 // this function is for update the doc id field so that
 115 // the node object can be loaded earlier than the doc object.
 116 /////////////////////////////////////////////////////////////
 117    void update_doc_id(const oid_t& doc_id);
 118 };
 119
 120
 121 typedef node_smart_ptr* node_smart_ptrPtr;
 122
 123 #endif