blob: 468a7b0696878aedf5abbc696d66301e69ba7ec4 [file] [log] [blame]
Mark Sleee9ce01c2007-05-16 02:29:53 +00001// Copyright (c) 2006- Facebook
2// Distributed under the Thrift Software License
3//
4// See accompanying file LICENSE or visit the Thrift site at:
5// http://developers.facebook.com/thrift/
6
Mark Slee31985722006-05-24 21:45:31 +00007/**
8 * thrift - a lightweight cross-language rpc/serialization tool
9 *
10 * This file contains the main compiler engine for Thrift, which invokes the
11 * scanner/parser to build the thrift object tree. The interface generation
Mark Sleef5377b32006-10-10 01:42:59 +000012 * code for each language lives in a file by the language name under the
13 * generate/ folder, and all parse structures live in parse/
Mark Slee31985722006-05-24 21:45:31 +000014 *
15 * @author Mark Slee <mcslee@facebook.com>
16 */
17
18#include <stdlib.h>
19#include <stdio.h>
20#include <stdarg.h>
21#include <string>
Mark Sleef0712dc2006-10-25 19:03:57 +000022#include <sys/types.h>
23#include <sys/stat.h>
dweatherford65b70752007-10-31 02:18:14 +000024#include <errno.h>
Mark Slee31985722006-05-24 21:45:31 +000025
Mark Sleef0712dc2006-10-25 19:03:57 +000026// Careful: must include globals first for extern definitions
Mark Slee31985722006-05-24 21:45:31 +000027#include "globals.h"
28
29#include "main.h"
30#include "parse/t_program.h"
Mark Sleef0712dc2006-10-25 19:03:57 +000031#include "parse/t_scope.h"
Mark Slee31985722006-05-24 21:45:31 +000032#include "generate/t_cpp_generator.h"
Mark Sleeb15a68b2006-06-07 06:46:24 +000033#include "generate/t_java_generator.h"
Mark Slee6e536442006-06-30 18:28:50 +000034#include "generate/t_php_generator.h"
Mark Sleefc89d392006-09-04 00:04:39 +000035#include "generate/t_py_generator.h"
Mark Slee6d7d5952007-01-27 01:44:22 +000036#include "generate/t_rb_generator.h"
Mark Slee0e0ff7e2007-01-18 22:59:59 +000037#include "generate/t_xsd_generator.h"
Mark Slee2c44d202007-05-16 02:18:07 +000038#include "generate/t_perl_generator.h"
Christopher Piro2f5afce2007-06-29 07:17:33 +000039#include "generate/t_erl_generator.h"
Christopher Pirob97b89d2007-09-18 00:07:42 +000040#include "generate/t_ocaml_generator.h"
iproctorff8eb922007-07-25 19:06:13 +000041#include "generate/t_hs_generator.h"
Mark Slee7e9eea42007-09-10 21:00:23 +000042#include "generate/t_cocoa_generator.h"
Mark Slee31985722006-05-24 21:45:31 +000043
44using namespace std;
45
Mark Sleef5377b32006-10-10 01:42:59 +000046/**
47 * Global program tree
48 */
Mark Slee31985722006-05-24 21:45:31 +000049t_program* g_program;
50
Mark Sleef5377b32006-10-10 01:42:59 +000051/**
Mark Sleef0712dc2006-10-25 19:03:57 +000052 * Global types
53 */
54
55t_type* g_type_void;
56t_type* g_type_string;
Mark Slee8d725a22007-04-13 01:57:12 +000057t_type* g_type_binary;
Mark Sleeb6200d82007-01-19 19:14:36 +000058t_type* g_type_slist;
Mark Sleef0712dc2006-10-25 19:03:57 +000059t_type* g_type_bool;
60t_type* g_type_byte;
61t_type* g_type_i16;
62t_type* g_type_i32;
63t_type* g_type_i64;
64t_type* g_type_double;
65
66/**
67 * Global scope
68 */
69t_scope* g_scope;
70
71/**
72 * Parent scope to also parse types
73 */
74t_scope* g_parent_scope;
75
76/**
77 * Prefix for putting types in parent scope
78 */
79string g_parent_prefix;
80
81/**
82 * Parsing pass
83 */
84PARSE_MODE g_parse_mode;
85
86/**
87 * Current directory of file being parsed
88 */
89string g_curdir;
90
91/**
92 * Current file being parsed
93 */
94string g_curpath;
95
96/**
Martin Kraemer32c66e12006-11-09 00:06:36 +000097 * Search path for inclusions
98 */
Mark Slee2329a832006-11-09 00:23:30 +000099vector<string> g_incl_searchpath;
Martin Kraemer32c66e12006-11-09 00:06:36 +0000100
101/**
Mark Sleef5377b32006-10-10 01:42:59 +0000102 * Global debug state
103 */
Mark Slee31985722006-05-24 21:45:31 +0000104int g_debug = 0;
105
Mark Sleef5377b32006-10-10 01:42:59 +0000106/**
Mark Sleef0712dc2006-10-25 19:03:57 +0000107 * Warning level
108 */
109int g_warn = 1;
110
111/**
112 * Verbose output
113 */
114int g_verbose = 0;
115
116/**
Mark Sleef5377b32006-10-10 01:42:59 +0000117 * Global time string
118 */
Mark Slee31985722006-05-24 21:45:31 +0000119char* g_time_str;
120
Mark Slee31985722006-05-24 21:45:31 +0000121/**
David Reisscbd4bac2007-08-14 17:12:33 +0000122 * The last parsed doctext comment.
123 */
124char* g_doctext;
125
126/**
127 * The location of the last parsed doctext comment.
128 */
129int g_doctext_lineno;
130
131/**
Mark Sleef0712dc2006-10-25 19:03:57 +0000132 * Flags to control code generation
133 */
134bool gen_cpp = false;
135bool gen_java = false;
Mark Slee01a9f882007-08-31 00:55:28 +0000136bool gen_javabean = false;
Mark Slee6d7d5952007-01-27 01:44:22 +0000137bool gen_rb = false;
Mark Sleef0712dc2006-10-25 19:03:57 +0000138bool gen_py = false;
Mark Slee0e0ff7e2007-01-18 22:59:59 +0000139bool gen_xsd = false;
Mark Sleef0712dc2006-10-25 19:03:57 +0000140bool gen_php = false;
141bool gen_phpi = false;
Mark Slee756b1d12007-07-06 00:30:21 +0000142bool gen_rest = false;
Mark Slee2c44d202007-05-16 02:18:07 +0000143bool gen_perl = false;
Christopher Piro2f5afce2007-06-29 07:17:33 +0000144bool gen_erl = false;
Christopher Pirob97b89d2007-09-18 00:07:42 +0000145bool gen_ocaml = false;
iproctorff8eb922007-07-25 19:06:13 +0000146bool gen_hs = false;
Mark Slee7e9eea42007-09-10 21:00:23 +0000147bool gen_cocoa = false;
David Reissd779cbe2007-08-31 01:42:55 +0000148bool gen_dense = false;
Mark Sleef0712dc2006-10-25 19:03:57 +0000149bool gen_recurse = false;
150
151/**
Mark Slee31985722006-05-24 21:45:31 +0000152 * Report an error to the user. This is called yyerror for historical
153 * reasons (lex and yacc expect the error reporting routine to be called
154 * this). Call this function to report any errors to the user.
155 * yyerror takes printf style arguments.
156 *
157 * @param fmt C format string followed by additional arguments
158 */
159void yyerror(char* fmt, ...) {
160 va_list args;
161 fprintf(stderr,
Mark Sleef0712dc2006-10-25 19:03:57 +0000162 "[ERROR:%s:%d] (last token was '%s')\n",
163 g_curpath.c_str(),
Mark Slee31985722006-05-24 21:45:31 +0000164 yylineno,
165 yytext);
Mark Slee31985722006-05-24 21:45:31 +0000166
167 va_start(args, fmt);
168 vfprintf(stderr, fmt, args);
169 va_end(args);
170
171 fprintf(stderr, "\n");
172}
173
174/**
175 * Prints a debug message from the parser.
176 *
177 * @param fmt C format string followed by additional arguments
178 */
179void pdebug(char* fmt, ...) {
180 if (g_debug == 0) {
181 return;
182 }
183 va_list args;
Mark Slee30152872006-11-28 01:24:07 +0000184 printf("[PARSE:%d] ", yylineno);
Mark Sleef0712dc2006-10-25 19:03:57 +0000185 va_start(args, fmt);
186 vprintf(fmt, args);
187 va_end(args);
188 printf("\n");
189}
190
191/**
192 * Prints a verbose output mode message
193 *
194 * @param fmt C format string followed by additional arguments
195 */
196void pverbose(char* fmt, ...) {
197 if (g_verbose == 0) {
198 return;
199 }
200 va_list args;
201 va_start(args, fmt);
202 vprintf(fmt, args);
203 va_end(args);
204}
205
206/**
207 * Prints a warning message
208 *
209 * @param fmt C format string followed by additional arguments
210 */
211void pwarning(int level, char* fmt, ...) {
212 if (g_warn < level) {
213 return;
214 }
215 va_list args;
216 printf("[WARNING:%s:%d] ", g_curpath.c_str(), yylineno);
Mark Slee31985722006-05-24 21:45:31 +0000217 va_start(args, fmt);
218 vprintf(fmt, args);
219 va_end(args);
220 printf("\n");
221}
222
223/**
224 * Prints a failure message and exits
225 *
226 * @param fmt C format string followed by additional arguments
227 */
Mark Slee30152872006-11-28 01:24:07 +0000228void failure(const char* fmt, ...) {
Mark Slee2c44d202007-05-16 02:18:07 +0000229 va_list args;
Mark Sleef0712dc2006-10-25 19:03:57 +0000230 fprintf(stderr, "[FAILURE:%s:%d] ", g_curpath.c_str(), yylineno);
Mark Slee31985722006-05-24 21:45:31 +0000231 va_start(args, fmt);
232 vfprintf(stderr, fmt, args);
233 va_end(args);
234 printf("\n");
235 exit(1);
236}
237
238/**
Mark Sleef0712dc2006-10-25 19:03:57 +0000239 * Converts a string filename into a thrift program name
240 */
241string program_name(string filename) {
242 string::size_type slash = filename.rfind("/");
243 if (slash != string::npos) {
244 filename = filename.substr(slash+1);
245 }
246 string::size_type dot = filename.rfind(".");
247 if (dot != string::npos) {
248 filename = filename.substr(0, dot);
249 }
250 return filename;
251}
252
253/**
254 * Gets the directory path of a filename
255 */
256string directory_name(string filename) {
257 string::size_type slash = filename.rfind("/");
258 // No slash, just use the current directory
259 if (slash == string::npos) {
260 return ".";
261 }
262 return filename.substr(0, slash);
263}
264
265/**
266 * Finds the appropriate file path for the given filename
267 */
268string include_file(string filename) {
269 // Absolute path? Just try that
Martin Kraemer32c66e12006-11-09 00:06:36 +0000270 if (filename[0] == '/') {
271 // Realpath!
272 char rp[PATH_MAX];
273 if (realpath(filename.c_str(), rp) == NULL) {
274 pwarning(0, "Cannot open include file %s\n", filename.c_str());
275 return std::string();
276 }
Mark Slee2c44d202007-05-16 02:18:07 +0000277
278 // Stat this file
Martin Kraemer32c66e12006-11-09 00:06:36 +0000279 struct stat finfo;
280 if (stat(rp, &finfo) == 0) {
281 return rp;
282 }
283 } else { // relative path, start searching
284 // new search path with current dir global
285 vector<string> sp = g_incl_searchpath;
286 sp.insert(sp.begin(), g_curdir);
Mark Slee2c44d202007-05-16 02:18:07 +0000287
Martin Kraemer32c66e12006-11-09 00:06:36 +0000288 // iterate through paths
289 vector<string>::iterator it;
290 for (it = sp.begin(); it != sp.end(); it++) {
291 string sfilename = *(it) + "/" + filename;
Mark Slee2c44d202007-05-16 02:18:07 +0000292
Martin Kraemer32c66e12006-11-09 00:06:36 +0000293 // Realpath!
294 char rp[PATH_MAX];
295 if (realpath(sfilename.c_str(), rp) == NULL) {
296 continue;
297 }
Mark Slee2c44d202007-05-16 02:18:07 +0000298
Martin Kraemer32c66e12006-11-09 00:06:36 +0000299 // Stat this files
300 struct stat finfo;
301 if (stat(rp, &finfo) == 0) {
302 return rp;
303 }
304 }
Mark Sleef0712dc2006-10-25 19:03:57 +0000305 }
Mark Slee2c44d202007-05-16 02:18:07 +0000306
Mark Sleef0712dc2006-10-25 19:03:57 +0000307 // Uh oh
308 pwarning(0, "Could not find include file %s\n", filename.c_str());
309 return std::string();
310}
311
312/**
David Reisscbd4bac2007-08-14 17:12:33 +0000313 * Clears any previously stored doctext string.
314 * Also prints a warning if we are discarding information.
315 */
316void clear_doctext() {
317 if (g_doctext != NULL) {
318 pwarning(2, "Uncaptured doctext at on line %d.", g_doctext_lineno);
319 }
320 free(g_doctext);
321 g_doctext = NULL;
322}
323
324/**
David Reiss1ac05802007-07-30 22:00:27 +0000325 * Cleans up text commonly found in doxygen-like comments
326 *
327 * Warning: if you mix tabs and spaces in a non-uniform way,
328 * you will get what you deserve.
329 */
330char* clean_up_doctext(char* doctext) {
331 // Convert to C++ string, and remove Windows's carriage returns.
332 string docstring = doctext;
333 docstring.erase(
334 remove(docstring.begin(), docstring.end(), '\r'),
335 docstring.end());
336
337 // Separate into lines.
338 vector<string> lines;
339 string::size_type pos = string::npos;
340 string::size_type last;
341 while (true) {
342 last = (pos == string::npos) ? 0 : pos+1;
343 pos = docstring.find('\n', last);
344 if (pos == string::npos) {
345 // First bit of cleaning. If the last line is only whitespace, drop it.
346 string::size_type nonwhite = docstring.find_first_not_of(" \t", last);
347 if (nonwhite != string::npos) {
348 lines.push_back(docstring.substr(last));
349 }
350 break;
351 }
352 lines.push_back(docstring.substr(last, pos-last));
353 }
354
355 // A very profound docstring.
356 if (lines.empty()) {
357 return NULL;
358 }
359
360 // Clear leading whitespace from the first line.
361 pos = lines.front().find_first_not_of(" \t");
362 lines.front().erase(0, pos);
363
364 // If every nonblank line after the first has the same number of spaces/tabs,
365 // then a star, remove them.
366 bool have_prefix = true;
367 bool found_prefix = false;
368 string::size_type prefix_len = 0;
369 vector<string>::iterator l_iter;
370 for (l_iter = lines.begin()+1; l_iter != lines.end(); ++l_iter) {
371 if (l_iter->empty()) {
372 continue;
373 }
374
375 pos = l_iter->find_first_not_of(" \t");
376 if (!found_prefix) {
377 if (pos != string::npos) {
378 if (l_iter->at(pos) == '*') {
379 found_prefix = true;
380 prefix_len = pos;
381 } else {
382 have_prefix = false;
383 break;
384 }
385 } else {
386 // Whitespace-only line. Truncate it.
387 l_iter->clear();
388 }
389 } else if (l_iter->size() > pos
390 && l_iter->at(pos) == '*'
391 && pos == prefix_len) {
392 // Business as usual.
393 } else if (pos == string::npos) {
394 // Whitespace-only line. Let's truncate it for them.
395 l_iter->clear();
396 } else {
397 // The pattern has been broken.
398 have_prefix = false;
399 break;
400 }
401 }
402
403 // If our prefix survived, delete it from every line.
404 if (have_prefix) {
405 // Get the star too.
406 prefix_len++;
407 for (l_iter = lines.begin()+1; l_iter != lines.end(); ++l_iter) {
408 l_iter->erase(0, prefix_len);
409 }
410 }
411
412 // Now delete the minimum amount of leading whitespace from each line.
413 prefix_len = string::npos;
414 for (l_iter = lines.begin()+1; l_iter != lines.end(); ++l_iter) {
415 if (l_iter->empty()) {
416 continue;
417 }
418 pos = l_iter->find_first_not_of(" \t");
419 if (pos != string::npos
420 && (prefix_len == string::npos || pos < prefix_len)) {
421 prefix_len = pos;
422 }
423 }
424
425 // If our prefix survived, delete it from every line.
426 if (prefix_len != string::npos) {
427 for (l_iter = lines.begin()+1; l_iter != lines.end(); ++l_iter) {
428 l_iter->erase(0, prefix_len);
429 }
430 }
431
432 // Remove trailing whitespace from every line.
433 for (l_iter = lines.begin(); l_iter != lines.end(); ++l_iter) {
434 pos = l_iter->find_last_not_of(" \t");
435 if (pos != string::npos && pos != l_iter->length()-1) {
436 l_iter->erase(pos+1);
437 }
438 }
439
440 // If the first line is empty, remove it.
441 // Don't do this earlier because a lot of steps skip the first line.
442 if (lines.front().empty()) {
443 lines.erase(lines.begin());
444 }
445
446 // Now rejoin the lines and copy them back into doctext.
447 docstring.clear();
448 for (l_iter = lines.begin(); l_iter != lines.end(); ++l_iter) {
449 docstring += *l_iter;
450 docstring += '\n';
451 }
452
453 assert(docstring.length() <= strlen(doctext));
454 strcpy(doctext, docstring.c_str());
455 return doctext;
456}
457
458/** Set to true to debug docstring parsing */
459static bool dump_docs = false;
460
461/**
462 * Dumps docstrings to stdout
David Reisscdffe262007-08-14 17:12:31 +0000463 * Only works for top-level definitions and the whole program doc
464 * (i.e., not enum constants, struct fields, or functions.
David Reiss1ac05802007-07-30 22:00:27 +0000465 */
466void dump_docstrings(t_program* program) {
David Reisscdffe262007-08-14 17:12:31 +0000467 string progdoc = program->get_doc();
David Reissc2532a92007-07-30 23:46:11 +0000468 if (!progdoc.empty()) {
469 printf("Whole program doc:\n%s\n", progdoc.c_str());
470 }
David Reiss1ac05802007-07-30 22:00:27 +0000471 const vector<t_typedef*>& typedefs = program->get_typedefs();
472 vector<t_typedef*>::const_iterator t_iter;
473 for (t_iter = typedefs.begin(); t_iter != typedefs.end(); ++t_iter) {
474 t_typedef* td = *t_iter;
475 if (td->has_doc()) {
David Reisscdffe262007-08-14 17:12:31 +0000476 printf("typedef %s:\n%s\n", td->get_name().c_str(), td->get_doc().c_str());
477 }
478 }
479 const vector<t_enum*>& enums = program->get_enums();
480 vector<t_enum*>::const_iterator e_iter;
481 for (e_iter = enums.begin(); e_iter != enums.end(); ++e_iter) {
482 t_enum* en = *e_iter;
483 if (en->has_doc()) {
484 printf("enum %s:\n%s\n", en->get_name().c_str(), en->get_doc().c_str());
485 }
486 }
487 const vector<t_const*>& consts = program->get_consts();
488 vector<t_const*>::const_iterator c_iter;
489 for (c_iter = consts.begin(); c_iter != consts.end(); ++c_iter) {
490 t_const* co = *c_iter;
491 if (co->has_doc()) {
492 printf("const %s:\n%s\n", co->get_name().c_str(), co->get_doc().c_str());
493 }
494 }
495 const vector<t_struct*>& structs = program->get_structs();
496 vector<t_struct*>::const_iterator s_iter;
497 for (s_iter = structs.begin(); s_iter != structs.end(); ++s_iter) {
498 t_struct* st = *s_iter;
499 if (st->has_doc()) {
500 printf("struct %s:\n%s\n", st->get_name().c_str(), st->get_doc().c_str());
501 }
502 }
503 const vector<t_struct*>& xceptions = program->get_xceptions();
504 vector<t_struct*>::const_iterator x_iter;
505 for (x_iter = xceptions.begin(); x_iter != xceptions.end(); ++x_iter) {
506 t_struct* xn = *x_iter;
507 if (xn->has_doc()) {
508 printf("xception %s:\n%s\n", xn->get_name().c_str(), xn->get_doc().c_str());
509 }
510 }
511 const vector<t_service*>& services = program->get_services();
512 vector<t_service*>::const_iterator v_iter;
513 for (v_iter = services.begin(); v_iter != services.end(); ++v_iter) {
514 t_service* sv = *v_iter;
515 if (sv->has_doc()) {
516 printf("service %s:\n%s\n", sv->get_name().c_str(), sv->get_doc().c_str());
David Reiss1ac05802007-07-30 22:00:27 +0000517 }
518 }
519}
520
521/**
David Reiss18bf22d2007-08-28 20:49:17 +0000522 * Call generate_fingerprint for every structure.
523 */
524void generate_all_fingerprints(t_program* program) {
525 const vector<t_struct*>& structs = program->get_structs();
526 vector<t_struct*>::const_iterator s_iter;
527 for (s_iter = structs.begin(); s_iter != structs.end(); ++s_iter) {
528 t_struct* st = *s_iter;
529 st->generate_fingerprint();
530 }
531
David Reissd779cbe2007-08-31 01:42:55 +0000532 const vector<t_struct*>& xceptions = program->get_xceptions();
533 vector<t_struct*>::const_iterator x_iter;
534 for (x_iter = xceptions.begin(); x_iter != xceptions.end(); ++x_iter) {
535 t_struct* st = *x_iter;
536 st->generate_fingerprint();
537 }
538
David Reiss47557bc2007-09-04 21:31:04 +0000539 g_type_void->generate_fingerprint();
540
David Reiss18bf22d2007-08-28 20:49:17 +0000541 // If you want to generate fingerprints for implicit structures, start here.
542 /*
543 const vector<t_service*>& services = program->get_services();
544 vector<t_service*>::const_iterator v_iter;
545 for (v_iter = services.begin(); v_iter != services.end(); ++v_iter) {
546 t_service* sv = *v_iter;
547 }
548 */
549}
550
551/**
Mark Slee31985722006-05-24 21:45:31 +0000552 * Diplays the usage message and then exits with an error code.
553 */
554void usage() {
Mark Sleeb15a68b2006-06-07 06:46:24 +0000555 fprintf(stderr, "Usage: thrift [options] file\n");
556 fprintf(stderr, "Options:\n");
Mark Slee2329a832006-11-09 00:23:30 +0000557 fprintf(stderr, " -cpp Generate C++ output files\n");
558 fprintf(stderr, " -java Generate Java output files\n");
Mark Slee01a9f882007-08-31 00:55:28 +0000559 fprintf(stderr, " -javabean Generate Java bean-style output files\n");
Mark Slee2329a832006-11-09 00:23:30 +0000560 fprintf(stderr, " -php Generate PHP output files\n");
561 fprintf(stderr, " -phpi Generate PHP inlined files\n");
562 fprintf(stderr, " -py Generate Python output files\n");
ccheeverf53b5cf2007-02-05 20:33:11 +0000563 fprintf(stderr, " -rb Generate Ruby output files\n");
564 fprintf(stderr, " -xsd Generate XSD output files\n");
Mark Slee2c44d202007-05-16 02:18:07 +0000565 fprintf(stderr, " -perl Generate Perl output files\n");
Christopher Piro2f5afce2007-06-29 07:17:33 +0000566 fprintf(stderr, " -erl Generate Erlang output files\n");
Christopher Pirob97b89d2007-09-18 00:07:42 +0000567 fprintf(stderr, " -ocaml Generate OCaml output files\n");
iproctorff8eb922007-07-25 19:06:13 +0000568 fprintf(stderr, " -hs Generate Haskell output files\n");
Mark Slee7e9eea42007-09-10 21:00:23 +0000569 fprintf(stderr, " -cocoa Generate Cocoa/Objective-C output files\n");
dweatherford65b70752007-10-31 02:18:14 +0000570 fprintf(stderr, " -o dir Set the output directory for gen-* packages\n");
571 fprintf(stderr, " (default: current directory)\n");
David Reissd779cbe2007-08-31 01:42:55 +0000572 fprintf(stderr, " -I dir Add a directory to the list of directories\n");
Mark Slee227ac2c2007-03-07 05:46:50 +0000573 fprintf(stderr, " searched for include directives\n");
David Reissd779cbe2007-08-31 01:42:55 +0000574 fprintf(stderr, " -dense Generate metadata for TDenseProtocol (C++)\n");
575 fprintf(stderr, " -rest Generate PHP REST processors (with -php)\n");
Mark Slee2329a832006-11-09 00:23:30 +0000576 fprintf(stderr, " -nowarn Suppress all compiler warnings (BAD!)\n");
577 fprintf(stderr, " -strict Strict compiler warnings on\n");
578 fprintf(stderr, " -v[erbose] Verbose mode\n");
579 fprintf(stderr, " -r[ecurse] Also generate included files\n");
580 fprintf(stderr, " -debug Parse debug trace to stdout\n");
Mark Slee31985722006-05-24 21:45:31 +0000581 exit(1);
582}
583
584/**
Mark Slee30152872006-11-28 01:24:07 +0000585 * You know, when I started working on Thrift I really thought it wasn't going
586 * to become a programming language because it was just a generator and it
587 * wouldn't need runtime type information and all that jazz. But then we
588 * decided to add constants, and all of a sudden that means runtime type
589 * validation and inference, except the "runtime" is the code generator
590 * runtime. Shit. I've been had.
591 */
592void validate_const_rec(std::string name, t_type* type, t_const_value* value) {
593 if (type->is_void()) {
594 throw "type error: cannot declare a void const: " + name;
595 }
596
597 if (type->is_base_type()) {
598 t_base_type::t_base tbase = ((t_base_type*)type)->get_base();
599 switch (tbase) {
600 case t_base_type::TYPE_STRING:
601 if (value->get_type() != t_const_value::CV_STRING) {
602 throw "type error: const \"" + name + "\" was declared as string";
603 }
604 break;
605 case t_base_type::TYPE_BOOL:
606 if (value->get_type() != t_const_value::CV_INTEGER) {
607 throw "type error: const \"" + name + "\" was declared as bool";
608 }
609 break;
610 case t_base_type::TYPE_BYTE:
611 if (value->get_type() != t_const_value::CV_INTEGER) {
612 throw "type error: const \"" + name + "\" was declared as byte";
613 }
614 break;
615 case t_base_type::TYPE_I16:
616 if (value->get_type() != t_const_value::CV_INTEGER) {
617 throw "type error: const \"" + name + "\" was declared as i16";
618 }
619 break;
620 case t_base_type::TYPE_I32:
621 if (value->get_type() != t_const_value::CV_INTEGER) {
622 throw "type error: const \"" + name + "\" was declared as i32";
623 }
624 break;
625 case t_base_type::TYPE_I64:
626 if (value->get_type() != t_const_value::CV_INTEGER) {
627 throw "type error: const \"" + name + "\" was declared as i64";
628 }
629 break;
630 case t_base_type::TYPE_DOUBLE:
631 if (value->get_type() != t_const_value::CV_INTEGER &&
632 value->get_type() != t_const_value::CV_DOUBLE) {
633 throw "type error: const \"" + name + "\" was declared as double";
634 }
635 break;
636 default:
David Reissdd7796f2007-08-28 21:09:06 +0000637 throw "compiler error: no const of base type " + t_base_type::t_base_name(tbase) + name;
Mark Slee30152872006-11-28 01:24:07 +0000638 }
639 } else if (type->is_enum()) {
640 if (value->get_type() != t_const_value::CV_INTEGER) {
641 throw "type error: const \"" + name + "\" was declared as enum";
642 }
643 } else if (type->is_struct() || type->is_xception()) {
644 if (value->get_type() != t_const_value::CV_MAP) {
645 throw "type error: const \"" + name + "\" was declared as struct/xception";
646 }
647 const vector<t_field*>& fields = ((t_struct*)type)->get_members();
648 vector<t_field*>::const_iterator f_iter;
649
650 const map<t_const_value*, t_const_value*>& val = value->get_map();
651 map<t_const_value*, t_const_value*>::const_iterator v_iter;
652 for (v_iter = val.begin(); v_iter != val.end(); ++v_iter) {
653 if (v_iter->first->get_type() != t_const_value::CV_STRING) {
654 throw "type error: " + name + " struct key must be string";
655 }
656 t_type* field_type = NULL;
657 for (f_iter = fields.begin(); f_iter != fields.end(); ++f_iter) {
658 if ((*f_iter)->get_name() == v_iter->first->get_string()) {
659 field_type = (*f_iter)->get_type();
660 }
661 }
662 if (field_type == NULL) {
663 throw "type error: " + type->get_name() + " has no field " + v_iter->first->get_string();
664 }
665
666 validate_const_rec(name + "." + v_iter->first->get_string(), field_type, v_iter->second);
667 }
668 } else if (type->is_map()) {
669 t_type* k_type = ((t_map*)type)->get_key_type();
670 t_type* v_type = ((t_map*)type)->get_val_type();
671 const map<t_const_value*, t_const_value*>& val = value->get_map();
672 map<t_const_value*, t_const_value*>::const_iterator v_iter;
673 for (v_iter = val.begin(); v_iter != val.end(); ++v_iter) {
674 validate_const_rec(name + "<key>", k_type, v_iter->first);
675 validate_const_rec(name + "<val>", v_type, v_iter->second);
Mark Slee2c44d202007-05-16 02:18:07 +0000676 }
Mark Slee30152872006-11-28 01:24:07 +0000677 } else if (type->is_list() || type->is_set()) {
678 t_type* e_type;
679 if (type->is_list()) {
680 e_type = ((t_list*)type)->get_elem_type();
681 } else {
682 e_type = ((t_set*)type)->get_elem_type();
683 }
684 const vector<t_const_value*>& val = value->get_list();
685 vector<t_const_value*>::const_iterator v_iter;
686 for (v_iter = val.begin(); v_iter != val.end(); ++v_iter) {
687 validate_const_rec(name + "<elem>", e_type, *v_iter);
688 }
689 }
690}
691
692/**
693 * Check the type of the parsed const information against its declared type
694 */
695void validate_const_type(t_const* c) {
696 validate_const_rec(c->get_name(), c->get_type(), c->get_value());
697}
698
699/**
Mark Slee7ff32452007-02-01 05:26:18 +0000700 * Check the type of a default value assigned to a field.
701 */
702void validate_field_value(t_field* field, t_const_value* cv) {
703 validate_const_rec(field->get_name(), field->get_type(), cv);
704}
705
706/**
Mark Sleef0712dc2006-10-25 19:03:57 +0000707 * Parses a program
708 */
Mark Slee2c44d202007-05-16 02:18:07 +0000709void parse(t_program* program, t_program* parent_program) {
Mark Sleef0712dc2006-10-25 19:03:57 +0000710 // Get scope file path
711 string path = program->get_path();
Mark Slee2c44d202007-05-16 02:18:07 +0000712
Mark Sleef0712dc2006-10-25 19:03:57 +0000713 // Set current dir global, which is used in the include_file function
714 g_curdir = directory_name(path);
715 g_curpath = path;
716
717 // Open the file
718 yyin = fopen(path.c_str(), "r");
719 if (yyin == 0) {
720 failure("Could not open input file: \"%s\"", path.c_str());
721 }
722
723 // Create new scope and scan for includes
724 pverbose("Scanning %s for includes\n", path.c_str());
Mark Slee2c44d202007-05-16 02:18:07 +0000725 g_parse_mode = INCLUDES;
Mark Sleef0712dc2006-10-25 19:03:57 +0000726 g_program = program;
727 g_scope = program->scope();
Mark Slee30152872006-11-28 01:24:07 +0000728 try {
Mark Slee36bfa2e2007-01-19 20:09:51 +0000729 yylineno = 1;
Mark Slee30152872006-11-28 01:24:07 +0000730 if (yyparse() != 0) {
731 failure("Parser error during include pass.");
732 }
733 } catch (string x) {
734 failure(x.c_str());
Mark Sleef0712dc2006-10-25 19:03:57 +0000735 }
736 fclose(yyin);
737
738 // Recursively parse all the include programs
739 vector<t_program*>& includes = program->get_includes();
740 vector<t_program*>::iterator iter;
741 for (iter = includes.begin(); iter != includes.end(); ++iter) {
742 parse(*iter, program);
743 }
744
745 // Parse the program the file
746 g_parse_mode = PROGRAM;
747 g_program = program;
748 g_scope = program->scope();
749 g_parent_scope = (parent_program != NULL) ? parent_program->scope() : NULL;
750 g_parent_prefix = program->get_name() + ".";
751 g_curpath = path;
752 yyin = fopen(path.c_str(), "r");
753 if (yyin == 0) {
754 failure("Could not open input file: \"%s\"", path.c_str());
755 }
756 pverbose("Parsing %s for types\n", path.c_str());
Mark Slee36bfa2e2007-01-19 20:09:51 +0000757 yylineno = 1;
David Reiss877237a2007-07-27 00:40:19 +0000758 try {
759 if (yyparse() != 0) {
760 failure("Parser error during types pass.");
761 }
762 } catch (string x) {
763 failure(x.c_str());
Mark Sleef0712dc2006-10-25 19:03:57 +0000764 }
765 fclose(yyin);
766}
767
768/**
769 * Generate code
770 */
771void generate(t_program* program) {
772 // Oooohh, recursive code generation, hot!!
773 if (gen_recurse) {
774 const vector<t_program*>& includes = program->get_includes();
775 for (size_t i = 0; i < includes.size(); ++i) {
dweatherford65b70752007-10-31 02:18:14 +0000776 // Propogate output path from parent to child programs
777 includes[i]->set_out_path(program->get_out_path());
778
Mark Sleef0712dc2006-10-25 19:03:57 +0000779 generate(includes[i]);
780 }
781 }
782
783 // Generate code!
784 try {
785 pverbose("Program: %s\n", program->get_path().c_str());
786
David Reiss18bf22d2007-08-28 20:49:17 +0000787 // Compute fingerprints.
788 generate_all_fingerprints(program);
789
Mark Sleef0712dc2006-10-25 19:03:57 +0000790 if (gen_cpp) {
791 pverbose("Generating C++\n");
David Reissd779cbe2007-08-31 01:42:55 +0000792 t_cpp_generator* cpp = new t_cpp_generator(program, gen_dense);
Mark Sleef0712dc2006-10-25 19:03:57 +0000793 cpp->generate_program();
794 delete cpp;
795 }
796
797 if (gen_java) {
798 pverbose("Generating Java\n");
Mark Slee01a9f882007-08-31 00:55:28 +0000799 t_java_generator* java = new t_java_generator(program, false);
800 java->generate_program();
801 delete java;
802 }
803
804 if (gen_javabean) {
805 pverbose("Generating Java Beans\n");
806 t_java_generator* java = new t_java_generator(program, true);
Mark Sleef0712dc2006-10-25 19:03:57 +0000807 java->generate_program();
808 delete java;
809 }
810
811 if (gen_php) {
812 pverbose("Generating PHP\n");
Mark Slee756b1d12007-07-06 00:30:21 +0000813 t_php_generator* php = new t_php_generator(program, false, gen_rest);
Mark Sleef0712dc2006-10-25 19:03:57 +0000814 php->generate_program();
815 delete php;
816 }
817
818 if (gen_phpi) {
819 pverbose("Generating PHP-inline\n");
Mark Slee756b1d12007-07-06 00:30:21 +0000820 t_php_generator* phpi = new t_php_generator(program, true, gen_rest);
Mark Sleef0712dc2006-10-25 19:03:57 +0000821 phpi->generate_program();
822 delete phpi;
823 }
824
825 if (gen_py) {
826 pverbose("Generating Python\n");
827 t_py_generator* py = new t_py_generator(program);
828 py->generate_program();
829 delete py;
830 }
Mark Slee0e0ff7e2007-01-18 22:59:59 +0000831
Mark Slee6d7d5952007-01-27 01:44:22 +0000832 if (gen_rb) {
833 pverbose("Generating Ruby\n");
834 t_rb_generator* rb = new t_rb_generator(program);
835 rb->generate_program();
836 delete rb;
837 }
838
Mark Slee0e0ff7e2007-01-18 22:59:59 +0000839 if (gen_xsd) {
840 pverbose("Generating XSD\n");
841 t_xsd_generator* xsd = new t_xsd_generator(program);
842 xsd->generate_program();
843 delete xsd;
844 }
845
Mark Slee2c44d202007-05-16 02:18:07 +0000846 if (gen_perl) {
847 pverbose("Generating PERL\n");
848 t_perl_generator* perl = new t_perl_generator(program);
849 perl->generate_program();
850 delete perl;
851 }
852
Christopher Pirob97b89d2007-09-18 00:07:42 +0000853 if (gen_erl) {
854 pverbose("Generating Erlang\n");
855 t_erl_generator* erl = new t_erl_generator(program);
856 erl->generate_program();
857 delete erl;
858 }
859
iproctor9a41a0c2007-07-16 21:59:24 +0000860 if (gen_ocaml) {
861 pverbose("Generating OCaml\n");
862 t_ocaml_generator* ocaml = new t_ocaml_generator(program);
863 ocaml->generate_program();
864 delete ocaml;
865 }
866
iproctorff8eb922007-07-25 19:06:13 +0000867 if (gen_hs) {
868 pverbose("Generating Haskell\n");
869 t_hs_generator* hs = new t_hs_generator(program);
870 hs->generate_program();
871 delete hs;
872 }
Christopher Pirob97b89d2007-09-18 00:07:42 +0000873
Mark Slee7e9eea42007-09-10 21:00:23 +0000874 if (gen_cocoa) {
875 pverbose("Generating Cocoa/Objective-C\n");
876 t_cocoa_generator* cocoa = new t_cocoa_generator(program);
877 cocoa->generate_program();
878 delete cocoa;
879 }
Christopher Pirob97b89d2007-09-18 00:07:42 +0000880
David Reiss1ac05802007-07-30 22:00:27 +0000881 if (dump_docs) {
882 dump_docstrings(program);
883 }
Mark Sleef0712dc2006-10-25 19:03:57 +0000884 } catch (string s) {
885 printf("Error: %s\n", s.c_str());
886 } catch (const char* exc) {
887 printf("Error: %s\n", exc);
888 }
889
890}
891
892/**
Mark Sleef5377b32006-10-10 01:42:59 +0000893 * Parse it up.. then spit it back out, in pretty much every language. Alright
894 * not that many languages, but the cool ones that we care about.
Mark Slee31985722006-05-24 21:45:31 +0000895 */
896int main(int argc, char** argv) {
897 int i;
dweatherford65b70752007-10-31 02:18:14 +0000898 std::string out_path;
Mark Sleef5377b32006-10-10 01:42:59 +0000899
Mark Sleeb15a68b2006-06-07 06:46:24 +0000900 // Setup time string
901 time_t now = time(NULL);
902 g_time_str = ctime(&now);
Mark Slee31985722006-05-24 21:45:31 +0000903
Mark Sleef0712dc2006-10-25 19:03:57 +0000904 // Check for necessary arguments, you gotta have at least a filename and
905 // an output language flag
Mark Sleeb15a68b2006-06-07 06:46:24 +0000906 if (argc < 2) {
907 usage();
908 }
Mark Slee31985722006-05-24 21:45:31 +0000909
Mark Sleef5377b32006-10-10 01:42:59 +0000910 // Hacky parameter handling... I didn't feel like using a library sorry!
Mark Slee31985722006-05-24 21:45:31 +0000911 for (i = 1; i < argc-1; i++) {
Mark Sleefdbee812006-09-27 18:50:48 +0000912 char* arg;
Mark Slee2329a832006-11-09 00:23:30 +0000913
Mark Sleefdbee812006-09-27 18:50:48 +0000914 arg = strtok(argv[i], " ");
915 while (arg != NULL) {
Mark Slee2329a832006-11-09 00:23:30 +0000916 // Treat double dashes as single dashes
Mark Slee52cb2232006-11-10 22:32:07 +0000917 if (arg[0] == '-' && arg[1] == '-') {
Mark Slee2329a832006-11-09 00:23:30 +0000918 ++arg;
919 }
920
921 if (strcmp(arg, "-debug") == 0) {
Mark Sleefdbee812006-09-27 18:50:48 +0000922 g_debug = 1;
Mark Slee2329a832006-11-09 00:23:30 +0000923 } else if (strcmp(arg, "-nowarn") == 0) {
Mark Sleef0712dc2006-10-25 19:03:57 +0000924 g_warn = 0;
Mark Slee2329a832006-11-09 00:23:30 +0000925 } else if (strcmp(arg, "-strict") == 0) {
Mark Sleef0712dc2006-10-25 19:03:57 +0000926 g_warn = 2;
Mark Slee2329a832006-11-09 00:23:30 +0000927 } else if (strcmp(arg, "-v") == 0 || strcmp(arg, "-verbose") == 0 ) {
Mark Sleef0712dc2006-10-25 19:03:57 +0000928 g_verbose = 1;
Mark Slee2329a832006-11-09 00:23:30 +0000929 } else if (strcmp(arg, "-r") == 0 || strcmp(arg, "-recurse") == 0 ) {
Mark Sleef0712dc2006-10-25 19:03:57 +0000930 gen_recurse = true;
David Reissd779cbe2007-08-31 01:42:55 +0000931 } else if (strcmp(arg, "-dense") == 0) {
932 gen_dense = true;
Mark Slee2329a832006-11-09 00:23:30 +0000933 } else if (strcmp(arg, "-cpp") == 0) {
Mark Sleefdbee812006-09-27 18:50:48 +0000934 gen_cpp = true;
Mark Slee01a9f882007-08-31 00:55:28 +0000935 } else if (strcmp(arg, "-javabean") == 0) {
936 gen_javabean = true;
Mark Slee2329a832006-11-09 00:23:30 +0000937 } else if (strcmp(arg, "-java") == 0) {
Mark Sleefdbee812006-09-27 18:50:48 +0000938 gen_java = true;
Mark Slee2329a832006-11-09 00:23:30 +0000939 } else if (strcmp(arg, "-php") == 0) {
Mark Sleefdbee812006-09-27 18:50:48 +0000940 gen_php = true;
Mark Slee2329a832006-11-09 00:23:30 +0000941 } else if (strcmp(arg, "-phpi") == 0) {
Mark Sleef5377b32006-10-10 01:42:59 +0000942 gen_phpi = true;
Mark Slee756b1d12007-07-06 00:30:21 +0000943 } else if (strcmp(arg, "-rest") == 0) {
944 gen_rest = true;
Mark Slee2329a832006-11-09 00:23:30 +0000945 } else if (strcmp(arg, "-py") == 0) {
Mark Sleefdbee812006-09-27 18:50:48 +0000946 gen_py = true;
Mark Slee6d7d5952007-01-27 01:44:22 +0000947 } else if (strcmp(arg, "-rb") == 0) {
948 gen_rb = true;
Mark Slee0e0ff7e2007-01-18 22:59:59 +0000949 } else if (strcmp(arg, "-xsd") == 0) {
950 gen_xsd = true;
Mark Slee2c44d202007-05-16 02:18:07 +0000951 } else if (strcmp(arg, "-perl") == 0) {
952 gen_perl = true;
Christopher Piro2f5afce2007-06-29 07:17:33 +0000953 } else if (strcmp(arg, "-erl") == 0) {
954 gen_erl = true;
Christopher Pirob97b89d2007-09-18 00:07:42 +0000955 } else if (strcmp(arg, "-ocaml") == 0) {
956 gen_ocaml = true;
iproctorff8eb922007-07-25 19:06:13 +0000957 } else if (strcmp(arg, "-hs") == 0) {
958 gen_hs = true;
Mark Slee7e9eea42007-09-10 21:00:23 +0000959 } else if (strcmp(arg, "-cocoa") == 0) {
960 gen_cocoa = true;
Martin Kraemer32c66e12006-11-09 00:06:36 +0000961 } else if (strcmp(arg, "-I") == 0) {
962 // An argument of "-I\ asdf" is invalid and has unknown results
963 arg = argv[++i];
964
965 if (arg == NULL) {
966 fprintf(stderr, "!!! Missing Include directory");
967 usage();
968 }
969 g_incl_searchpath.push_back(arg);
dweatherford65b70752007-10-31 02:18:14 +0000970 } else if (strcmp(arg, "-o") == 0) {
971 arg = argv[++i];
972 if (arg == NULL) {
973 fprintf(stderr, "-o: missing output directory");
974 usage();
975 }
976 out_path = arg;
977 struct stat sb;
978 if (stat(out_path.c_str(), &sb) < 0) {
979 fprintf(stderr, "Output directory %s is unusable: %s\n", out_path.c_str(), strerror(errno));
980 return -1;
981 }
982 if (! S_ISDIR(sb.st_mode)) {
983 fprintf(stderr, "Output directory %s exists but is not a directory\n", out_path.c_str());
984 return -1;
985 }
Mark Sleefdbee812006-09-27 18:50:48 +0000986 } else {
987 fprintf(stderr, "!!! Unrecognized option: %s\n", arg);
988 usage();
989 }
990
991 // Tokenize more
992 arg = strtok(NULL, " ");
Mark Slee31985722006-05-24 21:45:31 +0000993 }
994 }
Mark Slee2c44d202007-05-16 02:18:07 +0000995
Mark Sleef0712dc2006-10-25 19:03:57 +0000996 // You gotta generate something!
Christopher Pirob97b89d2007-09-18 00:07:42 +0000997 if (!gen_cpp && !gen_java && !gen_javabean && !gen_php && !gen_phpi && !gen_py && !gen_rb && !gen_xsd && !gen_perl && !gen_erl && !gen_ocaml && !gen_hs && !gen_cocoa) {
Mark Sleeb15a68b2006-06-07 06:46:24 +0000998 fprintf(stderr, "!!! No output language(s) specified\n\n");
999 usage();
1000 }
Mark Sleef0712dc2006-10-25 19:03:57 +00001001
1002 // Real-pathify it
1003 char rp[PATH_MAX];
1004 if (realpath(argv[i], rp) == NULL) {
1005 failure("Could not open input file: %s", argv[i]);
Mark Slee31985722006-05-24 21:45:31 +00001006 }
Mark Sleef0712dc2006-10-25 19:03:57 +00001007 string input_file(rp);
1008
Mark Sleef5377b32006-10-10 01:42:59 +00001009 // Instance of the global parse tree
Mark Sleef0712dc2006-10-25 19:03:57 +00001010 t_program* program = new t_program(input_file);
dweatherford65b70752007-10-31 02:18:14 +00001011 if (out_path.size()) {
1012 program->set_out_path(out_path);
1013 }
Mark Sleef0712dc2006-10-25 19:03:57 +00001014
1015 // Initialize global types
1016 g_type_void = new t_base_type("void", t_base_type::TYPE_VOID);
1017 g_type_string = new t_base_type("string", t_base_type::TYPE_STRING);
Mark Slee8d725a22007-04-13 01:57:12 +00001018 g_type_binary = new t_base_type("string", t_base_type::TYPE_STRING);
1019 ((t_base_type*)g_type_binary)->set_binary(true);
Mark Sleeb6200d82007-01-19 19:14:36 +00001020 g_type_slist = new t_base_type("string", t_base_type::TYPE_STRING);
1021 ((t_base_type*)g_type_slist)->set_string_list(true);
Mark Sleef0712dc2006-10-25 19:03:57 +00001022 g_type_bool = new t_base_type("bool", t_base_type::TYPE_BOOL);
1023 g_type_byte = new t_base_type("byte", t_base_type::TYPE_BYTE);
1024 g_type_i16 = new t_base_type("i16", t_base_type::TYPE_I16);
1025 g_type_i32 = new t_base_type("i32", t_base_type::TYPE_I32);
1026 g_type_i64 = new t_base_type("i64", t_base_type::TYPE_I64);
1027 g_type_double = new t_base_type("double", t_base_type::TYPE_DOUBLE);
Mark Sleee8540632006-05-30 09:24:40 +00001028
Mark Sleef5377b32006-10-10 01:42:59 +00001029 // Parse it!
Mark Sleef0712dc2006-10-25 19:03:57 +00001030 parse(program, NULL);
Mark Slee31985722006-05-24 21:45:31 +00001031
Mark Sleef0712dc2006-10-25 19:03:57 +00001032 // Generate it!
1033 generate(program);
Mark Sleeb15a68b2006-06-07 06:46:24 +00001034
Mark Sleef0712dc2006-10-25 19:03:57 +00001035 // Clean up. Who am I kidding... this program probably orphans heap memory
1036 // all over the place, but who cares because it is about to exit and it is
1037 // all referenced and used by this wacky parse tree up until now anyways.
Mark Sleeb15a68b2006-06-07 06:46:24 +00001038
Mark Sleef0712dc2006-10-25 19:03:57 +00001039 delete program;
1040 delete g_type_void;
1041 delete g_type_string;
1042 delete g_type_bool;
1043 delete g_type_byte;
1044 delete g_type_i16;
1045 delete g_type_i32;
1046 delete g_type_i64;
1047 delete g_type_double;
Mark Slee31985722006-05-24 21:45:31 +00001048
1049 // Finished
Mark Slee31985722006-05-24 21:45:31 +00001050 return 0;
1051}