File: StoreSymbolRecord.h

package info (click to toggle)
swiftlang 6.1.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,791,532 kB
  • sloc: cpp: 9,901,743; ansic: 2,201,431; asm: 1,091,827; python: 308,252; objc: 82,166; f90: 80,126; lisp: 38,358; pascal: 25,559; sh: 20,429; ml: 5,058; perl: 4,745; makefile: 4,484; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (96 lines) | stat: -rw-r--r-- 3,480 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
//===--- StoreSymbolRecord.h ------------------------------------*- C++ -*-===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2018 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

#ifndef INDEXSTOREDB_LIB_INDEX_STORESYMBOLRECORD_H
#define INDEXSTOREDB_LIB_INDEX_STORESYMBOLRECORD_H

#include "IndexStoreDB/Core/Symbol.h"
#include "IndexStoreDB/Index/SymbolDataProvider.h"
#include "IndexStoreDB/Database/IDCode.h"
#include "indexstore/IndexStoreCXX.h"
#include "llvm/ADT/StringRef.h"
#include <string>

namespace IndexStoreDB {
  class CanonicalFilePathRef;
  class TimestampedPath;

namespace index {
  class StoreSymbolRecord;
  typedef std::shared_ptr<StoreSymbolRecord> StoreSymbolRecordRef;

struct FileAndTarget {
  TimestampedPath Path;
  std::string Target;
};

class StoreSymbolRecord : public SymbolDataProvider {
  indexstore::IndexStoreRef Store;
  std::string RecordName;
  db::IDCode ProviderCode;
  SymbolProviderKind SymProviderKind;
  std::vector<FileAndTarget> FileAndTargetRefs;

public:
  ~StoreSymbolRecord();

  static StoreSymbolRecordRef create(indexstore::IndexStoreRef store,
                                     StringRef recordName, db::IDCode providerCode,
                                     SymbolProviderKind symProviderKind,
                                     ArrayRef<FileAndTarget> fileReferences);

  StringRef getName() const { return RecordName; }

  SymbolProviderKind getProviderKind() const {
    return SymProviderKind;
  }

  ArrayRef<FileAndTarget> getSourceFileReferencesAndTargets() const {
    return FileAndTargetRefs;
  }

  /// \returns true for error.
  bool doForData(function_ref<void(indexstore::IndexRecordReader &)> Action);

  //===--------------------------------------------------------------------===//
  // SymbolDataProvider interface
  //===--------------------------------------------------------------------===//

  virtual std::string getIdentifier() const override { return RecordName; }

  virtual bool isSystem() const override;

  virtual bool foreachCoreSymbolData(function_ref<bool(StringRef USR,
                                                       StringRef Name,
                                                       SymbolInfo Info,
                                                       SymbolRoleSet Roles,
                                                       SymbolRoleSet RelatedRoles)> Receiver) override;

  virtual bool foreachSymbolOccurrence(function_ref<bool(SymbolOccurrenceRef Occur)> Receiver) override;

  virtual bool foreachSymbolOccurrenceByUSR(ArrayRef<db::IDCode> USRs,
                                            SymbolRoleSet RoleSet,
               function_ref<bool(SymbolOccurrenceRef Occur)> Receiver) override;

  virtual bool foreachRelatedSymbolOccurrenceByUSR(ArrayRef<db::IDCode> USRs,
                                            SymbolRoleSet RoleSet,
               function_ref<bool(SymbolOccurrenceRef Occur)> Receiver) override;

  virtual bool foreachUnitTestSymbolOccurrence(
               function_ref<bool(SymbolOccurrenceRef Occur)> Receiver) override;

};

} // namespace index
} // namespace IndexStoreDB

#endif