cde/programs/dtinfo/DtMmdb/dstr/dlist.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: dlist.h /main/4 1996/07/18 14:29:10 drk $
  25  *
  26  * Copyright (c) 1992 HaL Computer Systems, Inc.  All rights reserved.
  27  * UNPUBLISHED -- rights reserved under the Copyright Laws of the United
  28  * States.  Use of a copyright notice is precautionary only and does not
  29  * imply publication or disclosure.
  30  *
  31  * This software contains confidential information and trade secrets of HaL
  32  * Computer Systems, Inc.  Use, disclosure, or reproduction is prohibited
  33  * without the prior express written permission of HaL Computer Systems, Inc.
  34  *
  35  *                         RESTRICTED RIGHTS LEGEND
  36  * Use, duplication, or disclosure by the Government is subject to
  37  * restrictions as set forth in subparagraph (c)(l)(ii) of the Rights in
  38  * Technical Data and Computer Software clause at DFARS 252.227-7013.
  39  *                        HaL Computer Systems, Inc.
  40  *                  1315 Dell Avenue, Campbell, CA  95008
  41  *
  42  */
  43
  44
  45
  46 #ifndef _dlist_h
  47 #define _dlist_h 1
  48
  49 #include "utility/debug.h"
  50 #include "utility/types.h"
  51 #include "dstr/dlist_cell.h"
  52
  53 // doubly-linked list class
  54
  55 class dlist {
  56
  57 public:
  58    dlist(Boolean remove_cells = true);
  59    virtual ~dlist();
  60
  61 // append a dlist. x becomes part of this list. no copy
  62 // is performed. tail_list -> head and tail_list -> tail
  63 // are set to NULL.  Also, tail_list -> ct = 0.
  64    void append(dlist* tail_list);
  65
  66 // update functions
  67    void insert_before(dlist_cell* ref,  dlist_cell* x) ; //insert before ref
  68    void insert_after(dlist_cell* ref, dlist_cell* x) ; // insert after ref
  69    void insert_as_head(dlist_cell* x);  // insert x at head
  70    void insert_as_tail(dlist_cell* x);  // insert x at tail
  71
  72    void delete_cell(dlist_cell*) ;
  73    void remove() ; // remove all cells (call delete on each cell)
  74
  75 // empty the list without free cells
  76    void empty_list() { v_head = v_tail = 0; v_ct = 0;} ;
  77
  78 // status function
  79    int count() { return v_ct; }; // number of cells in the list
  80    dlist_cell* get_head() { return v_head; };
  81    dlist_cell* get_tail() { return v_tail; };
  82
  83    long first();   // 0 if the list is empty
  84    void next(long& index);
  85    long last();    // 0 if the list is empty
  86
  87 protected:
  88    int v_ct;            // cell in the list
  89    dlist_cell *v_head;  // head pointer
  90    dlist_cell *v_tail;  // tail pointer
  91    int remove_cells_when_done;
  92 };
  93
  94 typedef dlist *dlistPtr;
  95
  96 #endif