1 ###################################################
2 # Samba3 client generator for IDL structures
3 # on top of Samba4 style NDR functions
4 # Copyright jelmer@samba.org 2005-2006
5 # released under the GNU GPL
7 package Parse::Pidl::Samba3::ClientNDR;
11 @EXPORT_OK = qw(GenerateFunctionInEnv ParseFunction $res $res_hdr);
14 use Parse::Pidl qw(fatal warning);
15 use Parse::Pidl::Typelist qw(hasType getType mapTypeName scalar_is_reference);
16 use Parse::Pidl::Util qw(has_property is_constant ParseExpr);
17 use Parse::Pidl::NDR qw(GetPrevLevel GetNextLevel ContainsDeferred);
18 use Parse::Pidl::Samba4 qw(DeclLong);
19 use Parse::Pidl::Samba4::NDR::Parser qw(GenerateFunctionInEnv);
21 use vars qw($VERSION);
24 sub indent($) { my ($self) = @_; $self->{tabs}.="\t"; }
25 sub deindent($) { my ($self) = @_; $self->{tabs} = substr($self->{tabs}, 1); }
26 sub pidl($$) { my ($self,$txt) = @_; $self->{res} .= "$self->{tabs}$txt\n"; }
27 sub pidl_hdr($$) { my ($self, $txt) = @_; $self->{res_hdr} .= "$txt\n"; }
28 sub fn_declare($$) { my ($self,$n) = @_; $self->pidl($n); $self->pidl_hdr("$n;"); }
33 my $self = { res => "", res_hdr => "", tabs => "" };
37 sub ParseFunction($$$)
39 my ($self, $uif, $fn) = @_;
43 my $ufn = "DCERPC_".uc($fn->{NAME});
45 foreach (@{$fn->{ELEMENTS}}) {
46 $defargs .= ", " . DeclLong($_);
48 $self->fn_declare("NTSTATUS rpccli_$fn->{NAME}(struct rpc_pipe_client *cli, TALLOC_CTX *mem_ctx$defargs)");
51 $self->pidl("struct $fn->{NAME} r;");
52 $self->pidl("NTSTATUS status;");
54 $self->pidl("/* In parameters */");
56 foreach (@{$fn->{ELEMENTS}}) {
57 if (grep(/in/, @{$_->{DIRECTION}})) {
58 $self->pidl("r.in.$_->{NAME} = $_->{NAME};");
63 $self->pidl("if (DEBUGLEVEL >= 10)");
64 $self->pidl("\tNDR_PRINT_IN_DEBUG($fn->{NAME}, &r);");
66 $self->pidl("status = cli_do_rpc_ndr(cli, mem_ctx, PI_$uif, $ufn, &r, (ndr_pull_flags_fn_t)ndr_pull_$fn->{NAME}, (ndr_push_flags_fn_t)ndr_push_$fn->{NAME});");
69 $self->pidl("if (!NT_STATUS_IS_OK(status)) {");
71 $self->pidl("return status;");
76 $self->pidl("if (DEBUGLEVEL >= 10)");
77 $self->pidl("\tNDR_PRINT_OUT_DEBUG($fn->{NAME}, &r);");
79 $self->pidl("if (NT_STATUS_IS_ERR(status)) {");
80 $self->pidl("\treturn status;");
83 $self->pidl("/* Return variables */");
84 foreach my $e (@{$fn->{ELEMENTS}}) {
85 next unless (grep(/out/, @{$e->{DIRECTION}}));
88 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");
90 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
92 if ($e->{LEVELS}[0]->{POINTER_TYPE} ne "ref") {
93 $self->pidl("if ( $e->{NAME} ) {");
98 if ($e->{LEVELS}[$level]->{TYPE} eq "ARRAY") {
99 # This is a call to GenerateFunctionInEnv intentionally.
100 # Since the data is being copied into a user-provided data
101 # structure, the user should be able to know the size beforehand
102 # to allocate a structure of the right size.
103 my $env = GenerateFunctionInEnv($fn, "r.");
104 my $size_is = ParseExpr($e->{LEVELS}[$level]->{SIZE_IS}, $env, $e->{ORIGINAL});
105 $self->pidl("memcpy($e->{NAME}, r.out.$e->{NAME}, $size_is);");
107 $self->pidl("*$e->{NAME} = *r.out.$e->{NAME};");
110 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
111 if ($e->{LEVELS}[0]->{POINTER_TYPE} ne "ref") {
119 $self->pidl("/* Return result */");
120 if (not $fn->{RETURN_TYPE}) {
121 $self->pidl("return NT_STATUS_OK;");
122 } elsif ($fn->{RETURN_TYPE} eq "NTSTATUS") {
123 $self->pidl("return r.out.result;");
124 } elsif ($fn->{RETURN_TYPE} eq "WERROR") {
125 $self->pidl("return werror_to_ntstatus(r.out.result);");
127 warning($fn->{ORIGINAL}, "Unable to convert $fn->{RETURN_TYPE} to NTSTATUS");
128 $self->pidl("return NT_STATUS_OK;");
136 sub ParseInterface($$)
138 my ($self, $if) = @_;
140 my $uif = uc($if->{NAME});
142 $self->pidl_hdr("#ifndef __CLI_$uif\__");
143 $self->pidl_hdr("#define __CLI_$uif\__");
144 $self->ParseFunction(uc($if->{NAME}), $_) foreach (@{$if->{FUNCTIONS}});
145 $self->pidl_hdr("#endif /* __CLI_$uif\__ */");
150 my($self,$ndr,$header,$ndr_header) = @_;
153 $self->pidl(" * Unix SMB/CIFS implementation.");
154 $self->pidl(" * client auto-generated by pidl. DO NOT MODIFY!");
157 $self->pidl("#include \"includes.h\"");
158 $self->pidl("#include \"$header\"");
159 $self->pidl_hdr("#include \"$ndr_header\"");
163 $self->ParseInterface($_) if ($_->{TYPE} eq "INTERFACE");
166 return ($self->{res}, $self->{res_hdr});