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
8 package Parse::Pidl::Samba3::ClientNDR;
12 @EXPORT_OK = qw(ParseFunction $res $res_hdr ParseOutputArgument);
15 use Parse::Pidl qw(fatal warning error);
16 use Parse::Pidl::Util qw(has_property ParseExpr);
17 use Parse::Pidl::Samba4 qw(DeclLong);
18 use Parse::Pidl::Samba4::Header qw(GenerateFunctionInEnv);
20 use vars qw($VERSION);
23 sub indent($) { my ($self) = @_; $self->{tabs}.="\t"; }
24 sub deindent($) { my ($self) = @_; $self->{tabs} = substr($self->{tabs}, 1); }
25 sub pidl($$) { my ($self,$txt) = @_; $self->{res} .= $txt ? "$self->{tabs}$txt\n" : "\n"; }
26 sub pidl_hdr($$) { my ($self, $txt) = @_; $self->{res_hdr} .= "$txt\n"; }
27 sub fn_declare($$) { my ($self,$n) = @_; $self->pidl($n); $self->pidl_hdr("$n;"); }
32 my $nt = int((length($s)+1)/8);
34 my $ns = (length($s)-$lt);
35 return "\t"x($nt)." "x($ns);
41 my $self = { res => "", res_hdr => "", tabs => "" };
45 sub ElementDirection($)
49 return "[in,out]" if (has_property($e, "in") and has_property($e, "out"));
50 return "[in]" if (has_property($e, "in"));
51 return "[out]" if (has_property($e, "out"));
55 sub HeaderProperties($$)
57 my($props,$ignores) = @_;
60 foreach my $d (keys %{$props}) {
61 next if (grep(/^$d$/, @$ignores));
62 if($props->{$d} ne "1") {
63 $ret.= "$d($props->{$d}),";
70 return "[" . substr($ret, 0, -1) . "]";
74 sub ParseOutputArgument($$$)
76 my ($self, $fn, $e) = @_;
79 if ($e->{LEVELS}[0]->{TYPE} ne "POINTER" and $e->{LEVELS}[0]->{TYPE} ne "ARRAY") {
80 $self->pidl("return NT_STATUS_NOT_SUPPORTED;");
81 error($e->{ORIGINAL}, "[out] argument is not a pointer or array");
85 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
87 if ($e->{LEVELS}[0]->{POINTER_TYPE} ne "ref") {
88 $self->pidl("if ($e->{NAME} && r.out.$e->{NAME}) {");
93 if ($e->{LEVELS}[$level]->{TYPE} eq "ARRAY") {
94 # This is a call to GenerateFunctionInEnv intentionally.
95 # Since the data is being copied into a user-provided data
96 # structure, the user should be able to know the size beforehand
97 # to allocate a structure of the right size.
98 my $env = GenerateFunctionInEnv($fn, "r.");
99 my $l = $e->{LEVELS}[$level];
100 unless (defined($l->{SIZE_IS})) {
101 error($e->{ORIGINAL}, "no size known for [out] array `$e->{NAME}'");
102 $self->pidl('#error No size known for [out] array `$e->{NAME}');
104 my $size_is = ParseExpr($l->{SIZE_IS}, $env, $e->{ORIGINAL});
105 if (has_property($e, "charset")) {
106 $self->pidl("memcpy(CONST_DISCARD(char *, $e->{NAME}), r.out.$e->{NAME}, $size_is * sizeof(*$e->{NAME}));");
108 $self->pidl("memcpy($e->{NAME}, r.out.$e->{NAME}, $size_is * sizeof(*$e->{NAME}));");
112 $self->pidl("*$e->{NAME} = *r.out.$e->{NAME};");
115 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
116 if ($e->{LEVELS}[0]->{POINTER_TYPE} ne "ref") {
123 sub ParseFunction($$$)
125 my ($self, $if, $fn) = @_;
129 my $ufn = "NDR_".uc($fn->{NAME});
130 my $fn_str = "NTSTATUS rpccli_$fn->{NAME}";
131 my $pad = genpad($fn_str);
133 $fn_args .= "struct rpc_pipe_client *cli,\n" . $pad . "TALLOC_CTX *mem_ctx";
135 foreach (@{$fn->{ELEMENTS}}) {
136 my $dir = ElementDirection($_);
137 my $prop = HeaderProperties($_->{PROPERTIES}, ["in", "out"]);
138 $fn_args .= ",\n" . $pad . DeclLong($_) . " /* $dir $prop */";
141 if (defined($fn->{RETURN_TYPE}) && ($fn->{RETURN_TYPE} eq "WERROR")) {
142 $fn_args .= ",\n" . $pad . "WERROR *werror";
145 $self->fn_declare("$fn_str($fn_args)");
148 $self->pidl("struct $fn->{NAME} r;");
149 $self->pidl("NTSTATUS status;");
151 $self->pidl("/* In parameters */");
153 foreach (@{$fn->{ELEMENTS}}) {
154 if (grep(/in/, @{$_->{DIRECTION}})) {
155 $self->pidl("r.in.$_->{NAME} = $_->{NAME};");
160 $self->pidl("if (DEBUGLEVEL >= 10) {");
162 $self->pidl("NDR_PRINT_IN_DEBUG($fn->{NAME}, &r);");
166 $self->pidl("status = cli->dispatch(cli,");
167 $self->pidl("\t\t\tmem_ctx,");
168 $self->pidl("\t\t\t&ndr_table_$if,");
169 $self->pidl("\t\t\t$ufn,");
170 $self->pidl("\t\t\t&r);");
173 $self->pidl("if (!NT_STATUS_IS_OK(status)) {");
175 $self->pidl("return status;");
180 $self->pidl("if (DEBUGLEVEL >= 10) {");
182 $self->pidl("NDR_PRINT_OUT_DEBUG($fn->{NAME}, &r);");
186 $self->pidl("if (NT_STATUS_IS_ERR(status)) {");
188 $self->pidl("return status;");
192 $self->pidl("/* Return variables */");
193 foreach my $e (@{$fn->{ELEMENTS}}) {
194 next unless (grep(/out/, @{$e->{DIRECTION}}));
196 $self->ParseOutputArgument($fn, $e);
201 $self->pidl("/* Return result */");
202 if (not $fn->{RETURN_TYPE}) {
203 $self->pidl("return NT_STATUS_OK;");
204 } elsif ($fn->{RETURN_TYPE} eq "NTSTATUS") {
205 $self->pidl("return r.out.result;");
206 } elsif ($fn->{RETURN_TYPE} eq "WERROR") {
207 $self->pidl("if (werror) {");
209 $self->pidl("*werror = r.out.result;");
213 $self->pidl("return werror_to_ntstatus(r.out.result);");
215 warning($fn->{ORIGINAL}, "Unable to convert $fn->{RETURN_TYPE} to NTSTATUS");
216 $self->pidl("return NT_STATUS_OK;");
224 sub ParseInterface($$)
226 my ($self, $if) = @_;
228 my $uif = uc($if->{NAME});
230 $self->pidl_hdr("#ifndef __CLI_$uif\__");
231 $self->pidl_hdr("#define __CLI_$uif\__");
232 foreach (@{$if->{FUNCTIONS}}) {
233 next if ($_->{PROPERTIES}{noopnum});
234 $self->ParseFunction($if->{NAME}, $_);
236 $self->pidl_hdr("#endif /* __CLI_$uif\__ */");
241 my($self,$ndr,$header,$ndr_header) = @_;
244 $self->pidl(" * Unix SMB/CIFS implementation.");
245 $self->pidl(" * client auto-generated by pidl. DO NOT MODIFY!");
248 $self->pidl("#include \"includes.h\"");
249 $self->pidl("#include \"$header\"");
250 $self->pidl_hdr("#include \"$ndr_header\"");
254 $self->ParseInterface($_) if ($_->{TYPE} eq "INTERFACE");
257 return ($self->{res}, $self->{res_hdr});