1 /* Cycript - The Truly Universal Scripting Language
2 * Copyright (C) 2009-2016 Jay Freeman (saurik)
5 /* GNU Affero General Public License, Version 3 {{{ */
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
29 #include <clang-c/Index.h>
32 #include "Functor.hpp"
33 #include "Replace.hpp"
36 static CXChildVisitResult
CYVisit(CXCursor cursor
, CXCursor parent
, CXClientData arg
) {
37 (*reinterpret_cast<const Functor
<void (CXCursor
)> *>(arg
))(cursor
);
38 return CXChildVisit_Continue
;
41 static unsigned CYForChild(CXCursor cursor
, const Functor
<void (CXCursor
)> &visitor
) {
42 return clang_visitChildren(cursor
, &CYVisit
, const_cast<void *>(static_cast<const void *>(&visitor
)));
45 static bool CYOneChild(CXCursor cursor
, const Functor
<void (CXCursor
)> &visitor
) {
47 CYForChild(cursor
, fun([&](CXCursor child
) {
58 CYCXString(CXString value
) :
63 CYCXString(CXCursor cursor
) :
64 value_(clang_getCursorSpelling(cursor
))
68 CYCXString(CXCursorKind kind
) :
69 value_(clang_getCursorKindSpelling(kind
))
73 CYCXString(CXFile file
) :
74 value_(clang_getFileName(file
))
78 CYCXString(CXTranslationUnit unit
, CXToken token
) :
79 value_(clang_getTokenSpelling(unit
, token
))
84 clang_disposeString(value_
);
87 operator const char *() const {
88 return clang_getCString(value_
);
91 const char *Pool(CYPool
&pool
) const {
92 return pool
.strdup(*this);
95 bool operator ==(const char *rhs
) const {
96 const char *lhs(*this);
97 return lhs
== rhs
|| strcmp(lhs
, rhs
) == 0;
101 template <void (&clang_get_Location
)(CXSourceLocation
, CXFile
*, unsigned *, unsigned *, unsigned *) = clang_getSpellingLocation
>
102 struct CYCXPosition
{
108 CYCXPosition(CXSourceLocation location
) {
109 clang_get_Location(location
, &file_
, &line_
, &column_
, &offset_
);
112 CYCXPosition(CXTranslationUnit unit
, CXToken token
) :
113 CYCXPosition(clang_getTokenLocation(unit
, token
))
117 CXSourceLocation
Get(CXTranslationUnit unit
) const {
118 return clang_getLocation(unit
, file_
, line_
, column_
);
122 template <void (&clang_get_Location
)(CXSourceLocation
, CXFile
*, unsigned *, unsigned *, unsigned *)>
123 std::ostream
&operator <<(std::ostream
&out
, const CYCXPosition
<clang_get_Location
> &position
) {
124 if (position
.file_
!= NULL
)
125 out
<< "[" << CYCXString(position
.file_
) << "]:";
126 out
<< position
.line_
<< ":" << position
.column_
<< "@" << position
.offset_
;
131 unsigned priority_
= 0;
137 typedef std::map
<std::string
, CYKey
> CYKeyMap
;
139 struct CYChildBaton
{
140 CXTranslationUnit unit
;
143 CYChildBaton(CXTranslationUnit unit
, CYKeyMap
&keys
) :
152 CXTranslationUnit unit_
;
158 CYTokens(CXTranslationUnit unit
, CXSourceRange range
) :
161 clang_tokenize(unit_
, range
, &tokens_
, &count_
);
164 // libclang's tokenizer is horribly broken and returns "extra" tokens.
165 // this code goes back through the tokens and filters for good ones :/
167 CYCXPosition
<> end(clang_getRangeEnd(range
));
168 CYCXString
file(end
.file_
);
170 for (valid_
= 0; valid_
!= count_
; ++valid_
) {
171 CYCXPosition
<> position(unit
, tokens_
[valid_
]);
172 _assert(CYCXString(position
.file_
) == file
);
173 if (position
.offset_
>= end
.offset_
)
178 CYTokens(CXTranslationUnit unit
, CXCursor cursor
) :
179 CYTokens(unit
, clang_getCursorExtent(cursor
))
184 clang_disposeTokens(unit_
, tokens_
, count_
);
187 operator CXToken
*() const {
191 size_t size() const {
196 static CYUTF8String
CYCXPoolUTF8Range(CYPool
&pool
, CXSourceRange range
) {
197 CYCXPosition
<> start(clang_getRangeStart(range
));
198 CYCXPosition
<> end(clang_getRangeEnd(range
));
199 CYCXString
file(start
.file_
);
200 _assert(file
== CYCXString(end
.file_
));
204 char *data(static_cast<char *>(CYPoolFile(temp
, file
, &size
)));
205 _assert(start
.offset_
<= size
&& end
.offset_
<= size
&& start
.offset_
<= end
.offset_
);
208 code
.size
= end
.offset_
- start
.offset_
;
209 code
.data
= pool
.strndup(data
+ start
.offset_
, code
.size
);
213 static CYExpression
*CYTranslateExpression(CXTranslationUnit unit
, CXCursor cursor
) {
214 switch (CXCursorKind kind
= clang_getCursorKind(cursor
)) {
215 case CXCursor_CallExpr
: {
216 CYExpression
*function(NULL
);
217 CYList
<CYArgument
> arguments
;
218 CYForChild(cursor
, fun([&](CXCursor child
) {
219 CYExpression
*expression(CYTranslateExpression(unit
, child
));
220 if (function
== NULL
)
221 function
= expression
;
223 arguments
->*$
C_(expression
);
225 return $
C(function
, arguments
);
228 case CXCursor_DeclRefExpr
: {
229 return $
V(CYCXString(cursor
).Pool($pool
));
232 case CXCursor_IntegerLiteral
: {
233 // libclang doesn't provide any reasonable way to do this
234 // note: clang_tokenize doesn't work if this is a macro
235 // the token range starts inside the macro but ends after it
236 // the tokenizer freaks out and either fails with 0 tokens
237 // or returns some massive number of tokens ending here :/
239 CYUTF8String
token(CYCXPoolUTF8Range($pool
, clang_getCursorExtent(cursor
)));
240 double value(CYCastDouble(token
));
241 if (std::isnan(value
))
242 return $
V(token
.data
);
243 return $
CYNumber(value
);
246 case CXCursor_CStyleCastExpr
:
247 // XXX: most of the time, this is a "NoOp" integer cast; but we should check it
249 case CXCursor_UnexposedExpr
:
250 // there is a very high probability that this is actually an "ImplicitCastExpr"
251 // "Douglas Gregor" <dgregor@apple.com> err'd on the incorrect side of this one
252 // http://lists.llvm.org/pipermail/cfe-commits/Week-of-Mon-20110926/046998.html
254 case CXCursor_ParenExpr
: {
255 CYExpression
*pass(NULL
);
256 CYOneChild(cursor
, fun([&](CXCursor child
) {
257 pass
= CYTranslateExpression(unit
, child
);
263 //std::cerr << "E:" << CYCXString(kind) << std::endl;
268 static CYStatement
*CYTranslateStatement(CXTranslationUnit unit
, CXCursor cursor
) {
269 switch (CXCursorKind kind
= clang_getCursorKind(cursor
)) {
270 case CXCursor_ReturnStmt
: {
271 CYExpression
*value(NULL
);
272 CYOneChild(cursor
, fun([&](CXCursor child
) {
273 value
= CYTranslateExpression(unit
, child
);
275 return $
CYReturn(value
);
279 //std::cerr << "S:" << CYCXString(kind) << std::endl;
284 static CYStatement
*CYTranslateBlock(CXTranslationUnit unit
, CXCursor cursor
) {
285 CYList
<CYStatement
> statements
;
286 CYForChild(cursor
, fun([&](CXCursor child
) {
287 statements
->*CYTranslateStatement(unit
, child
);
289 return $
CYBlock(statements
);
292 static CYType
*CYDecodeType(CXType type
);
293 static void CYParseType(CXType type
, CYType
*typed
);
295 static void CYParseEnumeration(CXCursor cursor
, CYType
*typed
) {
296 CYList
<CYEnumConstant
> constants
;
298 CYForChild(cursor
, fun([&](CXCursor child
) {
299 if (clang_getCursorKind(child
) == CXCursor_EnumConstantDecl
)
300 constants
->*$
CYEnumConstant($
I($pool
.strdup(CYCXString(child
))), $
D(clang_getEnumConstantDeclValue(child
)));
303 CYType
*integer(CYDecodeType(clang_getEnumDeclIntegerType(cursor
)));
304 typed
->specifier_
= $
CYTypeEnum(NULL
, integer
->specifier_
, constants
);
307 static void CYParseStructure(CXCursor cursor
, CYType
*typed
) {
308 CYList
<CYTypeStructField
> fields
;
309 CYForChild(cursor
, fun([&](CXCursor child
) {
310 if (clang_getCursorKind(child
) == CXCursor_FieldDecl
)
311 fields
->*$
CYTypeStructField(CYDecodeType(clang_getCursorType(child
)), $
I(CYCXString(child
).Pool($pool
)));
314 typed
->specifier_
= $
CYTypeStruct(NULL
, $
CYStructTail(fields
));
317 static void CYParseCursor(CXType type
, CXCursor cursor
, CYType
*typed
) {
318 CYCXString
spelling(cursor
);
320 switch (CXCursorKind kind
= clang_getCursorKind(cursor
)) {
321 case CXCursor_EnumDecl
:
322 if (spelling
[0] != '\0')
323 typed
->specifier_
= $
CYTypeReference(CYTypeReferenceEnum
, $
I(spelling
.Pool($pool
)));
325 CYParseEnumeration(cursor
, typed
);
328 case CXCursor_StructDecl
: {
329 if (spelling
[0] != '\0')
330 typed
->specifier_
= $
CYTypeReference(CYTypeReferenceStruct
, $
I(spelling
.Pool($pool
)));
332 CYParseStructure(cursor
, typed
);
335 case CXCursor_UnionDecl
: {
340 std::cerr
<< "C:" << CYCXString(kind
) << std::endl
;
346 static CYTypedParameter
*CYParseSignature(CXType type
, CYType
*typed
) {
347 CYParseType(clang_getResultType(type
), typed
);
348 CYList
<CYTypedParameter
> parameters
;
349 for (int i(0), e(clang_getNumArgTypes(type
)); i
!= e
; ++i
)
350 parameters
->*$
CYTypedParameter(CYDecodeType(clang_getArgType(type
, i
)), NULL
);
354 static void CYParseFunction(CXType type
, CYType
*typed
) {
355 typed
= typed
->Modify($
CYTypeFunctionWith(clang_isFunctionTypeVariadic(type
), CYParseSignature(type
, typed
)));
358 static void CYParseType(CXType type
, CYType
*typed
) {
359 switch (CXTypeKind kind
= type
.kind
) {
360 case CXType_Unexposed
: {
361 CXType
result(clang_getResultType(type
));
362 if (result
.kind
== CXType_Invalid
)
363 CYParseCursor(type
, clang_getTypeDeclaration(type
), typed
);
365 // clang marks function pointers as Unexposed but still supports them
366 CYParseFunction(type
, typed
);
369 case CXType_Bool
: typed
->specifier_
= $
CYTypeVariable("bool"); break;
370 case CXType_Float
: typed
->specifier_
= $
CYTypeVariable("float"); break;
371 case CXType_Double
: typed
->specifier_
= $
CYTypeVariable("double"); break;
373 case CXType_Char_U
: typed
->specifier_
= $
CYTypeCharacter(CYTypeNeutral
); break;
374 case CXType_Char_S
: typed
->specifier_
= $
CYTypeCharacter(CYTypeNeutral
); break;
375 case CXType_SChar
: typed
->specifier_
= $
CYTypeCharacter(CYTypeSigned
); break;
376 case CXType_UChar
: typed
->specifier_
= $
CYTypeCharacter(CYTypeUnsigned
); break;
378 case CXType_Short
: typed
->specifier_
= $
CYTypeIntegral(CYTypeSigned
, 0); break;
379 case CXType_UShort
: typed
->specifier_
= $
CYTypeIntegral(CYTypeUnsigned
, 0); break;
381 case CXType_Int
: typed
->specifier_
= $
CYTypeIntegral(CYTypeSigned
, 1); break;
382 case CXType_UInt
: typed
->specifier_
= $
CYTypeIntegral(CYTypeUnsigned
, 1); break;
384 case CXType_Long
: typed
->specifier_
= $
CYTypeIntegral(CYTypeSigned
, 2); break;
385 case CXType_ULong
: typed
->specifier_
= $
CYTypeIntegral(CYTypeUnsigned
, 2); break;
387 case CXType_LongLong
: typed
->specifier_
= $
CYTypeIntegral(CYTypeSigned
, 3); break;
388 case CXType_ULongLong
: typed
->specifier_
= $
CYTypeIntegral(CYTypeUnsigned
, 3); break;
390 case CXType_Int128
: typed
->specifier_
= $
CYTypeInt128(CYTypeSigned
); break;
391 case CXType_UInt128
: typed
->specifier_
= $
CYTypeInt128(CYTypeUnsigned
); break;
393 case CXType_BlockPointer
: {
394 CXType
pointee(clang_getPointeeType(type
));
395 _assert(!clang_isFunctionTypeVariadic(pointee
));
396 typed
= typed
->Modify($
CYTypeBlockWith(CYParseSignature(pointee
, typed
)));
399 case CXType_ConstantArray
:
400 CYParseType(clang_getArrayElementType(type
), typed
);
401 typed
= typed
->Modify($
CYTypeArrayOf($
D(clang_getArraySize(type
))));
405 typed
->specifier_
= $
CYTypeVariable($pool
.strdup(CYCXString(clang_getTypeSpelling(type
))));
408 case CXType_FunctionProto
:
409 CYParseFunction(type
, typed
);
412 case CXType_IncompleteArray
:
413 // XXX: I probably should not decay to Pointer
414 CYParseType(clang_getArrayElementType(type
), typed
);
415 typed
= typed
->Modify($
CYTypePointerTo());
418 case CXType_ObjCClass
:
419 typed
->specifier_
= $
CYTypeVariable("Class");
423 typed
->specifier_
= $
CYTypeVariable("id");
426 case CXType_ObjCInterface
:
427 typed
->specifier_
= $
CYTypeVariable($pool
.strdup(CYCXString(clang_getTypeSpelling(type
))));
430 case CXType_ObjCObjectPointer
: {
431 CXType
pointee(clang_getPointeeType(type
));
432 if (pointee
.kind
!= CXType_Unexposed
) {
433 CYParseType(pointee
, typed
);
434 typed
= typed
->Modify($
CYTypePointerTo());
436 // Clang seems to have internal typedefs for id and Class that are awkward
441 typed
->specifier_
= $
CYTypeVariable("SEL");
445 CYParseType(clang_getPointeeType(type
), typed
);
446 typed
= typed
->Modify($
CYTypePointerTo());
450 typed
->specifier_
= $
CYTypeReference(CYTypeReferenceStruct
, $
I($pool
.strdup(CYCXString(clang_getTypeSpelling(type
)))));
454 // use the declaration in order to isolate the name of the typedef itself
455 typed
->specifier_
= $
CYTypeVariable($pool
.strdup(CYCXString(clang_getTypeDeclaration(type
))));
463 typed
->specifier_
= $
CYTypeVoid();
467 std::cerr
<< "T:" << CYCXString(clang_getTypeKindSpelling(kind
)) << std::endl
;
468 std::cerr
<< "_: " << CYCXString(clang_getTypeSpelling(type
)) << std::endl
;
472 if (clang_isConstQualifiedType(type
))
473 typed
= typed
->Modify($
CYTypeConstant());
476 static CYType
*CYDecodeType(CXType type
) {
477 CYType
*typed($
CYType(NULL
));
478 CYParseType(type
, typed
);
482 static CXChildVisitResult
CYChildVisit(CXCursor cursor
, CXCursor parent
, CXClientData arg
) {
483 CYChildBaton
&baton(*static_cast<CYChildBaton
*>(arg
));
484 CXTranslationUnit
&unit(baton
.unit
);
486 CXChildVisitResult
result(CXChildVisit_Continue
);
487 CYCXString
spelling(cursor
);
488 std::string
name(spelling
);
489 std::ostringstream value
;
490 unsigned priority(2);
491 unsigned flags(CYBridgeHold
);
493 /*CXSourceLocation location(clang_getCursorLocation(cursor));
494 CYCXPosition<> position(location);
495 std::cerr << spelling << " " << position << std::endl;*/
497 try { switch (CXCursorKind kind
= clang_getCursorKind(cursor
)) {
498 case CXCursor_EnumConstantDecl
: {
499 value
<< clang_getEnumConstantDeclValue(cursor
);
502 case CXCursor_EnumDecl
: {
503 if (spelling
[0] == '\0')
505 // XXX: this was blindly copied from StructDecl
506 if (!clang_isCursorDefinition(cursor
))
512 CYParseEnumeration(cursor
, &typed
);
515 CYOutput
out(*value
.rdbuf(), options
);
516 CYTypeExpression(&typed
).Output(out
, CYNoBFC
);
518 value
<< ".withName(\"" << name
<< "\")";
519 name
= "$cye" + name
;
520 flags
= CYBridgeType
;
522 // the enum constants are implemented separately *also*
523 // XXX: maybe move output logic to function we can call
524 result
= CXChildVisit_Recurse
;
527 case CXCursor_MacroDefinition
: {
528 CXSourceRange
range(clang_getCursorExtent(cursor
));
529 CYTokens
tokens(unit
, range
);
530 _assert(tokens
.size() != 0);
532 CXCursor cursors
[tokens
.size()];
533 clang_annotateTokens(unit
, tokens
, tokens
.size(), cursors
);
536 CYList
<CYFunctionParameter
> parameters
;
539 if (tokens
.size() != 1) {
540 CYCXPosition
<> start(clang_getRangeStart(range
));
541 CYCXString
first(unit
, tokens
[offset
]);
543 CYCXPosition
<> paren(unit
, tokens
[offset
]);
544 if (start
.offset_
+ strlen(spelling
) == paren
.offset_
) {
546 _assert(++offset
!= tokens
.size());
547 CYCXString
token(unit
, tokens
[offset
]);
548 parameters
->*$
P($
B($
I(token
.Pool($pool
))));
549 _assert(++offset
!= tokens
.size());
550 CYCXString
comma(unit
, tokens
[offset
]);
553 _assert(comma
== ",");
560 std::ostringstream body
;
561 for (unsigned i(offset
); i
!= tokens
.size(); ++i
) {
562 CYCXString
token(unit
, tokens
[i
]);
572 CYOutput
out(*value
.rdbuf(), options
);
573 out
<< '(' << "function" << '(';
576 out
<< "return" << ' ';
578 out
<< ';' << '}' << ')';
582 case CXCursor_StructDecl
: {
583 if (spelling
[0] == '\0')
585 if (!clang_isCursorDefinition(cursor
))
591 CYParseStructure(cursor
, &typed
);
594 CYOutput
out(*value
.rdbuf(), options
);
595 CYTypeExpression(&typed
).Output(out
, CYNoBFC
);
597 value
<< ".withName(\"" << name
<< "\")";
598 name
= "$cys" + name
;
599 flags
= CYBridgeType
;
602 case CXCursor_TypedefDecl
: {
605 CYType
*typed(CYDecodeType(clang_getTypedefDeclUnderlyingType(cursor
)));
606 if (typed
->specifier_
== NULL
)
607 value
<< "(typedef " << CYCXString(clang_getTypeSpelling(clang_getTypedefDeclUnderlyingType(cursor
))) << ")";
610 CYOutput
out(*value
.rdbuf(), options
);
611 CYTypeExpression(typed
).Output(out
, CYNoBFC
);
615 case CXCursor_FunctionDecl
:
616 case CXCursor_VarDecl
: {
619 CYList
<CYFunctionParameter
> parameters
;
620 CYStatement
*code(NULL
);
624 CYForChild(cursor
, fun([&](CXCursor child
) {
625 switch (CXCursorKind kind
= clang_getCursorKind(child
)) {
626 case CXCursor_AsmLabelAttr
:
627 label
= CYCXString(child
);
630 case CXCursor_CompoundStmt
:
631 code
= CYTranslateBlock(unit
, child
);
634 case CXCursor_ParmDecl
:
635 parameters
->*$
P($
B($
I(CYCXString(child
).Pool($pool
))));
638 case CXCursor_IntegerLiteral
:
639 case CXCursor_ObjCClassRef
:
640 case CXCursor_TypeRef
:
641 case CXCursor_UnexposedAttr
:
645 //std::cerr << "A:" << CYCXString(child) << std::endl;
653 } else if (label
[0] != '_')
657 CXType
type(clang_getCursorType(cursor
));
658 value
<< "*(typedef " << CYCXString(clang_getTypeSpelling(type
)) << ").pointerTo()(dlsym(RTLD_DEFAULT,'" << label
.substr(1) << "'))";
661 CYOutput
out(*value
.rdbuf(), options
);
662 CYFunctionExpression
*function($
CYFunctionExpression(NULL
, parameters
, code
));
663 function
->Output(out
, CYNoBFC
);
664 //std::cerr << value.str() << std::endl;
669 result
= CXChildVisit_Recurse
;
673 CYKey
&key(baton
.keys
[name
]);
674 if (key
.priority_
<= priority
) {
675 key
.priority_
= priority
;
676 key
.code_
= value
.str();
679 } } catch (const CYException
&error
) {
681 //std::cerr << error.PoolCString(pool) << std::endl;
688 int main(int argc
, const char *argv
[]) {
689 CXIndex
index(clang_createIndex(0, 0));
691 const char *file(argv
[1]);
695 argv
[--offset
] = "-ObjC++";
698 CXTranslationUnit
unit(clang_parseTranslationUnit(index
, file
, argv
+ offset
, argc
- offset
, NULL
, 0, CXTranslationUnit_DetailedPreprocessingRecord
));
700 for (unsigned i(0), e(clang_getNumDiagnostics(unit
)); i
!= e
; ++i
) {
701 CXDiagnostic
diagnostic(clang_getDiagnostic(unit
, i
));
702 CYCXString
spelling(clang_getDiagnosticSpelling(diagnostic
));
703 std::cerr
<< spelling
<< std::endl
;
707 CYChildBaton
baton(unit
, keys
);
708 clang_visitChildren(clang_getTranslationUnitCursor(unit
), &CYChildVisit
, &baton
);
710 for (CYKeyMap::const_iterator
key(keys
.begin()); key
!= keys
.end(); ++key
) {
711 std::string
code(key
->second
.code_
);
712 for (size_t i(0), e(code
.size()); i
!= e
; ++i
)
713 if (code
[i
] <= 0 || code
[i
] >= 0x7f || code
[i
] == '\n')
715 std::cout
<< key
->first
<< "|" << key
->second
.flags_
<< "\"" << code
<< "\"" << std::endl
;
718 clang_disposeTranslationUnit(unit
);
719 clang_disposeIndex(index
);