1/*
2 * Copyright (c) 2010 Apple Inc. All rights reserved.
3 *
4 * @APPLE_LICENSE_HEADER_START@
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * 1.  Redistributions of source code must retain the above copyright
11 *     notice, this list of conditions and the following disclaimer.
12 * 2.  Redistributions in binary form must reproduce the above copyright
13 *     notice, this list of conditions and the following disclaimer in the
14 *     documentation and/or other materials provided with the distribution.
15 * 3.  Neither the name of Apple Inc. ("Apple") nor the names of its
16 *     contributors may be used to endorse or promote products derived from
17 *     this software without specific prior written permission.
18 *
19 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
20 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
23 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 *
30 * Portions of this software have been released under the following terms:
31 *
32 * (c) Copyright 1989-1993 OPEN SOFTWARE FOUNDATION, INC.
33 * (c) Copyright 1989-1993 HEWLETT-PACKARD COMPANY
34 * (c) Copyright 1989-1993 DIGITAL EQUIPMENT CORPORATION
35 *
36 * To anyone who acknowledges that this file is provided "AS IS"
37 * without any express or implied warranty:
38 * permission to use, copy, modify, and distribute this file for any
39 * purpose is hereby granted without fee, provided that the above
40 * copyright notices and this notice appears in all source code copies,
41 * and that none of the names of Open Software Foundation, Inc., Hewlett-
42 * Packard Company or Digital Equipment Corporation be used
43 * in advertising or publicity pertaining to distribution of the software
44 * without specific, written prior permission.  Neither Open Software
45 * Foundation, Inc., Hewlett-Packard Company nor Digital
46 * Equipment Corporation makes any representations about the suitability
47 * of this software for any purpose.
48 *
49 * Copyright (c) 2007, Novell, Inc. All rights reserved.
50 * Redistribution and use in source and binary forms, with or without
51 * modification, are permitted provided that the following conditions
52 * are met:
53 *
54 * 1.  Redistributions of source code must retain the above copyright
55 *     notice, this list of conditions and the following disclaimer.
56 * 2.  Redistributions in binary form must reproduce the above copyright
57 *     notice, this list of conditions and the following disclaimer in the
58 *     documentation and/or other materials provided with the distribution.
59 * 3.  Neither the name of Novell Inc. nor the names of its contributors
60 *     may be used to endorse or promote products derived from this
61 *     this software without specific prior written permission.
62 *
63 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
64 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
65 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
66 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY
67 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
68 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
69 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
70 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
71 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
72 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
73 *
74 * @APPLE_LICENSE_HEADER_END@
75 */
76
77/*
78**
79**  NAME:
80**
81**      clihandl.h
82**
83**  FACILITY:
84**
85**      IDL Compiler Backend
86**
87**  ABSTRACT:
88**
89**  Header file for clihandl.c
90**
91**  VERSION: DCE 1.0
92**
93*/
94#ifndef CLIHANDL_H
95#define CLIHANDL_H
96
97#include <commstat.h>
98
99typedef enum {
100    BE_parm_handle_t_k,    /* Operation has first parameter of type handle_t */
101    BE_parm_user_handle_k, /* Operation has first parm with [handle] attrib */
102    BE_context_handle_k,   /* Operation has an [in] context handle parameter */
103    BE_impl_handle_t_k,    /* No handle parm. Implicit handle_t handle */
104    BE_impl_user_handle_k, /* No handle parm. Implicit [handle] handle */
105    BE_auto_handle_k,      /* No handle parm. [auto_handle] interface */
106    BE_rep_as_handle_t_k,  /* First parm handle_t with [rep_as] passed by val */
107    BE_rep_as_handle_t_p_k /* First parm handle_t with [rep_as] passed by ref */
108} BE_handle_type_k_t;
109
110typedef struct {
111    BE_handle_type_k_t handle_type;  /* Type of handle for operation */
112    char const *assoc_name;       /* Ptr to name to be used for assoc handle */
113    char const *type_name;        /* Ptr to name of [handle] type */
114    char const *user_handle_name; /* Ptr to name of [handle] object */
115    char deref_assoc;         /* '*' if handle must be dereferenced, else ' ' */
116    char deref_generic;      /* '*' if handle must be dereferenced, else ' ' */
117    boolean auto_handle_idempotent_op;  /* Only used if op is [auto_handle]
118                                           TRUE if op is [idempotent] */
119    NAMETABLE_id_t rep_as_name; /* Name of handle_t param to which [rep_as]
120                                        is attached */
121    NAMETABLE_id_t rep_as_type; /* Type of handle param which has [rep_as] */
122} BE_handle_info_t;
123
124extern char assoc_handle_ptr[];
125
126void BE_setup_client_handle(
127    FILE *fid,
128    AST_interface_n_t *p_interface,
129    AST_operation_n_t *p_operation,
130    BE_handle_info_t *p_handle_info
131);
132
133void CSPELL_call_start(
134    FILE *fid,
135    BE_handle_info_t *p_handle_info,
136    AST_interface_n_t *p_interface,
137    AST_operation_n_t *p_operation,
138    unsigned long op_num,            /* Number of current operation */
139    BE_stat_info_t *p_comm_stat_info,
140    BE_stat_info_t *p_fault_stat_info
141);
142
143void CSPELL_auto_handle_statics
144(
145    FILE * fid
146);
147
148void CSPELL_restart_logic
149(
150    FILE * fid,
151    AST_operation_n_t *p_operation,
152    boolean uses_packet
153);
154
155void CSPELL_binding_free_if_needed
156(
157    FILE *fid,
158    BE_handle_info_t *p_handle_info
159);
160
161#endif
162