• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 //===- CXComment.h - Routines for manipulating CXComments -----------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file defines routines for manipulating CXComments.
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #ifndef LLVM_CLANG_CXCOMMENT_H
15 #define LLVM_CLANG_CXCOMMENT_H
16 
17 #include "CXTranslationUnit.h"
18 #include "clang-c/Index.h"
19 #include "clang/AST/ASTContext.h"
20 #include "clang/AST/Comment.h"
21 #include "clang/Frontend/ASTUnit.h"
22 
23 namespace clang {
24 namespace comments {
25   class CommandTraits;
26 }
27 
28 namespace cxcomment {
29 
createCXComment(const comments::Comment * C,CXTranslationUnit TU)30 inline CXComment createCXComment(const comments::Comment *C,
31                                  CXTranslationUnit TU) {
32   CXComment Result;
33   Result.ASTNode = C;
34   Result.TranslationUnit = TU;
35   return Result;
36 }
37 
getASTNode(CXComment CXC)38 inline const comments::Comment *getASTNode(CXComment CXC) {
39   return static_cast<const comments::Comment *>(CXC.ASTNode);
40 }
41 
42 template<typename T>
getASTNodeAs(CXComment CXC)43 inline const T *getASTNodeAs(CXComment CXC) {
44   const comments::Comment *C = getASTNode(CXC);
45   if (!C)
46     return NULL;
47 
48   return dyn_cast<T>(C);
49 }
50 
getASTContext(CXComment CXC)51 inline ASTContext &getASTContext(CXComment CXC) {
52   return cxtu::getASTUnit(CXC.TranslationUnit)->getASTContext();
53 }
54 
getCommandTraits(CXComment CXC)55 inline comments::CommandTraits &getCommandTraits(CXComment CXC) {
56   return getASTContext(CXC).getCommentCommandTraits();
57 }
58 
59 } // end namespace cxcomment
60 } // end namespace clang
61 
62 #endif
63 
64