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} .= $txt ? "$self->{tabs}$txt\n" : "\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, $if, $fn) = @_;
44 my $ufn = "NDR_".uc($fn->{NAME});
46 foreach (@{$fn->{ELEMENTS}}) {
47 $defargs .= ", " . DeclLong($_);
50 if (defined($fn->{RETURN_TYPE}) && ($fn->{RETURN_TYPE} eq "WERROR")) {
51 $defargs .= ", WERROR *werror";
54 $self->fn_declare("NTSTATUS rpccli_$fn->{NAME}(struct rpc_pipe_client *cli, TALLOC_CTX *mem_ctx$defargs)");
57 $self->pidl("struct $fn->{NAME} r;");
58 $self->pidl("NTSTATUS status;");
60 $self->pidl("/* In parameters */");
62 foreach (@{$fn->{ELEMENTS}}) {
63 if (grep(/in/, @{$_->{DIRECTION}})) {
64 $self->pidl("r.in.$_->{NAME} = $_->{NAME};");
69 $self->pidl("if (DEBUGLEVEL >= 10) {");
71 $self->pidl("NDR_PRINT_IN_DEBUG($fn->{NAME}, &r);");
75 $self->pidl("status = cli_do_rpc_ndr(cli, mem_ctx, PI_$uif, &ndr_table_$if, $ufn, &r);");
78 $self->pidl("if (!NT_STATUS_IS_OK(status)) {");
80 $self->pidl("return status;");
85 $self->pidl("if (DEBUGLEVEL >= 10) {");
87 $self->pidl("NDR_PRINT_OUT_DEBUG($fn->{NAME}, &r);");
91 $self->pidl("if (NT_STATUS_IS_ERR(status)) {");
93 $self->pidl("return status;");
97 $self->pidl("/* Return variables */");
98 foreach my $e (@{$fn->{ELEMENTS}}) {
99 next unless (grep(/out/, @{$e->{DIRECTION}}));
102 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");
104 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
106 if ($e->{LEVELS}[0]->{POINTER_TYPE} ne "ref") {
107 $self->pidl("if ($e->{NAME} && r.out.$e->{NAME}) {");
112 if ($e->{LEVELS}[$level]->{TYPE} eq "ARRAY") {
113 # This is a call to GenerateFunctionInEnv intentionally.
114 # Since the data is being copied into a user-provided data
115 # structure, the user should be able to know the size beforehand
116 # to allocate a structure of the right size.
117 my $env = GenerateFunctionInEnv($fn, "r.");
118 my $size_is = ParseExpr($e->{LEVELS}[$level]->{SIZE_IS}, $env, $e->{ORIGINAL});
119 $self->pidl("memcpy($e->{NAME}, r.out.$e->{NAME}, $size_is);");
121 $self->pidl("*$e->{NAME} = *r.out.$e->{NAME};");
124 if ($e->{LEVELS}[0]->{TYPE} eq "POINTER") {
125 if ($e->{LEVELS}[0]->{POINTER_TYPE} ne "ref") {
133 $self->pidl("/* Return result */");
134 if (not $fn->{RETURN_TYPE}) {
135 $self->pidl("return NT_STATUS_OK;");
136 } elsif ($fn->{RETURN_TYPE} eq "NTSTATUS") {
137 $self->pidl("return r.out.result;");
138 } elsif ($fn->{RETURN_TYPE} eq "WERROR") {
139 $self->pidl("if (werror) {");
141 $self->pidl("*werror = r.out.result;");
145 $self->pidl("return werror_to_ntstatus(r.out.result);");
147 warning($fn->{ORIGINAL}, "Unable to convert $fn->{RETURN_TYPE} to NTSTATUS");
148 $self->pidl("return NT_STATUS_OK;");
156 sub ParseInterface($$)
158 my ($self, $if) = @_;
160 my $uif = uc($if->{NAME});
162 $self->pidl_hdr("#ifndef __CLI_$uif\__");
163 $self->pidl_hdr("#define __CLI_$uif\__");
164 $self->ParseFunction($if->{NAME}, $_) foreach (@{$if->{FUNCTIONS}});
165 $self->pidl_hdr("#endif /* __CLI_$uif\__ */");
170 my($self,$ndr,$header,$ndr_header) = @_;
173 $self->pidl(" * Unix SMB/CIFS implementation.");
174 $self->pidl(" * client auto-generated by pidl. DO NOT MODIFY!");
177 $self->pidl("#include \"includes.h\"");
178 $self->pidl("#include \"$header\"");
179 $self->pidl_hdr("#include \"$ndr_header\"");
183 $self->ParseInterface($_) if ($_->{TYPE} eq "INTERFACE");
186 return ($self->{res}, $self->{res_hdr});