1 /* GNU Objective-C Typed Streams interface.
2 Copyright (C) 1993, 1995 Free Software Foundation, Inc.
4 This file is part of GNU CC.
6 GNU CC is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by the
8 Free Software Foundation; either version 2, or (at your option) any
11 GNU CC is distributed in the hope that it will be useful, but WITHOUT
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
14 License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU CC; see the file COPYING. If not, write to
18 the Free Software Foundation, 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
21 /* As a special exception, if you link this library with files compiled
22 with GCC to produce an executable, this does not cause the resulting
23 executable to be covered by the GNU General Public License. This
24 exception does not however invalidate any other reasons why the
25 executable file might be covered by the GNU General Public License. */
27 #ifndef __typedstream_INCLUDE_GNU
28 #define __typedstream_INCLUDE_GNU
30 #include "objc/objc.h"
31 #include "objc/hash.h"
34 typedef int (*objc_typed_read_func
)(void*, char*, int);
35 typedef int (*objc_typed_write_func
)(void*, const char*, int);
36 typedef int (*objc_typed_flush_func
)(void*);
37 typedef int (*objc_typed_eof_func
)(void*);
39 #define OBJC_READONLY 0x01
40 #define OBJC_WRITEONLY 0x02
42 #define OBJC_MANAGED_STREAM 0x01
43 #define OBJC_FILE_STREAM 0x02
44 #define OBJC_MEMORY_STREAM 0x04
46 #define OBJC_TYPED_STREAM_VERSION 0x01
48 typedef struct objc_typed_stream
{
50 cache_ptr object_table
; /* read/written objects */
51 cache_ptr stream_table
; /* other read/written but shared things.. */
52 cache_ptr class_table
; /* class version mapping */
53 cache_ptr object_refs
; /* forward references */
54 int mode
; /* OBJC_READONLY or OBJC_WRITEONLY */
55 int type
; /* MANAGED, FILE, MEMORY etc bit string */
56 int version
; /* version used when writing */
58 objc_typed_read_func read
;
59 objc_typed_write_func write
;
60 objc_typed_eof_func eof
;
61 objc_typed_flush_func flush
;
65 #define _B_VALUE 0x1fU
68 #define _B_NUMBER 0x0fU
70 /* standard opcodes */
71 #define _B_INVALID 0x00U
76 #define _B_RCOMM 0xa0U
77 #define _B_UCOMM 0xc0U
80 /* eXtension opcodes */
81 #define _BX_OBJECT 0x00U
82 #define _BX_CLASS 0x01U
84 #define _BX_OBJREF 0x03U
85 #define _BX_OBJROOT 0x04U
89 ** Read and write objects as specified by TYPE. All the `last'
90 ** arguments are pointers to the objects to read/write.
93 int objc_write_type (TypedStream
* stream
, const char* type
, const void* data
);
94 int objc_read_type (TypedStream
* stream
, const char* type
, void* data
);
96 int objc_write_types (TypedStream
* stream
, const char* type
, ...);
97 int objc_read_types (TypedStream
* stream
, const char* type
, ...);
99 int objc_write_object_reference (TypedStream
* stream
, id object
);
100 int objc_write_root_object (TypedStream
* stream
, id object
);
102 long objc_get_stream_class_version (TypedStream
* stream
, Class
class);
106 ** Convenience functions
109 int objc_write_array (TypedStream
* stream
, const char* type
,
110 int count
, const void* data
);
111 int objc_read_array (TypedStream
* stream
, const char* type
,
112 int count
, void* data
);
114 int objc_write_object (TypedStream
* stream
, id object
);
115 int objc_read_object (TypedStream
* stream
, id
* object
);
120 ** Open a typed stream for reading or writing. MODE may be either of
121 ** OBJC_READONLY or OBJC_WRITEONLY.
124 TypedStream
* objc_open_typed_stream (FILE* physical
, int mode
);
125 TypedStream
* objc_open_typed_stream_for_file (const char* file_name
, int mode
);
127 void objc_close_typed_stream (TypedStream
* stream
);
129 BOOL
objc_end_of_typed_stream (TypedStream
* stream
);
130 void objc_flush_typed_stream (TypedStream
* stream
);
132 #endif /* not __typedstream_INCLUDE_GNU */