1
###################################################
2
# create C header files for an IDL structure
3
# Copyright tridge@samba.org 2000
4
# Copyright jelmer@samba.org 2005
5
# released under the GNU GPL
7
package Parse::Pidl::Samba4::Header;
12
@EXPORT_OK = qw(GenerateFunctionInEnv GenerateFunctionOutEnv EnvSubstituteValue GenerateStructEnv);
15
use Parse::Pidl qw(fatal);
16
use Parse::Pidl::Typelist qw(mapTypeName scalar_is_reference);
17
use Parse::Pidl::Util qw(has_property is_constant unmake_str ParseExpr);
18
use Parse::Pidl::Samba4 qw(is_intree ElementStars ArrayBrackets choose_header);
20
use vars qw($VERSION);
26
sub pidl($) { $res .= shift; }
31
$res .="\t" foreach (1..$tab_depth);
35
#####################################################################
36
# parse a properties list
37
sub HeaderProperties($$)
39
my($props,$ignores) = @_;
42
foreach my $d (keys %{$props}) {
43
next if (grep(/^$d$/, @$ignores));
44
if($props->{$d} ne "1") {
45
$ret.= "$d($props->{$d}),";
52
pidl "/* [" . substr($ret, 0, -1) . "] */";
56
#####################################################################
57
# parse a structure element
63
if (has_property($element, "represent_as")) {
64
pidl mapTypeName($element->{PROPERTIES}->{represent_as})." ";
66
if (ref($element->{TYPE}) eq "HASH") {
67
HeaderType($element, $element->{TYPE}, $element->{TYPE}->{NAME});
69
HeaderType($element, $element->{TYPE}, "");
71
pidl " ".ElementStars($element);
73
pidl $element->{NAME};
74
pidl ArrayBrackets($element);
77
if (defined $element->{PROPERTIES}) {
78
HeaderProperties($element->{PROPERTIES}, ["in", "out"]);
83
#####################################################################
85
sub HeaderStruct($$;$)
87
my($struct,$name,$tail) = @_;
89
pidl $tail if defined($tail) and not defined($struct->{ELEMENTS});
90
return if (not defined($struct->{ELEMENTS}));
94
foreach (@{$struct->{ELEMENTS}}) {
99
# some compilers can't handle empty structures
100
pidl tabs()."char _empty_;\n";
104
if (defined $struct->{PROPERTIES}) {
105
HeaderProperties($struct->{PROPERTIES}, []);
107
pidl $tail if defined($tail);
110
#####################################################################
114
my($enum,$name,$tail) = @_;
118
if (defined($enum->{ELEMENTS})) {
119
pidl "\n#ifndef USE_UINT_ENUMS\n";
122
foreach my $e (@{$enum->{ELEMENTS}}) {
123
unless ($first) { pidl ",\n"; }
136
pidl " { __donnot_use_enum_$name=0x7FFFFFFF}\n";
137
foreach my $e (@{$enum->{ELEMENTS}}) {
141
if ($t =~ /(.*)=(.*)/) {
145
fatal($e->{ORIGINAL}, "you can't mix enum member with values and without values!")
146
unless ($without_val == 0);
151
fatal($e->{ORIGINAL}, "you can't mix enum member with values and without values!")
152
unless ($with_val == 0);
154
pidl "#define $name ( $value )\n";
158
pidl $tail if defined($tail);
161
#####################################################################
165
my($bitmap,$name) = @_;
167
return unless defined($bitmap->{ELEMENTS});
169
pidl "/* bitmap $name */\n";
170
pidl "#define $_\n" foreach (@{$bitmap->{ELEMENTS}});
174
#####################################################################
176
sub HeaderUnion($$;$)
178
my($union,$name,$tail) = @_;
182
pidl $tail if defined($tail) and not defined($union->{ELEMENTS});
183
return if (not defined($union->{ELEMENTS}));
186
foreach my $e (@{$union->{ELEMENTS}}) {
187
if ($e->{TYPE} ne "EMPTY") {
188
if (! defined $done{$e->{NAME}}) {
191
$done{$e->{NAME}} = 1;
197
if (defined $union->{PROPERTIES}) {
198
HeaderProperties($union->{PROPERTIES}, []);
200
pidl $tail if defined($tail);
203
#####################################################################
205
sub HeaderType($$$;$)
207
my($e,$data,$name,$tail) = @_;
208
if (ref($data) eq "HASH") {
209
($data->{TYPE} eq "ENUM") && HeaderEnum($data, $name, $tail);
210
($data->{TYPE} eq "BITMAP") && HeaderBitmap($data, $name);
211
($data->{TYPE} eq "STRUCT") && HeaderStruct($data, $name, $tail);
212
($data->{TYPE} eq "UNION") && HeaderUnion($data, $name, $tail);
216
if (has_property($e, "charset")) {
219
pidl mapTypeName($e->{TYPE});
221
pidl $tail if defined($tail);
224
#####################################################################
226
sub HeaderTypedef($;$)
228
my($typedef,$tail) = @_;
229
HeaderType($typedef, $typedef->{DATA}, $typedef->{NAME}, $tail) if defined ($typedef->{DATA});
232
#####################################################################
237
if (!defined($const->{ARRAY_LEN}[0])) {
238
pidl "#define $const->{NAME}\t( $const->{VALUE} )\n";
240
pidl "#define $const->{NAME}\t $const->{VALUE}\n";
244
sub ElementDirection($)
248
return "inout" if (has_property($e, "in") and has_property($e, "out"));
249
return "in" if (has_property($e, "in"));
250
return "out" if (has_property($e, "out"));
254
#####################################################################
256
sub HeaderFunctionInOut($$)
260
return unless defined($fn->{ELEMENTS});
262
foreach my $e (@{$fn->{ELEMENTS}}) {
263
HeaderElement($e) if (ElementDirection($e) eq $prop);
267
#####################################################################
268
# determine if we need an "in" or "out" section
269
sub HeaderFunctionInOut_needed($$)
273
return 1 if ($prop eq "out" && defined($fn->{RETURN_TYPE}));
275
return undef unless defined($fn->{ELEMENTS});
277
foreach my $e (@{$fn->{ELEMENTS}}) {
278
return 1 if (ElementDirection($e) eq $prop);
286
#####################################################################
288
sub HeaderFunction($)
292
return if ($headerstructs{$fn->{NAME}});
294
$headerstructs{$fn->{NAME}} = 1;
296
pidl "\nstruct $fn->{NAME} {\n";
300
if (HeaderFunctionInOut_needed($fn, "in") or
301
HeaderFunctionInOut_needed($fn, "inout")) {
302
pidl tabs()."struct {\n";
304
HeaderFunctionInOut($fn, "in");
305
HeaderFunctionInOut($fn, "inout");
307
pidl tabs()."} in;\n\n";
311
if (HeaderFunctionInOut_needed($fn, "out") or
312
HeaderFunctionInOut_needed($fn, "inout")) {
313
pidl tabs()."struct {\n";
315
HeaderFunctionInOut($fn, "out");
316
HeaderFunctionInOut($fn, "inout");
317
if (defined($fn->{RETURN_TYPE})) {
318
pidl tabs().mapTypeName($fn->{RETURN_TYPE}) . " result;\n";
321
pidl tabs()."} out;\n\n";
326
# sigh - some compilers don't like empty structures
327
pidl tabs()."int _dummy_element;\n";
337
foreach my $import (@imports) {
338
$import = unmake_str($import);
339
$import =~ s/\.idl$//;
340
pidl choose_header("librpc/gen_ndr/$import\.h", "gen_ndr/$import.h") . "\n";
347
foreach (@includes) {
348
pidl "#include $_\n";
352
#####################################################################
353
# parse the interface definitions
354
sub HeaderInterface($)
356
my($interface) = shift;
358
pidl "#ifndef _HEADER_$interface->{NAME}\n";
359
pidl "#define _HEADER_$interface->{NAME}\n\n";
361
foreach my $c (@{$interface->{CONSTS}}) {
365
foreach my $t (@{$interface->{TYPES}}) {
366
HeaderTypedef($t, ";\n\n") if ($t->{TYPE} eq "TYPEDEF");
367
HeaderStruct($t, $t->{NAME}, ";\n\n") if ($t->{TYPE} eq "STRUCT");
368
HeaderUnion($t, $t->{NAME}, ";\n\n") if ($t->{TYPE} eq "UNION");
369
HeaderEnum($t, $t->{NAME}, ";\n\n") if ($t->{TYPE} eq "ENUM");
370
HeaderBitmap($t, $t->{NAME}) if ($t->{TYPE} eq "BITMAP");
373
foreach my $fn (@{$interface->{FUNCTIONS}}) {
377
pidl "#endif /* _HEADER_$interface->{NAME} */\n";
384
pidl unmake_str($quote->{DATA}) . "\n";
387
#####################################################################
388
# parse a parsed IDL into a C header
396
pidl "/* header auto-generated by pidl */\n\n";
398
pidl "#include <util/data_blob.h>\n";
400
pidl "#include <stdint.h>\n";
404
($_->{TYPE} eq "CPP_QUOTE") && HeaderQuote($_);
405
($_->{TYPE} eq "INTERFACE") && HeaderInterface($_);
406
($_->{TYPE} eq "IMPORT") && HeaderImport(@{$_->{PATHS}});
407
($_->{TYPE} eq "INCLUDE") && HeaderInclude(@{$_->{PATHS}});
413
sub GenerateStructEnv($$)
418
foreach my $e (@{$x->{ELEMENTS}}) {
419
$env{$e->{NAME}} = "$v->$e->{NAME}";
427
sub EnvSubstituteValue($$)
431
# Substitute the value() values in the env
432
foreach my $e (@{$s->{ELEMENTS}}) {
433
next unless (defined(my $v = has_property($e, "value")));
435
$env->{$e->{NAME}} = ParseExpr($v, $env, $e);
441
sub GenerateFunctionInEnv($;$)
443
my ($fn, $base) = @_;
446
$base = "r->" unless defined($base);
448
foreach my $e (@{$fn->{ELEMENTS}}) {
449
if (grep (/in/, @{$e->{DIRECTION}})) {
450
$env{$e->{NAME}} = $base."in.$e->{NAME}";
457
sub GenerateFunctionOutEnv($;$)
459
my ($fn, $base) = @_;
462
$base = "r->" unless defined($base);
464
foreach my $e (@{$fn->{ELEMENTS}}) {
465
if (grep (/out/, @{$e->{DIRECTION}})) {
466
$env{$e->{NAME}} = $base."out.$e->{NAME}";
467
} elsif (grep (/in/, @{$e->{DIRECTION}})) {
468
$env{$e->{NAME}} = $base."in.$e->{NAME}";