/*
 * CDE - Common Desktop Environment
 *
 * Copyright (c) 1993-2012, The Open Group. All rights reserved.
 *
 * These libraries and programs are free software; you can
 * redistribute them and/or modify them under the terms of the GNU
 * Lesser General Public License as published by the Free Software
 * Foundation; either version 2 of the License, or (at your option)
 * any later version.
 *
 * These libraries and programs are distributed in the hope that
 * they will be useful, but WITHOUT ANY WARRANTY; without even the
 * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 * PURPOSE. See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with these libraries and programs; if not, write
 * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
 * Floor, Boston, MA 02110-1301 USA
 */
/*
 * $XConsortium: doc_hd.h /main/4 1996/06/11 17:28:52 cde-hal $
 *
 * Copyright (c) 1992 HAL Computer Systems International, Ltd.
 * All rights reserved.  Unpublished -- rights reserved under
 * the Copyright Laws of the United States.  USE OF A COPYRIGHT
 * NOTICE IS PRECAUTIONARY ONLY AND DOES NOT IMPLY PUBLICATION
 * OR DISCLOSURE.
 * 
 * THIS SOFTWARE CONTAINS CONFIDENTIAL INFORMATION AND TRADE
 * SECRETS OF HAL COMPUTER SYSTEMS INTERNATIONAL, LTD.  USE,
 * DISCLOSURE, OR REPRODUCTION IS PROHIBITED WITHOUT THE
 * PRIOR EXPRESS WRITTEN PERMISSION OF HAL COMPUTER SYSTEMS
 * INTERNATIONAL, LTD.
 * 
 *                         RESTRICTED RIGHTS LEGEND
 * Use, duplication, or disclosure by the Government is subject
 * to the restrictions as set forth in subparagraph (c)(l)(ii)
 * of the Rights in Technical Data and Computer Software clause
 * at DFARS 252.227-7013.
 *
 *          HAL COMPUTER SYSTEMS INTERNATIONAL, LTD.
 *                  1315 Dell Avenue
 *                  Campbell, CA  95008
 * 
 */


#ifndef _doc_hd_h
#define _doc_hd_h 1

#include "object/tuple.h"
#include "object/short_list.h"
#include "object/pstring.h"
#include "object/oid.h"
#include "object/integer.h"
#include "oliasdb/olias_consts.h"
#include "api/smart_ptr.h"

#ifdef A16_BROWSER
#define long_title title
#endif

/*************************************/
// The doc class
/*************************************/

class doc : public mmdb_tuple
{
public:
   doc() : mmdb_tuple(NUM_DOC_FIELDS, DOC_CODE) {};
   virtual ~doc() {};

   MMDB_SIGNATURES(doc);
 
protected:
   friend class doc_smart_ptr;
};

typedef doc* docPtr;

/*************************************/
/*************************************/


class doc_smart_ptr : public smart_ptr
{
public:
   doc_smart_ptr(info_lib*, const char* base_name, const int seq_num);
   doc_smart_ptr(info_base* base_ptr, const int seq_num);

   doc_smart_ptr(info_lib*, const char* ibase_name, const oid_t& toc_node_id);
   doc_smart_ptr(info_base* ibase_ptr, const oid_t& toc_node_id);

   doc_smart_ptr(const oid_t& doc_id, info_lib*, const char* ibase_name);
   doc_smart_ptr(const oid_t& doc_id, info_base*);

   virtual ~doc_smart_ptr() {};

   oid_t  locator_id();
   const char*  short_title();
   const char*  long_title();
   short_list_handler* tab_list();
   int seq_num();  // seq number for Fulcrum.
   const char*  license_terms();
   unsigned int license_terms_size();
};



#endif
