cde/programs/dtinfo/dtinfo/src/Basic/InfoBase.hh

   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 libraries 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: InfoBase.hh /main/3 1996/06/11 16:19:27 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 class InfobaseEntry ;
  51
  52 class InfoBase : public LibraryElement
  53 {
  54   enum { AVERAGE_BOOKS_PER = 6 };
  55
  56 public: // functions
  57   DEF_CLASS (InfoBase);
  58
  59   InfoBase (info_base *infobase)
  60     : f_infobase (infobase),
  61       f_search_info(NULL)
  62     { display_flag (0); }
  63
  64   // NOTE: hide LEND here !
  65
  66   const char *desc() const      { return f_infobase->get_base_desc() ; }
  67   const char *path() const      { return f_infobase->get_base_path() ; }
  68   const char *name() const      { return f_infobase->get_base_name() ; }
  69
  70
  71   // NOTE: need to get rid of const casts (needs lend support?)
  72   const char *display_as()
  73     { return ((const char *) f_infobase->get_base_desc()); }
  74
  75   const char *id()
  76     { return ((const char *) f_infobase->get_base_name()); }
  77
  78   InfobaseEntry *search_info() const
  79   { return f_search_info ; }
  80
  81   InfobaseEntry *search_info(InfobaseEntry* info);
  82
  83   bool has_children_internal();
  84
  85 protected: // functions
  86   void create_children();
  87   void display();
  88
  89 protected: // variables
  90   info_base     *f_infobase;
  91   InfobaseEntry *f_search_info ; // storage freed elsewhere (SearchEngine)
  92 };
  93
  94 inline InfobaseEntry *
  95 InfoBase::search_info(InfobaseEntry * info)
  96 {
  97     assert(f_search_info == NULL); // debugging only, no error handline reqd - jbm
  98     f_search_info = info ;
  99     return info;
 100 }
 101