29e0435ac0
The `Index.h` header defines some functions and data structures that are useful for other (non-indexing) APIs. This patch extracts those into separate headers. Reviewed By: akyrtzi, benlangmuir Differential Revision: https://reviews.llvm.org/D134837
84 lines
2.5 KiB
C
84 lines
2.5 KiB
C
/*===-- clang-c/CXFile.h - C Index File ---------------------------*- C -*-===*\
|
|
|* *|
|
|
|* Part of the LLVM Project, under the Apache License v2.0 with LLVM *|
|
|
|* Exceptions. *|
|
|
|* See https://llvm.org/LICENSE.txt for license information. *|
|
|
|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *|
|
|
|* *|
|
|
|*===----------------------------------------------------------------------===*|
|
|
|* *|
|
|
|* This header provides the interface to C Index files. *|
|
|
|* *|
|
|
\*===----------------------------------------------------------------------===*/
|
|
|
|
#ifndef LLVM_CLANG_C_CXFILE_H
|
|
#define LLVM_CLANG_C_CXFILE_H
|
|
|
|
#include <time.h>
|
|
|
|
#include "clang-c/CXString.h"
|
|
#include "clang-c/ExternC.h"
|
|
#include "clang-c/Platform.h"
|
|
|
|
LLVM_CLANG_C_EXTERN_C_BEGIN
|
|
|
|
/**
|
|
* \defgroup CINDEX_FILES File manipulation routines
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* A particular source file that is part of a translation unit.
|
|
*/
|
|
typedef void *CXFile;
|
|
|
|
/**
|
|
* Retrieve the complete file and path name of the given file.
|
|
*/
|
|
CINDEX_LINKAGE CXString clang_getFileName(CXFile SFile);
|
|
|
|
/**
|
|
* Retrieve the last modification time of the given file.
|
|
*/
|
|
CINDEX_LINKAGE time_t clang_getFileTime(CXFile SFile);
|
|
|
|
/**
|
|
* Uniquely identifies a CXFile, that refers to the same underlying file,
|
|
* across an indexing session.
|
|
*/
|
|
typedef struct {
|
|
unsigned long long data[3];
|
|
} CXFileUniqueID;
|
|
|
|
/**
|
|
* Retrieve the unique ID for the given \c file.
|
|
*
|
|
* \param file the file to get the ID for.
|
|
* \param outID stores the returned CXFileUniqueID.
|
|
* \returns If there was a failure getting the unique ID, returns non-zero,
|
|
* otherwise returns 0.
|
|
*/
|
|
CINDEX_LINKAGE int clang_getFileUniqueID(CXFile file, CXFileUniqueID *outID);
|
|
|
|
/**
|
|
* Returns non-zero if the \c file1 and \c file2 point to the same file,
|
|
* or they are both NULL.
|
|
*/
|
|
CINDEX_LINKAGE int clang_File_isEqual(CXFile file1, CXFile file2);
|
|
|
|
/**
|
|
* Returns the real path name of \c file.
|
|
*
|
|
* An empty string may be returned. Use \c clang_getFileName() in that case.
|
|
*/
|
|
CINDEX_LINKAGE CXString clang_File_tryGetRealPathName(CXFile file);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
LLVM_CLANG_C_EXTERN_C_END
|
|
|
|
#endif
|