[cfe-dev] libclang interface for comments AST

[Jacob Carlborg]

On 2012-07-17 18:45, Dmitri Gribenko wrote:

> I agree that it is easy to make up a string with an empty value.  But
> what about clang_ParamCommandComment_getDirection, for example?  There
> is no "neutral" parameter passing direction.

Just add a new member to the enum representing an invalid value. Just as 
you've done with CXCommentKind. Call it 
CXCommentParamPassDirection_Null, CXCommentParamPassDirection_Invalid or 
something similar.

Another option, that always works, is to use an out parameter.

int clang_ParamCommandComment_getDirection(CXComment Comment, enum 
CXCommentParamPassDirection* out);

Or the other way around:

enum CXCommentParamPassDirection 
clang_ParamCommandComment_getDirection(CXComment Comment, int* success);

Although this doesn't really fit with the rest of the API.

> The design is not final (and the API is not fully implemented), so I
> didn't know if I will need anything else except void *Data.

Fair enough.

> The API is inconsistent in itself: struct CXUnsavedFile, struct
> CXVersion have members starting with uppercase letter, some other
> structs use lowercase.  Of these two styles I followed general clang
> style (which is a better thing to do).
>
> Dmitri
>

These are the only structs that have names starting with uppercase:

CXCompletionResult
CXCodeCompleteResults
CXUnsavedFile
CXVersion

BTW, it seems that libclang has its own style, which I see no problem 
with since it's C not C++.

-- 
/Jacob Carlborg