summaryrefslogtreecommitdiff
path: root/TAO/tao/marshal.h
blob: 045019bc6f801da3e250dff6e29e234720138d7f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
// This may look like C, but it's really -*- C++ -*-

// ============================================================================
//
// = LIBRARY
//    TAO
// 
// = FILENAME
//    marshal.h
//
// = DESCRIPTION
//     Classes that marshal various IDL data types.
//
// = AUTHOR
//     Aniruddha S. Gokhale
// 
// ============================================================================

#if !defined (TAO_MARSHAL_H)
#define TAO_MARSHAL_H

#include "ace/OS.h"
#include "ace/Synch.h"
#include "ace/Singleton.h"

#include "tao/typecode.h"
#include "tao/object.h"  // CORBA_Object::_duplicate() needed by inline method
#include "tao/principa.h"

CORBA_TypeCode::traverse_status
DEEP_COPY (CORBA_TypeCode_ptr  param,
	   const void *source,
	   const void *dest,
	   CORBA_Environment &env);

CORBA_TypeCode::traverse_status
DEEP_FREE (CORBA_TypeCode_ptr  param,
	   const void *source,
	   const void *dest,
	   CORBA_Environment &env);

// = Forward declarations.
class TAO_Marshal_Object;
class TAO_Marshal_Primitive;
class TAO_Marshal_Any;
class TAO_Marshal_TypeCode;
class TAO_Marshal_Principal;
class TAO_Marshal_ObjRef;
class TAO_Marshal_Struct;
class TAO_Marshal_Union;
class TAO_Marshal_String;
class TAO_Marshal_Sequence;
class TAO_Marshal_Array;
class TAO_Marshal_Alias;
class TAO_Marshal_Except;
class TAO_Marshal_WString;

class TAO_Marshal_Factory
{
  // = TITLE
  // A Factory for generating specialized marshaling objects
  //
  // = DESCRIPTION
public:
  TAO_Marshal_Factory (void);
  // constructor

  virtual ~TAO_Marshal_Factory (void);
  // destructor

  virtual TAO_Marshal_Object *make_marshal_object (CORBA_TypeCode_ptr tc,
						  CORBA_Environment &env);
  // Factory method that returns the appropriate marshal object.

private:
  struct TAO_Marshal_Object_Entry
  {
    TAO_Marshal_Object *obj_;  
  };

  TAO_Marshal_Object_Entry mobj_table_[TC_KIND_COUNT];
  // A table of specialized marshal objects indexed by the _kind
  // field.

#if 0
  // define data members that are instances of various Marshal_Object classes
  TAO_Marshal_Primitive *m_primitive_;
  TAO_Marshal_Any       *m_any_;
  TAO_Marshal_TypeCode  *m_typecode_;
  TAO_Marshal_Principal *m_principal_;
  TAO_Marshal_ObjRef    *m_objref_;
  TAO_Marshal_Struct    *m_struct_;
  TAO_Marshal_Union     *m_union_;
  TAO_Marshal_String    *m_string_;
  TAO_Marshal_Sequence  *m_sequence_;
  TAO_Marshal_Array     *m_array_;
  TAO_Marshal_Alias     *m_alias_;
  TAO_Marshal_Except    *m_except_;
  TAO_Marshal_WString   *m_wstring_;
#endif /* 0 */
};

// Create a type for the singleton factory
typedef ACE_Singleton<TAO_Marshal_Factory, ACE_SYNCH_MUTEX> 
	TAO_MARSHAL_FACTORY;

class TAO_Marshal
// = TITLE
//    Namespace in which to put otherwise "global" methods like
//    initialize, etc.
{
public:
  static void initialize (void);

  static TAO_Marshal_Factory* DEFAULT_MARSHAL_FACTORY;
};

class TAO_Marshal_Object
{
  // = TITLE
  //    The Marshaling object that provides a common interface to the
  //    CDR object for marshaling different IDL data types
  //
  // = DESCRIPTION
  //    Provides a set of virtual methods for encoding, decoding,
  //    deep_copying, and deep_freeing.
public:
  // = Encoding and decoding operations.

  virtual CORBA_TypeCode::traverse_status encode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *,
                                                  void *context,
                                                  CORBA_Environment &env) = 0;
  // Encoding operation.

  virtual CORBA_TypeCode::traverse_status decode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *parent_typecode,
                                                  void *context,
                                                  CORBA_Environment &env) = 0;
  // Decoding operation.

  TAO_Marshal_Object (void);
  // constructor

  virtual ~TAO_Marshal_Object (void);
  // destructor
};

