ccls/src/indexer.h

455 lines
13 KiB
C
Raw Normal View History

2017-02-22 08:52:00 +00:00
#pragma once
2017-04-05 08:06:18 +00:00
#include "position.h"
2017-03-14 08:33:39 +00:00
#include "serializer.h"
2017-04-05 08:06:18 +00:00
#include "utils.h"
2017-03-25 20:32:44 +00:00
#include "libclangmm/clangmm.h"
#include "libclangmm/Utility.h"
2017-02-22 08:52:00 +00:00
2017-03-25 20:32:44 +00:00
#include <optional.h>
2017-02-22 08:52:00 +00:00
#include <rapidjson/writer.h>
#include <rapidjson/prettywriter.h>
#include <rapidjson/stringbuffer.h>
#include <rapidjson/document.h>
2017-03-25 20:32:44 +00:00
#include <algorithm>
#include <iostream>
#include <cstdint>
#include <cassert>
#include <fstream>
#include <unordered_map>
2017-02-24 08:39:25 +00:00
struct IndexedTypeDef;
struct IndexedFuncDef;
struct IndexedVarDef;
2017-02-22 08:52:00 +00:00
using namespace std::experimental;
2017-03-17 07:58:41 +00:00
template <typename T>
2017-02-25 23:59:09 +00:00
struct Id {
uint64_t id;
2017-03-17 07:58:41 +00:00
Id() : id(0) {} // Needed for containers. Do not use directly.
2017-02-27 07:25:59 +00:00
Id(uint64_t id) : id(id) {}
2017-02-25 23:59:09 +00:00
2017-03-17 07:58:41 +00:00
bool operator==(const Id<T>& other) const { return id == other.id; }
2017-02-25 23:59:09 +00:00
2017-03-17 07:58:41 +00:00
bool operator<(const Id<T>& other) const { return id < other.id; }
2017-02-25 23:59:09 +00:00
};
namespace std {
2017-03-17 07:58:41 +00:00
template <typename T>
struct hash<Id<T>> {
size_t operator()(const Id<T>& k) const { return hash<uint64_t>()(k.id); }
};
2017-02-25 23:59:09 +00:00
}
2017-03-17 07:58:41 +00:00
template <typename T>
2017-02-25 23:59:09 +00:00
bool operator==(const Id<T>& a, const Id<T>& b) {
assert(a.group == b.group && "Cannot compare Ids from different groups");
return a.id == b.id;
}
struct _FakeFileType {};
using TypeId = Id<IndexedTypeDef>;
using FuncId = Id<IndexedFuncDef>;
using VarId = Id<IndexedVarDef>;
2017-03-13 06:03:54 +00:00
struct IdCache;
2017-03-11 02:24:51 +00:00
2017-03-17 07:58:41 +00:00
template <typename T>
2017-02-25 23:59:09 +00:00
struct Ref {
Id<T> id;
2017-04-05 08:06:18 +00:00
Range loc;
2017-02-22 08:52:00 +00:00
2017-03-17 07:58:41 +00:00
Ref() {} // For serialization.
2017-04-05 08:06:18 +00:00
Ref(Id<T> id, Range loc) : id(id), loc(loc) {}
2017-02-22 08:52:00 +00:00
2017-02-25 23:59:09 +00:00
bool operator==(const Ref<T>& other) {
return id == other.id && loc == other.loc;
}
2017-03-17 07:58:41 +00:00
bool operator!=(const Ref<T>& other) { return !(*this == other); }
2017-02-25 23:59:09 +00:00
bool operator<(const Ref<T>& other) const {
return id < other.id && loc < other.loc;
2017-02-22 08:52:00 +00:00
}
};
2017-03-17 07:58:41 +00:00
template <typename T>
2017-02-25 23:59:09 +00:00
bool operator==(const Ref<T>& a, const Ref<T>& b) {
return a.id == b.id && a.loc == b.loc;
2017-02-22 08:52:00 +00:00
}
2017-03-17 07:58:41 +00:00
template <typename T>
2017-02-25 23:59:09 +00:00
bool operator!=(const Ref<T>& a, const Ref<T>& b) {
return !(a == b);
}
2017-02-22 08:52:00 +00:00
2017-02-24 08:39:25 +00:00
using TypeRef = Ref<IndexedTypeDef>;
using FuncRef = Ref<IndexedFuncDef>;
using VarRef = Ref<IndexedVarDef>;
2017-02-22 08:52:00 +00:00
// TODO: skip as much forward-processing as possible when |is_system_def| is
// set to false.
// TODO: Either eliminate the defs created as a by-product of cross-referencing,
// or do not emit things we don't have definitions for.
2017-04-05 08:06:18 +00:00
template <typename TypeId,
typename FuncId,
typename VarId,
typename Range>
2017-02-25 06:08:14 +00:00
struct TypeDefDefinitionData {
2017-02-22 08:52:00 +00:00
// General metadata.
std::string usr;
std::string short_name;
std::string qualified_name;
// While a class/type can technically have a separate declaration/definition,
// it doesn't really happen in practice. The declaration never contains
// comments or insightful information. The user always wants to jump from
// the declaration to the definition - never the other way around like in
// functions and (less often) variables.
//
// It's also difficult to identify a `class Foo;` statement with the clang
// indexer API (it's doable using cursor AST traversal), so we don't bother
// supporting the feature.
optional<Range> definition_spelling;
2017-04-05 08:06:18 +00:00
optional<Range> definition_extent;
2017-02-22 08:52:00 +00:00
// If set, then this is the same underlying type as the given value (ie, this
// type comes from a using or typedef statement).
optional<TypeId> alias_of;
2017-02-25 06:08:14 +00:00
// Immediate parent types.
2017-02-22 08:52:00 +00:00
std::vector<TypeId> parents;
// Types, functions, and variables defined in this type.
std::vector<TypeId> types;
std::vector<FuncId> funcs;
std::vector<VarId> vars;
2017-03-17 07:58:41 +00:00
TypeDefDefinitionData() {} // For reflection.
2017-02-27 07:23:43 +00:00
TypeDefDefinitionData(const std::string& usr) : usr(usr) {}
2017-02-25 23:59:09 +00:00
bool operator==(const TypeDefDefinitionData<TypeId, FuncId, VarId, Range>&
2017-03-17 07:58:41 +00:00
other) const {
return usr == other.usr && short_name == other.short_name &&
qualified_name == other.qualified_name &&
2017-04-05 08:06:18 +00:00
definition_spelling == other.definition_spelling &&
definition_extent == other.definition_extent &&
alias_of == other.alias_of &&
2017-03-17 07:58:41 +00:00
parents == other.parents && types == other.types &&
funcs == other.funcs && vars == other.vars;
2017-02-25 23:59:09 +00:00
}
bool operator!=(const TypeDefDefinitionData<TypeId, FuncId, VarId, Range>&
2017-03-17 07:58:41 +00:00
other) const {
return !(*this == other);
}
2017-02-25 06:08:14 +00:00
};
2017-03-17 07:58:41 +00:00
template <typename TVisitor,
typename TypeId,
typename FuncId,
typename VarId,
2017-04-05 08:06:18 +00:00
typename Range>
2017-03-17 07:58:41 +00:00
void Reflect(TVisitor& visitor,
TypeDefDefinitionData<TypeId, FuncId, VarId, Range>& value) {
2017-03-14 08:33:39 +00:00
REFLECT_MEMBER_START();
REFLECT_MEMBER(usr);
REFLECT_MEMBER(short_name);
REFLECT_MEMBER(qualified_name);
REFLECT_MEMBER(definition);
REFLECT_MEMBER(alias_of);
REFLECT_MEMBER(parents);
REFLECT_MEMBER(types);
REFLECT_MEMBER(funcs);
REFLECT_MEMBER(vars);
REFLECT_MEMBER_END();
}
2017-02-25 06:08:14 +00:00
struct IndexedTypeDef {
using Def = TypeDefDefinitionData<TypeId, FuncId, VarId, Range>;
2017-04-05 08:06:18 +00:00
Def def;
2017-02-25 06:08:14 +00:00
2017-02-27 07:23:43 +00:00
TypeId id;
2017-02-25 06:08:14 +00:00
// Immediate derived types.
std::vector<TypeId> derived;
2017-04-03 01:34:15 +00:00
// Declared variables of this type.
// TODO: this needs a lot more work and lots of tests.
// TODO: add instantiation on ctor / dtor, do not add instantiation if type is ptr
std::vector<VarId> instantiations;
2017-02-22 08:52:00 +00:00
// Every usage, useful for things like renames.
// NOTE: Do not insert directly! Use AddUsage instead.
2017-04-05 08:06:18 +00:00
std::vector<Range> uses;
2017-02-22 08:52:00 +00:00
2017-03-17 07:58:41 +00:00
IndexedTypeDef() : def("") {} // For serialization
2017-02-24 08:39:25 +00:00
IndexedTypeDef(TypeId id, const std::string& usr);
2017-02-25 23:59:09 +00:00
2017-04-03 01:34:15 +00:00
bool HasInterestingState() const {
return
2017-04-05 08:06:18 +00:00
def.definition_spelling ||
def.definition_extent ||
2017-04-03 01:34:15 +00:00
!derived.empty() ||
!instantiations.empty() ||
!uses.empty();
}
2017-02-25 23:59:09 +00:00
bool operator<(const IndexedTypeDef& other) const {
2017-02-27 07:23:43 +00:00
return def.usr < other.def.usr;
2017-02-25 23:59:09 +00:00
}
2017-02-22 08:52:00 +00:00
};
2017-03-25 20:40:04 +00:00
MAKE_HASHABLE(IndexedTypeDef, t.def.usr);
2017-02-25 23:59:09 +00:00
2017-04-05 08:06:18 +00:00
template <typename TypeId,
typename FuncId,
typename VarId,
typename FuncRef,
typename Range>
2017-02-25 06:08:14 +00:00
struct FuncDefDefinitionData {
2017-02-22 08:52:00 +00:00
// General metadata.
std::string usr;
std::string short_name;
std::string qualified_name;
optional<Range> definition_spelling;
2017-04-05 08:06:18 +00:00
optional<Range> definition_extent;
2017-02-22 08:52:00 +00:00
// Type which declares this one (ie, it is a method)
optional<TypeId> declaring_type;
2017-02-25 06:08:14 +00:00
2017-02-22 08:52:00 +00:00
// Method this method overrides.
optional<FuncId> base;
// Local variables defined in this function.
std::vector<VarId> locals;
2017-02-25 06:08:14 +00:00
// Functions that this function calls.
std::vector<FuncRef> callees;
2017-03-17 07:58:41 +00:00
FuncDefDefinitionData() {} // For reflection.
2017-02-27 07:23:43 +00:00
FuncDefDefinitionData(const std::string& usr) : usr(usr) {
2017-03-17 07:58:41 +00:00
// assert(usr.size() > 0);
2017-02-25 06:08:14 +00:00
}
2017-02-25 23:59:09 +00:00
2017-03-17 07:58:41 +00:00
bool operator==(
const FuncDefDefinitionData<TypeId, FuncId, VarId, FuncRef, Range>&
2017-03-17 07:58:41 +00:00
other) const {
return usr == other.usr && short_name == other.short_name &&
qualified_name == other.qualified_name &&
2017-04-05 08:06:18 +00:00
definition_spelling == other.definition_spelling &&
definition_extent == other.definition_extent &&
2017-03-17 07:58:41 +00:00
declaring_type == other.declaring_type && base == other.base &&
locals == other.locals && callees == other.callees;
}
bool operator!=(
const FuncDefDefinitionData<TypeId, FuncId, VarId, FuncRef, Range>&
2017-03-17 07:58:41 +00:00
other) const {
return !(*this == other);
2017-02-25 23:59:09 +00:00
}
2017-02-25 06:08:14 +00:00
};
2017-03-17 07:58:41 +00:00
template <typename TVisitor,
typename TypeId,
typename FuncId,
typename VarId,
typename FuncRef,
2017-04-05 08:06:18 +00:00
typename Range>
2017-03-17 07:58:41 +00:00
void Reflect(
TVisitor& visitor,
FuncDefDefinitionData<TypeId, FuncId, VarId, FuncRef, Range>& value) {
2017-03-14 08:33:39 +00:00
REFLECT_MEMBER_START();
REFLECT_MEMBER(usr);
REFLECT_MEMBER(short_name);
REFLECT_MEMBER(qualified_name);
REFLECT_MEMBER(definition);
REFLECT_MEMBER(declaring_type);
REFLECT_MEMBER(base);
REFLECT_MEMBER(locals);
REFLECT_MEMBER(callees);
REFLECT_MEMBER_END();
}
2017-02-25 06:08:14 +00:00
struct IndexedFuncDef {
using Def = FuncDefDefinitionData<TypeId, FuncId, VarId, FuncRef, Range>;
2017-04-05 08:06:18 +00:00
Def def;
2017-02-25 06:08:14 +00:00
2017-02-27 07:23:43 +00:00
FuncId id;
2017-02-25 06:08:14 +00:00
// Places the function is forward-declared.
2017-04-05 08:06:18 +00:00
std::vector<Range> declarations;
2017-02-25 06:08:14 +00:00
// Methods which directly override this one.
std::vector<FuncId> derived;
2017-02-22 08:52:00 +00:00
// Functions which call this one.
// TODO: Functions can get called outside of just functions - for example,
// they can get called in static context (maybe redirect to main?)
// or in class initializer list (redirect to class ctor?)
// - Right now those usages will not get listed here (but they should be
// inside of all_uses).
std::vector<FuncRef> callers;
// All usages. For interesting usages, see callees.
2017-04-05 08:06:18 +00:00
std::vector<Range> uses;
2017-02-22 08:52:00 +00:00
2017-03-17 07:58:41 +00:00
IndexedFuncDef() {} // For reflection.
2017-03-22 17:16:09 +00:00
IndexedFuncDef(FuncId id, const std::string& usr) : def(usr), id(id) {
2017-03-17 07:58:41 +00:00
// assert(usr.size() > 0);
2017-02-22 08:52:00 +00:00
}
2017-02-25 23:59:09 +00:00
2017-04-03 01:34:15 +00:00
bool HasInterestingState() const {
return
2017-04-05 08:06:18 +00:00
def.definition_spelling ||
def.definition_extent ||
2017-04-03 01:34:15 +00:00
!def.callees.empty() ||
!declarations.empty() ||
!derived.empty() ||
!callers.empty() ||
!uses.empty();
}
2017-02-25 23:59:09 +00:00
bool operator<(const IndexedFuncDef& other) const {
2017-02-27 07:23:43 +00:00
return def.usr < other.def.usr;
2017-02-25 23:59:09 +00:00
}
2017-02-22 08:52:00 +00:00
};
2017-03-25 20:40:04 +00:00
MAKE_HASHABLE(IndexedFuncDef, t.def.usr);
2017-02-25 23:59:09 +00:00
2017-04-05 08:06:18 +00:00
template <typename TypeId,
typename FuncId,
typename VarId,
typename Range>
2017-02-25 06:08:14 +00:00
struct VarDefDefinitionData {
2017-02-22 08:52:00 +00:00
// General metadata.
std::string usr;
std::string short_name;
std::string qualified_name;
2017-04-05 08:06:18 +00:00
optional<Range> declaration;
// TODO: definitions should be a list of ranges, since there can be more
// than one - when??
optional<Range> definition_spelling;
2017-04-05 08:06:18 +00:00
optional<Range> definition_extent;
2017-02-22 08:52:00 +00:00
// Type of the variable.
optional<TypeId> variable_type;
// Type which declares this one (ie, it is a method)
optional<TypeId> declaring_type;
2017-03-17 07:58:41 +00:00
VarDefDefinitionData() {} // For reflection.
2017-02-27 07:23:43 +00:00
VarDefDefinitionData(const std::string& usr) : usr(usr) {}
2017-02-25 23:59:09 +00:00
bool operator==(const VarDefDefinitionData<TypeId, FuncId, VarId, Range>&
2017-03-17 07:58:41 +00:00
other) const {
return usr == other.usr && short_name == other.short_name &&
qualified_name == other.qualified_name &&
2017-04-05 08:06:18 +00:00
declaration == other.declaration &&
definition_spelling == other.definition_spelling &&
definition_extent == other.definition_extent &&
2017-03-17 07:58:41 +00:00
variable_type == other.variable_type &&
declaring_type == other.declaring_type;
}
bool operator!=(const VarDefDefinitionData<TypeId, FuncId, VarId, Range>&
2017-03-17 07:58:41 +00:00
other) const {
return !(*this == other);
2017-02-25 23:59:09 +00:00
}
2017-02-25 06:08:14 +00:00
};
2017-03-17 07:58:41 +00:00
template <typename TVisitor,
typename TypeId,
typename FuncId,
typename VarId,
2017-04-05 08:06:18 +00:00
typename Range>
2017-03-17 07:58:41 +00:00
void Reflect(TVisitor& visitor,
VarDefDefinitionData<TypeId, FuncId, VarId, Range>& value) {
2017-03-14 08:33:39 +00:00
REFLECT_MEMBER_START();
REFLECT_MEMBER(usr);
REFLECT_MEMBER(short_name);
REFLECT_MEMBER(qualified_name);
2017-04-05 08:06:18 +00:00
REFLECT_MEMBER(definition_spelling);
REFLECT_MEMBER(definition_extent);
2017-03-14 08:33:39 +00:00
REFLECT_MEMBER(variable_type);
REFLECT_MEMBER(declaring_type);
REFLECT_MEMBER_END();
}
2017-02-25 06:08:14 +00:00
struct IndexedVarDef {
using Def = VarDefDefinitionData<TypeId, FuncId, VarId, Range>;
2017-04-05 08:06:18 +00:00
Def def;
2017-02-25 06:08:14 +00:00
2017-02-27 07:23:43 +00:00
VarId id;
2017-02-22 08:52:00 +00:00
// Usages.
2017-04-05 08:06:18 +00:00
std::vector<Range> uses;
2017-02-25 23:59:09 +00:00
2017-03-17 07:58:41 +00:00
IndexedVarDef() : def("") {} // For serialization
2017-03-22 17:16:09 +00:00
IndexedVarDef(VarId id, const std::string& usr) : def(usr), id(id) {
2017-03-17 07:58:41 +00:00
// assert(usr.size() > 0);
2017-02-22 08:52:00 +00:00
}
2017-02-25 23:59:09 +00:00
2017-04-03 01:34:15 +00:00
bool HasInterestingState() const {
return
2017-04-05 08:06:18 +00:00
def.definition_spelling ||
def.definition_extent ||
2017-04-03 01:34:15 +00:00
!uses.empty();
}
2017-02-25 23:59:09 +00:00
bool operator<(const IndexedVarDef& other) const {
2017-02-27 07:23:43 +00:00
return def.usr < other.def.usr;
2017-02-25 23:59:09 +00:00
}
2017-02-22 08:52:00 +00:00
};
2017-03-25 20:40:04 +00:00
MAKE_HASHABLE(IndexedVarDef, t.def.usr);
2017-02-22 08:52:00 +00:00
2017-02-26 19:45:59 +00:00
struct IdCache {
2017-04-03 01:34:15 +00:00
std::string primary_file;
2017-02-22 08:52:00 +00:00
std::unordered_map<std::string, TypeId> usr_to_type_id;
std::unordered_map<std::string, FuncId> usr_to_func_id;
std::unordered_map<std::string, VarId> usr_to_var_id;
2017-02-26 19:45:59 +00:00
std::unordered_map<TypeId, std::string> type_id_to_usr;
std::unordered_map<FuncId, std::string> func_id_to_usr;
std::unordered_map<VarId, std::string> var_id_to_usr;
2017-02-22 08:52:00 +00:00
2017-04-03 01:34:15 +00:00
IdCache(const std::string& primary_file);
2017-04-05 08:06:18 +00:00
Range ForceResolve(const CXSourceRange& range, bool interesting);
Range ForceResolveSpelling(const CXCursor& cx_cursor, bool interesting);
optional<Range> ResolveSpelling(const CXCursor& cx_cursor, bool interesting);
optional<Range> ResolveSpelling(const clang::Cursor& cursor, bool interesting);
Range ForceResolveExtent(const CXCursor& cx_cursor, bool interesting);
optional<Range> ResolveExtent(const CXCursor& cx_cursor, bool interesting);
optional<Range> ResolveExtent(const clang::Cursor& cursor, bool interesting);
2017-02-25 23:59:09 +00:00
};
struct IndexedFile {
2017-02-28 06:41:42 +00:00
IdCache id_cache;
2017-02-25 23:59:09 +00:00
2017-02-27 07:23:43 +00:00
std::string path;
2017-02-23 08:18:54 +00:00
std::vector<IndexedTypeDef> types;
std::vector<IndexedFuncDef> funcs;
std::vector<IndexedVarDef> vars;
2017-02-22 08:52:00 +00:00
2017-02-28 06:41:42 +00:00
IndexedFile(const std::string& path);
2017-02-22 08:52:00 +00:00
TypeId ToTypeId(const std::string& usr);
FuncId ToFuncId(const std::string& usr);
VarId ToVarId(const std::string& usr);
TypeId ToTypeId(const CXCursor& usr);
FuncId ToFuncId(const CXCursor& usr);
VarId ToVarId(const CXCursor& usr);
2017-02-23 08:18:54 +00:00
IndexedTypeDef* Resolve(TypeId id);
IndexedFuncDef* Resolve(FuncId id);
IndexedVarDef* Resolve(VarId id);
2017-02-22 08:52:00 +00:00
std::string ToString();
};
2017-03-17 07:58:41 +00:00
IndexedFile Parse(std::string filename,
std::vector<std::string> args,
2017-03-22 17:16:09 +00:00
bool dump_ast = false);