Add GNU LGPL headers to all .c .C and .h files
[oweals/cde.git] / cde / programs / dtinfo / DtMmdb / storage / unixf_storage.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: unixf_storage.h /main/5 1996/07/18 14:56:35 drk $
25  *
26  * Copyright (c) 1993 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 _unixf_storage_h
52 #define _unixf_storage_h 1
53
54 #include <sys/types.h>
55 #include <sys/stat.h>
56
57 #include "utility/funcs.h"
58 #include "storage/lru.h"
59 #include "storage/abs_storage.h"
60
61 extern lru unixf_mgr;
62
63 //class unixf_storage : public rep_cell, public abs_storage, public fstream 
64 class unixf_storage : public abs_storage, public fstream 
65 {
66
67 protected:
68    int mode;
69    int total_bytes;
70    int _open(int mode);
71    Boolean v_file_exist;
72
73 public:
74 // mode: see ios::in etc. stuff in file iostream.h 
75    unixf_storage( char* file_path, 
76                   char* file_nm, 
77                   rep_policy*,
78                   int md = ios::in | ios::out 
79                 );
80    virtual ~unixf_storage() ;
81
82    virtual void remove() ;
83
84 // IO functions
85    int readString (mmdb_pos_t loc, char*, int len, int str_offset = 0);
86    int appendString(mmdb_pos_t loc, const char*, int len, Boolean flush_opt = false);
87    int updateString(mmdb_pos_t loc, const char* base, int len, int string_ofst = 0, Boolean flush = false);
88
89
90 // non-applicable funcs
91    int insertString(mmdb_pos_t& , const char* , int, Boolean = false)
92        { return -1; };
93    int get_str_ptr(mmdb_pos_t, char*&, int& ) 
94        { return -1; };
95
96    int deleteString (mmdb_pos_t, Boolean = false ) 
97        { return -1; };
98    int allocString (mmdb_pos_t& , int, char*&, int = 0)
99        { return -1; };
100    virtual int truncate(int target_length_in_bytes);
101
102    Boolean io_mode(int mode) ;
103    int bytes() ;
104
105    friend class storage_mgr_t;
106    friend class ld_dyn_hash;
107    friend class handler;
108 };
109
110 typedef unixf_storage* unixf_storagePtr;
111
112 #endif