class TAO_Marshal_Primitive: public TAO_Marshal_Object
{
  // @@ Andy, please fill in here and add comments to this class.
  // = TITLE
  // = DESCRIPTION
public:
  TAO_Marshal_Primitive (void);

  virtual ~TAO_Marshal_Primitive (void);

  virtual CORBA_TypeCode::traverse_status encode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *,
                                                  void *context,
                                                  CORBA_Environment &env);
  virtual CORBA_TypeCode::traverse_status decode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *parent_typecode,
                                                  void *context,
                                                  CORBA_Environment &env);
  static CORBA_TypeCode::traverse_status deep_copy (CORBA_TypeCode_ptr tc,
                                                  const void *source,
                                                  const void *dest,
                                                  CORBA_Environment &env);
  static CORBA_TypeCode::traverse_status deep_free (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *,
                                                  CORBA_Environment &env);
};

// Create a type for the singleton
typedef ACE_Singleton<TAO_Marshal_Primitive, ACE_SYNCH_MUTEX>
	TAO_MARSHAL_PRIMITIVE;

class TAO_Marshal_Any: public TAO_Marshal_Object
{
  // = TITLE
  // = DESCRIPTION
public:
  TAO_Marshal_Any (void);

  virtual ~TAO_Marshal_Any (void);

  virtual CORBA_TypeCode::traverse_status encode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *,
                                                  void *context,
                                                  CORBA_Environment &env);
  virtual CORBA_TypeCode::traverse_status decode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *parent_typecode,
                                                  void *context,
                                                  CORBA_Environment &env);
  static CORBA_TypeCode::traverse_status deep_copy (CORBA_TypeCode_ptr tc,
                                                  const void *source,
                                                  const void *dest,
                                                  CORBA_Environment &env);
  static CORBA_TypeCode::traverse_status deep_free (CORBA_TypeCode_ptr tc,
                                                  const void *source,
                                                  const void *,
                                                  CORBA_Environment &env);
};

// Create a type for the singleton
typedef ACE_Singleton<TAO_Marshal_Any, ACE_SYNCH_MUTEX> 
	TAO_MARSHAL_ANY;

class TAO_Marshal_TypeCode: public TAO_Marshal_Object
{
  // = TITLE
  // = DESCRIPTION
public:
  TAO_Marshal_TypeCode (void);

  virtual ~TAO_Marshal_TypeCode (void);

  virtual CORBA_TypeCode::traverse_status encode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *,
                                                  void *context,
                                                  CORBA_Environment &env);
  virtual CORBA_TypeCode::traverse_status decode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *parent_typecode,
                                                  void *context,
                                                  CORBA_Environment &env);
  static CORBA_TypeCode::traverse_status deep_copy (CORBA_TypeCode_ptr tc,
                                                  const void *source,
                                                  const void *dest,
                                                  CORBA_Environment &env);
  static CORBA_TypeCode::traverse_status deep_free (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *,
                                                  CORBA_Environment &env);
};

// Create a type for the singleton
typedef ACE_Singleton<TAO_Marshal_TypeCode, ACE_SYNCH_MUTEX> 
	TAO_MARSHAL_TYPECODE;

class TAO_Marshal_Principal: public TAO_Marshal_Object
{
  // = TITLE
  // = DESCRIPTION
public:
  TAO_Marshal_Principal (void);

  virtual ~TAO_Marshal_Principal (void);

  virtual CORBA_TypeCode::traverse_status encode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *,
                                                  void *context,
                                                  CORBA_Environment &env);
  virtual CORBA_TypeCode::traverse_status decode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *parent_typecode,
                                                  void *context,
                                                  CORBA_Environment &env);
  static CORBA_TypeCode::traverse_status deep_copy (CORBA_TypeCode_ptr tc,
                                                  const void *source,
                                                  const void *dest,
                                                  CORBA_Environment &env);
  static CORBA_TypeCode::traverse_status deep_free (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *,
                                                  CORBA_Environment &env);
};

// Create a type for the singleton
typedef ACE_Singleton<TAO_Marshal_Principal, ACE_SYNCH_MUTEX> 
	TAO_MARSHAL_PRINCIPAL;

class TAO_Marshal_ObjRef: public TAO_Marshal_Object
{
  // = TITLE
  // = DESCRIPTION
public:
  TAO_Marshal_ObjRef (void);

  virtual ~TAO_Marshal_ObjRef (void);

  virtual CORBA_TypeCode::traverse_status encode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *,
                                                  void *context,
                                                  CORBA_Environment &env);
  virtual CORBA_TypeCode::traverse_status decode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *parent_typecode,
                                                  void *context,
                                                  CORBA_Environment &env);
  static CORBA_TypeCode::traverse_status deep_copy (CORBA_TypeCode_ptr tc,
                                                  const void *source,
                                                  const void *dest,
                                                  CORBA_Environment &env);
  static CORBA_TypeCode::traverse_status deep_free (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *,
                                                  CORBA_Environment &env);
};

