cde/programs/dtinfo/DtMmdb/object/compressed_pstring.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: compressed_pstring.h /main/4 1996/06/11 17:23:49 cde-hal $
  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 _compressed_pstring_h
  52 #define _compressed_pstring_h 1
  53
  54 #include "object/pstring.h"
  55 #include "compression/abs_agent.h"
  56
  57 /***************************************
  58 * compressed string class.
  59 ****************************************/
  60
  61 class compressed_pstring: public pstring
  62 {
  63
  64 protected:
  65
  66 #ifdef C_API
  67    static buffer* v_cp_io_buf_ptr;
  68    static buffer* working_buffer_ptr;
  69 #else
  70    static buffer v_cp_io_buf;
  71    static buffer working_buffer;
  72 #endif
  73
  74    oid_t compress_agent_id;
  75
  76    compress_agent_handler* agent;
  77
  78    unsigned int v_uncompressed_sz;
  79
  80 protected:
  81    void _compress();
  82
  83 public:
  84    compressed_pstring(c_code_t = COMPRESSED_STRING_CODE);
  85    virtual ~compressed_pstring();
  86
  87 // get uncompresed version
  88 #ifdef C_API
  89    char* get(buffer& optional_buffer = *v_cp_io_buf_ptr);
  90 #else
  91    char* get(buffer& optional_buffer = v_cp_io_buf);
  92 #endif
  93
  94    int size() const; // get uncompressed data size
  95
  96    MMDB_SIGNATURES(compressed_pstring);
  97
  98 // asciiIn function
  99    virtual io_status _asciiIn(istream&) ; // read in string part
 100    virtual io_status _asciiIn(const char* buf, int size) ;
 101
 102    virtual io_status asciiIn(istream&) ;  // read in compress agent id and then
 103    virtual io_status asciiIn(const char* buf, int size, const oid_t&) ;
 104    virtual io_status asciiIn(const char* buf, int size) ;
 105
 106 // compacted disk representation In and Out functions
 107    virtual int cdr_sizeof();
 108    virtual io_status cdrOut(buffer&);
 109    virtual io_status cdrIn(buffer&);
 110
 111    friend class compressed_pstring_handler;
 112
 113 #ifdef C_API
 114    friend void initialize_MMDB();
 115    friend void quit_MMDB();
 116 #endif
 117
 118 private:
 119
 120 };
 121
 122 HANDLER_SIGNATURES(compressed_pstring)
 123
 124 #endif