blob: c13ae91cb656d28a4bdf9df46814520a49089fb3 [file] [log] [blame]
Steve Naroff2b8ee6c2009-09-01 15:55:40 +00001/* c-index-test.c */
Steve Naroff50398192009-08-28 15:28:48 +00002
3#include "clang-c/Index.h"
Douglas Gregorc7ed3722010-08-25 22:15:42 +00004#include <ctype.h>
Douglas Gregor0c8296d2009-11-07 00:00:49 +00005#include <stdlib.h>
Steve Naroff89922f82009-08-31 00:59:03 +00006#include <stdio.h>
Steve Naroffaf08ddc2009-09-03 15:49:00 +00007#include <string.h>
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00008#include <assert.h>
Steve Naroffaf08ddc2009-09-03 15:49:00 +00009
Ted Kremenek0d435192009-11-17 18:13:31 +000010/******************************************************************************/
11/* Utility functions. */
12/******************************************************************************/
13
John Thompson2e06fc82009-10-27 13:42:56 +000014#ifdef _MSC_VER
15char *basename(const char* path)
16{
17 char* base1 = (char*)strrchr(path, '/');
18 char* base2 = (char*)strrchr(path, '\\');
19 if (base1 && base2)
20 return((base1 > base2) ? base1 + 1 : base2 + 1);
21 else if (base1)
22 return(base1 + 1);
23 else if (base2)
24 return(base2 + 1);
25
26 return((char*)path);
27}
28#else
Steve Naroffff9e18c2009-09-24 20:03:06 +000029extern char *basename(const char *);
John Thompson2e06fc82009-10-27 13:42:56 +000030#endif
Steve Naroffff9e18c2009-09-24 20:03:06 +000031
Douglas Gregor45ba9a12010-07-25 17:39:21 +000032/** \brief Return the default parsing options. */
Douglas Gregor44c181a2010-07-23 00:33:23 +000033static unsigned getDefaultParsingOptions() {
34 unsigned options = CXTranslationUnit_DetailedPreprocessingRecord;
35
36 if (getenv("CINDEXTEST_EDITING"))
Douglas Gregorb1c031b2010-08-09 22:28:58 +000037 options |= clang_defaultEditingTranslationUnitOptions();
Douglas Gregor87c08a52010-08-13 22:48:40 +000038 if (getenv("CINDEXTEST_COMPLETION_CACHING"))
39 options |= CXTranslationUnit_CacheCompletionResults;
Douglas Gregor44c181a2010-07-23 00:33:23 +000040
41 return options;
42}
43
Daniel Dunbar51b058c2010-02-14 08:32:24 +000044static void PrintExtent(FILE *out, unsigned begin_line, unsigned begin_column,
45 unsigned end_line, unsigned end_column) {
46 fprintf(out, "[%d:%d - %d:%d]", begin_line, begin_column,
Daniel Dunbard52864b2010-02-14 10:02:57 +000047 end_line, end_column);
Daniel Dunbar51b058c2010-02-14 08:32:24 +000048}
49
Ted Kremenek1c6da172009-11-17 19:37:36 +000050static unsigned CreateTranslationUnit(CXIndex Idx, const char *file,
51 CXTranslationUnit *TU) {
Ted Kremeneke68fff62010-02-17 00:41:32 +000052
Douglas Gregora88084b2010-02-18 18:08:43 +000053 *TU = clang_createTranslationUnit(Idx, file);
Dan Gohman6be2a222010-07-26 21:44:15 +000054 if (!*TU) {
Ted Kremenek1c6da172009-11-17 19:37:36 +000055 fprintf(stderr, "Unable to load translation unit from '%s'!\n", file);
56 return 0;
Ted Kremeneke68fff62010-02-17 00:41:32 +000057 }
Ted Kremenek1c6da172009-11-17 19:37:36 +000058 return 1;
59}
60
Douglas Gregor4db64a42010-01-23 00:14:00 +000061void free_remapped_files(struct CXUnsavedFile *unsaved_files,
62 int num_unsaved_files) {
63 int i;
64 for (i = 0; i != num_unsaved_files; ++i) {
65 free((char *)unsaved_files[i].Filename);
66 free((char *)unsaved_files[i].Contents);
67 }
Douglas Gregor653a55f2010-08-19 20:50:29 +000068 free(unsaved_files);
Douglas Gregor4db64a42010-01-23 00:14:00 +000069}
70
71int parse_remapped_files(int argc, const char **argv, int start_arg,
72 struct CXUnsavedFile **unsaved_files,
73 int *num_unsaved_files) {
74 int i;
75 int arg;
76 int prefix_len = strlen("-remap-file=");
77 *unsaved_files = 0;
78 *num_unsaved_files = 0;
Ted Kremeneke68fff62010-02-17 00:41:32 +000079
Douglas Gregor4db64a42010-01-23 00:14:00 +000080 /* Count the number of remapped files. */
81 for (arg = start_arg; arg < argc; ++arg) {
82 if (strncmp(argv[arg], "-remap-file=", prefix_len))
83 break;
Ted Kremeneke68fff62010-02-17 00:41:32 +000084
Douglas Gregor4db64a42010-01-23 00:14:00 +000085 ++*num_unsaved_files;
86 }
Ted Kremeneke68fff62010-02-17 00:41:32 +000087
Douglas Gregor4db64a42010-01-23 00:14:00 +000088 if (*num_unsaved_files == 0)
89 return 0;
Ted Kremeneke68fff62010-02-17 00:41:32 +000090
Douglas Gregor4db64a42010-01-23 00:14:00 +000091 *unsaved_files
Douglas Gregor653a55f2010-08-19 20:50:29 +000092 = (struct CXUnsavedFile *)malloc(sizeof(struct CXUnsavedFile) *
93 *num_unsaved_files);
Douglas Gregor4db64a42010-01-23 00:14:00 +000094 for (arg = start_arg, i = 0; i != *num_unsaved_files; ++i, ++arg) {
95 struct CXUnsavedFile *unsaved = *unsaved_files + i;
96 const char *arg_string = argv[arg] + prefix_len;
97 int filename_len;
98 char *filename;
99 char *contents;
100 FILE *to_file;
101 const char *semi = strchr(arg_string, ';');
102 if (!semi) {
Ted Kremeneke68fff62010-02-17 00:41:32 +0000103 fprintf(stderr,
Douglas Gregor4db64a42010-01-23 00:14:00 +0000104 "error: -remap-file=from;to argument is missing semicolon\n");
105 free_remapped_files(*unsaved_files, i);
106 *unsaved_files = 0;
107 *num_unsaved_files = 0;
108 return -1;
109 }
Ted Kremeneke68fff62010-02-17 00:41:32 +0000110
Douglas Gregor4db64a42010-01-23 00:14:00 +0000111 /* Open the file that we're remapping to. */
112 to_file = fopen(semi + 1, "r");
113 if (!to_file) {
114 fprintf(stderr, "error: cannot open file %s that we are remapping to\n",
115 semi + 1);
116 free_remapped_files(*unsaved_files, i);
117 *unsaved_files = 0;
118 *num_unsaved_files = 0;
119 return -1;
120 }
Ted Kremeneke68fff62010-02-17 00:41:32 +0000121
Douglas Gregor4db64a42010-01-23 00:14:00 +0000122 /* Determine the length of the file we're remapping to. */
123 fseek(to_file, 0, SEEK_END);
124 unsaved->Length = ftell(to_file);
125 fseek(to_file, 0, SEEK_SET);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000126
Douglas Gregor4db64a42010-01-23 00:14:00 +0000127 /* Read the contents of the file we're remapping to. */
128 contents = (char *)malloc(unsaved->Length + 1);
129 if (fread(contents, 1, unsaved->Length, to_file) != unsaved->Length) {
130 fprintf(stderr, "error: unexpected %s reading 'to' file %s\n",
131 (feof(to_file) ? "EOF" : "error"), semi + 1);
132 fclose(to_file);
133 free_remapped_files(*unsaved_files, i);
134 *unsaved_files = 0;
135 *num_unsaved_files = 0;
136 return -1;
137 }
138 contents[unsaved->Length] = 0;
139 unsaved->Contents = contents;
Ted Kremeneke68fff62010-02-17 00:41:32 +0000140
Douglas Gregor4db64a42010-01-23 00:14:00 +0000141 /* Close the file. */
142 fclose(to_file);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000143
Douglas Gregor4db64a42010-01-23 00:14:00 +0000144 /* Copy the file name that we're remapping from. */
145 filename_len = semi - arg_string;
146 filename = (char *)malloc(filename_len + 1);
147 memcpy(filename, arg_string, filename_len);
148 filename[filename_len] = 0;
149 unsaved->Filename = filename;
150 }
Ted Kremeneke68fff62010-02-17 00:41:32 +0000151
Douglas Gregor4db64a42010-01-23 00:14:00 +0000152 return 0;
153}
154
Ted Kremenek0d435192009-11-17 18:13:31 +0000155/******************************************************************************/
156/* Pretty-printing. */
157/******************************************************************************/
158
Steve Naroffaf08ddc2009-09-03 15:49:00 +0000159static void PrintCursor(CXCursor Cursor) {
Ted Kremeneke68fff62010-02-17 00:41:32 +0000160 if (clang_isInvalid(Cursor.kind)) {
161 CXString ks = clang_getCursorKindSpelling(Cursor.kind);
162 printf("Invalid Cursor => %s", clang_getCString(ks));
163 clang_disposeString(ks);
164 }
Steve Naroff699a07d2009-09-25 21:32:34 +0000165 else {
Ted Kremeneke68fff62010-02-17 00:41:32 +0000166 CXString string, ks;
Douglas Gregorc5d1e932010-01-19 01:20:04 +0000167 CXCursor Referenced;
Douglas Gregor1db19de2010-01-19 21:36:55 +0000168 unsigned line, column;
Ted Kremeneke68fff62010-02-17 00:41:32 +0000169
170 ks = clang_getCursorKindSpelling(Cursor.kind);
Steve Naroffef0cef62009-11-09 17:45:52 +0000171 string = clang_getCursorSpelling(Cursor);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000172 printf("%s=%s", clang_getCString(ks),
173 clang_getCString(string));
174 clang_disposeString(ks);
Steve Naroffef0cef62009-11-09 17:45:52 +0000175 clang_disposeString(string);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000176
Douglas Gregorc5d1e932010-01-19 01:20:04 +0000177 Referenced = clang_getCursorReferenced(Cursor);
178 if (!clang_equalCursors(Referenced, clang_getNullCursor())) {
179 CXSourceLocation Loc = clang_getCursorLocation(Referenced);
Douglas Gregor46766dc2010-01-26 19:19:08 +0000180 clang_getInstantiationLocation(Loc, 0, &line, &column, 0);
Douglas Gregor1db19de2010-01-19 21:36:55 +0000181 printf(":%d:%d", line, column);
Douglas Gregorc5d1e932010-01-19 01:20:04 +0000182 }
Douglas Gregorb6998662010-01-19 19:34:47 +0000183
184 if (clang_isCursorDefinition(Cursor))
185 printf(" (Definition)");
Douglas Gregor58ddb602010-08-23 23:00:57 +0000186
187 switch (clang_getCursorAvailability(Cursor)) {
188 case CXAvailability_Available:
189 break;
190
191 case CXAvailability_Deprecated:
192 printf(" (deprecated)");
193 break;
194
195 case CXAvailability_NotAvailable:
196 printf(" (unavailable)");
197 break;
198 }
Steve Naroff699a07d2009-09-25 21:32:34 +0000199 }
Steve Naroffaf08ddc2009-09-03 15:49:00 +0000200}
Steve Naroff89922f82009-08-31 00:59:03 +0000201
Ted Kremeneke68fff62010-02-17 00:41:32 +0000202static const char* GetCursorSource(CXCursor Cursor) {
Douglas Gregor1db19de2010-01-19 21:36:55 +0000203 CXSourceLocation Loc = clang_getCursorLocation(Cursor);
Ted Kremenek74844072010-02-17 00:41:20 +0000204 CXString source;
Douglas Gregor1db19de2010-01-19 21:36:55 +0000205 CXFile file;
Douglas Gregor46766dc2010-01-26 19:19:08 +0000206 clang_getInstantiationLocation(Loc, &file, 0, 0, 0);
Douglas Gregor1db19de2010-01-19 21:36:55 +0000207 source = clang_getFileName(file);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000208 if (!clang_getCString(source)) {
Ted Kremenek74844072010-02-17 00:41:20 +0000209 clang_disposeString(source);
210 return "<invalid loc>";
211 }
212 else {
Ted Kremeneke68fff62010-02-17 00:41:32 +0000213 const char *b = basename(clang_getCString(source));
Ted Kremenek74844072010-02-17 00:41:20 +0000214 clang_disposeString(source);
215 return b;
216 }
Ted Kremenek9298cfc2009-11-17 05:31:58 +0000217}
218
Ted Kremenek0d435192009-11-17 18:13:31 +0000219/******************************************************************************/
Ted Kremenekce2ae882010-01-26 17:59:48 +0000220/* Callbacks. */
221/******************************************************************************/
222
223typedef void (*PostVisitTU)(CXTranslationUnit);
224
Douglas Gregora88084b2010-02-18 18:08:43 +0000225void PrintDiagnostic(CXDiagnostic Diagnostic) {
226 FILE *out = stderr;
Douglas Gregor5352ac02010-01-28 00:27:43 +0000227 CXFile file;
Douglas Gregor274f1902010-02-22 23:17:23 +0000228 CXString Msg;
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000229 unsigned display_opts = CXDiagnostic_DisplaySourceLocation
230 | CXDiagnostic_DisplayColumn | CXDiagnostic_DisplaySourceRanges;
231 unsigned i, num_fixits;
Ted Kremenekf7b714d2010-03-25 02:00:39 +0000232
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000233 if (clang_getDiagnosticSeverity(Diagnostic) == CXDiagnostic_Ignored)
Douglas Gregor5352ac02010-01-28 00:27:43 +0000234 return;
Ted Kremeneke68fff62010-02-17 00:41:32 +0000235
Douglas Gregor274f1902010-02-22 23:17:23 +0000236 Msg = clang_formatDiagnostic(Diagnostic, display_opts);
237 fprintf(stderr, "%s\n", clang_getCString(Msg));
238 clang_disposeString(Msg);
Ted Kremenekf7b714d2010-03-25 02:00:39 +0000239
Douglas Gregor5352ac02010-01-28 00:27:43 +0000240 clang_getInstantiationLocation(clang_getDiagnosticLocation(Diagnostic),
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000241 &file, 0, 0, 0);
242 if (!file)
243 return;
Ted Kremeneke68fff62010-02-17 00:41:32 +0000244
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000245 num_fixits = clang_getDiagnosticNumFixIts(Diagnostic);
246 for (i = 0; i != num_fixits; ++i) {
Douglas Gregor473d7012010-02-19 18:16:06 +0000247 CXSourceRange range;
248 CXString insertion_text = clang_getDiagnosticFixIt(Diagnostic, i, &range);
249 CXSourceLocation start = clang_getRangeStart(range);
250 CXSourceLocation end = clang_getRangeEnd(range);
251 unsigned start_line, start_column, end_line, end_column;
252 CXFile start_file, end_file;
Ted Kremenekf7b714d2010-03-25 02:00:39 +0000253 clang_getInstantiationLocation(start, &start_file, &start_line,
Douglas Gregor473d7012010-02-19 18:16:06 +0000254 &start_column, 0);
255 clang_getInstantiationLocation(end, &end_file, &end_line, &end_column, 0);
256 if (clang_equalLocations(start, end)) {
257 /* Insertion. */
258 if (start_file == file)
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000259 fprintf(out, "FIX-IT: Insert \"%s\" at %d:%d\n",
Douglas Gregor473d7012010-02-19 18:16:06 +0000260 clang_getCString(insertion_text), start_line, start_column);
261 } else if (strcmp(clang_getCString(insertion_text), "") == 0) {
262 /* Removal. */
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000263 if (start_file == file && end_file == file) {
264 fprintf(out, "FIX-IT: Remove ");
265 PrintExtent(out, start_line, start_column, end_line, end_column);
266 fprintf(out, "\n");
Douglas Gregor51c6d382010-01-29 00:41:11 +0000267 }
Douglas Gregor473d7012010-02-19 18:16:06 +0000268 } else {
269 /* Replacement. */
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000270 if (start_file == end_file) {
271 fprintf(out, "FIX-IT: Replace ");
272 PrintExtent(out, start_line, start_column, end_line, end_column);
Douglas Gregor473d7012010-02-19 18:16:06 +0000273 fprintf(out, " with \"%s\"\n", clang_getCString(insertion_text));
Douglas Gregor436f3f02010-02-18 22:27:07 +0000274 }
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000275 break;
276 }
Douglas Gregor473d7012010-02-19 18:16:06 +0000277 clang_disposeString(insertion_text);
Douglas Gregor51c6d382010-01-29 00:41:11 +0000278 }
Douglas Gregor5352ac02010-01-28 00:27:43 +0000279}
280
Douglas Gregora88084b2010-02-18 18:08:43 +0000281void PrintDiagnostics(CXTranslationUnit TU) {
282 int i, n = clang_getNumDiagnostics(TU);
283 for (i = 0; i != n; ++i) {
284 CXDiagnostic Diag = clang_getDiagnostic(TU, i);
285 PrintDiagnostic(Diag);
286 clang_disposeDiagnostic(Diag);
287 }
288}
289
Ted Kremenekce2ae882010-01-26 17:59:48 +0000290/******************************************************************************/
Douglas Gregore5b72ba2010-01-20 21:32:04 +0000291/* Logic for testing traversal. */
Ted Kremenek0d435192009-11-17 18:13:31 +0000292/******************************************************************************/
293
Ted Kremenekfe6fd3d2010-01-05 23:18:49 +0000294static const char *FileCheckPrefix = "CHECK";
295
Douglas Gregora7bde202010-01-19 00:34:46 +0000296static void PrintCursorExtent(CXCursor C) {
297 CXSourceRange extent = clang_getCursorExtent(C);
Douglas Gregor1db19de2010-01-19 21:36:55 +0000298 CXFile begin_file, end_file;
299 unsigned begin_line, begin_column, end_line, end_column;
Ted Kremeneke68fff62010-02-17 00:41:32 +0000300
Douglas Gregor1db19de2010-01-19 21:36:55 +0000301 clang_getInstantiationLocation(clang_getRangeStart(extent),
Douglas Gregor46766dc2010-01-26 19:19:08 +0000302 &begin_file, &begin_line, &begin_column, 0);
Douglas Gregor1db19de2010-01-19 21:36:55 +0000303 clang_getInstantiationLocation(clang_getRangeEnd(extent),
Douglas Gregor46766dc2010-01-26 19:19:08 +0000304 &end_file, &end_line, &end_column, 0);
Douglas Gregor1db19de2010-01-19 21:36:55 +0000305 if (!begin_file || !end_file)
Ted Kremenek70ee5422010-01-16 01:44:12 +0000306 return;
Douglas Gregor1db19de2010-01-19 21:36:55 +0000307
Daniel Dunbar51b058c2010-02-14 08:32:24 +0000308 printf(" Extent=");
309 PrintExtent(stdout, begin_line, begin_column, end_line, end_column);
Ted Kremenekfe6fd3d2010-01-05 23:18:49 +0000310}
311
Douglas Gregore5b72ba2010-01-20 21:32:04 +0000312/* Data used by all of the visitors. */
313typedef struct {
314 CXTranslationUnit TU;
315 enum CXCursorKind *Filter;
316} VisitorData;
Ted Kremenekfe6fd3d2010-01-05 23:18:49 +0000317
Daniel Dunbar625e4ef2009-12-01 02:35:37 +0000318
Ted Kremeneke68fff62010-02-17 00:41:32 +0000319enum CXChildVisitResult FilteredPrintingVisitor(CXCursor Cursor,
Douglas Gregore5b72ba2010-01-20 21:32:04 +0000320 CXCursor Parent,
321 CXClientData ClientData) {
322 VisitorData *Data = (VisitorData *)ClientData;
323 if (!Data->Filter || (Cursor.kind == *(enum CXCursorKind *)Data->Filter)) {
Douglas Gregor98258af2010-01-18 22:46:11 +0000324 CXSourceLocation Loc = clang_getCursorLocation(Cursor);
Douglas Gregor1db19de2010-01-19 21:36:55 +0000325 unsigned line, column;
Douglas Gregor46766dc2010-01-26 19:19:08 +0000326 clang_getInstantiationLocation(Loc, 0, &line, &column, 0);
Ted Kremenekfe6fd3d2010-01-05 23:18:49 +0000327 printf("// %s: %s:%d:%d: ", FileCheckPrefix,
Douglas Gregor1db19de2010-01-19 21:36:55 +0000328 GetCursorSource(Cursor), line, column);
Steve Naroffaf08ddc2009-09-03 15:49:00 +0000329 PrintCursor(Cursor);
Douglas Gregora7bde202010-01-19 00:34:46 +0000330 PrintCursorExtent(Cursor);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000331 printf("\n");
Douglas Gregore5b72ba2010-01-20 21:32:04 +0000332 return CXChildVisit_Recurse;
Steve Naroff2d4d6292009-08-31 14:26:51 +0000333 }
Ted Kremeneke68fff62010-02-17 00:41:32 +0000334
Douglas Gregore5b72ba2010-01-20 21:32:04 +0000335 return CXChildVisit_Continue;
Steve Naroff89922f82009-08-31 00:59:03 +0000336}
Steve Naroff50398192009-08-28 15:28:48 +0000337
Ted Kremeneke68fff62010-02-17 00:41:32 +0000338static enum CXChildVisitResult FunctionScanVisitor(CXCursor Cursor,
Douglas Gregore5b72ba2010-01-20 21:32:04 +0000339 CXCursor Parent,
340 CXClientData ClientData) {
Daniel Dunbar625e4ef2009-12-01 02:35:37 +0000341 const char *startBuf, *endBuf;
342 unsigned startLine, startColumn, endLine, endColumn, curLine, curColumn;
343 CXCursor Ref;
Douglas Gregore5b72ba2010-01-20 21:32:04 +0000344 VisitorData *Data = (VisitorData *)ClientData;
Daniel Dunbar625e4ef2009-12-01 02:35:37 +0000345
Douglas Gregorb6998662010-01-19 19:34:47 +0000346 if (Cursor.kind != CXCursor_FunctionDecl ||
347 !clang_isCursorDefinition(Cursor))
Douglas Gregore5b72ba2010-01-20 21:32:04 +0000348 return CXChildVisit_Continue;
Daniel Dunbar625e4ef2009-12-01 02:35:37 +0000349
350 clang_getDefinitionSpellingAndExtent(Cursor, &startBuf, &endBuf,
351 &startLine, &startColumn,
352 &endLine, &endColumn);
353 /* Probe the entire body, looking for both decls and refs. */
354 curLine = startLine;
355 curColumn = startColumn;
356
357 while (startBuf < endBuf) {
Douglas Gregor98258af2010-01-18 22:46:11 +0000358 CXSourceLocation Loc;
Douglas Gregor1db19de2010-01-19 21:36:55 +0000359 CXFile file;
Ted Kremenek74844072010-02-17 00:41:20 +0000360 CXString source;
Ted Kremeneke68fff62010-02-17 00:41:32 +0000361
Daniel Dunbar625e4ef2009-12-01 02:35:37 +0000362 if (*startBuf == '\n') {
363 startBuf++;
364 curLine++;
365 curColumn = 1;
366 } else if (*startBuf != '\t')
367 curColumn++;
Ted Kremeneke68fff62010-02-17 00:41:32 +0000368
Douglas Gregor98258af2010-01-18 22:46:11 +0000369 Loc = clang_getCursorLocation(Cursor);
Douglas Gregor46766dc2010-01-26 19:19:08 +0000370 clang_getInstantiationLocation(Loc, &file, 0, 0, 0);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000371
Douglas Gregor1db19de2010-01-19 21:36:55 +0000372 source = clang_getFileName(file);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000373 if (clang_getCString(source)) {
Douglas Gregorb9790342010-01-22 21:44:22 +0000374 CXSourceLocation RefLoc
375 = clang_getLocation(Data->TU, file, curLine, curColumn);
376 Ref = clang_getCursor(Data->TU, RefLoc);
Douglas Gregor98258af2010-01-18 22:46:11 +0000377 if (Ref.kind == CXCursor_NoDeclFound) {
378 /* Nothing found here; that's fine. */
379 } else if (Ref.kind != CXCursor_FunctionDecl) {
380 printf("// %s: %s:%d:%d: ", FileCheckPrefix, GetCursorSource(Ref),
381 curLine, curColumn);
382 PrintCursor(Ref);
383 printf("\n");
384 }
Daniel Dunbar625e4ef2009-12-01 02:35:37 +0000385 }
Ted Kremenek74844072010-02-17 00:41:20 +0000386 clang_disposeString(source);
Daniel Dunbar625e4ef2009-12-01 02:35:37 +0000387 startBuf++;
388 }
Ted Kremeneke68fff62010-02-17 00:41:32 +0000389
Douglas Gregore5b72ba2010-01-20 21:32:04 +0000390 return CXChildVisit_Continue;
Daniel Dunbar625e4ef2009-12-01 02:35:37 +0000391}
392
Ted Kremenek7d405622010-01-12 23:34:26 +0000393/******************************************************************************/
394/* USR testing. */
395/******************************************************************************/
396
Douglas Gregore5b72ba2010-01-20 21:32:04 +0000397enum CXChildVisitResult USRVisitor(CXCursor C, CXCursor parent,
398 CXClientData ClientData) {
399 VisitorData *Data = (VisitorData *)ClientData;
400 if (!Data->Filter || (C.kind == *(enum CXCursorKind *)Data->Filter)) {
Ted Kremenekcf84aa42010-01-18 20:23:29 +0000401 CXString USR = clang_getCursorUSR(C);
Ted Kremeneke542f772010-04-20 23:15:40 +0000402 const char *cstr = clang_getCString(USR);
403 if (!cstr || cstr[0] == '\0') {
Ted Kremenek7d405622010-01-12 23:34:26 +0000404 clang_disposeString(USR);
Ted Kremeneke74ef122010-04-16 21:31:52 +0000405 return CXChildVisit_Recurse;
Ted Kremenek7d405622010-01-12 23:34:26 +0000406 }
Ted Kremeneke542f772010-04-20 23:15:40 +0000407 printf("// %s: %s %s", FileCheckPrefix, GetCursorSource(C), cstr);
408
Douglas Gregora7bde202010-01-19 00:34:46 +0000409 PrintCursorExtent(C);
Ted Kremenek7d405622010-01-12 23:34:26 +0000410 printf("\n");
411 clang_disposeString(USR);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000412
Douglas Gregore5b72ba2010-01-20 21:32:04 +0000413 return CXChildVisit_Recurse;
Ted Kremeneke68fff62010-02-17 00:41:32 +0000414 }
415
Douglas Gregore5b72ba2010-01-20 21:32:04 +0000416 return CXChildVisit_Continue;
Ted Kremenek7d405622010-01-12 23:34:26 +0000417}
418
419/******************************************************************************/
Ted Kremenek16b55a72010-01-26 19:31:51 +0000420/* Inclusion stack testing. */
421/******************************************************************************/
422
423void InclusionVisitor(CXFile includedFile, CXSourceLocation *includeStack,
424 unsigned includeStackLen, CXClientData data) {
Ted Kremeneke68fff62010-02-17 00:41:32 +0000425
Ted Kremenek16b55a72010-01-26 19:31:51 +0000426 unsigned i;
Ted Kremenek74844072010-02-17 00:41:20 +0000427 CXString fname;
428
429 fname = clang_getFileName(includedFile);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000430 printf("file: %s\nincluded by:\n", clang_getCString(fname));
Ted Kremenek74844072010-02-17 00:41:20 +0000431 clang_disposeString(fname);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000432
Ted Kremenek16b55a72010-01-26 19:31:51 +0000433 for (i = 0; i < includeStackLen; ++i) {
434 CXFile includingFile;
435 unsigned line, column;
436 clang_getInstantiationLocation(includeStack[i], &includingFile, &line,
437 &column, 0);
Ted Kremenek74844072010-02-17 00:41:20 +0000438 fname = clang_getFileName(includingFile);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000439 printf(" %s:%d:%d\n", clang_getCString(fname), line, column);
Ted Kremenek74844072010-02-17 00:41:20 +0000440 clang_disposeString(fname);
Ted Kremenek16b55a72010-01-26 19:31:51 +0000441 }
442 printf("\n");
443}
444
445void PrintInclusionStack(CXTranslationUnit TU) {
Ted Kremeneke68fff62010-02-17 00:41:32 +0000446 clang_getInclusions(TU, InclusionVisitor, NULL);
Ted Kremenek16b55a72010-01-26 19:31:51 +0000447}
448
449/******************************************************************************/
Ted Kremenek3bed5272010-03-03 06:37:58 +0000450/* Linkage testing. */
451/******************************************************************************/
452
453static enum CXChildVisitResult PrintLinkage(CXCursor cursor, CXCursor p,
454 CXClientData d) {
455 const char *linkage = 0;
456
457 if (clang_isInvalid(clang_getCursorKind(cursor)))
458 return CXChildVisit_Recurse;
459
460 switch (clang_getCursorLinkage(cursor)) {
461 case CXLinkage_Invalid: break;
Douglas Gregorc2a2b3c2010-03-04 19:36:27 +0000462 case CXLinkage_NoLinkage: linkage = "NoLinkage"; break;
463 case CXLinkage_Internal: linkage = "Internal"; break;
464 case CXLinkage_UniqueExternal: linkage = "UniqueExternal"; break;
465 case CXLinkage_External: linkage = "External"; break;
Ted Kremenek3bed5272010-03-03 06:37:58 +0000466 }
467
468 if (linkage) {
469 PrintCursor(cursor);
470 printf("linkage=%s\n", linkage);
471 }
472
473 return CXChildVisit_Recurse;
474}
475
476/******************************************************************************/
Ted Kremenek8e0ac172010-05-14 21:29:26 +0000477/* Typekind testing. */
478/******************************************************************************/
479
480static enum CXChildVisitResult PrintTypeKind(CXCursor cursor, CXCursor p,
481 CXClientData d) {
482
483 if (!clang_isInvalid(clang_getCursorKind(cursor))) {
484 CXType T = clang_getCursorType(cursor);
Ted Kremenek8e0ac172010-05-14 21:29:26 +0000485 CXString S = clang_getTypeKindSpelling(T.kind);
486 PrintCursor(cursor);
487 printf(" typekind=%s", clang_getCString(S));
Ted Kremenek8e0ac172010-05-14 21:29:26 +0000488 clang_disposeString(S);
Benjamin Kramere1403d22010-06-22 09:29:44 +0000489 /* Print the canonical type if it is different. */
Ted Kremenek04c3cf32010-06-21 20:15:39 +0000490 {
491 CXType CT = clang_getCanonicalType(T);
492 if (!clang_equalTypes(T, CT)) {
493 CXString CS = clang_getTypeKindSpelling(CT.kind);
494 printf(" [canonical=%s]", clang_getCString(CS));
495 clang_disposeString(CS);
496 }
497 }
Benjamin Kramere1403d22010-06-22 09:29:44 +0000498 /* Print the return type if it exists. */
Ted Kremenek04c3cf32010-06-21 20:15:39 +0000499 {
Ted Kremenek9a140842010-06-21 20:48:56 +0000500 CXType RT = clang_getCursorResultType(cursor);
Ted Kremenek04c3cf32010-06-21 20:15:39 +0000501 if (RT.kind != CXType_Invalid) {
502 CXString RS = clang_getTypeKindSpelling(RT.kind);
503 printf(" [result=%s]", clang_getCString(RS));
504 clang_disposeString(RS);
505 }
506 }
Ted Kremenek3ce9e7d2010-07-30 00:14:11 +0000507 /* Print if this is a non-POD type. */
508 printf(" [isPOD=%d]", clang_isPODType(T));
Ted Kremenek04c3cf32010-06-21 20:15:39 +0000509
Ted Kremenek8e0ac172010-05-14 21:29:26 +0000510 printf("\n");
511 }
512 return CXChildVisit_Recurse;
513}
514
515
516/******************************************************************************/
Ted Kremenek7d405622010-01-12 23:34:26 +0000517/* Loading ASTs/source. */
518/******************************************************************************/
519
Daniel Dunbar625e4ef2009-12-01 02:35:37 +0000520static int perform_test_load(CXIndex Idx, CXTranslationUnit TU,
Ted Kremenek98271562010-01-12 18:53:15 +0000521 const char *filter, const char *prefix,
Ted Kremenekce2ae882010-01-26 17:59:48 +0000522 CXCursorVisitor Visitor,
523 PostVisitTU PV) {
Ted Kremeneke68fff62010-02-17 00:41:32 +0000524
Ted Kremenekfe6fd3d2010-01-05 23:18:49 +0000525 if (prefix)
Ted Kremeneke68fff62010-02-17 00:41:32 +0000526 FileCheckPrefix = prefix;
Ted Kremeneke3ee02a2010-01-26 17:55:33 +0000527
528 if (Visitor) {
529 enum CXCursorKind K = CXCursor_NotImplemented;
530 enum CXCursorKind *ck = &K;
531 VisitorData Data;
Ted Kremeneke68fff62010-02-17 00:41:32 +0000532
Ted Kremeneke3ee02a2010-01-26 17:55:33 +0000533 /* Perform some simple filtering. */
534 if (!strcmp(filter, "all") || !strcmp(filter, "local")) ck = NULL;
Daniel Dunbarb1ffee62010-02-10 20:42:40 +0000535 else if (!strcmp(filter, "none")) K = (enum CXCursorKind) ~0;
Ted Kremeneke3ee02a2010-01-26 17:55:33 +0000536 else if (!strcmp(filter, "category")) K = CXCursor_ObjCCategoryDecl;
537 else if (!strcmp(filter, "interface")) K = CXCursor_ObjCInterfaceDecl;
538 else if (!strcmp(filter, "protocol")) K = CXCursor_ObjCProtocolDecl;
539 else if (!strcmp(filter, "function")) K = CXCursor_FunctionDecl;
540 else if (!strcmp(filter, "typedef")) K = CXCursor_TypedefDecl;
541 else if (!strcmp(filter, "scan-function")) Visitor = FunctionScanVisitor;
542 else {
543 fprintf(stderr, "Unknown filter for -test-load-tu: %s\n", filter);
544 return 1;
545 }
Ted Kremeneke68fff62010-02-17 00:41:32 +0000546
Ted Kremeneke3ee02a2010-01-26 17:55:33 +0000547 Data.TU = TU;
548 Data.Filter = ck;
549 clang_visitChildren(clang_getTranslationUnitCursor(TU), Visitor, &Data);
Ted Kremenek0d435192009-11-17 18:13:31 +0000550 }
Ted Kremeneke68fff62010-02-17 00:41:32 +0000551
Ted Kremenekce2ae882010-01-26 17:59:48 +0000552 if (PV)
553 PV(TU);
Ted Kremeneke3ee02a2010-01-26 17:55:33 +0000554
Douglas Gregora88084b2010-02-18 18:08:43 +0000555 PrintDiagnostics(TU);
Ted Kremenek0d435192009-11-17 18:13:31 +0000556 clang_disposeTranslationUnit(TU);
557 return 0;
558}
559
Ted Kremenekfe6fd3d2010-01-05 23:18:49 +0000560int perform_test_load_tu(const char *file, const char *filter,
Ted Kremenekce2ae882010-01-26 17:59:48 +0000561 const char *prefix, CXCursorVisitor Visitor,
562 PostVisitTU PV) {
Daniel Dunbar625e4ef2009-12-01 02:35:37 +0000563 CXIndex Idx;
564 CXTranslationUnit TU;
Ted Kremenek020a0952010-02-11 07:41:25 +0000565 int result;
Ted Kremeneke68fff62010-02-17 00:41:32 +0000566 Idx = clang_createIndex(/* excludeDeclsFromPCH */
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000567 !strcmp(filter, "local") ? 1 : 0,
568 /* displayDiagnosics=*/1);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000569
Ted Kremenek020a0952010-02-11 07:41:25 +0000570 if (!CreateTranslationUnit(Idx, file, &TU)) {
571 clang_disposeIndex(Idx);
Daniel Dunbar625e4ef2009-12-01 02:35:37 +0000572 return 1;
Ted Kremenek020a0952010-02-11 07:41:25 +0000573 }
Daniel Dunbar625e4ef2009-12-01 02:35:37 +0000574
Ted Kremenek020a0952010-02-11 07:41:25 +0000575 result = perform_test_load(Idx, TU, filter, prefix, Visitor, PV);
576 clang_disposeIndex(Idx);
577 return result;
Daniel Dunbar625e4ef2009-12-01 02:35:37 +0000578}
579
Ted Kremenekce2ae882010-01-26 17:59:48 +0000580int perform_test_load_source(int argc, const char **argv,
581 const char *filter, CXCursorVisitor Visitor,
582 PostVisitTU PV) {
Daniel Dunbar8506dde2009-12-03 01:54:28 +0000583 const char *UseExternalASTs =
584 getenv("CINDEXTEST_USE_EXTERNAL_AST_GENERATION");
Daniel Dunbarada487d2009-12-01 02:03:10 +0000585 CXIndex Idx;
586 CXTranslationUnit TU;
Douglas Gregor4db64a42010-01-23 00:14:00 +0000587 struct CXUnsavedFile *unsaved_files = 0;
588 int num_unsaved_files = 0;
589 int result;
Douglas Gregorabc563f2010-07-19 21:46:24 +0000590
Daniel Dunbarada487d2009-12-01 02:03:10 +0000591 Idx = clang_createIndex(/* excludeDeclsFromPCH */
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000592 !strcmp(filter, "local") ? 1 : 0,
593 /* displayDiagnosics=*/1);
Daniel Dunbarada487d2009-12-01 02:03:10 +0000594
Daniel Dunbar8506dde2009-12-03 01:54:28 +0000595 if (UseExternalASTs && strlen(UseExternalASTs))
596 clang_setUseExternalASTGeneration(Idx, 1);
597
Ted Kremenek020a0952010-02-11 07:41:25 +0000598 if (parse_remapped_files(argc, argv, 0, &unsaved_files, &num_unsaved_files)) {
599 clang_disposeIndex(Idx);
Douglas Gregor4db64a42010-01-23 00:14:00 +0000600 return -1;
Ted Kremenek020a0952010-02-11 07:41:25 +0000601 }
Douglas Gregor4db64a42010-01-23 00:14:00 +0000602
Ted Kremeneke68fff62010-02-17 00:41:32 +0000603 TU = clang_createTranslationUnitFromSourceFile(Idx, 0,
604 argc - num_unsaved_files,
Douglas Gregor4db64a42010-01-23 00:14:00 +0000605 argv + num_unsaved_files,
606 num_unsaved_files,
Douglas Gregora88084b2010-02-18 18:08:43 +0000607 unsaved_files);
Daniel Dunbarada487d2009-12-01 02:03:10 +0000608 if (!TU) {
609 fprintf(stderr, "Unable to load translation unit!\n");
Douglas Gregorabc563f2010-07-19 21:46:24 +0000610 free_remapped_files(unsaved_files, num_unsaved_files);
Ted Kremenek020a0952010-02-11 07:41:25 +0000611 clang_disposeIndex(Idx);
Daniel Dunbarada487d2009-12-01 02:03:10 +0000612 return 1;
613 }
614
Ted Kremenekce2ae882010-01-26 17:59:48 +0000615 result = perform_test_load(Idx, TU, filter, NULL, Visitor, PV);
Douglas Gregor4db64a42010-01-23 00:14:00 +0000616 free_remapped_files(unsaved_files, num_unsaved_files);
Ted Kremenek020a0952010-02-11 07:41:25 +0000617 clang_disposeIndex(Idx);
Douglas Gregor4db64a42010-01-23 00:14:00 +0000618 return result;
Daniel Dunbarada487d2009-12-01 02:03:10 +0000619}
620
Douglas Gregorabc563f2010-07-19 21:46:24 +0000621int perform_test_reparse_source(int argc, const char **argv, int trials,
622 const char *filter, CXCursorVisitor Visitor,
623 PostVisitTU PV) {
624 const char *UseExternalASTs =
625 getenv("CINDEXTEST_USE_EXTERNAL_AST_GENERATION");
626 CXIndex Idx;
627 CXTranslationUnit TU;
628 struct CXUnsavedFile *unsaved_files = 0;
629 int num_unsaved_files = 0;
630 int result;
631 int trial;
632
633 Idx = clang_createIndex(/* excludeDeclsFromPCH */
634 !strcmp(filter, "local") ? 1 : 0,
635 /* displayDiagnosics=*/1);
636
637 if (UseExternalASTs && strlen(UseExternalASTs))
638 clang_setUseExternalASTGeneration(Idx, 1);
639
640 if (parse_remapped_files(argc, argv, 0, &unsaved_files, &num_unsaved_files)) {
641 clang_disposeIndex(Idx);
642 return -1;
643 }
644
Daniel Dunbarc8a61802010-08-18 23:09:16 +0000645 /* Load the initial translation unit -- we do this without honoring remapped
646 * files, so that we have a way to test results after changing the source. */
Douglas Gregor44c181a2010-07-23 00:33:23 +0000647 TU = clang_parseTranslationUnit(Idx, 0,
648 argv + num_unsaved_files,
649 argc - num_unsaved_files,
Daniel Dunbarc8a61802010-08-18 23:09:16 +0000650 0, 0, getDefaultParsingOptions());
Douglas Gregorabc563f2010-07-19 21:46:24 +0000651 if (!TU) {
652 fprintf(stderr, "Unable to load translation unit!\n");
653 free_remapped_files(unsaved_files, num_unsaved_files);
654 clang_disposeIndex(Idx);
655 return 1;
656 }
657
658 for (trial = 0; trial < trials; ++trial) {
Douglas Gregore1e13bf2010-08-11 15:58:42 +0000659 if (clang_reparseTranslationUnit(TU, num_unsaved_files, unsaved_files,
660 clang_defaultReparseOptions(TU))) {
Daniel Dunbarc8a61802010-08-18 23:09:16 +0000661 fprintf(stderr, "Unable to reparse translation unit!\n");
Douglas Gregorabc563f2010-07-19 21:46:24 +0000662 clang_disposeTranslationUnit(TU);
663 free_remapped_files(unsaved_files, num_unsaved_files);
664 clang_disposeIndex(Idx);
665 return -1;
666 }
667 }
668
669 result = perform_test_load(Idx, TU, filter, NULL, Visitor, PV);
670 free_remapped_files(unsaved_files, num_unsaved_files);
671 clang_disposeIndex(Idx);
672 return result;
673}
674
Ted Kremenek0d435192009-11-17 18:13:31 +0000675/******************************************************************************/
Ted Kremenek1c6da172009-11-17 19:37:36 +0000676/* Logic for testing clang_getCursor(). */
677/******************************************************************************/
678
679static void print_cursor_file_scan(CXCursor cursor,
680 unsigned start_line, unsigned start_col,
Ted Kremenek1d5fdf32009-11-18 02:02:52 +0000681 unsigned end_line, unsigned end_col,
682 const char *prefix) {
Ted Kremenek9096a202010-01-07 01:17:12 +0000683 printf("// %s: ", FileCheckPrefix);
Ted Kremenek1d5fdf32009-11-18 02:02:52 +0000684 if (prefix)
685 printf("-%s", prefix);
Daniel Dunbar51b058c2010-02-14 08:32:24 +0000686 PrintExtent(stdout, start_line, start_col, end_line, end_col);
687 printf(" ");
Ted Kremenek1c6da172009-11-17 19:37:36 +0000688 PrintCursor(cursor);
689 printf("\n");
690}
691
Ted Kremenek1d5fdf32009-11-18 02:02:52 +0000692static int perform_file_scan(const char *ast_file, const char *source_file,
693 const char *prefix) {
Ted Kremenek1c6da172009-11-17 19:37:36 +0000694 CXIndex Idx;
695 CXTranslationUnit TU;
696 FILE *fp;
Daniel Dunbar2389eff2010-02-14 08:32:32 +0000697 CXCursor prevCursor = clang_getNullCursor();
Douglas Gregorb9790342010-01-22 21:44:22 +0000698 CXFile file;
Daniel Dunbar2389eff2010-02-14 08:32:32 +0000699 unsigned line = 1, col = 1;
Daniel Dunbar8f0bf812010-02-14 08:32:51 +0000700 unsigned start_line = 1, start_col = 1;
Ted Kremeneke68fff62010-02-17 00:41:32 +0000701
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000702 if (!(Idx = clang_createIndex(/* excludeDeclsFromPCH */ 1,
703 /* displayDiagnosics=*/1))) {
Ted Kremenek1c6da172009-11-17 19:37:36 +0000704 fprintf(stderr, "Could not create Index\n");
705 return 1;
706 }
Ted Kremeneke68fff62010-02-17 00:41:32 +0000707
Ted Kremenek1c6da172009-11-17 19:37:36 +0000708 if (!CreateTranslationUnit(Idx, ast_file, &TU))
709 return 1;
Ted Kremeneke68fff62010-02-17 00:41:32 +0000710
Ted Kremenek1c6da172009-11-17 19:37:36 +0000711 if ((fp = fopen(source_file, "r")) == NULL) {
712 fprintf(stderr, "Could not open '%s'\n", source_file);
713 return 1;
714 }
Ted Kremeneke68fff62010-02-17 00:41:32 +0000715
Douglas Gregorb9790342010-01-22 21:44:22 +0000716 file = clang_getFile(TU, source_file);
Daniel Dunbar2389eff2010-02-14 08:32:32 +0000717 for (;;) {
718 CXCursor cursor;
719 int c = fgetc(fp);
Benjamin Kramera9933b92009-11-17 20:51:40 +0000720
Daniel Dunbar2389eff2010-02-14 08:32:32 +0000721 if (c == '\n') {
722 ++line;
723 col = 1;
724 } else
725 ++col;
726
727 /* Check the cursor at this position, and dump the previous one if we have
728 * found something new.
729 */
730 cursor = clang_getCursor(TU, clang_getLocation(TU, file, line, col));
731 if ((c == EOF || !clang_equalCursors(cursor, prevCursor)) &&
732 prevCursor.kind != CXCursor_InvalidFile) {
733 print_cursor_file_scan(prevCursor, start_line, start_col,
Daniel Dunbard52864b2010-02-14 10:02:57 +0000734 line, col, prefix);
Daniel Dunbar2389eff2010-02-14 08:32:32 +0000735 start_line = line;
736 start_col = col;
Benjamin Kramera9933b92009-11-17 20:51:40 +0000737 }
Daniel Dunbar2389eff2010-02-14 08:32:32 +0000738 if (c == EOF)
739 break;
Benjamin Kramera9933b92009-11-17 20:51:40 +0000740
Daniel Dunbar2389eff2010-02-14 08:32:32 +0000741 prevCursor = cursor;
Ted Kremenek1c6da172009-11-17 19:37:36 +0000742 }
Ted Kremeneke68fff62010-02-17 00:41:32 +0000743
Ted Kremenek1c6da172009-11-17 19:37:36 +0000744 fclose(fp);
745 return 0;
746}
747
748/******************************************************************************/
Ted Kremenek0d435192009-11-17 18:13:31 +0000749/* Logic for testing clang_codeComplete(). */
750/******************************************************************************/
751
Douglas Gregor0c8296d2009-11-07 00:00:49 +0000752/* Parse file:line:column from the input string. Returns 0 on success, non-zero
753 on failure. If successful, the pointer *filename will contain newly-allocated
754 memory (that will be owned by the caller) to store the file name. */
Ted Kremeneke68fff62010-02-17 00:41:32 +0000755int parse_file_line_column(const char *input, char **filename, unsigned *line,
Douglas Gregorfc8ea232010-01-26 17:06:03 +0000756 unsigned *column, unsigned *second_line,
757 unsigned *second_column) {
Douglas Gregor88d23952009-11-09 18:19:57 +0000758 /* Find the second colon. */
Douglas Gregorfc8ea232010-01-26 17:06:03 +0000759 const char *last_colon = strrchr(input, ':');
760 unsigned values[4], i;
761 unsigned num_values = (second_line && second_column)? 4 : 2;
762
Douglas Gregor0c8296d2009-11-07 00:00:49 +0000763 char *endptr = 0;
Douglas Gregorfc8ea232010-01-26 17:06:03 +0000764 if (!last_colon || last_colon == input) {
765 if (num_values == 4)
766 fprintf(stderr, "could not parse filename:line:column:line:column in "
767 "'%s'\n", input);
768 else
769 fprintf(stderr, "could not parse filename:line:column in '%s'\n", input);
Douglas Gregor0c8296d2009-11-07 00:00:49 +0000770 return 1;
771 }
772
Douglas Gregorfc8ea232010-01-26 17:06:03 +0000773 for (i = 0; i != num_values; ++i) {
774 const char *prev_colon;
775
776 /* Parse the next line or column. */
777 values[num_values - i - 1] = strtol(last_colon + 1, &endptr, 10);
778 if (*endptr != 0 && *endptr != ':') {
Ted Kremeneke68fff62010-02-17 00:41:32 +0000779 fprintf(stderr, "could not parse %s in '%s'\n",
Douglas Gregorfc8ea232010-01-26 17:06:03 +0000780 (i % 2 ? "column" : "line"), input);
781 return 1;
782 }
Ted Kremeneke68fff62010-02-17 00:41:32 +0000783
Douglas Gregorfc8ea232010-01-26 17:06:03 +0000784 if (i + 1 == num_values)
785 break;
786
787 /* Find the previous colon. */
788 prev_colon = last_colon - 1;
789 while (prev_colon != input && *prev_colon != ':')
790 --prev_colon;
791 if (prev_colon == input) {
Ted Kremeneke68fff62010-02-17 00:41:32 +0000792 fprintf(stderr, "could not parse %s in '%s'\n",
Douglas Gregorfc8ea232010-01-26 17:06:03 +0000793 (i % 2 == 0? "column" : "line"), input);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000794 return 1;
Douglas Gregorfc8ea232010-01-26 17:06:03 +0000795 }
796
797 last_colon = prev_colon;
Douglas Gregor88d23952009-11-09 18:19:57 +0000798 }
799
Douglas Gregorfc8ea232010-01-26 17:06:03 +0000800 *line = values[0];
801 *column = values[1];
Ted Kremeneke68fff62010-02-17 00:41:32 +0000802
Douglas Gregorfc8ea232010-01-26 17:06:03 +0000803 if (second_line && second_column) {
804 *second_line = values[2];
805 *second_column = values[3];
806 }
807
Douglas Gregor88d23952009-11-09 18:19:57 +0000808 /* Copy the file name. */
Douglas Gregorfc8ea232010-01-26 17:06:03 +0000809 *filename = (char*)malloc(last_colon - input + 1);
810 memcpy(*filename, input, last_colon - input);
811 (*filename)[last_colon - input] = 0;
Douglas Gregor0c8296d2009-11-07 00:00:49 +0000812 return 0;
813}
814
815const char *
816clang_getCompletionChunkKindSpelling(enum CXCompletionChunkKind Kind) {
817 switch (Kind) {
818 case CXCompletionChunk_Optional: return "Optional";
819 case CXCompletionChunk_TypedText: return "TypedText";
820 case CXCompletionChunk_Text: return "Text";
821 case CXCompletionChunk_Placeholder: return "Placeholder";
822 case CXCompletionChunk_Informative: return "Informative";
823 case CXCompletionChunk_CurrentParameter: return "CurrentParameter";
824 case CXCompletionChunk_LeftParen: return "LeftParen";
825 case CXCompletionChunk_RightParen: return "RightParen";
826 case CXCompletionChunk_LeftBracket: return "LeftBracket";
827 case CXCompletionChunk_RightBracket: return "RightBracket";
828 case CXCompletionChunk_LeftBrace: return "LeftBrace";
829 case CXCompletionChunk_RightBrace: return "RightBrace";
830 case CXCompletionChunk_LeftAngle: return "LeftAngle";
831 case CXCompletionChunk_RightAngle: return "RightAngle";
832 case CXCompletionChunk_Comma: return "Comma";
Douglas Gregorff5ce6e2009-12-18 18:53:37 +0000833 case CXCompletionChunk_ResultType: return "ResultType";
Douglas Gregor01dfea02010-01-10 23:08:15 +0000834 case CXCompletionChunk_Colon: return "Colon";
835 case CXCompletionChunk_SemiColon: return "SemiColon";
836 case CXCompletionChunk_Equal: return "Equal";
837 case CXCompletionChunk_HorizontalSpace: return "HorizontalSpace";
838 case CXCompletionChunk_VerticalSpace: return "VerticalSpace";
Douglas Gregor0c8296d2009-11-07 00:00:49 +0000839 }
Ted Kremeneke68fff62010-02-17 00:41:32 +0000840
Douglas Gregor0c8296d2009-11-07 00:00:49 +0000841 return "Unknown";
842}
843
Douglas Gregor3ac73852009-11-09 16:04:45 +0000844void print_completion_string(CXCompletionString completion_string, FILE *file) {
Daniel Dunbarf8297f12009-11-07 18:34:24 +0000845 int I, N;
Ted Kremeneke68fff62010-02-17 00:41:32 +0000846
Douglas Gregor3ac73852009-11-09 16:04:45 +0000847 N = clang_getNumCompletionChunks(completion_string);
Douglas Gregor0c8296d2009-11-07 00:00:49 +0000848 for (I = 0; I != N; ++I) {
Ted Kremenek2ef6f8f2010-02-17 01:42:24 +0000849 CXString text;
850 const char *cstr;
Douglas Gregor0c8296d2009-11-07 00:00:49 +0000851 enum CXCompletionChunkKind Kind
Douglas Gregor3ac73852009-11-09 16:04:45 +0000852 = clang_getCompletionChunkKind(completion_string, I);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000853
Douglas Gregor3ac73852009-11-09 16:04:45 +0000854 if (Kind == CXCompletionChunk_Optional) {
855 fprintf(file, "{Optional ");
856 print_completion_string(
Ted Kremeneke68fff62010-02-17 00:41:32 +0000857 clang_getCompletionChunkCompletionString(completion_string, I),
Douglas Gregor3ac73852009-11-09 16:04:45 +0000858 file);
859 fprintf(file, "}");
860 continue;
861 }
Ted Kremeneke68fff62010-02-17 00:41:32 +0000862
Douglas Gregord5a20892009-11-09 17:05:28 +0000863 text = clang_getCompletionChunkText(completion_string, I);
Ted Kremenek2ef6f8f2010-02-17 01:42:24 +0000864 cstr = clang_getCString(text);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000865 fprintf(file, "{%s %s}",
Douglas Gregor0c8296d2009-11-07 00:00:49 +0000866 clang_getCompletionChunkKindSpelling(Kind),
Ted Kremenek2ef6f8f2010-02-17 01:42:24 +0000867 cstr ? cstr : "");
868 clang_disposeString(text);
Douglas Gregor0c8296d2009-11-07 00:00:49 +0000869 }
Ted Kremenek2ef6f8f2010-02-17 01:42:24 +0000870
Douglas Gregor3ac73852009-11-09 16:04:45 +0000871}
872
873void print_completion_result(CXCompletionResult *completion_result,
874 CXClientData client_data) {
875 FILE *file = (FILE *)client_data;
Ted Kremeneke68fff62010-02-17 00:41:32 +0000876 CXString ks = clang_getCursorKindSpelling(completion_result->CursorKind);
877
878 fprintf(file, "%s:", clang_getCString(ks));
879 clang_disposeString(ks);
880
Douglas Gregor3ac73852009-11-09 16:04:45 +0000881 print_completion_string(completion_result->CompletionString, file);
Douglas Gregor58ddb602010-08-23 23:00:57 +0000882 fprintf(file, " (%u)",
Douglas Gregor12e13132010-05-26 22:00:08 +0000883 clang_getCompletionPriority(completion_result->CompletionString));
Douglas Gregor58ddb602010-08-23 23:00:57 +0000884 switch (clang_getCompletionAvailability(completion_result->CompletionString)){
885 case CXAvailability_Available:
886 break;
887
888 case CXAvailability_Deprecated:
889 fprintf(file, " (deprecated)");
890 break;
891
892 case CXAvailability_NotAvailable:
893 fprintf(file, " (unavailable)");
894 break;
895 }
896 fprintf(file, "\n");
Douglas Gregor0c8296d2009-11-07 00:00:49 +0000897}
898
Douglas Gregorc7ed3722010-08-25 22:15:42 +0000899int my_stricmp(const char *s1, const char *s2) {
900 while (*s1 && *s2) {
901 int c1 = tolower(*s1), c2 = tolower(*s2);
902 if (c1 < c2)
903 return -1;
904 else if (c1 > c2)
905 return 1;
906
907 ++s1;
908 ++s2;
909 }
910
911 if (*s1)
912 return 1;
913 else if (*s2)
914 return -1;
915 return 0;
916}
917
918int compare_completion_string(const void *xv, const void *yv) {
919 CXCompletionString x = ((CXCompletionResult *)xv)->CompletionString;
920 CXCompletionString y = ((CXCompletionResult *)yv)->CompletionString;
921 CXString xText, yText;
922 int I, N;
923 int result;
924 int FoundXText = 0, FoundYText = 0;
925
926 /* Find the typed text in x. */
927 for (I = 0, N = clang_getNumCompletionChunks(x); I != N; ++I) {
928 if (clang_getCompletionChunkKind(x, I) == CXCompletionChunk_TypedText) {
929 xText = clang_getCompletionChunkText(x, I);
930 FoundXText = 1;
931 break;
932 }
933 }
934
935 /* Find the typed text in x. */
936 for (I = 0, N = clang_getNumCompletionChunks(y); I != N; ++I) {
937 if (clang_getCompletionChunkKind(y, I) == CXCompletionChunk_TypedText) {
938 yText = clang_getCompletionChunkText(y, I);
939 FoundYText = 1;
940 break;
941 }
942 }
943
944 if (!FoundXText || !FoundYText) {
945 /* At least one of the results is missing a TypedText chunk. */
946 if (FoundXText)
947 clang_disposeString(xText);
948 if (FoundYText)
949 clang_disposeString(xText);
950
951 if (FoundXText || FoundYText)
952 return FoundXText? -1 : 1;
953 } else {
954 /* First, try case-insensitive comparisons. */
955 result = my_stricmp(clang_getCString(xText), clang_getCString(yText));
956
957 /* If that fails, try case-sensitive comparison. */
958 if (!result)
959 result = strcmp(clang_getCString(xText), clang_getCString(yText));
960
961 clang_disposeString(xText);
962 clang_disposeString(yText);
963 if (result)
964 return result;
965 }
966
967 /* The completion strings appear to be the same; try to order based on
968 priority. */
969 if (clang_getCompletionPriority(x) < clang_getCompletionPriority(y))
970 return -1;
971 else if (clang_getCompletionPriority(x) > clang_getCompletionPriority(y))
972 return 1;
973
974 return 0;
975}
976
Douglas Gregor1982c182010-07-12 18:38:41 +0000977int perform_code_completion(int argc, const char **argv, int timing_only) {
Douglas Gregor0c8296d2009-11-07 00:00:49 +0000978 const char *input = argv[1];
979 char *filename = 0;
980 unsigned line;
981 unsigned column;
Daniel Dunbarf8297f12009-11-07 18:34:24 +0000982 CXIndex CIdx;
Ted Kremenekf5d9c932009-11-17 18:09:14 +0000983 int errorCode;
Douglas Gregor735df882009-12-02 09:21:34 +0000984 struct CXUnsavedFile *unsaved_files = 0;
985 int num_unsaved_files = 0;
Douglas Gregorec6762c2009-12-18 16:20:58 +0000986 CXCodeCompleteResults *results = 0;
Douglas Gregordf95a132010-08-09 20:45:32 +0000987 CXTranslationUnit *TU = 0;
988
Douglas Gregor1982c182010-07-12 18:38:41 +0000989 if (timing_only)
990 input += strlen("-code-completion-timing=");
991 else
992 input += strlen("-code-completion-at=");
993
Ted Kremeneke68fff62010-02-17 00:41:32 +0000994 if ((errorCode = parse_file_line_column(input, &filename, &line, &column,
Douglas Gregorfc8ea232010-01-26 17:06:03 +0000995 0, 0)))
Ted Kremenekf5d9c932009-11-17 18:09:14 +0000996 return errorCode;
Douglas Gregor0c8296d2009-11-07 00:00:49 +0000997
Douglas Gregor735df882009-12-02 09:21:34 +0000998 if (parse_remapped_files(argc, argv, 2, &unsaved_files, &num_unsaved_files))
999 return -1;
1000
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001001 CIdx = clang_createIndex(0, 1);
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001002 if (getenv("CINDEXTEST_EDITING")) {
Daniel Dunbard91de2b2010-08-09 21:06:06 +00001003 unsigned I, Repeats = 5;
Douglas Gregordf95a132010-08-09 20:45:32 +00001004 TU = clang_parseTranslationUnit(CIdx, 0,
1005 argv + num_unsaved_files + 2,
1006 argc - num_unsaved_files - 2,
Daniel Dunbar43f331d2010-08-19 23:44:04 +00001007 0, 0, getDefaultParsingOptions());
Daniel Dunbar2de41c92010-08-19 23:44:06 +00001008 if (!TU) {
1009 fprintf(stderr, "Unable to load translation unit!\n");
1010 return 1;
1011 }
Douglas Gregordf95a132010-08-09 20:45:32 +00001012 for (I = 0; I != Repeats; ++I) {
1013 results = clang_codeCompleteAt(TU, filename, line, column,
1014 unsaved_files, num_unsaved_files,
1015 clang_defaultCodeCompleteOptions());
Daniel Dunbar2de41c92010-08-19 23:44:06 +00001016 if (!results) {
1017 fprintf(stderr, "Unable to perform code completion!\n");
1018 return 1;
1019 }
Douglas Gregordf95a132010-08-09 20:45:32 +00001020 if (I != Repeats-1)
1021 clang_disposeCodeCompleteResults(results);
1022 }
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001023 } else
1024 results = clang_codeComplete(CIdx,
1025 argv[argc - 1], argc - num_unsaved_files - 3,
1026 argv + num_unsaved_files + 2,
1027 num_unsaved_files, unsaved_files,
1028 filename, line, column);
Douglas Gregor936ea3b2010-01-28 00:56:43 +00001029
Douglas Gregorec6762c2009-12-18 16:20:58 +00001030 if (results) {
1031 unsigned i, n = results->NumResults;
Douglas Gregorc7ed3722010-08-25 22:15:42 +00001032 if (!timing_only) {
1033 /* Sort the code-completion results based on the typed text. */
1034 mergesort(results->Results, results->NumResults,
1035 sizeof(CXCompletionResult), &compare_completion_string);
1036
Douglas Gregor1982c182010-07-12 18:38:41 +00001037 for (i = 0; i != n; ++i)
1038 print_completion_result(results->Results + i, stdout);
Douglas Gregorc7ed3722010-08-25 22:15:42 +00001039 }
Douglas Gregora88084b2010-02-18 18:08:43 +00001040 n = clang_codeCompleteGetNumDiagnostics(results);
1041 for (i = 0; i != n; ++i) {
1042 CXDiagnostic diag = clang_codeCompleteGetDiagnostic(results, i);
1043 PrintDiagnostic(diag);
1044 clang_disposeDiagnostic(diag);
1045 }
Douglas Gregorec6762c2009-12-18 16:20:58 +00001046 clang_disposeCodeCompleteResults(results);
1047 }
Douglas Gregordf95a132010-08-09 20:45:32 +00001048 clang_disposeTranslationUnit(TU);
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001049 clang_disposeIndex(CIdx);
1050 free(filename);
Ted Kremeneke68fff62010-02-17 00:41:32 +00001051
Douglas Gregor735df882009-12-02 09:21:34 +00001052 free_remapped_files(unsaved_files, num_unsaved_files);
1053
Ted Kremenekf5d9c932009-11-17 18:09:14 +00001054 return 0;
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001055}
1056
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00001057typedef struct {
1058 char *filename;
1059 unsigned line;
1060 unsigned column;
1061} CursorSourceLocation;
1062
1063int inspect_cursor_at(int argc, const char **argv) {
1064 CXIndex CIdx;
1065 int errorCode;
1066 struct CXUnsavedFile *unsaved_files = 0;
1067 int num_unsaved_files = 0;
1068 CXTranslationUnit TU;
1069 CXCursor Cursor;
1070 CursorSourceLocation *Locations = 0;
1071 unsigned NumLocations = 0, Loc;
Douglas Gregor4db64a42010-01-23 00:14:00 +00001072
Ted Kremeneke68fff62010-02-17 00:41:32 +00001073 /* Count the number of locations. */
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00001074 while (strstr(argv[NumLocations+1], "-cursor-at=") == argv[NumLocations+1])
1075 ++NumLocations;
Ted Kremeneke68fff62010-02-17 00:41:32 +00001076
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00001077 /* Parse the locations. */
1078 assert(NumLocations > 0 && "Unable to count locations?");
1079 Locations = (CursorSourceLocation *)malloc(
1080 NumLocations * sizeof(CursorSourceLocation));
1081 for (Loc = 0; Loc < NumLocations; ++Loc) {
1082 const char *input = argv[Loc + 1] + strlen("-cursor-at=");
Ted Kremeneke68fff62010-02-17 00:41:32 +00001083 if ((errorCode = parse_file_line_column(input, &Locations[Loc].filename,
1084 &Locations[Loc].line,
Douglas Gregorfc8ea232010-01-26 17:06:03 +00001085 &Locations[Loc].column, 0, 0)))
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00001086 return errorCode;
1087 }
Ted Kremeneke68fff62010-02-17 00:41:32 +00001088
1089 if (parse_remapped_files(argc, argv, NumLocations + 1, &unsaved_files,
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00001090 &num_unsaved_files))
1091 return -1;
Ted Kremeneke68fff62010-02-17 00:41:32 +00001092
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001093 CIdx = clang_createIndex(0, 1);
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00001094 TU = clang_createTranslationUnitFromSourceFile(CIdx, argv[argc - 1],
1095 argc - num_unsaved_files - 2 - NumLocations,
Douglas Gregor4db64a42010-01-23 00:14:00 +00001096 argv + num_unsaved_files + 1 + NumLocations,
1097 num_unsaved_files,
Douglas Gregora88084b2010-02-18 18:08:43 +00001098 unsaved_files);
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00001099 if (!TU) {
1100 fprintf(stderr, "unable to parse input\n");
1101 return -1;
1102 }
Ted Kremeneke68fff62010-02-17 00:41:32 +00001103
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00001104 for (Loc = 0; Loc < NumLocations; ++Loc) {
Douglas Gregorb9790342010-01-22 21:44:22 +00001105 CXFile file = clang_getFile(TU, Locations[Loc].filename);
1106 if (!file)
1107 continue;
Ted Kremeneke68fff62010-02-17 00:41:32 +00001108
1109 Cursor = clang_getCursor(TU,
1110 clang_getLocation(TU, file, Locations[Loc].line,
1111 Locations[Loc].column));
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00001112 PrintCursor(Cursor);
1113 printf("\n");
1114 free(Locations[Loc].filename);
1115 }
Ted Kremeneke68fff62010-02-17 00:41:32 +00001116
Douglas Gregora88084b2010-02-18 18:08:43 +00001117 PrintDiagnostics(TU);
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00001118 clang_disposeTranslationUnit(TU);
1119 clang_disposeIndex(CIdx);
1120 free(Locations);
1121 free_remapped_files(unsaved_files, num_unsaved_files);
1122 return 0;
1123}
1124
Douglas Gregorfc8ea232010-01-26 17:06:03 +00001125int perform_token_annotation(int argc, const char **argv) {
1126 const char *input = argv[1];
1127 char *filename = 0;
1128 unsigned line, second_line;
1129 unsigned column, second_column;
1130 CXIndex CIdx;
1131 CXTranslationUnit TU = 0;
1132 int errorCode;
1133 struct CXUnsavedFile *unsaved_files = 0;
1134 int num_unsaved_files = 0;
1135 CXToken *tokens;
1136 unsigned num_tokens;
1137 CXSourceRange range;
1138 CXSourceLocation startLoc, endLoc;
1139 CXFile file = 0;
1140 CXCursor *cursors = 0;
1141 unsigned i;
1142
1143 input += strlen("-test-annotate-tokens=");
1144 if ((errorCode = parse_file_line_column(input, &filename, &line, &column,
1145 &second_line, &second_column)))
1146 return errorCode;
1147
1148 if (parse_remapped_files(argc, argv, 2, &unsaved_files, &num_unsaved_files))
1149 return -1;
1150
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001151 CIdx = clang_createIndex(0, 1);
Douglas Gregorfc8ea232010-01-26 17:06:03 +00001152 TU = clang_createTranslationUnitFromSourceFile(CIdx, argv[argc - 1],
1153 argc - num_unsaved_files - 3,
1154 argv + num_unsaved_files + 2,
1155 num_unsaved_files,
Douglas Gregora88084b2010-02-18 18:08:43 +00001156 unsaved_files);
Douglas Gregorfc8ea232010-01-26 17:06:03 +00001157 if (!TU) {
1158 fprintf(stderr, "unable to parse input\n");
1159 clang_disposeIndex(CIdx);
1160 free(filename);
1161 free_remapped_files(unsaved_files, num_unsaved_files);
1162 return -1;
Ted Kremeneke68fff62010-02-17 00:41:32 +00001163 }
Douglas Gregorfc8ea232010-01-26 17:06:03 +00001164 errorCode = 0;
1165
1166 file = clang_getFile(TU, filename);
1167 if (!file) {
1168 fprintf(stderr, "file %s is not in this translation unit\n", filename);
1169 errorCode = -1;
1170 goto teardown;
1171 }
1172
1173 startLoc = clang_getLocation(TU, file, line, column);
1174 if (clang_equalLocations(clang_getNullLocation(), startLoc)) {
Ted Kremeneke68fff62010-02-17 00:41:32 +00001175 fprintf(stderr, "invalid source location %s:%d:%d\n", filename, line,
Douglas Gregorfc8ea232010-01-26 17:06:03 +00001176 column);
1177 errorCode = -1;
Ted Kremeneke68fff62010-02-17 00:41:32 +00001178 goto teardown;
Douglas Gregorfc8ea232010-01-26 17:06:03 +00001179 }
1180
1181 endLoc = clang_getLocation(TU, file, second_line, second_column);
1182 if (clang_equalLocations(clang_getNullLocation(), endLoc)) {
Ted Kremeneke68fff62010-02-17 00:41:32 +00001183 fprintf(stderr, "invalid source location %s:%d:%d\n", filename,
Douglas Gregorfc8ea232010-01-26 17:06:03 +00001184 second_line, second_column);
1185 errorCode = -1;
Ted Kremeneke68fff62010-02-17 00:41:32 +00001186 goto teardown;
Douglas Gregorfc8ea232010-01-26 17:06:03 +00001187 }
1188
1189 range = clang_getRange(startLoc, endLoc);
1190 clang_tokenize(TU, range, &tokens, &num_tokens);
1191 cursors = (CXCursor *)malloc(num_tokens * sizeof(CXCursor));
1192 clang_annotateTokens(TU, tokens, num_tokens, cursors);
1193 for (i = 0; i != num_tokens; ++i) {
1194 const char *kind = "<unknown>";
1195 CXString spelling = clang_getTokenSpelling(TU, tokens[i]);
1196 CXSourceRange extent = clang_getTokenExtent(TU, tokens[i]);
1197 unsigned start_line, start_column, end_line, end_column;
1198
1199 switch (clang_getTokenKind(tokens[i])) {
1200 case CXToken_Punctuation: kind = "Punctuation"; break;
1201 case CXToken_Keyword: kind = "Keyword"; break;
1202 case CXToken_Identifier: kind = "Identifier"; break;
1203 case CXToken_Literal: kind = "Literal"; break;
1204 case CXToken_Comment: kind = "Comment"; break;
1205 }
Ted Kremeneke68fff62010-02-17 00:41:32 +00001206 clang_getInstantiationLocation(clang_getRangeStart(extent),
Douglas Gregor46766dc2010-01-26 19:19:08 +00001207 0, &start_line, &start_column, 0);
Douglas Gregorfc8ea232010-01-26 17:06:03 +00001208 clang_getInstantiationLocation(clang_getRangeEnd(extent),
Douglas Gregor46766dc2010-01-26 19:19:08 +00001209 0, &end_line, &end_column, 0);
Daniel Dunbar51b058c2010-02-14 08:32:24 +00001210 printf("%s: \"%s\" ", kind, clang_getCString(spelling));
1211 PrintExtent(stdout, start_line, start_column, end_line, end_column);
Douglas Gregor0045e9f2010-01-26 18:31:56 +00001212 if (!clang_isInvalid(cursors[i].kind)) {
1213 printf(" ");
1214 PrintCursor(cursors[i]);
1215 }
1216 printf("\n");
Douglas Gregorfc8ea232010-01-26 17:06:03 +00001217 }
1218 free(cursors);
1219
1220 teardown:
Douglas Gregora88084b2010-02-18 18:08:43 +00001221 PrintDiagnostics(TU);
Douglas Gregorfc8ea232010-01-26 17:06:03 +00001222 clang_disposeTranslationUnit(TU);
1223 clang_disposeIndex(CIdx);
1224 free(filename);
1225 free_remapped_files(unsaved_files, num_unsaved_files);
1226 return errorCode;
1227}
1228
Ted Kremenek0d435192009-11-17 18:13:31 +00001229/******************************************************************************/
Ted Kremenekf7b714d2010-03-25 02:00:39 +00001230/* USR printing. */
1231/******************************************************************************/
1232
1233static int insufficient_usr(const char *kind, const char *usage) {
1234 fprintf(stderr, "USR for '%s' requires: %s\n", kind, usage);
1235 return 1;
1236}
1237
1238static unsigned isUSR(const char *s) {
1239 return s[0] == 'c' && s[1] == ':';
1240}
1241
1242static int not_usr(const char *s, const char *arg) {
1243 fprintf(stderr, "'%s' argument ('%s') is not a USR\n", s, arg);
1244 return 1;
1245}
1246
1247static void print_usr(CXString usr) {
1248 const char *s = clang_getCString(usr);
1249 printf("%s\n", s);
1250 clang_disposeString(usr);
1251}
1252
1253static void display_usrs() {
1254 fprintf(stderr, "-print-usrs options:\n"
1255 " ObjCCategory <class name> <category name>\n"
1256 " ObjCClass <class name>\n"
1257 " ObjCIvar <ivar name> <class USR>\n"
1258 " ObjCMethod <selector> [0=class method|1=instance method] "
1259 "<class USR>\n"
1260 " ObjCProperty <property name> <class USR>\n"
1261 " ObjCProtocol <protocol name>\n");
1262}
1263
1264int print_usrs(const char **I, const char **E) {
1265 while (I != E) {
1266 const char *kind = *I;
1267 unsigned len = strlen(kind);
1268 switch (len) {
1269 case 8:
1270 if (memcmp(kind, "ObjCIvar", 8) == 0) {
1271 if (I + 2 >= E)
1272 return insufficient_usr(kind, "<ivar name> <class USR>");
1273 if (!isUSR(I[2]))
1274 return not_usr("<class USR>", I[2]);
1275 else {
1276 CXString x;
1277 x.Spelling = I[2];
1278 x.MustFreeString = 0;
1279 print_usr(clang_constructUSR_ObjCIvar(I[1], x));
1280 }
1281
1282 I += 3;
1283 continue;
1284 }
1285 break;
1286 case 9:
1287 if (memcmp(kind, "ObjCClass", 9) == 0) {
1288 if (I + 1 >= E)
1289 return insufficient_usr(kind, "<class name>");
1290 print_usr(clang_constructUSR_ObjCClass(I[1]));
1291 I += 2;
1292 continue;
1293 }
1294 break;
1295 case 10:
1296 if (memcmp(kind, "ObjCMethod", 10) == 0) {
1297 if (I + 3 >= E)
1298 return insufficient_usr(kind, "<method selector> "
1299 "[0=class method|1=instance method] <class USR>");
1300 if (!isUSR(I[3]))
1301 return not_usr("<class USR>", I[3]);
1302 else {
1303 CXString x;
1304 x.Spelling = I[3];
1305 x.MustFreeString = 0;
1306 print_usr(clang_constructUSR_ObjCMethod(I[1], atoi(I[2]), x));
1307 }
1308 I += 4;
1309 continue;
1310 }
1311 break;
1312 case 12:
1313 if (memcmp(kind, "ObjCCategory", 12) == 0) {
1314 if (I + 2 >= E)
1315 return insufficient_usr(kind, "<class name> <category name>");
1316 print_usr(clang_constructUSR_ObjCCategory(I[1], I[2]));
1317 I += 3;
1318 continue;
1319 }
1320 if (memcmp(kind, "ObjCProtocol", 12) == 0) {
1321 if (I + 1 >= E)
1322 return insufficient_usr(kind, "<protocol name>");
1323 print_usr(clang_constructUSR_ObjCProtocol(I[1]));
1324 I += 2;
1325 continue;
1326 }
1327 if (memcmp(kind, "ObjCProperty", 12) == 0) {
1328 if (I + 2 >= E)
1329 return insufficient_usr(kind, "<property name> <class USR>");
1330 if (!isUSR(I[2]))
1331 return not_usr("<class USR>", I[2]);
1332 else {
1333 CXString x;
1334 x.Spelling = I[2];
1335 x.MustFreeString = 0;
1336 print_usr(clang_constructUSR_ObjCProperty(I[1], x));
1337 }
1338 I += 3;
1339 continue;
1340 }
1341 break;
1342 default:
1343 break;
1344 }
1345 break;
1346 }
1347
1348 if (I != E) {
1349 fprintf(stderr, "Invalid USR kind: %s\n", *I);
1350 display_usrs();
1351 return 1;
1352 }
1353 return 0;
1354}
1355
1356int print_usrs_file(const char *file_name) {
1357 char line[2048];
1358 const char *args[128];
1359 unsigned numChars = 0;
1360
1361 FILE *fp = fopen(file_name, "r");
1362 if (!fp) {
1363 fprintf(stderr, "error: cannot open '%s'\n", file_name);
1364 return 1;
1365 }
1366
1367 /* This code is not really all that safe, but it works fine for testing. */
1368 while (!feof(fp)) {
1369 char c = fgetc(fp);
1370 if (c == '\n') {
1371 unsigned i = 0;
1372 const char *s = 0;
1373
1374 if (numChars == 0)
1375 continue;
1376
1377 line[numChars] = '\0';
1378 numChars = 0;
1379
1380 if (line[0] == '/' && line[1] == '/')
1381 continue;
1382
1383 s = strtok(line, " ");
1384 while (s) {
1385 args[i] = s;
1386 ++i;
1387 s = strtok(0, " ");
1388 }
1389 if (print_usrs(&args[0], &args[i]))
1390 return 1;
1391 }
1392 else
1393 line[numChars++] = c;
1394 }
1395
1396 fclose(fp);
1397 return 0;
1398}
1399
1400/******************************************************************************/
Ted Kremenek0d435192009-11-17 18:13:31 +00001401/* Command line processing. */
1402/******************************************************************************/
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00001403int write_pch_file(const char *filename, int argc, const char *argv[]) {
1404 CXIndex Idx;
1405 CXTranslationUnit TU;
1406 struct CXUnsavedFile *unsaved_files = 0;
1407 int num_unsaved_files = 0;
1408
1409 Idx = clang_createIndex(/* excludeDeclsFromPCH */1, /* displayDiagnosics=*/1);
1410
1411 if (parse_remapped_files(argc, argv, 0, &unsaved_files, &num_unsaved_files)) {
1412 clang_disposeIndex(Idx);
1413 return -1;
1414 }
1415
1416 TU = clang_parseTranslationUnit(Idx, 0,
1417 argv + num_unsaved_files,
1418 argc - num_unsaved_files,
1419 unsaved_files,
1420 num_unsaved_files,
1421 CXTranslationUnit_Incomplete);
1422 if (!TU) {
1423 fprintf(stderr, "Unable to load translation unit!\n");
1424 free_remapped_files(unsaved_files, num_unsaved_files);
1425 clang_disposeIndex(Idx);
1426 return 1;
1427 }
1428
Douglas Gregor19998442010-08-13 15:35:05 +00001429 if (clang_saveTranslationUnit(TU, filename, clang_defaultSaveOptions(TU)))
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00001430 fprintf(stderr, "Unable to write PCH file %s\n", filename);
1431 clang_disposeTranslationUnit(TU);
1432 free_remapped_files(unsaved_files, num_unsaved_files);
1433 clang_disposeIndex(Idx);
1434 return 0;
1435}
1436
1437/******************************************************************************/
1438/* Command line processing. */
1439/******************************************************************************/
Ted Kremenekf5d9c932009-11-17 18:09:14 +00001440
Douglas Gregore5b72ba2010-01-20 21:32:04 +00001441static CXCursorVisitor GetVisitor(const char *s) {
Ted Kremenek7d405622010-01-12 23:34:26 +00001442 if (s[0] == '\0')
Douglas Gregore5b72ba2010-01-20 21:32:04 +00001443 return FilteredPrintingVisitor;
Ted Kremenek7d405622010-01-12 23:34:26 +00001444 if (strcmp(s, "-usrs") == 0)
1445 return USRVisitor;
1446 return NULL;
1447}
1448
Ted Kremenekf5d9c932009-11-17 18:09:14 +00001449static void print_usage(void) {
1450 fprintf(stderr,
Ted Kremenek0d435192009-11-17 18:13:31 +00001451 "usage: c-index-test -code-completion-at=<site> <compiler arguments>\n"
Douglas Gregor1982c182010-07-12 18:38:41 +00001452 " c-index-test -code-completion-timing=<site> <compiler arguments>\n"
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00001453 " c-index-test -cursor-at=<site> <compiler arguments>\n"
Ted Kremenek1d5fdf32009-11-18 02:02:52 +00001454 " c-index-test -test-file-scan <AST file> <source file> "
1455 "[FileCheck prefix]\n"
Ted Kremenekfe6fd3d2010-01-05 23:18:49 +00001456 " c-index-test -test-load-tu <AST file> <symbol filter> "
1457 "[FileCheck prefix]\n"
Ted Kremenek7d405622010-01-12 23:34:26 +00001458 " c-index-test -test-load-tu-usrs <AST file> <symbol filter> "
1459 "[FileCheck prefix]\n"
Douglas Gregor1982c182010-07-12 18:38:41 +00001460 " c-index-test -test-load-source <symbol filter> {<args>}*\n");
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00001461 fprintf(stderr,
Douglas Gregorabc563f2010-07-19 21:46:24 +00001462 " c-index-test -test-load-source-reparse <trials> <symbol filter> "
1463 " {<args>}*\n"
Douglas Gregor1982c182010-07-12 18:38:41 +00001464 " c-index-test -test-load-source-usrs <symbol filter> {<args>}*\n"
Ted Kremenek16b55a72010-01-26 19:31:51 +00001465 " c-index-test -test-annotate-tokens=<range> {<args>}*\n"
1466 " c-index-test -test-inclusion-stack-source {<args>}*\n"
Ted Kremenek3bed5272010-03-03 06:37:58 +00001467 " c-index-test -test-inclusion-stack-tu <AST file>\n"
Ted Kremenekf7b714d2010-03-25 02:00:39 +00001468 " c-index-test -test-print-linkage-source {<args>}*\n"
Ted Kremenek8e0ac172010-05-14 21:29:26 +00001469 " c-index-test -test-print-typekind {<args>}*\n"
Chandler Carruth53513d22010-07-22 06:29:13 +00001470 " c-index-test -print-usr [<CursorKind> {<args>}]*\n");
1471 fprintf(stderr,
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00001472 " c-index-test -print-usr-file <file>\n"
1473 " c-index-test -write-pch <file> <compiler arguments>\n\n");
Douglas Gregorcaf4bd32010-07-20 14:34:35 +00001474 fprintf(stderr,
Ted Kremenek7d405622010-01-12 23:34:26 +00001475 " <symbol filter> values:\n%s",
Ted Kremenek0d435192009-11-17 18:13:31 +00001476 " all - load all symbols, including those from PCH\n"
1477 " local - load all symbols except those in PCH\n"
1478 " category - only load ObjC categories (non-PCH)\n"
1479 " interface - only load ObjC interfaces (non-PCH)\n"
1480 " protocol - only load ObjC protocols (non-PCH)\n"
1481 " function - only load functions (non-PCH)\n"
Daniel Dunbar625e4ef2009-12-01 02:35:37 +00001482 " typedef - only load typdefs (non-PCH)\n"
1483 " scan-function - scan function bodies (non-PCH)\n\n");
Ted Kremenekf5d9c932009-11-17 18:09:14 +00001484}
1485
1486int main(int argc, const char **argv) {
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001487 clang_enableStackTraces();
Ted Kremenekf5d9c932009-11-17 18:09:14 +00001488 if (argc > 2 && strstr(argv[1], "-code-completion-at=") == argv[1])
Douglas Gregor1982c182010-07-12 18:38:41 +00001489 return perform_code_completion(argc, argv, 0);
1490 if (argc > 2 && strstr(argv[1], "-code-completion-timing=") == argv[1])
1491 return perform_code_completion(argc, argv, 1);
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00001492 if (argc > 2 && strstr(argv[1], "-cursor-at=") == argv[1])
1493 return inspect_cursor_at(argc, argv);
Ted Kremenek7d405622010-01-12 23:34:26 +00001494 else if (argc >= 4 && strncmp(argv[1], "-test-load-tu", 13) == 0) {
Douglas Gregore5b72ba2010-01-20 21:32:04 +00001495 CXCursorVisitor I = GetVisitor(argv[1] + 13);
Ted Kremenek7d405622010-01-12 23:34:26 +00001496 if (I)
Ted Kremenekce2ae882010-01-26 17:59:48 +00001497 return perform_test_load_tu(argv[2], argv[3], argc >= 5 ? argv[4] : 0, I,
1498 NULL);
Ted Kremenek7d405622010-01-12 23:34:26 +00001499 }
Douglas Gregorabc563f2010-07-19 21:46:24 +00001500 else if (argc >= 5 && strncmp(argv[1], "-test-load-source-reparse", 25) == 0){
1501 CXCursorVisitor I = GetVisitor(argv[1] + 25);
1502 if (I) {
1503 int trials = atoi(argv[2]);
1504 return perform_test_reparse_source(argc - 4, argv + 4, trials, argv[3], I,
1505 NULL);
1506 }
1507 }
Ted Kremenek7d405622010-01-12 23:34:26 +00001508 else if (argc >= 4 && strncmp(argv[1], "-test-load-source", 17) == 0) {
Douglas Gregore5b72ba2010-01-20 21:32:04 +00001509 CXCursorVisitor I = GetVisitor(argv[1] + 17);
Ted Kremenek7d405622010-01-12 23:34:26 +00001510 if (I)
Ted Kremenekce2ae882010-01-26 17:59:48 +00001511 return perform_test_load_source(argc - 3, argv + 3, argv[2], I, NULL);
Ted Kremenek7d405622010-01-12 23:34:26 +00001512 }
1513 else if (argc >= 4 && strcmp(argv[1], "-test-file-scan") == 0)
Ted Kremenek1d5fdf32009-11-18 02:02:52 +00001514 return perform_file_scan(argv[2], argv[3],
1515 argc >= 5 ? argv[4] : 0);
Douglas Gregorfc8ea232010-01-26 17:06:03 +00001516 else if (argc > 2 && strstr(argv[1], "-test-annotate-tokens=") == argv[1])
1517 return perform_token_annotation(argc, argv);
Ted Kremenek16b55a72010-01-26 19:31:51 +00001518 else if (argc > 2 && strcmp(argv[1], "-test-inclusion-stack-source") == 0)
1519 return perform_test_load_source(argc - 2, argv + 2, "all", NULL,
1520 PrintInclusionStack);
1521 else if (argc > 2 && strcmp(argv[1], "-test-inclusion-stack-tu") == 0)
1522 return perform_test_load_tu(argv[2], "all", NULL, NULL,
1523 PrintInclusionStack);
Ted Kremenek3bed5272010-03-03 06:37:58 +00001524 else if (argc > 2 && strcmp(argv[1], "-test-print-linkage-source") == 0)
1525 return perform_test_load_source(argc - 2, argv + 2, "all", PrintLinkage,
1526 NULL);
Ted Kremenek8e0ac172010-05-14 21:29:26 +00001527 else if (argc > 2 && strcmp(argv[1], "-test-print-typekind") == 0)
1528 return perform_test_load_source(argc - 2, argv + 2, "all",
1529 PrintTypeKind, 0);
Ted Kremenekf7b714d2010-03-25 02:00:39 +00001530 else if (argc > 1 && strcmp(argv[1], "-print-usr") == 0) {
1531 if (argc > 2)
1532 return print_usrs(argv + 2, argv + argc);
1533 else {
1534 display_usrs();
1535 return 1;
1536 }
1537 }
1538 else if (argc > 2 && strcmp(argv[1], "-print-usr-file") == 0)
1539 return print_usrs_file(argv[2]);
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00001540 else if (argc > 2 && strcmp(argv[1], "-write-pch") == 0)
1541 return write_pch_file(argv[2], argc - 3, argv + 3);
1542
Ted Kremenekf5d9c932009-11-17 18:09:14 +00001543 print_usage();
1544 return 1;
Steve Naroff50398192009-08-28 15:28:48 +00001545}