// Create a type for the singleton
typedef ACE_Singleton<TAO_Marshal_ObjRef, ACE_SYNCH_MUTEX> 
	TAO_MARSHAL_OBJREF;

class TAO_Marshal_Struct: public TAO_Marshal_Object
{
  // = TITLE
  // = DESCRIPTION
public:
  TAO_Marshal_Struct (void);

  virtual ~TAO_Marshal_Struct (void);

  virtual CORBA_TypeCode::traverse_status encode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *,
                                                  void *context,
                                                  CORBA_Environment &env);
  virtual CORBA_TypeCode::traverse_status decode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *parent_typecode,
                                                  void *context,
                                                  CORBA_Environment &env);
  static CORBA_TypeCode::traverse_status deep_copy (CORBA_TypeCode_ptr tc,
                                                  const void *source,
                                                  const void *dest,
                                                  CORBA_Environment &env);
  static CORBA_TypeCode::traverse_status deep_free (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *,
                                                  CORBA_Environment &env);
};

// Create a type for the singleton
typedef ACE_Singleton<TAO_Marshal_Struct, ACE_SYNCH_MUTEX> 
	TAO_MARSHAL_STRUCT;

class TAO_Marshal_Union: public TAO_Marshal_Object
{
  // = TITLE
  // = DESCRIPTION
public:
  TAO_Marshal_Union (void);

  virtual ~TAO_Marshal_Union (void);

  virtual CORBA_TypeCode::traverse_status encode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *,
                                                  void *context,
                                                  CORBA_Environment &env);
  virtual CORBA_TypeCode::traverse_status decode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *parent_typecode,
                                                  void *context,
                                                  CORBA_Environment &env);
  static CORBA_TypeCode::traverse_status deep_copy (CORBA_TypeCode_ptr tc,
                                                  const void *source,
                                                  const void *dest,
                                                  CORBA_Environment &env);
  static CORBA_TypeCode::traverse_status deep_free (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *,
                                                  CORBA_Environment &env);
};

// Create a type for the singleton
typedef ACE_Singleton<TAO_Marshal_Union, ACE_SYNCH_MUTEX>
	TAO_MARSHAL_UNION;

class TAO_Marshal_String: public TAO_Marshal_Object
{
  // = TITLE
  // = DESCRIPTION
public:
  TAO_Marshal_String (void);

  virtual ~TAO_Marshal_String (void);

  virtual CORBA_TypeCode::traverse_status encode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *,
                                                  void *context,
                                                  CORBA_Environment &env);
  virtual CORBA_TypeCode::traverse_status decode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *parent_typecode,
                                                  void *context,
                                                  CORBA_Environment &env);
  static CORBA_TypeCode::traverse_status deep_copy (CORBA_TypeCode_ptr tc,
                                                  const void *source,
                                                  const void *dest,
                                                  CORBA_Environment &env);
  static CORBA_TypeCode::traverse_status deep_free (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *,
                                                  CORBA_Environment &env);
};

// Create a type for the singleton
typedef ACE_Singleton<TAO_Marshal_String, ACE_SYNCH_MUTEX> 
	TAO_MARSHAL_STRING;

class TAO_Marshal_Sequence: public TAO_Marshal_Object
{
  // = TITLE
  // = DESCRIPTION
public:
  TAO_Marshal_Sequence (void);

  virtual ~TAO_Marshal_Sequence (void);

  virtual CORBA_TypeCode::traverse_status encode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *,
                                                  void *context,
                                                  CORBA_Environment &env);
  virtual CORBA_TypeCode::traverse_status decode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *parent_typecode,
                                                  void *context,
                                                  CORBA_Environment &env);
  static CORBA_TypeCode::traverse_status deep_copy (CORBA_TypeCode_ptr tc,
                                                  const void *source,
                                                  const void *dest,
                                                  CORBA_Environment &env);
  static CORBA_TypeCode::traverse_status deep_free (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *,
                                                  CORBA_Environment &env);
};

// Create a type for the singleton
typedef ACE_Singleton<TAO_Marshal_Sequence, ACE_SYNCH_MUTEX> 
	TAO_MARSHAL_SEQUENCE;

class TAO_Marshal_Array: public TAO_Marshal_Object
{
  // = TITLE
  // = DESCRIPTION
public:
  TAO_Marshal_Array (void);

  virtual ~TAO_Marshal_Array (void);

