86b8951026c92aeaff8cb816ff943a025d8ea738
[ira/wip.git] / source / pidl / lib / Parse / Pidl / Samba3 / ClientNDR.pm
1 ###################################################
2 # Samba3 client generator for IDL structures
3 # on top of Samba4 style NDR functions
4 # Copyright jelmer@samba.org 2005-2006
5 # Copyright gd@samba.org 2008
6 # released under the GNU GPL
7
8 package Parse::Pidl::Samba3::ClientNDR;
9
10 use Exporter;
11 @ISA = qw(Exporter);
12 @EXPORT_OK = qw(ParseFunction $res $res_hdr);
13
14 use strict;
15 use Parse::Pidl qw(fatal warning);
16 use Parse::Pidl::Typelist qw(hasType getType mapTypeName scalar_is_reference);
17 use Parse::Pidl::Util qw(has_property is_constant ParseExpr);
18 use Parse::Pidl::NDR qw(GetPrevLevel GetNextLevel ContainsDeferred);
19 use Parse::Pidl::Samba4 qw(DeclLong);
20 use Parse::Pidl::Samba4::Header qw(GenerateFunctionInEnv);
21
22 use vars qw($VERSION);
23 $VERSION = '0.01';
24
25 sub indent($) { my ($self) = @_; $self->{tabs}.="\t"; }
26 sub deindent($) { my ($self) = @_; $self->{tabs} = substr($self->{tabs}, 1); }
27 sub pidl($$) { my ($self,$txt) = @_; $self->{res} .= $txt ? "$self->{tabs}$txt\n" : "\n"; }
28 sub pidl_hdr($$) { my ($self, $txt) = @_; $self->{res_hdr} .= "$txt\n"; } 
29 sub fn_declare($$) { my ($self,$n) = @_; $self->pidl($n); $self->pidl_hdr("$n;"); }
30
31 sub genpad($)
32 {
33         my ($s) = @_;
34         my $nt = int((length($s)+1)/8);
35         my $lt = ($nt*8)-1;
36         my $ns = (length($s)-$lt);
37         return "\t"x($nt)." "x($ns);
38 }
39
40 sub new($)
41 {
42         my ($class) = shift;
43         my $self = { res => "", res_hdr => "", tabs => "" };
44         bless($self, $class);
45 }
46
47 sub ParseFunction($$$)
48 {
49         my ($self, $if, $fn) = @_;
50
51         my $fn_args = "";
52         my $uif = uc($if);
53         my $ufn = "NDR_".uc($fn->{NAME});
54         my $fn_str = "NTSTATUS rpccli_$fn->{NAME}";
55         my $pad = genpad($fn_str);
56
57         $fn_args .= "struct rpc_pipe_client *cli,\n" . $pad . "TALLOC_CTX *mem_ctx";
58
59         foreach (@{$fn->{ELEMENTS}}) {
60                 $fn_args .= ",\n" . $pad . DeclLong($_);
61         }
62
63         if (defined($fn->{RETURN_TYPE}) && ($fn->{RETURN_TYPE} eq "WERROR")) {
64                 $fn_args .= ",\n" . $pad . "WERROR *werror";
65         }
66
67         $self->fn_declare("$fn_str($fn_args)");
68         $self->pidl("{");
69         $self->indent;
70         $self->pidl("struct $fn->{NAME} r;");
71         $self->pidl("NTSTATUS status;");
72         $self->pidl("");
73         $self->pidl("/* In parameters */");
74
75         foreach (@{$fn->{ELEMENTS}}) {
76                 if (grep(/in/, @{$_->{DIRECTION}})) {
77                         $self->pidl("r.in.$_->{NAME} = $_->{NAME};");
78                 }
79         }
80
81         $self->pidl("");
82         $self->pidl("if (DEBUGLEVEL >= 10) {");
83         $self->indent;
84         $self->pidl("NDR_PRINT_IN_DEBUG($fn->{NAME}, &r);");
85         $self->deindent;
86         $self->pidl("}");
87         $self->pidl("");
88         $self->pidl("status = cli_do_rpc_ndr(cli,");
89         $self->pidl("\t\t\tmem_ctx,");
90         $self->pidl("\t\t\tPI_$uif,");
91         $self->pidl("\t\t\t&ndr_table_$if,");
92         $self->pidl("\t\t\t$ufn,");
93         $self->pidl("\t\t\t&r);");
94         $self->pidl("");
95
96         $self->pidl("if (!NT_STATUS_IS_OK(status)) {");
97         $self->indent;
98         $self->pidl("return status;");
99         $self->deindent;
100         $self->pidl("}");
101
102         $self->pidl("");
103         $self->pidl("if (DEBUGLEVEL >= 10) {");
104         $self->indent;
105         $self->pidl("NDR_PRINT_OUT_DEBUG($fn->{NAME}, &r);");
106         $self->deindent;
107         $self->pidl("}");
108         $self->pidl("");
109         $self->pidl("if (NT_STATUS_IS_ERR(status)) {");
110         $self->indent;
111         $self->pidl("return status;");
112         $self->deindent;
113         $self->pidl("}");
114         $self->pidl("");
115         $self->pidl("/* Return variables */");
116         foreach my $e (@{$fn->{ELEMENTS}}) {
117                 next unless (grep(/out/, @{$e->{DIRECTION}}));
118                 my $level = 0;
119
120                 fatal($e->{ORIGINAL}, "[out] argument is not a pointer or array") if ($e->{LEVELS}[0]->{TYPE} ne "POINTER" and $e->{LEVELS}[0]->{TYPE} ne "ARRAY");
121
122                 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
123                         $level = 1;
124                         if ($e->{LEVELS}[0]->{POINTER_TYPE} ne "ref") {
125                                 $self->pidl("if ($e->{NAME} && r.out.$e->{NAME}) {");
126                                 $self->indent;
127                         }
128                 }
129
130                 if ($e->{LEVELS}[$level]->{TYPE} eq "ARRAY") {
131                         # This is a call to GenerateFunctionInEnv intentionally. 
132                         # Since the data is being copied into a user-provided data 
133                         # structure, the user should be able to know the size beforehand 
134                         # to allocate a structure of the right size.
135                         my $env = GenerateFunctionInEnv($fn, "r.");
136                         my $size_is = ParseExpr($e->{LEVELS}[$level]->{SIZE_IS}, $env, $e->{ORIGINAL});
137                         $self->pidl("memcpy($e->{NAME}, r.out.$e->{NAME}, $size_is);");
138                 } else {
139                         $self->pidl("*$e->{NAME} = *r.out.$e->{NAME};");
140                 }
141
142                 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
143                         if ($e->{LEVELS}[0]->{POINTER_TYPE} ne "ref") {
144                                 $self->deindent;
145                                 $self->pidl("}");
146                         }
147                 }
148         }
149
150         $self->pidl("");
151         $self->pidl("/* Return result */");
152         if (not $fn->{RETURN_TYPE}) {
153                 $self->pidl("return NT_STATUS_OK;");
154         } elsif ($fn->{RETURN_TYPE} eq "NTSTATUS") {
155                 $self->pidl("return r.out.result;");
156         } elsif ($fn->{RETURN_TYPE} eq "WERROR") {
157                 $self->pidl("if (werror) {");
158                 $self->indent;
159                 $self->pidl("*werror = r.out.result;");
160                 $self->deindent;
161                 $self->pidl("}");
162                 $self->pidl("");
163                 $self->pidl("return werror_to_ntstatus(r.out.result);");
164         } else {
165                 warning($fn->{ORIGINAL}, "Unable to convert $fn->{RETURN_TYPE} to NTSTATUS");
166                 $self->pidl("return NT_STATUS_OK;");
167         }
168
169         $self->deindent;
170         $self->pidl("}");
171         $self->pidl("");
172 }
173
174 sub ParseInterface($$)
175 {
176         my ($self, $if) = @_;
177
178         my $uif = uc($if->{NAME});
179
180         $self->pidl_hdr("#ifndef __CLI_$uif\__");
181         $self->pidl_hdr("#define __CLI_$uif\__");
182         $self->ParseFunction($if->{NAME}, $_) foreach (@{$if->{FUNCTIONS}});
183         $self->pidl_hdr("#endif /* __CLI_$uif\__ */");
184 }
185
186 sub Parse($$$$)
187 {
188         my($self,$ndr,$header,$ndr_header) = @_;
189
190         $self->pidl("/*");
191         $self->pidl(" * Unix SMB/CIFS implementation.");
192         $self->pidl(" * client auto-generated by pidl. DO NOT MODIFY!");
193         $self->pidl(" */");
194         $self->pidl("");
195         $self->pidl("#include \"includes.h\"");
196         $self->pidl("#include \"$header\"");
197         $self->pidl_hdr("#include \"$ndr_header\"");
198         $self->pidl("");
199         
200         foreach (@$ndr) {
201                 $self->ParseInterface($_) if ($_->{TYPE} eq "INTERFACE");
202         }
203
204         return ($self->{res}, $self->{res_hdr});
205 }
206
207 1;