1/*===-- clang-c/CXFile.h - C Index File ---------------------------*- C -*-===*\
3|* Part of the LLVM Project, under the Apache License v2.0 with LLVM *|
5|* See https://llvm.org/LICENSE.txt for license information. *|
6|* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception *|
8|*===----------------------------------------------------------------------===*|
10|* This header provides the interface to C Index files. *|
12\*===----------------------------------------------------------------------===*/
14#ifndef LLVM_CLANG_C_CXFILE_H
15#define LLVM_CLANG_C_CXFILE_H
26 * \defgroup CINDEX_FILES File manipulation routines
32 * A particular source file that is part of a translation unit.
37 * Retrieve the complete file and path name of the given file.
42 * Retrieve the last modification time of the given file.
47 * Uniquely identifies a CXFile, that refers to the same underlying file,
48 * across an indexing session.
51 unsigned long long data[3];
55 * Retrieve the unique ID for the given \c file.
57 * \param file the file to get the ID for.
58 * \param outID stores the returned CXFileUniqueID.
59 * \returns If there was a failure getting the unique ID, returns non-zero,
60 * otherwise returns 0.
65 * Returns non-zero if the \c file1 and \c file2 point to the same file,
66 * or they are both NULL.
71 * Returns the real path name of \c file.
73 * An empty string may be returned. Use \c clang_getFileName() in that case.
#define LLVM_CLANG_C_EXTERN_C_END
#define LLVM_CLANG_C_EXTERN_C_BEGIN
CINDEX_LINKAGE CXString clang_File_tryGetRealPathName(CXFile file)
Returns the real path name of file.
CINDEX_LINKAGE CXString clang_getFileName(CXFile SFile)
Retrieve the complete file and path name of the given file.
CINDEX_LINKAGE int clang_File_isEqual(CXFile file1, CXFile file2)
Returns non-zero if the file1 and file2 point to the same file, or they are both NULL.
CINDEX_LINKAGE time_t clang_getFileTime(CXFile SFile)
Retrieve the last modification time of the given file.
void * CXFile
A particular source file that is part of a translation unit.
CINDEX_LINKAGE int clang_getFileUniqueID(CXFile file, CXFileUniqueID *outID)
Retrieve the unique ID for the given file.
Uniquely identifies a CXFile, that refers to the same underlying file, across an indexing session.
unsigned long long data[3]