  virtual CORBA_TypeCode::traverse_status encode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *,
                                                  void *context,
                                                  CORBA_Environment &env);
  virtual CORBA_TypeCode::traverse_status decode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *parent_typecode,
                                                  void *context,
                                                  CORBA_Environment &env);
  static CORBA_TypeCode::traverse_status deep_copy (CORBA_TypeCode_ptr tc,
                                                  const void *source,
                                                  const void *dest,
                                                  CORBA_Environment &env);
  static CORBA_TypeCode::traverse_status deep_free (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *,
                                                  CORBA_Environment &env);
};

// Create a type for the singleton
typedef ACE_Singleton<TAO_Marshal_Array, ACE_SYNCH_MUTEX> 
	TAO_MARSHAL_ARRAY;

class TAO_Marshal_Alias: public TAO_Marshal_Object
{
  // = TITLE
  // = DESCRIPTION
public:
  TAO_Marshal_Alias (void);

  virtual ~TAO_Marshal_Alias (void);

  virtual CORBA_TypeCode::traverse_status encode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *,
                                                  void *context,
                                                  CORBA_Environment &env);
  virtual CORBA_TypeCode::traverse_status decode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *parent_typecode,
                                                  void *context,
                                                  CORBA_Environment &env);
  static CORBA_TypeCode::traverse_status deep_copy (CORBA_TypeCode_ptr tc,
                                                  const void *source,
                                                  const void *dest,
                                                  CORBA_Environment &env);
  static CORBA_TypeCode::traverse_status deep_free (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *,
                                                  CORBA_Environment &env);
};

// Create a type for the singleton
typedef ACE_Singleton<TAO_Marshal_Alias, ACE_SYNCH_MUTEX> 
	TAO_MARSHAL_ALIAS;

class TAO_Marshal_Except: public TAO_Marshal_Object
{
  // = TITLE
  // = DESCRIPTION
public:
  TAO_Marshal_Except (void);
  ~TAO_Marshal_Except (void);

  virtual CORBA_TypeCode::traverse_status encode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *,
                                                  void *context,
                                                  CORBA_Environment &env);
  virtual CORBA_TypeCode::traverse_status decode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *parent_typecode,
                                                  void *context,
                                                  CORBA_Environment &env);
  static CORBA_TypeCode::traverse_status deep_copy (CORBA_TypeCode_ptr tc,
                                                  const void *source,
                                                  const void *dest,
                                                  CORBA_Environment &env);
  static CORBA_TypeCode::traverse_status deep_free (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *,
                                                  CORBA_Environment &env);
};

// Create a type for the singleton
typedef ACE_Singleton<TAO_Marshal_Except, ACE_SYNCH_MUTEX> 
	TAO_MARSHAL_EXCEPT;

class TAO_Marshal_WString : public TAO_Marshal_Object
{
  // = TITLE
  // = DESCRIPTION
public:
  TAO_Marshal_WString (void);
  ~TAO_Marshal_WString (void);

  virtual CORBA_TypeCode::traverse_status encode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *,
                                                  void *context,
                                                  CORBA_Environment &env);
  virtual CORBA_TypeCode::traverse_status decode (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *parent_typecode,
                                                  void *context,
                                                  CORBA_Environment &env);
  static CORBA_TypeCode::traverse_status deep_copy (CORBA_TypeCode_ptr tc,
                                                  const void *source,
                                                  const void *dest,
                                                  CORBA_Environment &env);
  static CORBA_TypeCode::traverse_status deep_free (CORBA_TypeCode_ptr tc,
                                                  const void *data,
                                                  const void *,
                                                  CORBA_Environment &env);
};

// Create a type for the singleton
typedef ACE_Singleton<TAO_Marshal_WString, ACE_SYNCH_MUTEX> 
	TAO_MARSHAL_WSTRING;

// In this case, we make a substantial exception to how inline files
// are included.  Normally, we would conditionally include the inline
// file iff __ACE_INLINE__ is defined.  But, in the original, highly
// optimized Sun IIOP code, much of what is in the inline file was
// here ready to be inlined at a moments notice and ALWAYS.  So, in
// this ONE file, we defer to David Brownell's considerable prowess at
// creating typecode interpreters as well as to the ACE convention of
// placing inline functions into separate files.
#  if !defined (__ACE_INLINE__)
#    undef ACE_INLINE
#    define ACE_INLINE inline
#    define do_undef_on_ACE_INLINE
#  endif /* __ACE_INLINE__ */
#  include "marshal.i"
#  if defined (do_undef_on_ACE_INLINE)
#    undef do_undef_on_ACE_INLINE
#    undef ACE_INLINE
#    define ACE_INLINE
#  endif /* do_undef_on_ACE_INLINE */

#endif /* TAO_MARSHAL_H */