blob: 305fb40f9b6cd6f6344741258dcbce9842069373 [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 Gregor1e5e6682010-08-26 13:48:20 +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;
Douglas Gregore0329ac2010-09-02 00:07:54 +0000169 CXCursor SpecializationOf;
170
Ted Kremeneke68fff62010-02-17 00:41:32 +0000171 ks = clang_getCursorKindSpelling(Cursor.kind);
Steve Naroffef0cef62009-11-09 17:45:52 +0000172 string = clang_getCursorSpelling(Cursor);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000173 printf("%s=%s", clang_getCString(ks),
174 clang_getCString(string));
175 clang_disposeString(ks);
Steve Naroffef0cef62009-11-09 17:45:52 +0000176 clang_disposeString(string);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000177
Douglas Gregorc5d1e932010-01-19 01:20:04 +0000178 Referenced = clang_getCursorReferenced(Cursor);
179 if (!clang_equalCursors(Referenced, clang_getNullCursor())) {
Douglas Gregor1f60d9e2010-09-13 22:52:57 +0000180 if (clang_getCursorKind(Referenced) == CXCursor_OverloadedDeclRef) {
181 unsigned I, N = clang_getNumOverloadedDecls(Referenced);
182 printf("[");
183 for (I = 0; I != N; ++I) {
184 CXCursor Ovl = clang_getOverloadedDecl(Referenced, I);
185 if (I)
186 printf(", ");
187
188 CXSourceLocation Loc = clang_getCursorLocation(Ovl);
189 clang_getInstantiationLocation(Loc, 0, &line, &column, 0);
190 printf("%d:%d", line, column);
191 }
192 printf("]");
193 } else {
194 CXSourceLocation Loc = clang_getCursorLocation(Referenced);
195 clang_getInstantiationLocation(Loc, 0, &line, &column, 0);
196 printf(":%d:%d", line, column);
197 }
Douglas Gregorc5d1e932010-01-19 01:20:04 +0000198 }
Douglas Gregorb6998662010-01-19 19:34:47 +0000199
200 if (clang_isCursorDefinition(Cursor))
201 printf(" (Definition)");
Douglas Gregor58ddb602010-08-23 23:00:57 +0000202
203 switch (clang_getCursorAvailability(Cursor)) {
204 case CXAvailability_Available:
205 break;
206
207 case CXAvailability_Deprecated:
208 printf(" (deprecated)");
209 break;
210
211 case CXAvailability_NotAvailable:
212 printf(" (unavailable)");
213 break;
214 }
Ted Kremenek95f33552010-08-26 01:42:22 +0000215
216 if (Cursor.kind == CXCursor_IBOutletCollectionAttr) {
217 CXType T =
218 clang_getCanonicalType(clang_getIBOutletCollectionType(Cursor));
219 CXString S = clang_getTypeKindSpelling(T.kind);
220 printf(" [IBOutletCollection=%s]", clang_getCString(S));
221 clang_disposeString(S);
222 }
Ted Kremenek3064ef92010-08-27 21:34:58 +0000223
224 if (Cursor.kind == CXCursor_CXXBaseSpecifier) {
225 enum CX_CXXAccessSpecifier access = clang_getCXXAccessSpecifier(Cursor);
226 unsigned isVirtual = clang_isVirtualBase(Cursor);
227 const char *accessStr = 0;
228
229 switch (access) {
230 case CX_CXXInvalidAccessSpecifier:
231 accessStr = "invalid"; break;
232 case CX_CXXPublic:
233 accessStr = "public"; break;
234 case CX_CXXProtected:
235 accessStr = "protected"; break;
236 case CX_CXXPrivate:
237 accessStr = "private"; break;
238 }
239
240 printf(" [access=%s isVirtual=%s]", accessStr,
241 isVirtual ? "true" : "false");
242 }
Douglas Gregore0329ac2010-09-02 00:07:54 +0000243
244 SpecializationOf = clang_getSpecializedCursorTemplate(Cursor);
245 if (!clang_equalCursors(SpecializationOf, clang_getNullCursor())) {
246 CXSourceLocation Loc = clang_getCursorLocation(SpecializationOf);
247 CXString Name = clang_getCursorSpelling(SpecializationOf);
248 clang_getInstantiationLocation(Loc, 0, &line, &column, 0);
249 printf(" [Specialization of %s:%d:%d]",
250 clang_getCString(Name), line, column);
251 clang_disposeString(Name);
252 }
Steve Naroff699a07d2009-09-25 21:32:34 +0000253 }
Steve Naroffaf08ddc2009-09-03 15:49:00 +0000254}
Steve Naroff89922f82009-08-31 00:59:03 +0000255
Ted Kremeneke68fff62010-02-17 00:41:32 +0000256static const char* GetCursorSource(CXCursor Cursor) {
Douglas Gregor1db19de2010-01-19 21:36:55 +0000257 CXSourceLocation Loc = clang_getCursorLocation(Cursor);
Ted Kremenek74844072010-02-17 00:41:20 +0000258 CXString source;
Douglas Gregor1db19de2010-01-19 21:36:55 +0000259 CXFile file;
Douglas Gregor46766dc2010-01-26 19:19:08 +0000260 clang_getInstantiationLocation(Loc, &file, 0, 0, 0);
Douglas Gregor1db19de2010-01-19 21:36:55 +0000261 source = clang_getFileName(file);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000262 if (!clang_getCString(source)) {
Ted Kremenek74844072010-02-17 00:41:20 +0000263 clang_disposeString(source);
264 return "<invalid loc>";
265 }
266 else {
Ted Kremeneke68fff62010-02-17 00:41:32 +0000267 const char *b = basename(clang_getCString(source));
Ted Kremenek74844072010-02-17 00:41:20 +0000268 clang_disposeString(source);
269 return b;
270 }
Ted Kremenek9298cfc2009-11-17 05:31:58 +0000271}
272
Ted Kremenek0d435192009-11-17 18:13:31 +0000273/******************************************************************************/
Ted Kremenekce2ae882010-01-26 17:59:48 +0000274/* Callbacks. */
275/******************************************************************************/
276
277typedef void (*PostVisitTU)(CXTranslationUnit);
278
Douglas Gregora88084b2010-02-18 18:08:43 +0000279void PrintDiagnostic(CXDiagnostic Diagnostic) {
280 FILE *out = stderr;
Douglas Gregor5352ac02010-01-28 00:27:43 +0000281 CXFile file;
Douglas Gregor274f1902010-02-22 23:17:23 +0000282 CXString Msg;
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000283 unsigned display_opts = CXDiagnostic_DisplaySourceLocation
284 | CXDiagnostic_DisplayColumn | CXDiagnostic_DisplaySourceRanges;
285 unsigned i, num_fixits;
Ted Kremenekf7b714d2010-03-25 02:00:39 +0000286
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000287 if (clang_getDiagnosticSeverity(Diagnostic) == CXDiagnostic_Ignored)
Douglas Gregor5352ac02010-01-28 00:27:43 +0000288 return;
Ted Kremeneke68fff62010-02-17 00:41:32 +0000289
Douglas Gregor274f1902010-02-22 23:17:23 +0000290 Msg = clang_formatDiagnostic(Diagnostic, display_opts);
291 fprintf(stderr, "%s\n", clang_getCString(Msg));
292 clang_disposeString(Msg);
Ted Kremenekf7b714d2010-03-25 02:00:39 +0000293
Douglas Gregor5352ac02010-01-28 00:27:43 +0000294 clang_getInstantiationLocation(clang_getDiagnosticLocation(Diagnostic),
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000295 &file, 0, 0, 0);
296 if (!file)
297 return;
Ted Kremeneke68fff62010-02-17 00:41:32 +0000298
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000299 num_fixits = clang_getDiagnosticNumFixIts(Diagnostic);
300 for (i = 0; i != num_fixits; ++i) {
Douglas Gregor473d7012010-02-19 18:16:06 +0000301 CXSourceRange range;
302 CXString insertion_text = clang_getDiagnosticFixIt(Diagnostic, i, &range);
303 CXSourceLocation start = clang_getRangeStart(range);
304 CXSourceLocation end = clang_getRangeEnd(range);
305 unsigned start_line, start_column, end_line, end_column;
306 CXFile start_file, end_file;
Ted Kremenekf7b714d2010-03-25 02:00:39 +0000307 clang_getInstantiationLocation(start, &start_file, &start_line,
Douglas Gregor473d7012010-02-19 18:16:06 +0000308 &start_column, 0);
309 clang_getInstantiationLocation(end, &end_file, &end_line, &end_column, 0);
310 if (clang_equalLocations(start, end)) {
311 /* Insertion. */
312 if (start_file == file)
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000313 fprintf(out, "FIX-IT: Insert \"%s\" at %d:%d\n",
Douglas Gregor473d7012010-02-19 18:16:06 +0000314 clang_getCString(insertion_text), start_line, start_column);
315 } else if (strcmp(clang_getCString(insertion_text), "") == 0) {
316 /* Removal. */
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000317 if (start_file == file && end_file == file) {
318 fprintf(out, "FIX-IT: Remove ");
319 PrintExtent(out, start_line, start_column, end_line, end_column);
320 fprintf(out, "\n");
Douglas Gregor51c6d382010-01-29 00:41:11 +0000321 }
Douglas Gregor473d7012010-02-19 18:16:06 +0000322 } else {
323 /* Replacement. */
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000324 if (start_file == end_file) {
325 fprintf(out, "FIX-IT: Replace ");
326 PrintExtent(out, start_line, start_column, end_line, end_column);
Douglas Gregor473d7012010-02-19 18:16:06 +0000327 fprintf(out, " with \"%s\"\n", clang_getCString(insertion_text));
Douglas Gregor436f3f02010-02-18 22:27:07 +0000328 }
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000329 break;
330 }
Douglas Gregor473d7012010-02-19 18:16:06 +0000331 clang_disposeString(insertion_text);
Douglas Gregor51c6d382010-01-29 00:41:11 +0000332 }
Douglas Gregor5352ac02010-01-28 00:27:43 +0000333}
334
Douglas Gregora88084b2010-02-18 18:08:43 +0000335void PrintDiagnostics(CXTranslationUnit TU) {
336 int i, n = clang_getNumDiagnostics(TU);
337 for (i = 0; i != n; ++i) {
338 CXDiagnostic Diag = clang_getDiagnostic(TU, i);
339 PrintDiagnostic(Diag);
340 clang_disposeDiagnostic(Diag);
341 }
342}
343
Ted Kremenekce2ae882010-01-26 17:59:48 +0000344/******************************************************************************/
Douglas Gregore5b72ba2010-01-20 21:32:04 +0000345/* Logic for testing traversal. */
Ted Kremenek0d435192009-11-17 18:13:31 +0000346/******************************************************************************/
347
Ted Kremenekfe6fd3d2010-01-05 23:18:49 +0000348static const char *FileCheckPrefix = "CHECK";
349
Douglas Gregora7bde202010-01-19 00:34:46 +0000350static void PrintCursorExtent(CXCursor C) {
351 CXSourceRange extent = clang_getCursorExtent(C);
Douglas Gregor1db19de2010-01-19 21:36:55 +0000352 CXFile begin_file, end_file;
353 unsigned begin_line, begin_column, end_line, end_column;
Ted Kremeneke68fff62010-02-17 00:41:32 +0000354
Douglas Gregor1db19de2010-01-19 21:36:55 +0000355 clang_getInstantiationLocation(clang_getRangeStart(extent),
Douglas Gregor46766dc2010-01-26 19:19:08 +0000356 &begin_file, &begin_line, &begin_column, 0);
Douglas Gregor1db19de2010-01-19 21:36:55 +0000357 clang_getInstantiationLocation(clang_getRangeEnd(extent),
Douglas Gregor46766dc2010-01-26 19:19:08 +0000358 &end_file, &end_line, &end_column, 0);
Douglas Gregor1db19de2010-01-19 21:36:55 +0000359 if (!begin_file || !end_file)
Ted Kremenek70ee5422010-01-16 01:44:12 +0000360 return;
Douglas Gregor1db19de2010-01-19 21:36:55 +0000361
Daniel Dunbar51b058c2010-02-14 08:32:24 +0000362 printf(" Extent=");
363 PrintExtent(stdout, begin_line, begin_column, end_line, end_column);
Ted Kremenekfe6fd3d2010-01-05 23:18:49 +0000364}
365
Douglas Gregore5b72ba2010-01-20 21:32:04 +0000366/* Data used by all of the visitors. */
367typedef struct {
368 CXTranslationUnit TU;
369 enum CXCursorKind *Filter;
370} VisitorData;
Ted Kremenekfe6fd3d2010-01-05 23:18:49 +0000371
Daniel Dunbar625e4ef2009-12-01 02:35:37 +0000372
Ted Kremeneke68fff62010-02-17 00:41:32 +0000373enum CXChildVisitResult FilteredPrintingVisitor(CXCursor Cursor,
Douglas Gregore5b72ba2010-01-20 21:32:04 +0000374 CXCursor Parent,
375 CXClientData ClientData) {
376 VisitorData *Data = (VisitorData *)ClientData;
377 if (!Data->Filter || (Cursor.kind == *(enum CXCursorKind *)Data->Filter)) {
Douglas Gregor98258af2010-01-18 22:46:11 +0000378 CXSourceLocation Loc = clang_getCursorLocation(Cursor);
Douglas Gregor1db19de2010-01-19 21:36:55 +0000379 unsigned line, column;
Douglas Gregor46766dc2010-01-26 19:19:08 +0000380 clang_getInstantiationLocation(Loc, 0, &line, &column, 0);
Ted Kremenekfe6fd3d2010-01-05 23:18:49 +0000381 printf("// %s: %s:%d:%d: ", FileCheckPrefix,
Douglas Gregor1db19de2010-01-19 21:36:55 +0000382 GetCursorSource(Cursor), line, column);
Steve Naroffaf08ddc2009-09-03 15:49:00 +0000383 PrintCursor(Cursor);
Douglas Gregora7bde202010-01-19 00:34:46 +0000384 PrintCursorExtent(Cursor);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000385 printf("\n");
Douglas Gregore5b72ba2010-01-20 21:32:04 +0000386 return CXChildVisit_Recurse;
Steve Naroff2d4d6292009-08-31 14:26:51 +0000387 }
Ted Kremeneke68fff62010-02-17 00:41:32 +0000388
Douglas Gregore5b72ba2010-01-20 21:32:04 +0000389 return CXChildVisit_Continue;
Steve Naroff89922f82009-08-31 00:59:03 +0000390}
Steve Naroff50398192009-08-28 15:28:48 +0000391
Ted Kremeneke68fff62010-02-17 00:41:32 +0000392static enum CXChildVisitResult FunctionScanVisitor(CXCursor Cursor,
Douglas Gregore5b72ba2010-01-20 21:32:04 +0000393 CXCursor Parent,
394 CXClientData ClientData) {
Daniel Dunbar625e4ef2009-12-01 02:35:37 +0000395 const char *startBuf, *endBuf;
396 unsigned startLine, startColumn, endLine, endColumn, curLine, curColumn;
397 CXCursor Ref;
Douglas Gregore5b72ba2010-01-20 21:32:04 +0000398 VisitorData *Data = (VisitorData *)ClientData;
Daniel Dunbar625e4ef2009-12-01 02:35:37 +0000399
Douglas Gregorb6998662010-01-19 19:34:47 +0000400 if (Cursor.kind != CXCursor_FunctionDecl ||
401 !clang_isCursorDefinition(Cursor))
Douglas Gregore5b72ba2010-01-20 21:32:04 +0000402 return CXChildVisit_Continue;
Daniel Dunbar625e4ef2009-12-01 02:35:37 +0000403
404 clang_getDefinitionSpellingAndExtent(Cursor, &startBuf, &endBuf,
405 &startLine, &startColumn,
406 &endLine, &endColumn);
407 /* Probe the entire body, looking for both decls and refs. */
408 curLine = startLine;
409 curColumn = startColumn;
410
411 while (startBuf < endBuf) {
Douglas Gregor98258af2010-01-18 22:46:11 +0000412 CXSourceLocation Loc;
Douglas Gregor1db19de2010-01-19 21:36:55 +0000413 CXFile file;
Ted Kremenek74844072010-02-17 00:41:20 +0000414 CXString source;
Ted Kremeneke68fff62010-02-17 00:41:32 +0000415
Daniel Dunbar625e4ef2009-12-01 02:35:37 +0000416 if (*startBuf == '\n') {
417 startBuf++;
418 curLine++;
419 curColumn = 1;
420 } else if (*startBuf != '\t')
421 curColumn++;
Ted Kremeneke68fff62010-02-17 00:41:32 +0000422
Douglas Gregor98258af2010-01-18 22:46:11 +0000423 Loc = clang_getCursorLocation(Cursor);
Douglas Gregor46766dc2010-01-26 19:19:08 +0000424 clang_getInstantiationLocation(Loc, &file, 0, 0, 0);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000425
Douglas Gregor1db19de2010-01-19 21:36:55 +0000426 source = clang_getFileName(file);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000427 if (clang_getCString(source)) {
Douglas Gregorb9790342010-01-22 21:44:22 +0000428 CXSourceLocation RefLoc
429 = clang_getLocation(Data->TU, file, curLine, curColumn);
430 Ref = clang_getCursor(Data->TU, RefLoc);
Douglas Gregor98258af2010-01-18 22:46:11 +0000431 if (Ref.kind == CXCursor_NoDeclFound) {
432 /* Nothing found here; that's fine. */
433 } else if (Ref.kind != CXCursor_FunctionDecl) {
434 printf("// %s: %s:%d:%d: ", FileCheckPrefix, GetCursorSource(Ref),
435 curLine, curColumn);
436 PrintCursor(Ref);
437 printf("\n");
438 }
Daniel Dunbar625e4ef2009-12-01 02:35:37 +0000439 }
Ted Kremenek74844072010-02-17 00:41:20 +0000440 clang_disposeString(source);
Daniel Dunbar625e4ef2009-12-01 02:35:37 +0000441 startBuf++;
442 }
Ted Kremeneke68fff62010-02-17 00:41:32 +0000443
Douglas Gregore5b72ba2010-01-20 21:32:04 +0000444 return CXChildVisit_Continue;
Daniel Dunbar625e4ef2009-12-01 02:35:37 +0000445}
446
Ted Kremenek7d405622010-01-12 23:34:26 +0000447/******************************************************************************/
448/* USR testing. */
449/******************************************************************************/
450
Douglas Gregore5b72ba2010-01-20 21:32:04 +0000451enum CXChildVisitResult USRVisitor(CXCursor C, CXCursor parent,
452 CXClientData ClientData) {
453 VisitorData *Data = (VisitorData *)ClientData;
454 if (!Data->Filter || (C.kind == *(enum CXCursorKind *)Data->Filter)) {
Ted Kremenekcf84aa42010-01-18 20:23:29 +0000455 CXString USR = clang_getCursorUSR(C);
Ted Kremeneke542f772010-04-20 23:15:40 +0000456 const char *cstr = clang_getCString(USR);
457 if (!cstr || cstr[0] == '\0') {
Ted Kremenek7d405622010-01-12 23:34:26 +0000458 clang_disposeString(USR);
Ted Kremeneke74ef122010-04-16 21:31:52 +0000459 return CXChildVisit_Recurse;
Ted Kremenek7d405622010-01-12 23:34:26 +0000460 }
Ted Kremeneke542f772010-04-20 23:15:40 +0000461 printf("// %s: %s %s", FileCheckPrefix, GetCursorSource(C), cstr);
462
Douglas Gregora7bde202010-01-19 00:34:46 +0000463 PrintCursorExtent(C);
Ted Kremenek7d405622010-01-12 23:34:26 +0000464 printf("\n");
465 clang_disposeString(USR);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000466
Douglas Gregore5b72ba2010-01-20 21:32:04 +0000467 return CXChildVisit_Recurse;
Ted Kremeneke68fff62010-02-17 00:41:32 +0000468 }
469
Douglas Gregore5b72ba2010-01-20 21:32:04 +0000470 return CXChildVisit_Continue;
Ted Kremenek7d405622010-01-12 23:34:26 +0000471}
472
473/******************************************************************************/
Ted Kremenek16b55a72010-01-26 19:31:51 +0000474/* Inclusion stack testing. */
475/******************************************************************************/
476
477void InclusionVisitor(CXFile includedFile, CXSourceLocation *includeStack,
478 unsigned includeStackLen, CXClientData data) {
Ted Kremeneke68fff62010-02-17 00:41:32 +0000479
Ted Kremenek16b55a72010-01-26 19:31:51 +0000480 unsigned i;
Ted Kremenek74844072010-02-17 00:41:20 +0000481 CXString fname;
482
483 fname = clang_getFileName(includedFile);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000484 printf("file: %s\nincluded by:\n", clang_getCString(fname));
Ted Kremenek74844072010-02-17 00:41:20 +0000485 clang_disposeString(fname);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000486
Ted Kremenek16b55a72010-01-26 19:31:51 +0000487 for (i = 0; i < includeStackLen; ++i) {
488 CXFile includingFile;
489 unsigned line, column;
490 clang_getInstantiationLocation(includeStack[i], &includingFile, &line,
491 &column, 0);
Ted Kremenek74844072010-02-17 00:41:20 +0000492 fname = clang_getFileName(includingFile);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000493 printf(" %s:%d:%d\n", clang_getCString(fname), line, column);
Ted Kremenek74844072010-02-17 00:41:20 +0000494 clang_disposeString(fname);
Ted Kremenek16b55a72010-01-26 19:31:51 +0000495 }
496 printf("\n");
497}
498
499void PrintInclusionStack(CXTranslationUnit TU) {
Ted Kremeneke68fff62010-02-17 00:41:32 +0000500 clang_getInclusions(TU, InclusionVisitor, NULL);
Ted Kremenek16b55a72010-01-26 19:31:51 +0000501}
502
503/******************************************************************************/
Ted Kremenek3bed5272010-03-03 06:37:58 +0000504/* Linkage testing. */
505/******************************************************************************/
506
507static enum CXChildVisitResult PrintLinkage(CXCursor cursor, CXCursor p,
508 CXClientData d) {
509 const char *linkage = 0;
510
511 if (clang_isInvalid(clang_getCursorKind(cursor)))
512 return CXChildVisit_Recurse;
513
514 switch (clang_getCursorLinkage(cursor)) {
515 case CXLinkage_Invalid: break;
Douglas Gregorc2a2b3c2010-03-04 19:36:27 +0000516 case CXLinkage_NoLinkage: linkage = "NoLinkage"; break;
517 case CXLinkage_Internal: linkage = "Internal"; break;
518 case CXLinkage_UniqueExternal: linkage = "UniqueExternal"; break;
519 case CXLinkage_External: linkage = "External"; break;
Ted Kremenek3bed5272010-03-03 06:37:58 +0000520 }
521
522 if (linkage) {
523 PrintCursor(cursor);
524 printf("linkage=%s\n", linkage);
525 }
526
527 return CXChildVisit_Recurse;
528}
529
530/******************************************************************************/
Ted Kremenek8e0ac172010-05-14 21:29:26 +0000531/* Typekind testing. */
532/******************************************************************************/
533
534static enum CXChildVisitResult PrintTypeKind(CXCursor cursor, CXCursor p,
535 CXClientData d) {
536
537 if (!clang_isInvalid(clang_getCursorKind(cursor))) {
538 CXType T = clang_getCursorType(cursor);
Ted Kremenek8e0ac172010-05-14 21:29:26 +0000539 CXString S = clang_getTypeKindSpelling(T.kind);
540 PrintCursor(cursor);
541 printf(" typekind=%s", clang_getCString(S));
Ted Kremenek8e0ac172010-05-14 21:29:26 +0000542 clang_disposeString(S);
Benjamin Kramere1403d22010-06-22 09:29:44 +0000543 /* Print the canonical type if it is different. */
Ted Kremenek04c3cf32010-06-21 20:15:39 +0000544 {
545 CXType CT = clang_getCanonicalType(T);
546 if (!clang_equalTypes(T, CT)) {
547 CXString CS = clang_getTypeKindSpelling(CT.kind);
548 printf(" [canonical=%s]", clang_getCString(CS));
549 clang_disposeString(CS);
550 }
551 }
Benjamin Kramere1403d22010-06-22 09:29:44 +0000552 /* Print the return type if it exists. */
Ted Kremenek04c3cf32010-06-21 20:15:39 +0000553 {
Ted Kremenek9a140842010-06-21 20:48:56 +0000554 CXType RT = clang_getCursorResultType(cursor);
Ted Kremenek04c3cf32010-06-21 20:15:39 +0000555 if (RT.kind != CXType_Invalid) {
556 CXString RS = clang_getTypeKindSpelling(RT.kind);
557 printf(" [result=%s]", clang_getCString(RS));
558 clang_disposeString(RS);
559 }
560 }
Ted Kremenek3ce9e7d2010-07-30 00:14:11 +0000561 /* Print if this is a non-POD type. */
562 printf(" [isPOD=%d]", clang_isPODType(T));
Ted Kremenek04c3cf32010-06-21 20:15:39 +0000563
Ted Kremenek8e0ac172010-05-14 21:29:26 +0000564 printf("\n");
565 }
566 return CXChildVisit_Recurse;
567}
568
569
570/******************************************************************************/
Ted Kremenek7d405622010-01-12 23:34:26 +0000571/* Loading ASTs/source. */
572/******************************************************************************/
573
Daniel Dunbar625e4ef2009-12-01 02:35:37 +0000574static int perform_test_load(CXIndex Idx, CXTranslationUnit TU,
Ted Kremenek98271562010-01-12 18:53:15 +0000575 const char *filter, const char *prefix,
Ted Kremenekce2ae882010-01-26 17:59:48 +0000576 CXCursorVisitor Visitor,
577 PostVisitTU PV) {
Ted Kremeneke68fff62010-02-17 00:41:32 +0000578
Ted Kremenekfe6fd3d2010-01-05 23:18:49 +0000579 if (prefix)
Ted Kremeneke68fff62010-02-17 00:41:32 +0000580 FileCheckPrefix = prefix;
Ted Kremeneke3ee02a2010-01-26 17:55:33 +0000581
582 if (Visitor) {
583 enum CXCursorKind K = CXCursor_NotImplemented;
584 enum CXCursorKind *ck = &K;
585 VisitorData Data;
Ted Kremeneke68fff62010-02-17 00:41:32 +0000586
Ted Kremeneke3ee02a2010-01-26 17:55:33 +0000587 /* Perform some simple filtering. */
588 if (!strcmp(filter, "all") || !strcmp(filter, "local")) ck = NULL;
Daniel Dunbarb1ffee62010-02-10 20:42:40 +0000589 else if (!strcmp(filter, "none")) K = (enum CXCursorKind) ~0;
Ted Kremeneke3ee02a2010-01-26 17:55:33 +0000590 else if (!strcmp(filter, "category")) K = CXCursor_ObjCCategoryDecl;
591 else if (!strcmp(filter, "interface")) K = CXCursor_ObjCInterfaceDecl;
592 else if (!strcmp(filter, "protocol")) K = CXCursor_ObjCProtocolDecl;
593 else if (!strcmp(filter, "function")) K = CXCursor_FunctionDecl;
594 else if (!strcmp(filter, "typedef")) K = CXCursor_TypedefDecl;
595 else if (!strcmp(filter, "scan-function")) Visitor = FunctionScanVisitor;
596 else {
597 fprintf(stderr, "Unknown filter for -test-load-tu: %s\n", filter);
598 return 1;
599 }
Ted Kremeneke68fff62010-02-17 00:41:32 +0000600
Ted Kremeneke3ee02a2010-01-26 17:55:33 +0000601 Data.TU = TU;
602 Data.Filter = ck;
603 clang_visitChildren(clang_getTranslationUnitCursor(TU), Visitor, &Data);
Ted Kremenek0d435192009-11-17 18:13:31 +0000604 }
Ted Kremeneke68fff62010-02-17 00:41:32 +0000605
Ted Kremenekce2ae882010-01-26 17:59:48 +0000606 if (PV)
607 PV(TU);
Ted Kremeneke3ee02a2010-01-26 17:55:33 +0000608
Douglas Gregora88084b2010-02-18 18:08:43 +0000609 PrintDiagnostics(TU);
Ted Kremenek0d435192009-11-17 18:13:31 +0000610 clang_disposeTranslationUnit(TU);
611 return 0;
612}
613
Ted Kremenekfe6fd3d2010-01-05 23:18:49 +0000614int perform_test_load_tu(const char *file, const char *filter,
Ted Kremenekce2ae882010-01-26 17:59:48 +0000615 const char *prefix, CXCursorVisitor Visitor,
616 PostVisitTU PV) {
Daniel Dunbar625e4ef2009-12-01 02:35:37 +0000617 CXIndex Idx;
618 CXTranslationUnit TU;
Ted Kremenek020a0952010-02-11 07:41:25 +0000619 int result;
Ted Kremeneke68fff62010-02-17 00:41:32 +0000620 Idx = clang_createIndex(/* excludeDeclsFromPCH */
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000621 !strcmp(filter, "local") ? 1 : 0,
622 /* displayDiagnosics=*/1);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000623
Ted Kremenek020a0952010-02-11 07:41:25 +0000624 if (!CreateTranslationUnit(Idx, file, &TU)) {
625 clang_disposeIndex(Idx);
Daniel Dunbar625e4ef2009-12-01 02:35:37 +0000626 return 1;
Ted Kremenek020a0952010-02-11 07:41:25 +0000627 }
Daniel Dunbar625e4ef2009-12-01 02:35:37 +0000628
Ted Kremenek020a0952010-02-11 07:41:25 +0000629 result = perform_test_load(Idx, TU, filter, prefix, Visitor, PV);
630 clang_disposeIndex(Idx);
631 return result;
Daniel Dunbar625e4ef2009-12-01 02:35:37 +0000632}
633
Ted Kremenekce2ae882010-01-26 17:59:48 +0000634int perform_test_load_source(int argc, const char **argv,
635 const char *filter, CXCursorVisitor Visitor,
636 PostVisitTU PV) {
Daniel Dunbar8506dde2009-12-03 01:54:28 +0000637 const char *UseExternalASTs =
638 getenv("CINDEXTEST_USE_EXTERNAL_AST_GENERATION");
Daniel Dunbarada487d2009-12-01 02:03:10 +0000639 CXIndex Idx;
640 CXTranslationUnit TU;
Douglas Gregor4db64a42010-01-23 00:14:00 +0000641 struct CXUnsavedFile *unsaved_files = 0;
642 int num_unsaved_files = 0;
643 int result;
Douglas Gregorabc563f2010-07-19 21:46:24 +0000644
Daniel Dunbarada487d2009-12-01 02:03:10 +0000645 Idx = clang_createIndex(/* excludeDeclsFromPCH */
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000646 !strcmp(filter, "local") ? 1 : 0,
647 /* displayDiagnosics=*/1);
Daniel Dunbarada487d2009-12-01 02:03:10 +0000648
Daniel Dunbar8506dde2009-12-03 01:54:28 +0000649 if (UseExternalASTs && strlen(UseExternalASTs))
650 clang_setUseExternalASTGeneration(Idx, 1);
651
Ted Kremenek020a0952010-02-11 07:41:25 +0000652 if (parse_remapped_files(argc, argv, 0, &unsaved_files, &num_unsaved_files)) {
653 clang_disposeIndex(Idx);
Douglas Gregor4db64a42010-01-23 00:14:00 +0000654 return -1;
Ted Kremenek020a0952010-02-11 07:41:25 +0000655 }
Douglas Gregor4db64a42010-01-23 00:14:00 +0000656
Ted Kremeneke68fff62010-02-17 00:41:32 +0000657 TU = clang_createTranslationUnitFromSourceFile(Idx, 0,
658 argc - num_unsaved_files,
Douglas Gregor4db64a42010-01-23 00:14:00 +0000659 argv + num_unsaved_files,
660 num_unsaved_files,
Douglas Gregora88084b2010-02-18 18:08:43 +0000661 unsaved_files);
Daniel Dunbarada487d2009-12-01 02:03:10 +0000662 if (!TU) {
663 fprintf(stderr, "Unable to load translation unit!\n");
Douglas Gregorabc563f2010-07-19 21:46:24 +0000664 free_remapped_files(unsaved_files, num_unsaved_files);
Ted Kremenek020a0952010-02-11 07:41:25 +0000665 clang_disposeIndex(Idx);
Daniel Dunbarada487d2009-12-01 02:03:10 +0000666 return 1;
667 }
668
Ted Kremenekce2ae882010-01-26 17:59:48 +0000669 result = perform_test_load(Idx, TU, filter, NULL, Visitor, PV);
Douglas Gregor4db64a42010-01-23 00:14:00 +0000670 free_remapped_files(unsaved_files, num_unsaved_files);
Ted Kremenek020a0952010-02-11 07:41:25 +0000671 clang_disposeIndex(Idx);
Douglas Gregor4db64a42010-01-23 00:14:00 +0000672 return result;
Daniel Dunbarada487d2009-12-01 02:03:10 +0000673}
674
Douglas Gregorabc563f2010-07-19 21:46:24 +0000675int perform_test_reparse_source(int argc, const char **argv, int trials,
676 const char *filter, CXCursorVisitor Visitor,
677 PostVisitTU PV) {
678 const char *UseExternalASTs =
679 getenv("CINDEXTEST_USE_EXTERNAL_AST_GENERATION");
680 CXIndex Idx;
681 CXTranslationUnit TU;
682 struct CXUnsavedFile *unsaved_files = 0;
683 int num_unsaved_files = 0;
684 int result;
685 int trial;
686
687 Idx = clang_createIndex(/* excludeDeclsFromPCH */
688 !strcmp(filter, "local") ? 1 : 0,
689 /* displayDiagnosics=*/1);
690
691 if (UseExternalASTs && strlen(UseExternalASTs))
692 clang_setUseExternalASTGeneration(Idx, 1);
693
694 if (parse_remapped_files(argc, argv, 0, &unsaved_files, &num_unsaved_files)) {
695 clang_disposeIndex(Idx);
696 return -1;
697 }
698
Daniel Dunbarc8a61802010-08-18 23:09:16 +0000699 /* Load the initial translation unit -- we do this without honoring remapped
700 * files, so that we have a way to test results after changing the source. */
Douglas Gregor44c181a2010-07-23 00:33:23 +0000701 TU = clang_parseTranslationUnit(Idx, 0,
702 argv + num_unsaved_files,
703 argc - num_unsaved_files,
Daniel Dunbarc8a61802010-08-18 23:09:16 +0000704 0, 0, getDefaultParsingOptions());
Douglas Gregorabc563f2010-07-19 21:46:24 +0000705 if (!TU) {
706 fprintf(stderr, "Unable to load translation unit!\n");
707 free_remapped_files(unsaved_files, num_unsaved_files);
708 clang_disposeIndex(Idx);
709 return 1;
710 }
711
712 for (trial = 0; trial < trials; ++trial) {
Douglas Gregore1e13bf2010-08-11 15:58:42 +0000713 if (clang_reparseTranslationUnit(TU, num_unsaved_files, unsaved_files,
714 clang_defaultReparseOptions(TU))) {
Daniel Dunbarc8a61802010-08-18 23:09:16 +0000715 fprintf(stderr, "Unable to reparse translation unit!\n");
Douglas Gregorabc563f2010-07-19 21:46:24 +0000716 clang_disposeTranslationUnit(TU);
717 free_remapped_files(unsaved_files, num_unsaved_files);
718 clang_disposeIndex(Idx);
719 return -1;
720 }
721 }
722
723 result = perform_test_load(Idx, TU, filter, NULL, Visitor, PV);
724 free_remapped_files(unsaved_files, num_unsaved_files);
725 clang_disposeIndex(Idx);
726 return result;
727}
728
Ted Kremenek0d435192009-11-17 18:13:31 +0000729/******************************************************************************/
Ted Kremenek1c6da172009-11-17 19:37:36 +0000730/* Logic for testing clang_getCursor(). */
731/******************************************************************************/
732
733static void print_cursor_file_scan(CXCursor cursor,
734 unsigned start_line, unsigned start_col,
Ted Kremenek1d5fdf32009-11-18 02:02:52 +0000735 unsigned end_line, unsigned end_col,
736 const char *prefix) {
Ted Kremenek9096a202010-01-07 01:17:12 +0000737 printf("// %s: ", FileCheckPrefix);
Ted Kremenek1d5fdf32009-11-18 02:02:52 +0000738 if (prefix)
739 printf("-%s", prefix);
Daniel Dunbar51b058c2010-02-14 08:32:24 +0000740 PrintExtent(stdout, start_line, start_col, end_line, end_col);
741 printf(" ");
Ted Kremenek1c6da172009-11-17 19:37:36 +0000742 PrintCursor(cursor);
743 printf("\n");
744}
745
Ted Kremenek1d5fdf32009-11-18 02:02:52 +0000746static int perform_file_scan(const char *ast_file, const char *source_file,
747 const char *prefix) {
Ted Kremenek1c6da172009-11-17 19:37:36 +0000748 CXIndex Idx;
749 CXTranslationUnit TU;
750 FILE *fp;
Daniel Dunbar2389eff2010-02-14 08:32:32 +0000751 CXCursor prevCursor = clang_getNullCursor();
Douglas Gregorb9790342010-01-22 21:44:22 +0000752 CXFile file;
Daniel Dunbar2389eff2010-02-14 08:32:32 +0000753 unsigned line = 1, col = 1;
Daniel Dunbar8f0bf812010-02-14 08:32:51 +0000754 unsigned start_line = 1, start_col = 1;
Ted Kremeneke68fff62010-02-17 00:41:32 +0000755
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000756 if (!(Idx = clang_createIndex(/* excludeDeclsFromPCH */ 1,
757 /* displayDiagnosics=*/1))) {
Ted Kremenek1c6da172009-11-17 19:37:36 +0000758 fprintf(stderr, "Could not create Index\n");
759 return 1;
760 }
Ted Kremeneke68fff62010-02-17 00:41:32 +0000761
Ted Kremenek1c6da172009-11-17 19:37:36 +0000762 if (!CreateTranslationUnit(Idx, ast_file, &TU))
763 return 1;
Ted Kremeneke68fff62010-02-17 00:41:32 +0000764
Ted Kremenek1c6da172009-11-17 19:37:36 +0000765 if ((fp = fopen(source_file, "r")) == NULL) {
766 fprintf(stderr, "Could not open '%s'\n", source_file);
767 return 1;
768 }
Ted Kremeneke68fff62010-02-17 00:41:32 +0000769
Douglas Gregorb9790342010-01-22 21:44:22 +0000770 file = clang_getFile(TU, source_file);
Daniel Dunbar2389eff2010-02-14 08:32:32 +0000771 for (;;) {
772 CXCursor cursor;
773 int c = fgetc(fp);
Benjamin Kramera9933b92009-11-17 20:51:40 +0000774
Daniel Dunbar2389eff2010-02-14 08:32:32 +0000775 if (c == '\n') {
776 ++line;
777 col = 1;
778 } else
779 ++col;
780
781 /* Check the cursor at this position, and dump the previous one if we have
782 * found something new.
783 */
784 cursor = clang_getCursor(TU, clang_getLocation(TU, file, line, col));
785 if ((c == EOF || !clang_equalCursors(cursor, prevCursor)) &&
786 prevCursor.kind != CXCursor_InvalidFile) {
787 print_cursor_file_scan(prevCursor, start_line, start_col,
Daniel Dunbard52864b2010-02-14 10:02:57 +0000788 line, col, prefix);
Daniel Dunbar2389eff2010-02-14 08:32:32 +0000789 start_line = line;
790 start_col = col;
Benjamin Kramera9933b92009-11-17 20:51:40 +0000791 }
Daniel Dunbar2389eff2010-02-14 08:32:32 +0000792 if (c == EOF)
793 break;
Benjamin Kramera9933b92009-11-17 20:51:40 +0000794
Daniel Dunbar2389eff2010-02-14 08:32:32 +0000795 prevCursor = cursor;
Ted Kremenek1c6da172009-11-17 19:37:36 +0000796 }
Ted Kremeneke68fff62010-02-17 00:41:32 +0000797
Ted Kremenek1c6da172009-11-17 19:37:36 +0000798 fclose(fp);
799 return 0;
800}
801
802/******************************************************************************/
Ted Kremenek0d435192009-11-17 18:13:31 +0000803/* Logic for testing clang_codeComplete(). */
804/******************************************************************************/
805
Douglas Gregor0c8296d2009-11-07 00:00:49 +0000806/* Parse file:line:column from the input string. Returns 0 on success, non-zero
807 on failure. If successful, the pointer *filename will contain newly-allocated
808 memory (that will be owned by the caller) to store the file name. */
Ted Kremeneke68fff62010-02-17 00:41:32 +0000809int parse_file_line_column(const char *input, char **filename, unsigned *line,
Douglas Gregorfc8ea232010-01-26 17:06:03 +0000810 unsigned *column, unsigned *second_line,
811 unsigned *second_column) {
Douglas Gregor88d23952009-11-09 18:19:57 +0000812 /* Find the second colon. */
Douglas Gregorfc8ea232010-01-26 17:06:03 +0000813 const char *last_colon = strrchr(input, ':');
814 unsigned values[4], i;
815 unsigned num_values = (second_line && second_column)? 4 : 2;
816
Douglas Gregor0c8296d2009-11-07 00:00:49 +0000817 char *endptr = 0;
Douglas Gregorfc8ea232010-01-26 17:06:03 +0000818 if (!last_colon || last_colon == input) {
819 if (num_values == 4)
820 fprintf(stderr, "could not parse filename:line:column:line:column in "
821 "'%s'\n", input);
822 else
823 fprintf(stderr, "could not parse filename:line:column in '%s'\n", input);
Douglas Gregor0c8296d2009-11-07 00:00:49 +0000824 return 1;
825 }
826
Douglas Gregorfc8ea232010-01-26 17:06:03 +0000827 for (i = 0; i != num_values; ++i) {
828 const char *prev_colon;
829
830 /* Parse the next line or column. */
831 values[num_values - i - 1] = strtol(last_colon + 1, &endptr, 10);
832 if (*endptr != 0 && *endptr != ':') {
Ted Kremeneke68fff62010-02-17 00:41:32 +0000833 fprintf(stderr, "could not parse %s in '%s'\n",
Douglas Gregorfc8ea232010-01-26 17:06:03 +0000834 (i % 2 ? "column" : "line"), input);
835 return 1;
836 }
Ted Kremeneke68fff62010-02-17 00:41:32 +0000837
Douglas Gregorfc8ea232010-01-26 17:06:03 +0000838 if (i + 1 == num_values)
839 break;
840
841 /* Find the previous colon. */
842 prev_colon = last_colon - 1;
843 while (prev_colon != input && *prev_colon != ':')
844 --prev_colon;
845 if (prev_colon == input) {
Ted Kremeneke68fff62010-02-17 00:41:32 +0000846 fprintf(stderr, "could not parse %s in '%s'\n",
Douglas Gregorfc8ea232010-01-26 17:06:03 +0000847 (i % 2 == 0? "column" : "line"), input);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000848 return 1;
Douglas Gregorfc8ea232010-01-26 17:06:03 +0000849 }
850
851 last_colon = prev_colon;
Douglas Gregor88d23952009-11-09 18:19:57 +0000852 }
853
Douglas Gregorfc8ea232010-01-26 17:06:03 +0000854 *line = values[0];
855 *column = values[1];
Ted Kremeneke68fff62010-02-17 00:41:32 +0000856
Douglas Gregorfc8ea232010-01-26 17:06:03 +0000857 if (second_line && second_column) {
858 *second_line = values[2];
859 *second_column = values[3];
860 }
861
Douglas Gregor88d23952009-11-09 18:19:57 +0000862 /* Copy the file name. */
Douglas Gregorfc8ea232010-01-26 17:06:03 +0000863 *filename = (char*)malloc(last_colon - input + 1);
864 memcpy(*filename, input, last_colon - input);
865 (*filename)[last_colon - input] = 0;
Douglas Gregor0c8296d2009-11-07 00:00:49 +0000866 return 0;
867}
868
869const char *
870clang_getCompletionChunkKindSpelling(enum CXCompletionChunkKind Kind) {
871 switch (Kind) {
872 case CXCompletionChunk_Optional: return "Optional";
873 case CXCompletionChunk_TypedText: return "TypedText";
874 case CXCompletionChunk_Text: return "Text";
875 case CXCompletionChunk_Placeholder: return "Placeholder";
876 case CXCompletionChunk_Informative: return "Informative";
877 case CXCompletionChunk_CurrentParameter: return "CurrentParameter";
878 case CXCompletionChunk_LeftParen: return "LeftParen";
879 case CXCompletionChunk_RightParen: return "RightParen";
880 case CXCompletionChunk_LeftBracket: return "LeftBracket";
881 case CXCompletionChunk_RightBracket: return "RightBracket";
882 case CXCompletionChunk_LeftBrace: return "LeftBrace";
883 case CXCompletionChunk_RightBrace: return "RightBrace";
884 case CXCompletionChunk_LeftAngle: return "LeftAngle";
885 case CXCompletionChunk_RightAngle: return "RightAngle";
886 case CXCompletionChunk_Comma: return "Comma";
Douglas Gregorff5ce6e2009-12-18 18:53:37 +0000887 case CXCompletionChunk_ResultType: return "ResultType";
Douglas Gregor01dfea02010-01-10 23:08:15 +0000888 case CXCompletionChunk_Colon: return "Colon";
889 case CXCompletionChunk_SemiColon: return "SemiColon";
890 case CXCompletionChunk_Equal: return "Equal";
891 case CXCompletionChunk_HorizontalSpace: return "HorizontalSpace";
892 case CXCompletionChunk_VerticalSpace: return "VerticalSpace";
Douglas Gregor0c8296d2009-11-07 00:00:49 +0000893 }
Ted Kremeneke68fff62010-02-17 00:41:32 +0000894
Douglas Gregor0c8296d2009-11-07 00:00:49 +0000895 return "Unknown";
896}
897
Douglas Gregor3ac73852009-11-09 16:04:45 +0000898void print_completion_string(CXCompletionString completion_string, FILE *file) {
Daniel Dunbarf8297f12009-11-07 18:34:24 +0000899 int I, N;
Ted Kremeneke68fff62010-02-17 00:41:32 +0000900
Douglas Gregor3ac73852009-11-09 16:04:45 +0000901 N = clang_getNumCompletionChunks(completion_string);
Douglas Gregor0c8296d2009-11-07 00:00:49 +0000902 for (I = 0; I != N; ++I) {
Ted Kremenek2ef6f8f2010-02-17 01:42:24 +0000903 CXString text;
904 const char *cstr;
Douglas Gregor0c8296d2009-11-07 00:00:49 +0000905 enum CXCompletionChunkKind Kind
Douglas Gregor3ac73852009-11-09 16:04:45 +0000906 = clang_getCompletionChunkKind(completion_string, I);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000907
Douglas Gregor3ac73852009-11-09 16:04:45 +0000908 if (Kind == CXCompletionChunk_Optional) {
909 fprintf(file, "{Optional ");
910 print_completion_string(
Ted Kremeneke68fff62010-02-17 00:41:32 +0000911 clang_getCompletionChunkCompletionString(completion_string, I),
Douglas Gregor3ac73852009-11-09 16:04:45 +0000912 file);
913 fprintf(file, "}");
914 continue;
915 }
Ted Kremeneke68fff62010-02-17 00:41:32 +0000916
Douglas Gregord5a20892009-11-09 17:05:28 +0000917 text = clang_getCompletionChunkText(completion_string, I);
Ted Kremenek2ef6f8f2010-02-17 01:42:24 +0000918 cstr = clang_getCString(text);
Ted Kremeneke68fff62010-02-17 00:41:32 +0000919 fprintf(file, "{%s %s}",
Douglas Gregor0c8296d2009-11-07 00:00:49 +0000920 clang_getCompletionChunkKindSpelling(Kind),
Ted Kremenek2ef6f8f2010-02-17 01:42:24 +0000921 cstr ? cstr : "");
922 clang_disposeString(text);
Douglas Gregor0c8296d2009-11-07 00:00:49 +0000923 }
Ted Kremenek2ef6f8f2010-02-17 01:42:24 +0000924
Douglas Gregor3ac73852009-11-09 16:04:45 +0000925}
926
927void print_completion_result(CXCompletionResult *completion_result,
928 CXClientData client_data) {
929 FILE *file = (FILE *)client_data;
Ted Kremeneke68fff62010-02-17 00:41:32 +0000930 CXString ks = clang_getCursorKindSpelling(completion_result->CursorKind);
931
932 fprintf(file, "%s:", clang_getCString(ks));
933 clang_disposeString(ks);
934
Douglas Gregor3ac73852009-11-09 16:04:45 +0000935 print_completion_string(completion_result->CompletionString, file);
Douglas Gregor58ddb602010-08-23 23:00:57 +0000936 fprintf(file, " (%u)",
Douglas Gregor12e13132010-05-26 22:00:08 +0000937 clang_getCompletionPriority(completion_result->CompletionString));
Douglas Gregor58ddb602010-08-23 23:00:57 +0000938 switch (clang_getCompletionAvailability(completion_result->CompletionString)){
939 case CXAvailability_Available:
940 break;
941
942 case CXAvailability_Deprecated:
943 fprintf(file, " (deprecated)");
944 break;
945
946 case CXAvailability_NotAvailable:
947 fprintf(file, " (unavailable)");
948 break;
949 }
950 fprintf(file, "\n");
Douglas Gregor0c8296d2009-11-07 00:00:49 +0000951}
952
Douglas Gregor1e5e6682010-08-26 13:48:20 +0000953int my_stricmp(const char *s1, const char *s2) {
954 while (*s1 && *s2) {
955 int c1 = tolower(*s1), c2 = tolower(*s2);
956 if (c1 < c2)
957 return -1;
958 else if (c1 > c2)
959 return 1;
960
961 ++s1;
962 ++s2;
963 }
964
965 if (*s1)
966 return 1;
967 else if (*s2)
968 return -1;
969 return 0;
970}
971
Douglas Gregor1982c182010-07-12 18:38:41 +0000972int perform_code_completion(int argc, const char **argv, int timing_only) {
Douglas Gregor0c8296d2009-11-07 00:00:49 +0000973 const char *input = argv[1];
974 char *filename = 0;
975 unsigned line;
976 unsigned column;
Daniel Dunbarf8297f12009-11-07 18:34:24 +0000977 CXIndex CIdx;
Ted Kremenekf5d9c932009-11-17 18:09:14 +0000978 int errorCode;
Douglas Gregor735df882009-12-02 09:21:34 +0000979 struct CXUnsavedFile *unsaved_files = 0;
980 int num_unsaved_files = 0;
Douglas Gregorec6762c2009-12-18 16:20:58 +0000981 CXCodeCompleteResults *results = 0;
Douglas Gregordf95a132010-08-09 20:45:32 +0000982 CXTranslationUnit *TU = 0;
983
Douglas Gregor1982c182010-07-12 18:38:41 +0000984 if (timing_only)
985 input += strlen("-code-completion-timing=");
986 else
987 input += strlen("-code-completion-at=");
988
Ted Kremeneke68fff62010-02-17 00:41:32 +0000989 if ((errorCode = parse_file_line_column(input, &filename, &line, &column,
Douglas Gregorfc8ea232010-01-26 17:06:03 +0000990 0, 0)))
Ted Kremenekf5d9c932009-11-17 18:09:14 +0000991 return errorCode;
Douglas Gregor0c8296d2009-11-07 00:00:49 +0000992
Douglas Gregor735df882009-12-02 09:21:34 +0000993 if (parse_remapped_files(argc, argv, 2, &unsaved_files, &num_unsaved_files))
994 return -1;
995
Douglas Gregor0a812cf2010-02-18 23:07:20 +0000996 CIdx = clang_createIndex(0, 1);
Douglas Gregor1abc6bc2010-08-04 16:47:14 +0000997 if (getenv("CINDEXTEST_EDITING")) {
Daniel Dunbard91de2b2010-08-09 21:06:06 +0000998 unsigned I, Repeats = 5;
Douglas Gregordf95a132010-08-09 20:45:32 +0000999 TU = clang_parseTranslationUnit(CIdx, 0,
1000 argv + num_unsaved_files + 2,
1001 argc - num_unsaved_files - 2,
Daniel Dunbar43f331d2010-08-19 23:44:04 +00001002 0, 0, getDefaultParsingOptions());
Daniel Dunbar2de41c92010-08-19 23:44:06 +00001003 if (!TU) {
1004 fprintf(stderr, "Unable to load translation unit!\n");
1005 return 1;
1006 }
Douglas Gregordf95a132010-08-09 20:45:32 +00001007 for (I = 0; I != Repeats; ++I) {
1008 results = clang_codeCompleteAt(TU, filename, line, column,
1009 unsaved_files, num_unsaved_files,
1010 clang_defaultCodeCompleteOptions());
Daniel Dunbar2de41c92010-08-19 23:44:06 +00001011 if (!results) {
1012 fprintf(stderr, "Unable to perform code completion!\n");
1013 return 1;
1014 }
Douglas Gregordf95a132010-08-09 20:45:32 +00001015 if (I != Repeats-1)
1016 clang_disposeCodeCompleteResults(results);
1017 }
Douglas Gregor1abc6bc2010-08-04 16:47:14 +00001018 } else
1019 results = clang_codeComplete(CIdx,
1020 argv[argc - 1], argc - num_unsaved_files - 3,
1021 argv + num_unsaved_files + 2,
1022 num_unsaved_files, unsaved_files,
1023 filename, line, column);
Douglas Gregor936ea3b2010-01-28 00:56:43 +00001024
Douglas Gregorec6762c2009-12-18 16:20:58 +00001025 if (results) {
1026 unsigned i, n = results->NumResults;
Douglas Gregor1e5e6682010-08-26 13:48:20 +00001027 if (!timing_only) {
1028 /* Sort the code-completion results based on the typed text. */
1029 clang_sortCodeCompletionResults(results->Results, results->NumResults);
1030
Douglas Gregor1982c182010-07-12 18:38:41 +00001031 for (i = 0; i != n; ++i)
1032 print_completion_result(results->Results + i, stdout);
Douglas Gregor1e5e6682010-08-26 13:48:20 +00001033 }
Douglas Gregora88084b2010-02-18 18:08:43 +00001034 n = clang_codeCompleteGetNumDiagnostics(results);
1035 for (i = 0; i != n; ++i) {
1036 CXDiagnostic diag = clang_codeCompleteGetDiagnostic(results, i);
1037 PrintDiagnostic(diag);
1038 clang_disposeDiagnostic(diag);
1039 }
Douglas Gregorec6762c2009-12-18 16:20:58 +00001040 clang_disposeCodeCompleteResults(results);
1041 }
Douglas Gregordf95a132010-08-09 20:45:32 +00001042 clang_disposeTranslationUnit(TU);
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001043 clang_disposeIndex(CIdx);
1044 free(filename);
Ted Kremeneke68fff62010-02-17 00:41:32 +00001045
Douglas Gregor735df882009-12-02 09:21:34 +00001046 free_remapped_files(unsaved_files, num_unsaved_files);
1047
Ted Kremenekf5d9c932009-11-17 18:09:14 +00001048 return 0;
Douglas Gregor0c8296d2009-11-07 00:00:49 +00001049}
1050
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00001051typedef struct {
1052 char *filename;
1053 unsigned line;
1054 unsigned column;
1055} CursorSourceLocation;
1056
1057int inspect_cursor_at(int argc, const char **argv) {
1058 CXIndex CIdx;
1059 int errorCode;
1060 struct CXUnsavedFile *unsaved_files = 0;
1061 int num_unsaved_files = 0;
1062 CXTranslationUnit TU;
1063 CXCursor Cursor;
1064 CursorSourceLocation *Locations = 0;
1065 unsigned NumLocations = 0, Loc;
Douglas Gregor4db64a42010-01-23 00:14:00 +00001066
Ted Kremeneke68fff62010-02-17 00:41:32 +00001067 /* Count the number of locations. */
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00001068 while (strstr(argv[NumLocations+1], "-cursor-at=") == argv[NumLocations+1])
1069 ++NumLocations;
Ted Kremeneke68fff62010-02-17 00:41:32 +00001070
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00001071 /* Parse the locations. */
1072 assert(NumLocations > 0 && "Unable to count locations?");
1073 Locations = (CursorSourceLocation *)malloc(
1074 NumLocations * sizeof(CursorSourceLocation));
1075 for (Loc = 0; Loc < NumLocations; ++Loc) {
1076 const char *input = argv[Loc + 1] + strlen("-cursor-at=");
Ted Kremeneke68fff62010-02-17 00:41:32 +00001077 if ((errorCode = parse_file_line_column(input, &Locations[Loc].filename,
1078 &Locations[Loc].line,
Douglas Gregorfc8ea232010-01-26 17:06:03 +00001079 &Locations[Loc].column, 0, 0)))
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00001080 return errorCode;
1081 }
Ted Kremeneke68fff62010-02-17 00:41:32 +00001082
1083 if (parse_remapped_files(argc, argv, NumLocations + 1, &unsaved_files,
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00001084 &num_unsaved_files))
1085 return -1;
Ted Kremeneke68fff62010-02-17 00:41:32 +00001086
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001087 CIdx = clang_createIndex(0, 1);
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00001088 TU = clang_createTranslationUnitFromSourceFile(CIdx, argv[argc - 1],
1089 argc - num_unsaved_files - 2 - NumLocations,
Douglas Gregor4db64a42010-01-23 00:14:00 +00001090 argv + num_unsaved_files + 1 + NumLocations,
1091 num_unsaved_files,
Douglas Gregora88084b2010-02-18 18:08:43 +00001092 unsaved_files);
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00001093 if (!TU) {
1094 fprintf(stderr, "unable to parse input\n");
1095 return -1;
1096 }
Ted Kremeneke68fff62010-02-17 00:41:32 +00001097
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00001098 for (Loc = 0; Loc < NumLocations; ++Loc) {
Douglas Gregorb9790342010-01-22 21:44:22 +00001099 CXFile file = clang_getFile(TU, Locations[Loc].filename);
1100 if (!file)
1101 continue;
Ted Kremeneke68fff62010-02-17 00:41:32 +00001102
1103 Cursor = clang_getCursor(TU,
1104 clang_getLocation(TU, file, Locations[Loc].line,
1105 Locations[Loc].column));
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00001106 PrintCursor(Cursor);
1107 printf("\n");
1108 free(Locations[Loc].filename);
1109 }
Ted Kremeneke68fff62010-02-17 00:41:32 +00001110
Douglas Gregora88084b2010-02-18 18:08:43 +00001111 PrintDiagnostics(TU);
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00001112 clang_disposeTranslationUnit(TU);
1113 clang_disposeIndex(CIdx);
1114 free(Locations);
1115 free_remapped_files(unsaved_files, num_unsaved_files);
1116 return 0;
1117}
1118
Douglas Gregorfc8ea232010-01-26 17:06:03 +00001119int perform_token_annotation(int argc, const char **argv) {
1120 const char *input = argv[1];
1121 char *filename = 0;
1122 unsigned line, second_line;
1123 unsigned column, second_column;
1124 CXIndex CIdx;
1125 CXTranslationUnit TU = 0;
1126 int errorCode;
1127 struct CXUnsavedFile *unsaved_files = 0;
1128 int num_unsaved_files = 0;
1129 CXToken *tokens;
1130 unsigned num_tokens;
1131 CXSourceRange range;
1132 CXSourceLocation startLoc, endLoc;
1133 CXFile file = 0;
1134 CXCursor *cursors = 0;
1135 unsigned i;
1136
1137 input += strlen("-test-annotate-tokens=");
1138 if ((errorCode = parse_file_line_column(input, &filename, &line, &column,
1139 &second_line, &second_column)))
1140 return errorCode;
1141
1142 if (parse_remapped_files(argc, argv, 2, &unsaved_files, &num_unsaved_files))
1143 return -1;
1144
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001145 CIdx = clang_createIndex(0, 1);
Douglas Gregorfc8ea232010-01-26 17:06:03 +00001146 TU = clang_createTranslationUnitFromSourceFile(CIdx, argv[argc - 1],
1147 argc - num_unsaved_files - 3,
1148 argv + num_unsaved_files + 2,
1149 num_unsaved_files,
Douglas Gregora88084b2010-02-18 18:08:43 +00001150 unsaved_files);
Douglas Gregorfc8ea232010-01-26 17:06:03 +00001151 if (!TU) {
1152 fprintf(stderr, "unable to parse input\n");
1153 clang_disposeIndex(CIdx);
1154 free(filename);
1155 free_remapped_files(unsaved_files, num_unsaved_files);
1156 return -1;
Ted Kremeneke68fff62010-02-17 00:41:32 +00001157 }
Douglas Gregorfc8ea232010-01-26 17:06:03 +00001158 errorCode = 0;
1159
1160 file = clang_getFile(TU, filename);
1161 if (!file) {
1162 fprintf(stderr, "file %s is not in this translation unit\n", filename);
1163 errorCode = -1;
1164 goto teardown;
1165 }
1166
1167 startLoc = clang_getLocation(TU, file, line, column);
1168 if (clang_equalLocations(clang_getNullLocation(), startLoc)) {
Ted Kremeneke68fff62010-02-17 00:41:32 +00001169 fprintf(stderr, "invalid source location %s:%d:%d\n", filename, line,
Douglas Gregorfc8ea232010-01-26 17:06:03 +00001170 column);
1171 errorCode = -1;
Ted Kremeneke68fff62010-02-17 00:41:32 +00001172 goto teardown;
Douglas Gregorfc8ea232010-01-26 17:06:03 +00001173 }
1174
1175 endLoc = clang_getLocation(TU, file, second_line, second_column);
1176 if (clang_equalLocations(clang_getNullLocation(), endLoc)) {
Ted Kremeneke68fff62010-02-17 00:41:32 +00001177 fprintf(stderr, "invalid source location %s:%d:%d\n", filename,
Douglas Gregorfc8ea232010-01-26 17:06:03 +00001178 second_line, second_column);
1179 errorCode = -1;
Ted Kremeneke68fff62010-02-17 00:41:32 +00001180 goto teardown;
Douglas Gregorfc8ea232010-01-26 17:06:03 +00001181 }
1182
1183 range = clang_getRange(startLoc, endLoc);
1184 clang_tokenize(TU, range, &tokens, &num_tokens);
1185 cursors = (CXCursor *)malloc(num_tokens * sizeof(CXCursor));
1186 clang_annotateTokens(TU, tokens, num_tokens, cursors);
1187 for (i = 0; i != num_tokens; ++i) {
1188 const char *kind = "<unknown>";
1189 CXString spelling = clang_getTokenSpelling(TU, tokens[i]);
1190 CXSourceRange extent = clang_getTokenExtent(TU, tokens[i]);
1191 unsigned start_line, start_column, end_line, end_column;
1192
1193 switch (clang_getTokenKind(tokens[i])) {
1194 case CXToken_Punctuation: kind = "Punctuation"; break;
1195 case CXToken_Keyword: kind = "Keyword"; break;
1196 case CXToken_Identifier: kind = "Identifier"; break;
1197 case CXToken_Literal: kind = "Literal"; break;
1198 case CXToken_Comment: kind = "Comment"; break;
1199 }
Ted Kremeneke68fff62010-02-17 00:41:32 +00001200 clang_getInstantiationLocation(clang_getRangeStart(extent),
Douglas Gregor46766dc2010-01-26 19:19:08 +00001201 0, &start_line, &start_column, 0);
Douglas Gregorfc8ea232010-01-26 17:06:03 +00001202 clang_getInstantiationLocation(clang_getRangeEnd(extent),
Douglas Gregor46766dc2010-01-26 19:19:08 +00001203 0, &end_line, &end_column, 0);
Daniel Dunbar51b058c2010-02-14 08:32:24 +00001204 printf("%s: \"%s\" ", kind, clang_getCString(spelling));
1205 PrintExtent(stdout, start_line, start_column, end_line, end_column);
Douglas Gregor0045e9f2010-01-26 18:31:56 +00001206 if (!clang_isInvalid(cursors[i].kind)) {
1207 printf(" ");
1208 PrintCursor(cursors[i]);
1209 }
1210 printf("\n");
Douglas Gregorfc8ea232010-01-26 17:06:03 +00001211 }
1212 free(cursors);
1213
1214 teardown:
Douglas Gregora88084b2010-02-18 18:08:43 +00001215 PrintDiagnostics(TU);
Douglas Gregorfc8ea232010-01-26 17:06:03 +00001216 clang_disposeTranslationUnit(TU);
1217 clang_disposeIndex(CIdx);
1218 free(filename);
1219 free_remapped_files(unsaved_files, num_unsaved_files);
1220 return errorCode;
1221}
1222
Ted Kremenek0d435192009-11-17 18:13:31 +00001223/******************************************************************************/
Ted Kremenekf7b714d2010-03-25 02:00:39 +00001224/* USR printing. */
1225/******************************************************************************/
1226
1227static int insufficient_usr(const char *kind, const char *usage) {
1228 fprintf(stderr, "USR for '%s' requires: %s\n", kind, usage);
1229 return 1;
1230}
1231
1232static unsigned isUSR(const char *s) {
1233 return s[0] == 'c' && s[1] == ':';
1234}
1235
1236static int not_usr(const char *s, const char *arg) {
1237 fprintf(stderr, "'%s' argument ('%s') is not a USR\n", s, arg);
1238 return 1;
1239}
1240
1241static void print_usr(CXString usr) {
1242 const char *s = clang_getCString(usr);
1243 printf("%s\n", s);
1244 clang_disposeString(usr);
1245}
1246
1247static void display_usrs() {
1248 fprintf(stderr, "-print-usrs options:\n"
1249 " ObjCCategory <class name> <category name>\n"
1250 " ObjCClass <class name>\n"
1251 " ObjCIvar <ivar name> <class USR>\n"
1252 " ObjCMethod <selector> [0=class method|1=instance method] "
1253 "<class USR>\n"
1254 " ObjCProperty <property name> <class USR>\n"
1255 " ObjCProtocol <protocol name>\n");
1256}
1257
1258int print_usrs(const char **I, const char **E) {
1259 while (I != E) {
1260 const char *kind = *I;
1261 unsigned len = strlen(kind);
1262 switch (len) {
1263 case 8:
1264 if (memcmp(kind, "ObjCIvar", 8) == 0) {
1265 if (I + 2 >= E)
1266 return insufficient_usr(kind, "<ivar name> <class USR>");
1267 if (!isUSR(I[2]))
1268 return not_usr("<class USR>", I[2]);
1269 else {
1270 CXString x;
1271 x.Spelling = I[2];
1272 x.MustFreeString = 0;
1273 print_usr(clang_constructUSR_ObjCIvar(I[1], x));
1274 }
1275
1276 I += 3;
1277 continue;
1278 }
1279 break;
1280 case 9:
1281 if (memcmp(kind, "ObjCClass", 9) == 0) {
1282 if (I + 1 >= E)
1283 return insufficient_usr(kind, "<class name>");
1284 print_usr(clang_constructUSR_ObjCClass(I[1]));
1285 I += 2;
1286 continue;
1287 }
1288 break;
1289 case 10:
1290 if (memcmp(kind, "ObjCMethod", 10) == 0) {
1291 if (I + 3 >= E)
1292 return insufficient_usr(kind, "<method selector> "
1293 "[0=class method|1=instance method] <class USR>");
1294 if (!isUSR(I[3]))
1295 return not_usr("<class USR>", I[3]);
1296 else {
1297 CXString x;
1298 x.Spelling = I[3];
1299 x.MustFreeString = 0;
1300 print_usr(clang_constructUSR_ObjCMethod(I[1], atoi(I[2]), x));
1301 }
1302 I += 4;
1303 continue;
1304 }
1305 break;
1306 case 12:
1307 if (memcmp(kind, "ObjCCategory", 12) == 0) {
1308 if (I + 2 >= E)
1309 return insufficient_usr(kind, "<class name> <category name>");
1310 print_usr(clang_constructUSR_ObjCCategory(I[1], I[2]));
1311 I += 3;
1312 continue;
1313 }
1314 if (memcmp(kind, "ObjCProtocol", 12) == 0) {
1315 if (I + 1 >= E)
1316 return insufficient_usr(kind, "<protocol name>");
1317 print_usr(clang_constructUSR_ObjCProtocol(I[1]));
1318 I += 2;
1319 continue;
1320 }
1321 if (memcmp(kind, "ObjCProperty", 12) == 0) {
1322 if (I + 2 >= E)
1323 return insufficient_usr(kind, "<property name> <class USR>");
1324 if (!isUSR(I[2]))
1325 return not_usr("<class USR>", I[2]);
1326 else {
1327 CXString x;
1328 x.Spelling = I[2];
1329 x.MustFreeString = 0;
1330 print_usr(clang_constructUSR_ObjCProperty(I[1], x));
1331 }
1332 I += 3;
1333 continue;
1334 }
1335 break;
1336 default:
1337 break;
1338 }
1339 break;
1340 }
1341
1342 if (I != E) {
1343 fprintf(stderr, "Invalid USR kind: %s\n", *I);
1344 display_usrs();
1345 return 1;
1346 }
1347 return 0;
1348}
1349
1350int print_usrs_file(const char *file_name) {
1351 char line[2048];
1352 const char *args[128];
1353 unsigned numChars = 0;
1354
1355 FILE *fp = fopen(file_name, "r");
1356 if (!fp) {
1357 fprintf(stderr, "error: cannot open '%s'\n", file_name);
1358 return 1;
1359 }
1360
1361 /* This code is not really all that safe, but it works fine for testing. */
1362 while (!feof(fp)) {
1363 char c = fgetc(fp);
1364 if (c == '\n') {
1365 unsigned i = 0;
1366 const char *s = 0;
1367
1368 if (numChars == 0)
1369 continue;
1370
1371 line[numChars] = '\0';
1372 numChars = 0;
1373
1374 if (line[0] == '/' && line[1] == '/')
1375 continue;
1376
1377 s = strtok(line, " ");
1378 while (s) {
1379 args[i] = s;
1380 ++i;
1381 s = strtok(0, " ");
1382 }
1383 if (print_usrs(&args[0], &args[i]))
1384 return 1;
1385 }
1386 else
1387 line[numChars++] = c;
1388 }
1389
1390 fclose(fp);
1391 return 0;
1392}
1393
1394/******************************************************************************/
Ted Kremenek0d435192009-11-17 18:13:31 +00001395/* Command line processing. */
1396/******************************************************************************/
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00001397int write_pch_file(const char *filename, int argc, const char *argv[]) {
1398 CXIndex Idx;
1399 CXTranslationUnit TU;
1400 struct CXUnsavedFile *unsaved_files = 0;
1401 int num_unsaved_files = 0;
1402
1403 Idx = clang_createIndex(/* excludeDeclsFromPCH */1, /* displayDiagnosics=*/1);
1404
1405 if (parse_remapped_files(argc, argv, 0, &unsaved_files, &num_unsaved_files)) {
1406 clang_disposeIndex(Idx);
1407 return -1;
1408 }
1409
1410 TU = clang_parseTranslationUnit(Idx, 0,
1411 argv + num_unsaved_files,
1412 argc - num_unsaved_files,
1413 unsaved_files,
1414 num_unsaved_files,
1415 CXTranslationUnit_Incomplete);
1416 if (!TU) {
1417 fprintf(stderr, "Unable to load translation unit!\n");
1418 free_remapped_files(unsaved_files, num_unsaved_files);
1419 clang_disposeIndex(Idx);
1420 return 1;
1421 }
1422
Douglas Gregor19998442010-08-13 15:35:05 +00001423 if (clang_saveTranslationUnit(TU, filename, clang_defaultSaveOptions(TU)))
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00001424 fprintf(stderr, "Unable to write PCH file %s\n", filename);
1425 clang_disposeTranslationUnit(TU);
1426 free_remapped_files(unsaved_files, num_unsaved_files);
1427 clang_disposeIndex(Idx);
1428 return 0;
1429}
1430
1431/******************************************************************************/
1432/* Command line processing. */
1433/******************************************************************************/
Ted Kremenekf5d9c932009-11-17 18:09:14 +00001434
Douglas Gregore5b72ba2010-01-20 21:32:04 +00001435static CXCursorVisitor GetVisitor(const char *s) {
Ted Kremenek7d405622010-01-12 23:34:26 +00001436 if (s[0] == '\0')
Douglas Gregore5b72ba2010-01-20 21:32:04 +00001437 return FilteredPrintingVisitor;
Ted Kremenek7d405622010-01-12 23:34:26 +00001438 if (strcmp(s, "-usrs") == 0)
1439 return USRVisitor;
1440 return NULL;
1441}
1442
Ted Kremenekf5d9c932009-11-17 18:09:14 +00001443static void print_usage(void) {
1444 fprintf(stderr,
Ted Kremenek0d435192009-11-17 18:13:31 +00001445 "usage: c-index-test -code-completion-at=<site> <compiler arguments>\n"
Douglas Gregor1982c182010-07-12 18:38:41 +00001446 " c-index-test -code-completion-timing=<site> <compiler arguments>\n"
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00001447 " c-index-test -cursor-at=<site> <compiler arguments>\n"
Ted Kremenek1d5fdf32009-11-18 02:02:52 +00001448 " c-index-test -test-file-scan <AST file> <source file> "
1449 "[FileCheck prefix]\n"
Ted Kremenekfe6fd3d2010-01-05 23:18:49 +00001450 " c-index-test -test-load-tu <AST file> <symbol filter> "
1451 "[FileCheck prefix]\n"
Ted Kremenek7d405622010-01-12 23:34:26 +00001452 " c-index-test -test-load-tu-usrs <AST file> <symbol filter> "
1453 "[FileCheck prefix]\n"
Douglas Gregor1982c182010-07-12 18:38:41 +00001454 " c-index-test -test-load-source <symbol filter> {<args>}*\n");
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00001455 fprintf(stderr,
Douglas Gregorabc563f2010-07-19 21:46:24 +00001456 " c-index-test -test-load-source-reparse <trials> <symbol filter> "
1457 " {<args>}*\n"
Douglas Gregor1982c182010-07-12 18:38:41 +00001458 " c-index-test -test-load-source-usrs <symbol filter> {<args>}*\n"
Ted Kremenek16b55a72010-01-26 19:31:51 +00001459 " c-index-test -test-annotate-tokens=<range> {<args>}*\n"
1460 " c-index-test -test-inclusion-stack-source {<args>}*\n"
Ted Kremenek3bed5272010-03-03 06:37:58 +00001461 " c-index-test -test-inclusion-stack-tu <AST file>\n"
Ted Kremenekf7b714d2010-03-25 02:00:39 +00001462 " c-index-test -test-print-linkage-source {<args>}*\n"
Ted Kremenek8e0ac172010-05-14 21:29:26 +00001463 " c-index-test -test-print-typekind {<args>}*\n"
Chandler Carruth53513d22010-07-22 06:29:13 +00001464 " c-index-test -print-usr [<CursorKind> {<args>}]*\n");
1465 fprintf(stderr,
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00001466 " c-index-test -print-usr-file <file>\n"
1467 " c-index-test -write-pch <file> <compiler arguments>\n\n");
Douglas Gregorcaf4bd32010-07-20 14:34:35 +00001468 fprintf(stderr,
Ted Kremenek7d405622010-01-12 23:34:26 +00001469 " <symbol filter> values:\n%s",
Ted Kremenek0d435192009-11-17 18:13:31 +00001470 " all - load all symbols, including those from PCH\n"
1471 " local - load all symbols except those in PCH\n"
1472 " category - only load ObjC categories (non-PCH)\n"
1473 " interface - only load ObjC interfaces (non-PCH)\n"
1474 " protocol - only load ObjC protocols (non-PCH)\n"
1475 " function - only load functions (non-PCH)\n"
Daniel Dunbar625e4ef2009-12-01 02:35:37 +00001476 " typedef - only load typdefs (non-PCH)\n"
1477 " scan-function - scan function bodies (non-PCH)\n\n");
Ted Kremenekf5d9c932009-11-17 18:09:14 +00001478}
1479
1480int main(int argc, const char **argv) {
Douglas Gregor0a812cf2010-02-18 23:07:20 +00001481 clang_enableStackTraces();
Ted Kremenekf5d9c932009-11-17 18:09:14 +00001482 if (argc > 2 && strstr(argv[1], "-code-completion-at=") == argv[1])
Douglas Gregor1982c182010-07-12 18:38:41 +00001483 return perform_code_completion(argc, argv, 0);
1484 if (argc > 2 && strstr(argv[1], "-code-completion-timing=") == argv[1])
1485 return perform_code_completion(argc, argv, 1);
Douglas Gregorf2c87bd2010-01-15 19:40:17 +00001486 if (argc > 2 && strstr(argv[1], "-cursor-at=") == argv[1])
1487 return inspect_cursor_at(argc, argv);
Ted Kremenek7d405622010-01-12 23:34:26 +00001488 else if (argc >= 4 && strncmp(argv[1], "-test-load-tu", 13) == 0) {
Douglas Gregore5b72ba2010-01-20 21:32:04 +00001489 CXCursorVisitor I = GetVisitor(argv[1] + 13);
Ted Kremenek7d405622010-01-12 23:34:26 +00001490 if (I)
Ted Kremenekce2ae882010-01-26 17:59:48 +00001491 return perform_test_load_tu(argv[2], argv[3], argc >= 5 ? argv[4] : 0, I,
1492 NULL);
Ted Kremenek7d405622010-01-12 23:34:26 +00001493 }
Douglas Gregorabc563f2010-07-19 21:46:24 +00001494 else if (argc >= 5 && strncmp(argv[1], "-test-load-source-reparse", 25) == 0){
1495 CXCursorVisitor I = GetVisitor(argv[1] + 25);
1496 if (I) {
1497 int trials = atoi(argv[2]);
1498 return perform_test_reparse_source(argc - 4, argv + 4, trials, argv[3], I,
1499 NULL);
1500 }
1501 }
Ted Kremenek7d405622010-01-12 23:34:26 +00001502 else if (argc >= 4 && strncmp(argv[1], "-test-load-source", 17) == 0) {
Douglas Gregore5b72ba2010-01-20 21:32:04 +00001503 CXCursorVisitor I = GetVisitor(argv[1] + 17);
Ted Kremenek7d405622010-01-12 23:34:26 +00001504 if (I)
Ted Kremenekce2ae882010-01-26 17:59:48 +00001505 return perform_test_load_source(argc - 3, argv + 3, argv[2], I, NULL);
Ted Kremenek7d405622010-01-12 23:34:26 +00001506 }
1507 else if (argc >= 4 && strcmp(argv[1], "-test-file-scan") == 0)
Ted Kremenek1d5fdf32009-11-18 02:02:52 +00001508 return perform_file_scan(argv[2], argv[3],
1509 argc >= 5 ? argv[4] : 0);
Douglas Gregorfc8ea232010-01-26 17:06:03 +00001510 else if (argc > 2 && strstr(argv[1], "-test-annotate-tokens=") == argv[1])
1511 return perform_token_annotation(argc, argv);
Ted Kremenek16b55a72010-01-26 19:31:51 +00001512 else if (argc > 2 && strcmp(argv[1], "-test-inclusion-stack-source") == 0)
1513 return perform_test_load_source(argc - 2, argv + 2, "all", NULL,
1514 PrintInclusionStack);
1515 else if (argc > 2 && strcmp(argv[1], "-test-inclusion-stack-tu") == 0)
1516 return perform_test_load_tu(argv[2], "all", NULL, NULL,
1517 PrintInclusionStack);
Ted Kremenek3bed5272010-03-03 06:37:58 +00001518 else if (argc > 2 && strcmp(argv[1], "-test-print-linkage-source") == 0)
1519 return perform_test_load_source(argc - 2, argv + 2, "all", PrintLinkage,
1520 NULL);
Ted Kremenek8e0ac172010-05-14 21:29:26 +00001521 else if (argc > 2 && strcmp(argv[1], "-test-print-typekind") == 0)
1522 return perform_test_load_source(argc - 2, argv + 2, "all",
1523 PrintTypeKind, 0);
Ted Kremenekf7b714d2010-03-25 02:00:39 +00001524 else if (argc > 1 && strcmp(argv[1], "-print-usr") == 0) {
1525 if (argc > 2)
1526 return print_usrs(argv + 2, argv + argc);
1527 else {
1528 display_usrs();
1529 return 1;
1530 }
1531 }
1532 else if (argc > 2 && strcmp(argv[1], "-print-usr-file") == 0)
1533 return print_usrs_file(argv[2]);
Douglas Gregor7ae2faa2010-08-13 05:36:37 +00001534 else if (argc > 2 && strcmp(argv[1], "-write-pch") == 0)
1535 return write_pch_file(argv[2], argc - 3, argv + 3);
1536
Ted Kremenekf5d9c932009-11-17 18:09:14 +00001537 print_usage();
1538 return 1;
Steve Naroff50398192009-08-28 15:28:48 +00001539}