pidl: don't expect to have quote when creating import headers
[samba.git] / pidl / lib / Parse / Pidl / Wireshark / NDR.pm
1 ##################################################
2 # Wireshark NDR parser generator for IDL structures
3 # Copyright tridge@samba.org 2000-2003
4 # Copyright tpot@samba.org 2001,2005
5 # Copyright jelmer@samba.org 2004-2007
6 # Portions based on idl2eth.c by Ronnie Sahlberg
7 # released under the GNU GPL
8
9 =pod
10
11 =head1 NAME
12
13 Parse::Pidl::Wireshark::NDR - Parser generator for Wireshark
14
15 =cut
16
17 package Parse::Pidl::Wireshark::NDR;
18
19 use Exporter;
20 @ISA = qw(Exporter);
21 @EXPORT_OK = qw(field2name %res PrintIdl StripPrefixes RegisterInterfaceHandoff register_hf_field CheckUsed ProcessImport ProcessInclude find_type DumpEttList DumpEttDeclaration DumpHfList DumpHfDeclaration DumpFunctionTable register_type register_ett);
22
23 use strict;
24 use Parse::Pidl qw(error warning);
25 use Parse::Pidl::Typelist qw(getType);
26 use Parse::Pidl::Util qw(has_property property_matches make_str);
27 use Parse::Pidl::NDR qw(ContainsString GetNextLevel);
28 use Parse::Pidl::Dump qw(DumpType DumpFunction);
29 use Parse::Pidl::Wireshark::Conformance qw(ReadConformance);
30 use File::Basename;     
31
32 use vars qw($VERSION);
33 $VERSION = '0.01';
34
35 my %return_types = ();
36 my %dissector_used = ();
37
38 my %ptrtype_mappings = (
39         "unique" => "NDR_POINTER_UNIQUE",
40         "ref" => "NDR_POINTER_REF",
41         "ptr" => "NDR_POINTER_PTR"
42 );
43
44 sub StripPrefixes($$)
45 {
46         my ($s, $prefixes) = @_;
47
48         foreach (@$prefixes) {
49                 $s =~ s/^$_\_//g;
50         }
51
52         return $s;
53 }
54
55 # Convert a IDL structure field name (e.g access_mask) to a prettier
56 # string like 'Access Mask'.
57
58 sub field2name($)
59 {
60     my($field) = shift;
61
62     $field =~ s/_/ /g;          # Replace underscores with spaces
63     $field =~ s/(\w+)/\u\L$1/g; # Capitalise each word
64     
65     return $field;
66 }
67
68 sub new($)
69 {
70         my ($class) = @_;
71         my $self = {res => {hdr => "", def => "", code => ""}, tabs => "", cur_fn => undef,
72                 hf_used => {}, ett => [], conformance => undef
73
74         };
75         bless($self, $class);
76 }
77
78 sub pidl_fn_start($$)
79 {
80         my ($self, $fn) = @_;
81         $self->{cur_fn} = $fn;
82 }
83 sub pidl_fn_end($$)
84 {
85         my ($self, $fn) = @_;
86         die("Inconsistent state: $fn != $self->{cur_fn}") if ($fn ne $self->{cur_fn});
87         $self->{cur_fn} = undef;
88 }
89
90 sub pidl_code($$)
91 {
92         my ($self, $d) = @_;
93         return if (defined($self->{cur_fn}) and defined($self->{conformance}->{manual}->{$self->{cur_fn}}));
94  
95         if ($d) {
96                 $self->{res}->{code} .= $self->{tabs};
97                 $self->{res}->{code} .= $d;
98         }
99         $self->{res}->{code} .="\n";
100 }
101
102 sub pidl_hdr($$) { my ($self,$x) = @_; $self->{res}->{hdr} .= "$x\n"; }
103 sub pidl_def($$) { my ($self,$x) = @_; $self->{res}->{def} .= "$x\n"; }
104
105 sub indent($)
106 {
107         my ($self) = @_;
108         $self->{tabs} .= "\t";
109 }
110
111 sub deindent($)
112 {
113         my ($self) = @_;
114         $self->{tabs} = substr($self->{tabs}, 0, -1);
115 }
116
117 sub PrintIdl($$)
118 {
119         my ($self, $idl) = @_;
120
121         foreach (split /\n/, $idl) {
122                 $self->pidl_code("/* IDL: $_ */");
123         }
124
125         $self->pidl_code("");
126 }
127
128 #####################################################################
129 # parse the interface definitions
130 sub Interface($$)
131 {
132         my($self, $interface) = @_;
133         $self->Const($_,$interface->{NAME}) foreach (@{$interface->{CONSTS}});
134         $self->Type($_, $_->{NAME}, $interface->{NAME}) foreach (@{$interface->{TYPES}});
135         $self->Function($_,$interface->{NAME}) foreach (@{$interface->{FUNCTIONS}});
136 }
137
138 sub Enum($$$$)
139 {
140         my ($self, $e,$name,$ifname) = @_;
141         my $valsstring = "$ifname\_$name\_vals";
142         my $dissectorname = "$ifname\_dissect\_enum\_".StripPrefixes($name, $self->{conformance}->{strip_prefixes});
143
144         return if (defined($self->{conformance}->{noemit}->{StripPrefixes($name, $self->{conformance}->{strip_prefixes})}));
145
146         foreach (@{$e->{ELEMENTS}}) {
147                 if (/([^=]*)=(.*)/) {
148                         $self->pidl_hdr("#define $1 ($2)");
149                 }
150         }
151         
152         $self->pidl_hdr("extern const value_string $valsstring\[];");
153         $self->pidl_hdr("int $dissectorname(tvbuff_t *tvb _U_, int offset _U_, packet_info *pinfo _U_, proto_tree *tree _U_, guint8 *drep _U_, int hf_index _U_, guint32 *param _U_);");
154
155         $self->pidl_def("const value_string ".$valsstring."[] = {");
156         foreach (@{$e->{ELEMENTS}}) {
157                 next unless (/([^=]*)=(.*)/);
158                 $self->pidl_def("\t{ $1, \"$1\" },");
159         }
160
161         $self->pidl_def("{ 0, NULL }");
162         $self->pidl_def("};");
163
164         $self->pidl_fn_start($dissectorname);
165         $self->pidl_code("int");
166         $self->pidl_code("$dissectorname(tvbuff_t *tvb _U_, int offset _U_, packet_info *pinfo _U_, proto_tree *tree _U_, guint8 *drep _U_, int hf_index _U_, guint32 *param _U_)");
167         $self->pidl_code("{");
168         $self->indent;
169         $self->pidl_code("g$e->{BASE_TYPE} parameter=0;");
170         $self->pidl_code("if(param){");
171         $self->indent;
172         $self->pidl_code("parameter=(g$e->{BASE_TYPE})*param;");
173         $self->deindent;
174         $self->pidl_code("}");
175         $self->pidl_code("offset = dissect_ndr_$e->{BASE_TYPE}(tvb, offset, pinfo, tree, drep, hf_index, &parameter);");
176         $self->pidl_code("if(param){");
177         $self->indent;
178         $self->pidl_code("*param=(guint32)parameter;");
179         $self->deindent;
180         $self->pidl_code("}");
181         $self->pidl_code("return offset;");
182         $self->deindent;
183         $self->pidl_code("}\n");
184         $self->pidl_fn_end($dissectorname);
185
186         my $enum_size = $e->{BASE_TYPE};
187         $enum_size =~ s/uint//g;
188         $self->register_type($name, "offset = $dissectorname(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);", "FT_UINT$enum_size", "BASE_DEC", "0", "VALS($valsstring)", $enum_size / 8);
189 }
190
191 sub Bitmap($$$$)
192 {
193         my ($self,$e,$name,$ifname) = @_;
194         my $dissectorname = "$ifname\_dissect\_bitmap\_".StripPrefixes($name, $self->{conformance}->{strip_prefixes});
195
196         $self->register_ett("ett_$ifname\_$name");
197
198         $self->pidl_hdr("int $dissectorname(tvbuff_t *tvb _U_, int offset _U_, packet_info *pinfo _U_, proto_tree *tree _U_, guint8 *drep _U_, int hf_index _U_, guint32 param _U_);");
199
200         $self->pidl_fn_start($dissectorname);
201         $self->pidl_code("int");
202         $self->pidl_code("$dissectorname(tvbuff_t *tvb _U_, int offset _U_, packet_info *pinfo _U_, proto_tree *parent_tree _U_, guint8 *drep _U_, int hf_index _U_, guint32 param _U_)");
203         $self->pidl_code("{");
204         $self->indent;
205         $self->pidl_code("proto_item *item = NULL;");
206         $self->pidl_code("proto_tree *tree = NULL;");
207         $self->pidl_code("");
208                 
209         $self->pidl_code("g$e->{BASE_TYPE} flags;");
210         if ($e->{ALIGN} > 1) {
211                 $self->pidl_code("ALIGN_TO_$e->{ALIGN}_BYTES;");
212         }
213
214         $self->pidl_code("");
215
216         $self->pidl_code("if (parent_tree) {");
217         $self->indent;
218         $self->pidl_code("item = proto_tree_add_item(parent_tree, hf_index, tvb, offset, $e->{ALIGN}, TRUE);");
219         $self->pidl_code("tree = proto_item_add_subtree(item,ett_$ifname\_$name);");
220         $self->deindent;
221         $self->pidl_code("}\n");
222
223         $self->pidl_code("offset = dissect_ndr_$e->{BASE_TYPE}(tvb, offset, pinfo, NULL, drep, -1, &flags);");
224
225         $self->pidl_code("proto_item_append_text(item, \": \");\n");
226         $self->pidl_code("if (!flags)");
227         $self->pidl_code("\tproto_item_append_text(item, \"(No values set)\");\n");
228
229         foreach (@{$e->{ELEMENTS}}) {
230                 next unless (/([^ ]*) (.*)/);
231                 my ($en,$ev) = ($1,$2);
232                 my $hf_bitname = "hf_$ifname\_$name\_$en";
233                 my $filtername = "$ifname\.$name\.$en";
234
235                 $self->{hf_used}->{$hf_bitname} = 1;
236                 
237                 $self->register_hf_field($hf_bitname, field2name($en), $filtername, "FT_BOOLEAN", $e->{ALIGN} * 8, "TFS(&$name\_$en\_tfs)", $ev, "");
238
239                 $self->pidl_def("static const true_false_string $name\_$en\_tfs = {");
240                 if (defined($self->{conformance}->{tfs}->{$hf_bitname})) {
241                         $self->pidl_def("   $self->{conformance}->{tfs}->{$hf_bitname}->{TRUE_STRING},");
242                         $self->pidl_def("   $self->{conformance}->{tfs}->{$hf_bitname}->{FALSE_STRING},");
243                         $self->{conformance}->{tfs}->{$hf_bitname}->{USED} = 1;
244                 } else {
245                         $self->pidl_def("   \"$en is SET\",");
246                         $self->pidl_def("   \"$en is NOT SET\",");
247                 }
248                 $self->pidl_def("};");
249                 
250                 $self->pidl_code("proto_tree_add_boolean(tree, $hf_bitname, tvb, offset-$e->{ALIGN}, $e->{ALIGN}, flags);");
251                 $self->pidl_code("if (flags&$ev){");
252                 $self->pidl_code("\tproto_item_append_text(item, \"$en\");");
253                 $self->pidl_code("\tif (flags & (~$ev))");
254                 $self->pidl_code("\t\tproto_item_append_text(item, \", \");");
255                 $self->pidl_code("}");
256                 $self->pidl_code("flags&=(~$ev);");
257                 $self->pidl_code("");
258         }
259
260         $self->pidl_code("if (flags) {");
261         $self->pidl_code("\tproto_item_append_text(item, \"Unknown bitmap value 0x%x\", flags);");
262         $self->pidl_code("}\n");
263         $self->pidl_code("return offset;");
264         $self->deindent;
265         $self->pidl_code("}\n");
266         $self->pidl_fn_end($dissectorname);
267
268         my $size = $e->{BASE_TYPE};
269         $size =~ s/uint//g;
270         $self->register_type($name, "offset = $dissectorname(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);", "FT_UINT$size", "BASE_HEX", "0", "NULL", $size/8);
271 }
272
273 sub ElementLevel($$$$$$$)
274 {
275         my ($self,$e,$l,$hf,$myname,$pn,$ifname) = @_;
276
277         my $param = 0;
278
279         if (defined($self->{conformance}->{dissectorparams}->{$myname})) {
280                 $param = $self->{conformance}->{dissectorparams}->{$myname}->{PARAM};
281         }
282
283         if ($l->{TYPE} eq "POINTER") {
284                 my $type;
285                 if ($l->{LEVEL} eq "TOP") {
286                         $type = "toplevel";
287                 } elsif ($l->{LEVEL} eq "EMBEDDED") {
288                         $type = "embedded";
289                 }
290                 $self->pidl_code("offset = dissect_ndr_$type\_pointer(tvb, offset, pinfo, tree, drep, $myname\_, $ptrtype_mappings{$l->{POINTER_TYPE}}, \"Pointer to ".field2name(StripPrefixes($e->{NAME}, $self->{conformance}->{strip_prefixes})) . " ($e->{TYPE})\",$hf);");
291         } elsif ($l->{TYPE} eq "ARRAY") {
292                 if ($l->{IS_INLINE}) {
293                         error($e->{ORIGINAL}, "Inline arrays not supported");
294                 } elsif ($l->{IS_FIXED}) {
295                         $self->pidl_code("int i;");
296                         $self->pidl_code("for (i = 0; i < $l->{SIZE_IS}; i++)");
297                         $self->pidl_code("\toffset = $myname\_(tvb, offset, pinfo, tree, drep);");
298                 } else {
299                         my $type = "";
300                         $type .= "c" if ($l->{IS_CONFORMANT});
301                         $type .= "v" if ($l->{IS_VARYING});
302
303                         unless ($l->{IS_ZERO_TERMINATED}) {
304                                 $self->pidl_code("offset = dissect_ndr_u" . $type . "array(tvb, offset, pinfo, tree, drep, $myname\_);");
305                         } else {
306                                 my $nl = GetNextLevel($e,$l);
307                                 $self->pidl_code("char *data;");
308                                 $self->pidl_code("");
309                                 $self->pidl_code("offset = dissect_ndr_$type" . "string(tvb, offset, pinfo, tree, drep, sizeof(g$nl->{DATA_TYPE}), $hf, FALSE, &data);");
310                                 $self->pidl_code("proto_item_append_text(tree, \": %s\", data);");
311                         }
312                 }
313         } elsif ($l->{TYPE} eq "DATA") {
314                 if ($l->{DATA_TYPE} eq "string") {
315                         my $bs = 2; # Byte size defaults to that of UCS2
316
317
318                         ($bs = 1) if (property_matches($e, "flag", ".*LIBNDR_FLAG_STR_ASCII.*"));
319                         
320                         if (property_matches($e, "flag", ".*LIBNDR_FLAG_STR_SIZE4.*") and property_matches($e, "flag", ".*LIBNDR_FLAG_STR_LEN4.*")) {
321                                 $self->pidl_code("char *data;\n");
322                                 $self->pidl_code("offset = dissect_ndr_cvstring(tvb, offset, pinfo, tree, drep, $bs, $hf, FALSE, &data);");
323                                 $self->pidl_code("proto_item_append_text(tree, \": %s\", data);");
324                         } elsif (property_matches($e, "flag", ".*LIBNDR_FLAG_STR_SIZE4.*")) {
325                                 $self->pidl_code("offset = dissect_ndr_vstring(tvb, offset, pinfo, tree, drep, $bs, $hf, FALSE, NULL);");
326                         } else {
327                                 warn("Unable to handle string with flags $e->{PROPERTIES}->{flag}");
328                         }
329                 } else {
330                         my $call;
331
332                         if ($self->{conformance}->{imports}->{$l->{DATA_TYPE}}) {
333                                 $call = $self->{conformance}->{imports}->{$l->{DATA_TYPE}}->{DATA};     
334                                 $self->{conformance}->{imports}->{$l->{DATA_TYPE}}->{USED} = 1;
335                         } elsif (defined($self->{conformance}->{imports}->{"$pn.$e->{NAME}"})) {
336                                 $call = $self->{conformance}->{imports}->{"$pn.$e->{NAME}"}->{DATA};
337                                 $self->{conformance}->{imports}->{"$pn.$e->{NAME}"}->{USED} = 1;
338                             
339                         } elsif (defined($self->{conformance}->{types}->{$l->{DATA_TYPE}})) {
340                                 $call= $self->{conformance}->{types}->{$l->{DATA_TYPE}}->{DISSECTOR_NAME};
341                                 $self->{conformance}->{types}->{$l->{DATA_TYPE}}->{USED} = 1;
342                         } else {
343                                 $self->pidl_code("offset = $ifname\_dissect_struct_" . $l->{DATA_TYPE} . "(tvb,offset,pinfo,tree,drep,$hf,$param);");
344
345                                 return;
346                         }
347
348                         $call =~ s/\@HF\@/$hf/g;
349                         $call =~ s/\@PARAM\@/$param/g;
350                         $self->pidl_code($call);
351                 }
352         } elsif ($_->{TYPE} eq "SUBCONTEXT") {
353                 my $num_bits = ($l->{HEADER_SIZE}*8);
354                 $self->pidl_code("guint$num_bits size;");
355                 $self->pidl_code("int start_offset = offset;");
356                 $self->pidl_code("tvbuff_t *subtvb;");
357                 $self->pidl_code("offset = dissect_ndr_uint$num_bits(tvb, offset, pinfo, tree, drep, $hf, &size);");
358                 $self->pidl_code("proto_tree_add_text(tree, tvb, start_offset, offset - start_offset + size, \"Subcontext size\");");
359
360                 $self->pidl_code("subtvb = tvb_new_subset(tvb, offset, size, -1);");
361                 $self->pidl_code("$myname\_(subtvb, 0, pinfo, tree, drep);");
362         } else {
363                 die("Unknown type `$_->{TYPE}'");
364         }
365 }
366
367 sub Element($$$)
368 {
369         my ($self,$e,$pn,$ifname) = @_;
370
371         my $dissectorname = "$ifname\_dissect\_element\_".StripPrefixes($pn, $self->{conformance}->{strip_prefixes})."\_".StripPrefixes($e->{NAME}, $self->{conformance}->{strip_prefixes});
372
373         my $call_code = "offset = $dissectorname(tvb, offset, pinfo, tree, drep);";
374
375         my $type = $self->find_type($e->{TYPE});
376
377         if (not defined($type)) {
378                 # default settings
379                 $type = {
380                         MASK => 0,
381                         VALSSTRING => "NULL",
382                         FT_TYPE => "FT_NONE",
383                         BASE_TYPE => "BASE_NONE"
384                 };
385         }
386
387         if (ContainsString($e)) {
388                 $type = {
389                         MASK => 0,
390                         VALSSTRING => "NULL",
391                         FT_TYPE => "FT_STRING",
392                         BASE_TYPE => "BASE_NONE"
393                 };
394         }
395
396         my $hf = $self->register_hf_field("hf_$ifname\_$pn\_$e->{NAME}", field2name($e->{NAME}), "$ifname.$pn.$e->{NAME}", $type->{FT_TYPE}, $type->{BASE_TYPE}, $type->{VALSSTRING}, $type->{MASK}, "");
397         $self->{hf_used}->{$hf} = 1;
398
399         my $eltname = StripPrefixes($pn, $self->{conformance}->{strip_prefixes}) . ".$e->{NAME}";
400         if (defined($self->{conformance}->{noemit}->{$eltname})) {
401                 return $call_code;
402         }
403
404         my $add = "";
405
406         foreach (@{$e->{LEVELS}}) {
407                 next if ($_->{TYPE} eq "SWITCH");
408                 $self->pidl_def("static int $dissectorname$add(tvbuff_t *tvb _U_, int offset _U_, packet_info *pinfo _U_, proto_tree *tree _U_, guint8 *drep _U_);");
409                 $self->pidl_fn_start("$dissectorname$add");
410                 $self->pidl_code("static int");
411                 $self->pidl_code("$dissectorname$add(tvbuff_t *tvb _U_, int offset _U_, packet_info *pinfo _U_, proto_tree *tree _U_, guint8 *drep _U_)");
412                 $self->pidl_code("{");
413                 $self->indent;
414
415                 $self->ElementLevel($e,$_,$hf,$dissectorname.$add,$pn,$ifname);
416
417                 $self->pidl_code("");
418                 $self->pidl_code("return offset;");
419                 $self->deindent;
420                 $self->pidl_code("}\n");
421                 $self->pidl_fn_end("$dissectorname$add");
422                 $add.="_";
423                 last if ($_->{TYPE} eq "ARRAY" and $_->{IS_ZERO_TERMINATED});
424         }
425
426         return $call_code;
427 }
428
429 sub Function($$$)
430 {
431         my ($self, $fn,$ifname) = @_;
432
433         my %dissectornames;
434
435         foreach (@{$fn->{ELEMENTS}}) {
436             $dissectornames{$_->{NAME}} = $self->Element($_, $fn->{NAME}, $ifname) if not defined($dissectornames{$_->{NAME}});
437         }
438         
439         my $fn_name = $_->{NAME};
440         $fn_name =~ s/^${ifname}_//;
441
442         $self->PrintIdl(DumpFunction($fn->{ORIGINAL}));
443         $self->pidl_fn_start("$ifname\_dissect\_$fn_name\_response");
444         $self->pidl_code("static int");
445         $self->pidl_code("$ifname\_dissect\_${fn_name}_response(tvbuff_t *tvb _U_, int offset _U_, packet_info *pinfo _U_, proto_tree *tree _U_, guint8 *drep _U_)");
446         $self->pidl_code("{");
447         $self->indent;
448         if ( not defined($fn->{RETURN_TYPE})) {
449         } elsif ($fn->{RETURN_TYPE} eq "NTSTATUS" or $fn->{RETURN_TYPE} eq "WERROR") 
450         {
451                 $self->pidl_code("guint32 status;\n");
452         } elsif (my $type = getType($fn->{RETURN_TYPE})) {
453                 if ($type->{DATA}->{TYPE} eq "ENUM") {
454                         $self->pidl_code("g".Parse::Pidl::Typelist::enum_type_fn($type->{DATA}) . " status;\n");
455                 } elsif ($type->{DATA}->{TYPE} eq "SCALAR") {
456                         $self->pidl_code("g$fn->{RETURN_TYPE} status;\n");
457                 } else {
458                 error($fn, "return type `$fn->{RETURN_TYPE}' not yet supported");
459                 }
460         } else {
461                 error($fn, "unknown return type `$fn->{RETURN_TYPE}'");
462         }
463
464         $self->pidl_code("pinfo->dcerpc_procedure_name=\"${fn_name}\";");
465         foreach (@{$fn->{ELEMENTS}}) {
466                 if (grep(/out/,@{$_->{DIRECTION}})) {
467                         $self->pidl_code("$dissectornames{$_->{NAME}}");
468                         $self->pidl_code("offset = dissect_deferred_pointers(pinfo, tvb, offset, drep);");
469                         $self->pidl_code("");
470                 }
471         }
472
473         if (not defined($fn->{RETURN_TYPE})) {
474         } elsif ($fn->{RETURN_TYPE} eq "NTSTATUS") {
475                 $self->pidl_code("offset = dissect_ntstatus(tvb, offset, pinfo, tree, drep, hf\_$ifname\_status, &status);\n");
476                 $self->pidl_code("if (status != 0 && check_col(pinfo->cinfo, COL_INFO))");
477                 $self->pidl_code("\tcol_append_fstr(pinfo->cinfo, COL_INFO, \", Error: %s\", val_to_str(status, NT_errors, \"Unknown NT status 0x%08x\"));\n");
478                 $return_types{$ifname}->{"status"} = ["NTSTATUS", "NT Error"];
479         } elsif ($fn->{RETURN_TYPE} eq "WERROR") {
480                 $self->pidl_code("offset = dissect_ndr_uint32(tvb, offset, pinfo, tree, drep, hf\_$ifname\_werror, &status);\n");
481                 $self->pidl_code("if (status != 0 && check_col(pinfo->cinfo, COL_INFO))");
482                 $self->pidl_code("\tcol_append_fstr(pinfo->cinfo, COL_INFO, \", Error: %s\", val_to_str(status, WERR_errors, \"Unknown DOS error 0x%08x\"));\n");
483                 
484                 $return_types{$ifname}->{"werror"} = ["WERROR", "Windows Error"];
485         } elsif (my $type = getType($fn->{RETURN_TYPE})) {
486                 if ($type->{DATA}->{TYPE} eq "ENUM") {
487                         my $return_type = "g".Parse::Pidl::Typelist::enum_type_fn($type->{DATA});
488                         my $return_dissect = "dissect_ndr_" .Parse::Pidl::Typelist::enum_type_fn($type->{DATA});
489
490                         $self->pidl_code("offset = $return_dissect(tvb, offset, pinfo, tree, drep, hf\_$ifname\_$fn->{RETURN_TYPE}_status, &status);");
491                         $self->pidl_code("if (status != 0 && check_col(pinfo->cinfo, COL_INFO))");
492                         $self->pidl_code("\tcol_append_fstr(pinfo->cinfo, COL_INFO, \", Status: %s\", val_to_str(status, $ifname\_$fn->{RETURN_TYPE}\_vals, \"Unknown " . $fn->{RETURN_TYPE} . " error 0x%08x\"));\n");
493                         $return_types{$ifname}->{$fn->{RETURN_TYPE}."_status"} = [$fn->{RETURN_TYPE}, $fn->{RETURN_TYPE}];
494                 } elsif ($type->{DATA}->{TYPE} eq "SCALAR") {
495                         $self->pidl_code("offset = dissect_ndr_$fn->{RETURN_TYPE}(tvb, offset, pinfo, tree, drep, hf\_$ifname\_$fn->{RETURN_TYPE}_status, &status);");
496                         $self->pidl_code("if (status != 0 && check_col(pinfo->cinfo, COL_INFO))");
497                         $self->pidl_code("\tcol_append_fstr(pinfo->cinfo, COL_INFO, \", Status: %d\", status);\n");
498                         $return_types{$ifname}->{$fn->{RETURN_TYPE}."_status"} = [$fn->{RETURN_TYPE}, $fn->{RETURN_TYPE}];
499                 }
500         }
501
502         $self->pidl_code("return offset;");
503         $self->deindent;
504         $self->pidl_code("}\n");
505         $self->pidl_fn_end("$ifname\_dissect\_$fn_name\_response");
506
507         $self->pidl_fn_start("$ifname\_dissect\_$fn_name\_request");
508         $self->pidl_code("static int");
509         $self->pidl_code("$ifname\_dissect\_${fn_name}_request(tvbuff_t *tvb _U_, int offset _U_, packet_info *pinfo _U_, proto_tree *tree _U_, guint8 *drep _U_)");
510         $self->pidl_code("{");
511         $self->indent;
512         $self->pidl_code("pinfo->dcerpc_procedure_name=\"${fn_name}\";");
513         foreach (@{$fn->{ELEMENTS}}) {
514                 if (grep(/in/,@{$_->{DIRECTION}})) {
515                         $self->pidl_code("$dissectornames{$_->{NAME}}");
516                         $self->pidl_code("offset = dissect_deferred_pointers(pinfo, tvb, offset, drep);");
517                 }
518
519         }
520
521         $self->pidl_code("return offset;");
522         $self->deindent;
523         $self->pidl_code("}\n");
524         $self->pidl_fn_end("$ifname\_dissect\_$fn_name\_request");
525 }
526
527 sub Struct($$$$)
528 {
529         my ($self,$e,$name,$ifname) = @_;
530         my $dissectorname = "$ifname\_dissect\_struct\_".StripPrefixes($name, $self->{conformance}->{strip_prefixes});
531
532         return if (defined($self->{conformance}->{noemit}->{StripPrefixes($name, $self->{conformance}->{strip_prefixes})}));
533
534         $self->register_ett("ett_$ifname\_$name");
535
536         my $res = "";
537         ($res.="\t".$self->Element($_, $name, $ifname)."\n\n") foreach (@{$e->{ELEMENTS}});
538
539         $self->pidl_hdr("int $dissectorname(tvbuff_t *tvb _U_, int offset _U_, packet_info *pinfo _U_, proto_tree *parent_tree _U_, guint8 *drep _U_, int hf_index _U_, guint32 param _U_);");
540
541         $self->pidl_fn_start($dissectorname);
542         $self->pidl_code("int");
543         $self->pidl_code("$dissectorname(tvbuff_t *tvb _U_, int offset _U_, packet_info *pinfo _U_, proto_tree *parent_tree _U_, guint8 *drep _U_, int hf_index _U_, guint32 param _U_)");
544         $self->pidl_code("{");
545         $self->indent;
546         $self->pidl_code("proto_item *item = NULL;");
547         $self->pidl_code("proto_tree *tree = NULL;");
548         if ($e->{ALIGN} > 1) {
549                 $self->pidl_code("dcerpc_info *di = pinfo->private_data;");
550         }
551         $self->pidl_code("int old_offset;");
552         $self->pidl_code("");
553
554         if ($e->{ALIGN} > 1) {
555                 $self->pidl_code("ALIGN_TO_$e->{ALIGN}_BYTES;");
556         }
557         $self->pidl_code("");
558
559         $self->pidl_code("old_offset = offset;");
560         $self->pidl_code("");
561         $self->pidl_code("if (parent_tree) {");
562         $self->indent;
563         $self->pidl_code("item = proto_tree_add_item(parent_tree, hf_index, tvb, offset, -1, TRUE);");
564         $self->pidl_code("tree = proto_item_add_subtree(item, ett_$ifname\_$name);");
565         $self->deindent;
566         $self->pidl_code("}");
567
568         $self->pidl_code("\n$res");
569
570         $self->pidl_code("proto_item_set_len(item, offset-old_offset);\n");
571         if ($e->{ALIGN} > 1) {
572                 $self->pidl_code("");
573                 $self->pidl_code("if (di->call_data->flags & DCERPC_IS_NDR64) {");
574                 $self->indent;
575                 $self->pidl_code("ALIGN_TO_$e->{ALIGN}_BYTES;");
576                 $self->deindent;
577                 $self->pidl_code("}");
578         }
579         $self->pidl_code("");
580         $self->pidl_code("return offset;");
581         $self->deindent;
582         $self->pidl_code("}\n");
583         $self->pidl_fn_end($dissectorname);
584
585         $self->register_type($name, "offset = $dissectorname(tvb,offset,pinfo,tree,drep,\@HF\@,\@PARAM\@);", "FT_NONE", "BASE_NONE", 0, "NULL", 0);
586 }
587
588 sub Union($$$$)
589 {
590         my ($self,$e,$name,$ifname) = @_;
591
592         my $dissectorname = "$ifname\_dissect_".StripPrefixes($name, $self->{conformance}->{strip_prefixes});
593
594         return if (defined($self->{conformance}->{noemit}->{StripPrefixes($name, $self->{conformance}->{strip_prefixes})}));
595         
596         $self->register_ett("ett_$ifname\_$name");
597
598         my $res = "";
599         foreach (@{$e->{ELEMENTS}}) {
600                 $res.="\n\t\t$_->{CASE}:\n";
601                 if ($_->{TYPE} ne "EMPTY") {
602                         $res.="\t\t\t".$self->Element($_, $name, $ifname)."\n";
603                 }
604                 $res.="\t\tbreak;\n";
605         }
606
607         my $switch_type;
608         my $switch_dissect;
609         my $switch_dt = getType($e->{SWITCH_TYPE});
610         if ($switch_dt->{DATA}->{TYPE} eq "ENUM") {
611                 $switch_type = "g".Parse::Pidl::Typelist::enum_type_fn($switch_dt->{DATA});
612                 $switch_dissect = "dissect_ndr_" .Parse::Pidl::Typelist::enum_type_fn($switch_dt->{DATA});
613         } elsif ($switch_dt->{DATA}->{TYPE} eq "SCALAR") {
614                 $switch_type = "g$e->{SWITCH_TYPE}";
615                 $switch_dissect = "dissect_ndr_$e->{SWITCH_TYPE}";
616         }
617
618         $self->pidl_fn_start($dissectorname);
619         $self->pidl_code("static int");
620         $self->pidl_code("$dissectorname(tvbuff_t *tvb _U_, int offset _U_, packet_info *pinfo _U_, proto_tree *parent_tree _U_, guint8 *drep _U_, int hf_index _U_, guint32 param _U_)");
621         $self->pidl_code("{");
622         $self->indent;
623         $self->pidl_code("proto_item *item = NULL;");
624         $self->pidl_code("proto_tree *tree = NULL;");
625         $self->pidl_code("int old_offset;");
626         $self->pidl_code("$switch_type level;");
627         $self->pidl_code("");
628
629         $self->pidl_code("old_offset = offset;");
630         $self->pidl_code("if (parent_tree) {");
631         $self->indent;
632         $self->pidl_code("item = proto_tree_add_text(parent_tree, tvb, offset, -1, \"$name\");");
633         $self->pidl_code("tree = proto_item_add_subtree(item, ett_$ifname\_$name);");
634         $self->deindent;
635         $self->pidl_code("}");
636
637         $self->pidl_code("");
638
639         $self->pidl_code("offset = $switch_dissect(tvb, offset, pinfo, tree, drep, hf_index, &level);");
640
641         if ($e->{ALIGN} > 1) {
642                 $self->pidl_code("ALIGN_TO_$e->{ALIGN}_BYTES;");
643                 $self->pidl_code("");
644         }
645
646
647         $self->pidl_code("switch(level) {$res\t}");
648         $self->pidl_code("proto_item_set_len(item, offset-old_offset);\n");
649         $self->pidl_code("");
650
651         $self->pidl_code("return offset;");
652         $self->deindent;
653         $self->pidl_code("}");
654         $self->pidl_fn_end($dissectorname);
655
656         $self->register_type($name, "offset = $dissectorname(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);", "FT_NONE", "BASE_NONE", 0, "NULL", 0);
657 }
658
659 sub Const($$$)
660 {
661         my ($self,$const,$ifname) = @_;
662         
663         if (!defined($const->{ARRAY_LEN}[0])) {
664                 $self->pidl_hdr("#define $const->{NAME}\t( $const->{VALUE} )\n");
665         } else {
666                 $self->pidl_hdr("#define $const->{NAME}\t $const->{VALUE}\n");
667         }
668 }
669
670 sub Typedef($$$$)
671 {
672         my ($self,$e,$name,$ifname) = @_;
673
674         $self->Type($e->{DATA}, $name, $ifname);
675 }
676
677 sub Type($$$$)
678 {
679         my ($self, $e, $name, $ifname) = @_;
680
681         $self->PrintIdl(DumpType($e->{ORIGINAL}));
682
683         {
684                 ENUM => \&Enum,
685                 STRUCT => \&Struct,
686                 UNION => \&Union,
687                 BITMAP => \&Bitmap,
688                 TYPEDEF => \&Typedef
689         }->{$e->{TYPE}}->($self, $e, $name, $ifname);
690 }
691
692 sub RegisterInterface($$)
693 {
694         my ($self, $x) = @_;
695
696         $self->pidl_fn_start("proto_register_dcerpc_$x->{NAME}");
697         $self->pidl_code("void proto_register_dcerpc_$x->{NAME}(void)");
698         $self->pidl_code("{");
699         $self->indent;
700
701         $self->{res}->{code}.=$self->DumpHfList()."\n";
702         $self->{res}->{code}.="\n".DumpEttList($self->{ett})."\n";
703         
704         if (defined($x->{UUID})) {
705             # These can be changed to non-pidl_code names if the old dissectors
706             # in epan/dissctors are deleted.
707     
708             my $name = uc($x->{NAME}) . " (pidl)";
709             my $short_name = uc($x->{NAME});
710             my $filter_name = $x->{NAME};
711
712             if (has_property($x, "helpstring")) {
713                 $name = $x->{PROPERTIES}->{helpstring};
714             }
715
716             if (defined($self->{conformance}->{protocols}->{$x->{NAME}})) {
717                 $short_name = $self->{conformance}->{protocols}->{$x->{NAME}}->{SHORTNAME};
718                 $name = $self->{conformance}->{protocols}->{$x->{NAME}}->{LONGNAME};
719                 $filter_name = $self->{conformance}->{protocols}->{$x->{NAME}}->{FILTERNAME};
720             }
721
722             $self->pidl_code("proto_dcerpc_$x->{NAME} = proto_register_protocol(".make_str($name).", ".make_str($short_name).", ".make_str($filter_name).");");
723             
724             $self->pidl_code("proto_register_field_array(proto_dcerpc_$x->{NAME}, hf, array_length (hf));");
725             $self->pidl_code("proto_register_subtree_array(ett, array_length(ett));");
726         } else {
727             $self->pidl_code("proto_dcerpc = proto_get_id_by_filter_name(\"dcerpc\");");
728             $self->pidl_code("proto_register_field_array(proto_dcerpc, hf, array_length(hf));");
729             $self->pidl_code("proto_register_subtree_array(ett, array_length(ett));");
730         }
731             
732         $self->deindent;
733         $self->pidl_code("}\n");
734         $self->pidl_fn_end("proto_register_dcerpc_$x->{NAME}");
735 }
736
737 sub RegisterInterfaceHandoff($$)
738 {
739         my ($self,$x) = @_;
740
741         if (defined($x->{UUID})) {
742                 $self->pidl_fn_start("proto_reg_handoff_dcerpc_$x->{NAME}");
743             $self->pidl_code("void proto_reg_handoff_dcerpc_$x->{NAME}(void)");
744             $self->pidl_code("{");
745             $self->indent;
746             $self->pidl_code("dcerpc_init_uuid(proto_dcerpc_$x->{NAME}, ett_dcerpc_$x->{NAME},");
747             $self->pidl_code("\t&uuid_dcerpc_$x->{NAME}, ver_dcerpc_$x->{NAME},");
748             $self->pidl_code("\t$x->{NAME}_dissectors, hf_$x->{NAME}_opnum);");
749             $self->deindent;
750             $self->pidl_code("}");
751                 $self->pidl_fn_end("proto_reg_handoff_dcerpc_$x->{NAME}");
752
753                 $self->{hf_used}->{"hf_$x->{NAME}_opnum"} = 1;
754         }
755 }
756
757 sub ProcessInclude
758 {
759         my $self = shift;
760         my @includes = @_;
761         foreach (@includes) {
762                 $self->pidl_hdr("#include \"$_\"");
763         }
764         $self->pidl_hdr("");
765 }
766
767 sub ProcessImport
768 {
769         my $self = shift;
770         my @imports = @_;
771         foreach (@imports) {
772                 next if($_ eq "security");
773                 s/^\"//;
774                 s/\.idl"?$//;
775                 $self->pidl_hdr("#include \"packet-dcerpc-$_\.h\"");
776         }
777         $self->pidl_hdr("");
778 }
779
780 sub ProcessInterface($$)
781 {
782         my ($self, $x) = @_;
783
784         push(@{$self->{conformance}->{strip_prefixes}}, $x->{NAME});
785
786         my $define = "__PACKET_DCERPC_" . uc($_->{NAME}) . "_H";
787         $self->pidl_hdr("#ifndef $define");
788         $self->pidl_hdr("#define $define");
789         $self->pidl_hdr("");
790
791         $self->pidl_def("static gint proto_dcerpc_$x->{NAME} = -1;");
792         $self->register_ett("ett_dcerpc_$x->{NAME}");
793         $self->register_hf_field("hf_$x->{NAME}_opnum", "Operation", "$x->{NAME}.opnum", "FT_UINT16", "BASE_DEC", "NULL", 0, "");
794
795         if (defined($x->{UUID})) {
796                 my $if_uuid = $x->{UUID};
797
798             $self->pidl_def("/* Version information */\n\n");
799             
800             $self->pidl_def("static e_uuid_t uuid_dcerpc_$x->{NAME} = {");
801             $self->pidl_def("\t0x" . substr($if_uuid, 1, 8) 
802                 . ", 0x" . substr($if_uuid, 10, 4)
803             . ", 0x" . substr($if_uuid, 15, 4) . ",");
804             $self->pidl_def("\t{ 0x" . substr($if_uuid, 20, 2) 
805                 . ", 0x" . substr($if_uuid, 22, 2)
806             . ", 0x" . substr($if_uuid, 25, 2)
807             . ", 0x" . substr($if_uuid, 27, 2)
808             . ", 0x" . substr($if_uuid, 29, 2)
809             . ", 0x" . substr($if_uuid, 31, 2)
810             . ", 0x" . substr($if_uuid, 33, 2)
811             . ", 0x" . substr($if_uuid, 35, 2) . " }");
812             $self->pidl_def("};");
813         
814             my $maj = $x->{VERSION};
815             $maj =~ s/\.(.*)$//g;
816             $self->pidl_def("static guint16 ver_dcerpc_$x->{NAME} = $maj;");
817             $self->pidl_def("");
818         }
819
820         $return_types{$x->{NAME}} = {};
821
822         $self->Interface($x);
823
824         $self->pidl_code("\n".DumpFunctionTable($x));
825
826         foreach (keys %{$return_types{$x->{NAME}}}) {
827                 my ($type, $desc) = @{$return_types{$x->{NAME}}->{$_}};
828                 my $dt = $self->find_type($type);
829                 $dt or die("Unable to find information about return type `$type'");
830                 $self->register_hf_field("hf_$x->{NAME}_$_", $desc, "$x->{NAME}.$_", $dt->{FT_TYPE}, "BASE_HEX", $dt->{VALSSTRING}, 0, "");
831                 $self->{hf_used}->{"hf_$x->{NAME}_$_"} = 1;
832         }
833
834         $self->RegisterInterface($x);
835         $self->RegisterInterfaceHandoff($x);
836
837         $self->pidl_hdr("#endif /* $define */");
838 }
839
840 sub find_type($$)
841 {
842         my ($self, $n) = @_;
843
844         return $self->{conformance}->{types}->{$n};
845 }
846
847 sub register_type($$$$$$$$)
848 {
849         my ($self, $type,$call,$ft,$base,$mask,$vals,$length) = @_;
850
851         return if (defined($self->{conformance}->{types}->{$type}));
852
853         $self->{conformance}->{types}->{$type} = {
854                 NAME => $type,
855                 DISSECTOR_NAME => $call,
856                 FT_TYPE => $ft,
857                 BASE_TYPE => $base,
858                 MASK => $mask,
859                 VALSSTRING => $vals,
860                 ALIGNMENT => $length
861         };
862 }
863
864 # Loads the default types
865 sub Initialize($$)
866 {
867         my ($self, $cnf_file) = @_;
868
869         $self->{conformance} = {
870                 imports => {},
871                 header_fields=> {} 
872         };
873
874         ReadConformance($cnf_file, $self->{conformance}) or print STDERR "warning: No conformance file `$cnf_file'\n";
875         
876         foreach my $bytes (qw(1 2 4 8)) {
877                 my $bits = $bytes * 8;
878                 $self->register_type("uint$bits", "offset = PIDL_dissect_uint$bits(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);", "FT_UINT$bits", "BASE_DEC", 0, "NULL", $bytes);
879                 $self->register_type("int$bits", "offset = PIDL_dissect_uint$bits(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);", "FT_INT$bits", "BASE_DEC", 0, "NULL", $bytes);
880         }
881                 
882         $self->register_type("udlong", "offset = dissect_ndr_duint32(tvb, offset, pinfo, tree, drep, \@HF\@, NULL);", "FT_UINT64", "BASE_DEC", 0, "NULL", 4);
883         $self->register_type("bool8", "offset = PIDL_dissect_uint8(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);","FT_INT8", "BASE_DEC", 0, "NULL", 1);
884         $self->register_type("char", "offset = PIDL_dissect_uint8(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);","FT_INT8", "BASE_DEC", 0, "NULL", 1);
885         $self->register_type("long", "offset = PIDL_dissect_uint32(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);","FT_INT32", "BASE_DEC", 0, "NULL", 4);
886         $self->register_type("dlong", "offset = dissect_ndr_duint32(tvb, offset, pinfo, tree, drep, \@HF\@, NULL);","FT_INT64", "BASE_DEC", 0, "NULL", 8);
887         $self->register_type("GUID", "offset = dissect_ndr_uuid_t(tvb, offset, pinfo, tree, drep, \@HF\@, NULL);","FT_GUID", "BASE_NONE", 0, "NULL", 4);
888         $self->register_type("policy_handle", "offset = PIDL_dissect_policy_hnd(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);","FT_BYTES", "BASE_NONE", 0, "NULL", 4);
889         $self->register_type("NTTIME", "offset = dissect_ndr_nt_NTTIME(tvb, offset, pinfo, tree, drep, \@HF\@);","FT_ABSOLUTE_TIME", "ABSOLUTE_TIME_LOCAL", 0, "NULL", 4);
890         $self->register_type("NTTIME_hyper", "offset = dissect_ndr_nt_NTTIME(tvb, offset, pinfo, tree, drep, \@HF\@);","FT_ABSOLUTE_TIME", "ABSOLUTE_TIME_LOCAL", 0, "NULL", 4);
891         $self->register_type("time_t", "offset = dissect_ndr_time_t(tvb, offset, pinfo,tree, drep, \@HF\@, NULL);","FT_ABSOLUTE_TIME", "ABSOLUTE_TIME_LOCAL", 0, "NULL", 4);
892         $self->register_type("NTTIME_1sec", "offset = dissect_ndr_nt_NTTIME(tvb, offset, pinfo, tree, drep, \@HF\@);", "FT_ABSOLUTE_TIME", "ABSOLUTE_TIME_LOCAL", 0, "NULL", 4);
893         $self->register_type("SID", "
894                 dcerpc_info *di = (dcerpc_info *)pinfo->private_data;
895
896                 di->hf_index = \@HF\@;
897
898                 offset = dissect_ndr_nt_SID_with_options(tvb, offset, pinfo, tree, drep, param);
899         ","FT_STRING", "BASE_NONE", 0, "NULL", 4);
900         $self->register_type("WERROR", 
901                 "offset = PIDL_dissect_uint32(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);","FT_UINT32", "BASE_DEC", 0, "VALS(WERR_errors)", 4);
902         $self->register_type("NTSTATUS", 
903                 "offset = PIDL_dissect_uint32(tvb, offset, pinfo, tree, drep, \@HF\@, \@PARAM\@);","FT_UINT32", "BASE_DEC", 0, "VALS(NT_errors)", 4);
904
905 }
906
907 #####################################################################
908 # Generate Wireshark parser and header code
909 sub Parse($$$$$)
910 {
911         my($self,$ndr,$idl_file,$h_filename,$cnf_file) = @_;
912
913         $self->Initialize($cnf_file);
914
915         return (undef, undef) if defined($self->{conformance}->{noemit_dissector});
916
917         my $notice = 
918 "/* DO NOT EDIT
919         This filter was automatically generated
920         from $idl_file and $cnf_file.
921         
922         Pidl is a perl based IDL compiler for DCE/RPC idl files. 
923         It is maintained by the Samba team, not the Wireshark team.
924         Instructions on how to download and install Pidl can be 
925         found at http://wiki.wireshark.org/Pidl
926 */
927
928 ";
929
930         $self->pidl_hdr($notice);
931
932         $self->{res}->{headers} = "\n";
933         $self->{res}->{headers} .= "#ifdef HAVE_CONFIG_H\n";
934         $self->{res}->{headers} .= "#include \"config.h\"\n";
935         $self->{res}->{headers} .= "#endif\n\n";
936
937         $self->{res}->{headers} .= "#ifdef _MSC_VER\n";
938         $self->{res}->{headers} .= "#pragma warning(disable:4005)\n";
939         $self->{res}->{headers} .= "#pragma warning(disable:4013)\n";
940         $self->{res}->{headers} .= "#pragma warning(disable:4018)\n";
941         $self->{res}->{headers} .= "#pragma warning(disable:4101)\n";
942         $self->{res}->{headers} .= "#endif\n\n";
943
944         $self->{res}->{headers} .= "#include <glib.h>\n";
945         $self->{res}->{headers} .= "#include <string.h>\n";
946         $self->{res}->{headers} .= "#include <epan/packet.h>\n\n";
947
948         $self->{res}->{headers} .= "#include \"packet-dcerpc.h\"\n";
949         $self->{res}->{headers} .= "#include \"packet-dcerpc-nt.h\"\n";
950         $self->{res}->{headers} .= "#include \"packet-windows-common.h\"\n";
951
952         my $h_basename = basename($h_filename);
953
954         $self->{res}->{headers} .= "#include \"$h_basename\"\n";
955         $self->pidl_code("");
956
957         if (defined($self->{conformance}->{ett})) {
958                 register_ett($self,$_) foreach(@{$self->{conformance}->{ett}})
959         }
960
961         # Wireshark protocol registration
962
963         foreach (@$ndr) {
964                 $self->ProcessInterface($_) if ($_->{TYPE} eq "INTERFACE");
965                 $self->ProcessImport(@{$_->{PATHS}}) if ($_->{TYPE} eq "IMPORT");
966                 $self->ProcessInclude(@{$_->{PATHS}}) if ($_->{TYPE} eq "INCLUDE");
967         }
968
969         $self->{res}->{ett} = DumpEttDeclaration($self->{ett});
970         $self->{res}->{hf} = $self->DumpHfDeclaration();
971
972         my $parser = $notice;
973         $parser.= $self->{res}->{headers};
974         $parser.=$self->{res}->{ett};
975         $parser.=$self->{res}->{hf};
976         $parser.=$self->{res}->{def};
977         if (exists ($self->{conformance}->{override})) {
978                 $parser.=$self->{conformance}->{override};
979         }
980         $parser.=$self->{res}->{code};
981
982         my $header = "/* autogenerated by pidl */\n\n";
983         $header.=$self->{res}->{hdr};
984
985         $self->CheckUsed($self->{conformance});
986     
987         return ($parser,$header);
988 }
989
990 ###############################################################################
991 # ETT
992 ###############################################################################
993
994 sub register_ett($$)
995 {
996         my ($self, $name) = @_;
997
998         push (@{$self->{ett}}, $name);  
999 }
1000
1001 sub DumpEttList
1002 {
1003         my ($ett) = @_;
1004         my $res = "\tstatic gint *ett[] = {\n";
1005         foreach (@$ett) {
1006                 $res .= "\t\t&$_,\n";
1007         }
1008
1009         return "$res\t};\n";
1010 }
1011
1012 sub DumpEttDeclaration
1013 {
1014         my ($ett) = @_;
1015         my $res = "\n/* Ett declarations */\n";
1016         foreach (@$ett) {
1017                 $res .= "static gint $_ = -1;\n";
1018         }
1019
1020         return "$res\n";
1021 }
1022
1023 ###############################################################################
1024 # HF
1025 ###############################################################################
1026
1027 sub register_hf_field($$$$$$$$$) 
1028 {
1029         my ($self,$index,$name,$filter_name,$ft_type,$base_type,$valsstring,$mask,$blurb) = @_;
1030
1031         if (defined ($self->{conformance}->{hf_renames}->{$index})) {
1032                 $self->{conformance}->{hf_renames}->{$index}->{USED} = 1;
1033                 return $self->{conformance}->{hf_renames}->{$index}->{NEWNAME};
1034         }
1035
1036         $self->{conformance}->{header_fields}->{$index} = {
1037                 INDEX => $index,
1038                 NAME => $name,
1039                 FILTER => $filter_name,
1040                 FT_TYPE => $ft_type,
1041                 BASE_TYPE => $base_type,
1042                 VALSSTRING => $valsstring,
1043                 MASK => $mask,
1044                 BLURB => $blurb
1045         };
1046
1047         if ((not defined($blurb) or $blurb eq "") and 
1048                         defined($self->{conformance}->{fielddescription}->{$index})) {
1049                 $self->{conformance}->{header_fields}->{$index}->{BLURB} = 
1050                         $self->{conformance}->{fielddescription}->{$index}->{DESCRIPTION};
1051                 $self->{conformance}->{fielddescription}->{$index}->{USED} = 1;
1052         }
1053
1054         return $index;
1055 }
1056
1057 sub DumpHfDeclaration($)
1058 {
1059         my ($self) = @_;
1060         my $res = "";
1061
1062         $res = "\n/* Header field declarations */\n";
1063
1064         foreach (keys %{$self->{conformance}->{header_fields}}) 
1065         {
1066                 $res .= "static gint $_ = -1;\n";
1067         }
1068
1069         return "$res\n";
1070 }
1071
1072 sub make_str_or_null($)
1073 {
1074       my $str = shift;
1075       if (substr($str, 0, 1) eq "\"") {
1076               $str = substr($str, 1, length($str)-2);
1077       }
1078       $str =~ s/^\s*//;
1079       $str =~ s/\s*$//;
1080       if ($str eq "") {
1081               return "NULL";
1082       }
1083       return make_str($str);
1084 }
1085
1086 sub DumpHfList($)
1087 {
1088         my ($self) = @_;
1089         my $res = "\tstatic hf_register_info hf[] = {\n";
1090
1091         foreach (values %{$self->{conformance}->{header_fields}}) 
1092         {
1093                 $res .= "\t{ &$_->{INDEX}, 
1094           { ".make_str($_->{NAME}).", ".make_str($_->{FILTER}).", $_->{FT_TYPE}, $_->{BASE_TYPE}, $_->{VALSSTRING}, $_->{MASK}, ".make_str_or_null($_->{BLURB}).", HFILL }},
1095 ";
1096         }
1097
1098         return $res."\t};\n";
1099 }
1100
1101
1102 ###############################################################################
1103 # Function table
1104 ###############################################################################
1105
1106 sub DumpFunctionTable($)
1107 {
1108         my $if = shift;
1109
1110         my $res = "static dcerpc_sub_dissector $if->{NAME}\_dissectors[] = {\n";
1111         foreach (@{$if->{FUNCTIONS}}) {
1112                 my $fn_name = $_->{NAME};
1113                 $fn_name =~ s/^$if->{NAME}_//;
1114                 $res.= "\t{ $_->{OPNUM}, \"$fn_name\",\n";
1115                 $res.= "\t   $if->{NAME}_dissect_${fn_name}_request, $if->{NAME}_dissect_${fn_name}_response},\n";
1116         }
1117
1118         $res .= "\t{ 0, NULL, NULL, NULL }\n";
1119
1120         return "$res};\n";
1121 }
1122
1123 sub CheckUsed($$)
1124 {
1125         my ($self, $conformance) = @_;
1126         foreach (values %{$conformance->{header_fields}}) {
1127                 if (not defined($self->{hf_used}->{$_->{INDEX}})) {
1128                         warning($_->{POS}, "hf field `$_->{INDEX}' not used");
1129                 }
1130         }
1131
1132         foreach (values %{$conformance->{hf_renames}}) {
1133                 if (not $_->{USED}) {
1134                         warning($_->{POS}, "hf field `$_->{OLDNAME}' not used");
1135                 }
1136         }
1137
1138         foreach (values %{$conformance->{dissectorparams}}) {
1139                 if (not $_->{USED}) {
1140                         warning($_->{POS}, "dissector param never used");
1141                 }
1142         }
1143
1144         foreach (values %{$conformance->{imports}}) {
1145                 if (not $_->{USED}) {
1146                         warning($_->{POS}, "import never used");
1147                 }
1148         }
1149
1150         foreach (values %{$conformance->{types}}) {
1151                 if (not $_->{USED} and defined($_->{POS})) {
1152                         warning($_->{POS}, "type never used");
1153                 }
1154         }
1155
1156         foreach (values %{$conformance->{fielddescription}}) {
1157                 if (not $_->{USED}) {
1158                         warning($_->{POS}, "description never used");
1159                 }
1160         }
1161
1162         foreach (values %{$conformance->{tfs}}) {
1163                 if (not $_->{USED}) {
1164                         warning($_->{POS}, "True/False description never used");
1165                 }
1166         }
1167 }
1168
1169 1;