[IDE] Pass a SourceRange instead of a CharSourceRange in SemaAnnotator::passReference

Most `SemaAnnotator`s don’t actually care about the char source range. Instead, they only care about the start location of the reference, which is also included in `SourceRange`. Computing a `CharSourceRange` from a `SourceRange` is kind of expensive because it needs to start a new lexer. To avoid this overhead, pass `SourceRange` to `SemaAnnotator::passReference` and related functions and let the clients compute the `CharSourceRange` when needed. This reduces the overhead of index-while-building by about 10%.
2025-12-14 20:36:38 +01:00 · 2025-06-04 12:34:07 +02:00
parent 9ae142c9d3
commit c6c40de73d
10 changed files with 95 additions and 88 deletions
--- a/include/swift/IDE/SourceEntityWalker.h
+++ b/include/swift/IDE/SourceEntityWalker.h
@@ -140,7 +140,7 @@ public:
  /// refers to.
  /// \param ExtTyRef this is set when the entity is a reference to a type loc
  /// in \c ExtensionDecl.
-  virtual bool visitDeclReference(ValueDecl *D, CharSourceRange Range,
+  virtual bool visitDeclReference(ValueDecl *D, SourceRange Range,
                                  TypeDecl *CtorTyRef, ExtensionDecl *ExtTyRef,
                                  Type T, ReferenceMetaData Data);

@@ -156,7 +156,7 @@ public:
  /// \param Data whether this is a read, write or read/write access, etc.
  /// \param IsOpenBracket this is \c true when the method is called on an
  /// open bracket.
-  virtual bool visitSubscriptReference(ValueDecl *D, CharSourceRange Range,
+  virtual bool visitSubscriptReference(ValueDecl *D, SourceRange Range,
                                       ReferenceMetaData Data,
                                       bool IsOpenBracket);

@@ -167,7 +167,7 @@ public:
  /// \param D the referenced decl.
  /// \param Range the source range of the source reference.
  /// \param Data whether this is a read, write or read/write access, etc.
-  virtual bool visitCallAsFunctionReference(ValueDecl *D, CharSourceRange Range,
+  virtual bool visitCallAsFunctionReference(ValueDecl *D, SourceRange Range,
                                            ReferenceMetaData Data);

  /// This method is called for each keyword argument in a call expression.
--- a/lib/FrontendTool/LoadedModuleTrace.cpp
+++ b/lib/FrontendTool/LoadedModuleTrace.cpp
@@ -829,9 +829,9 @@ bool swift::emitLoadedModuleTraceIfNeeded(ModuleDecl *mainModule,
 class ObjcMethodReferenceCollector: public SourceEntityWalker {
  unsigned CurrentFileID;
  llvm::DenseMap<const clang::ObjCMethodDecl*, unsigned> results;
-  bool visitDeclReference(ValueDecl *D, CharSourceRange Range,
-                          TypeDecl *CtorTyRef, ExtensionDecl *ExtTyRef,
-                          Type T, ReferenceMetaData Data) override {
+  bool visitDeclReference(ValueDecl *D, SourceRange Range, TypeDecl *CtorTyRef,
+                          ExtensionDecl *ExtTyRef, Type T,
+                          ReferenceMetaData Data) override {
    if (!Range.isValid())
      return true;
    if (auto *clangD = dyn_cast_or_null<clang::ObjCMethodDecl>(D->getClangDecl()))
--- a/lib/IDE/IDERequests.cpp
+++ b/lib/IDE/IDERequests.cpp
@@ -89,8 +89,8 @@ private:
  bool walkToDeclPost(Decl *D) override;
  bool walkToStmtPre(Stmt *S) override;
  bool walkToStmtPost(Stmt *S) override;
-  bool visitDeclReference(ValueDecl *D, CharSourceRange Range,
-                          TypeDecl *CtorTyRef, ExtensionDecl *ExtTyRef, Type T,
+  bool visitDeclReference(ValueDecl *D, SourceRange Range, TypeDecl *CtorTyRef,
+                          ExtensionDecl *ExtTyRef, Type T,
                          ReferenceMetaData Data) override;
  bool visitCallArgName(Identifier Name, CharSourceRange Range,
                        ValueDecl *D) override;
@@ -105,7 +105,7 @@ private:
                  std::optional<ReferenceMetaData> Data = std::nullopt);
  bool tryResolve(ModuleEntity Mod, SourceLoc Loc);
  bool tryResolve(Stmt *St);
-  bool visitSubscriptReference(ValueDecl *D, CharSourceRange Range,
+  bool visitSubscriptReference(ValueDecl *D, SourceRange Range,
                               ReferenceMetaData Data,
                               bool IsOpenBracket) override;
 };
@@ -210,7 +210,7 @@ bool CursorInfoResolver::tryResolve(Stmt *St) {
 }

 bool CursorInfoResolver::visitSubscriptReference(ValueDecl *D,
-                                                 CharSourceRange Range,
+                                                 SourceRange Range,
                                                 ReferenceMetaData Data,
                                                 bool IsOpenBracket) {
  // We should treat both open and close brackets equally
@@ -301,8 +301,7 @@ bool CursorInfoResolver::walkToStmtPost(Stmt *S) {
  return true;
 }

-bool CursorInfoResolver::visitDeclReference(ValueDecl *D,
-                                            CharSourceRange Range,
+bool CursorInfoResolver::visitDeclReference(ValueDecl *D, SourceRange Range,
                                            TypeDecl *CtorTyRef,
                                            ExtensionDecl *ExtTyRef, Type T,
                                            ReferenceMetaData Data) {
@@ -310,7 +309,8 @@ bool CursorInfoResolver::visitDeclReference(ValueDecl *D,
    return false;
  if (Data.isImplicit || !Range.isValid())
    return true;
-  return !tryResolve(D, CtorTyRef, ExtTyRef, Range.getStart(), /*IsRef=*/true, T, Data);
+  return !tryResolve(D, CtorTyRef, ExtTyRef, Range.Start, /*IsRef=*/true, T,
+                     Data);
 }

 static bool isCursorOn(Expr *E, SourceLoc Loc) {
@@ -461,8 +461,8 @@ class RangeResolver : public SourceEntityWalker {
  bool walkToStmtPost(Stmt *S) override;
  bool walkToDeclPre(Decl *D, CharSourceRange Range) override;
  bool walkToDeclPost(Decl *D) override;
-  bool visitDeclReference(ValueDecl *D, CharSourceRange Range,
-                          TypeDecl *CtorTyRef, ExtensionDecl *ExtTyRef, Type T,
+  bool visitDeclReference(ValueDecl *D, SourceRange Range, TypeDecl *CtorTyRef,
+                          ExtensionDecl *ExtTyRef, Type T,
                          ReferenceMetaData Data) override;
  ResolvedRangeInfo moveArrayToASTContext(ResolvedRangeInfo Info);
 public:
@@ -799,12 +799,13 @@ public:
      Impl->analyzeDecl(D);
      return true;
    }
-    bool visitDeclReference(ValueDecl *D, CharSourceRange Range,
-                            TypeDecl *CtorTyRef, ExtensionDecl *ExtTyRef, Type T,
-                            ReferenceMetaData Data) override {
-      Impl->analyzeDeclRef(D, Range.getStart(), T, Data);
+    bool visitDeclReference(ValueDecl *D, SourceRange Range,
+                            TypeDecl *CtorTyRef, ExtensionDecl *ExtTyRef,
+                            Type T, ReferenceMetaData Data) override {
+      Impl->analyzeDeclRef(D, Range.Start, T, Data);
      return true;
    }
+
  public:
    CompleteWalker(Implementation *Impl) : Impl(Impl) {}
  };
@@ -813,11 +814,11 @@ public:
  /// decls in the range is referenced after it.
  class FurtherReferenceWalker : public SourceEntityWalker {
    Implementation *Impl;
-    bool visitDeclReference(ValueDecl *D, CharSourceRange Range,
-                            TypeDecl *CtorTyRef, ExtensionDecl *ExtTyRef, Type T,
-                            ReferenceMetaData Data) override {
+    bool visitDeclReference(ValueDecl *D, SourceRange Range,
+                            TypeDecl *CtorTyRef, ExtensionDecl *ExtTyRef,
+                            Type T, ReferenceMetaData Data) override {
      // If the reference is after the given range, continue logic.
-      if (!Impl->SM.isBeforeInBuffer(Impl->End, Range.getStart()))
+      if (!Impl->SM.isBeforeInBuffer(Impl->End, Range.Start))
        return true;

      // If the referenced decl is declared in the range, than the declared decl
@@ -829,6 +830,7 @@ public:
      }
      return true;
    }
+
  public:
    FurtherReferenceWalker(Implementation *Impl) : Impl(Impl) {}
  };
@@ -1140,11 +1142,11 @@ bool RangeResolver::walkToDeclPost(Decl *D) {
  return !Impl->hasResult();
 }

-
-bool RangeResolver::
-visitDeclReference(ValueDecl *D, CharSourceRange Range, TypeDecl *CtorTyRef,
-                   ExtensionDecl *ExtTyRef, Type T, ReferenceMetaData Data) {
-  Impl->analyzeDeclRef(D, Range.getStart(), T, Data);
+bool RangeResolver::visitDeclReference(ValueDecl *D, SourceRange Range,
+                                       TypeDecl *CtorTyRef,
+                                       ExtensionDecl *ExtTyRef, Type T,
+                                       ReferenceMetaData Data) {
+  Impl->analyzeDeclRef(D, Range.Start, T, Data);
  return true;
 }

--- a/lib/IDE/SourceEntityWalker.cpp
+++ b/lib/IDE/SourceEntityWalker.cpp
@@ -851,28 +851,19 @@ bool SemaAnnotator::passModulePathElements(
 bool SemaAnnotator::passSubscriptReference(ValueDecl *D, SourceLoc Loc,
                                           ReferenceMetaData Data,
                                           bool IsOpenBracket) {
-  CharSourceRange Range = Loc.isValid()
-                        ? CharSourceRange(Loc, 1)
-                        : CharSourceRange();
-
-  return SEWalker.visitSubscriptReference(D, Range, Data, IsOpenBracket);
+  return SEWalker.visitSubscriptReference(D, Loc, Data, IsOpenBracket);
 }

 bool SemaAnnotator::passCallAsFunctionReference(ValueDecl *D, SourceLoc Loc,
                                                ReferenceMetaData Data) {
-  CharSourceRange Range =
-      Loc.isValid() ? CharSourceRange(Loc, 1) : CharSourceRange();
-
-  return SEWalker.visitCallAsFunctionReference(D, Range, Data);
+  return SEWalker.visitCallAsFunctionReference(D, Loc, Data);
 }

 bool SemaAnnotator::
 passReference(ValueDecl *D, Type Ty, DeclNameLoc Loc, ReferenceMetaData Data) {
  SourceManager &SM = D->getASTContext().SourceMgr;
  SourceLoc BaseStart = Loc.getBaseNameLoc(), BaseEnd = BaseStart;
-  if (BaseStart.isValid() && SM.extractText({BaseStart, 1}) == "`")
-    BaseEnd = Lexer::getLocForEndOfToken(SM, BaseStart.getAdvancedLoc(1));
-  return passReference(D, Ty, BaseStart, {BaseStart, BaseEnd}, Data);
+  return passReference(D, Ty, Loc.getBaseNameLoc(), Loc.getSourceRange(), Data);
 }

 bool SemaAnnotator::
@@ -917,12 +908,7 @@ passReference(ValueDecl *D, Type Ty, SourceLoc BaseNameLoc, SourceRange Range,
    }
  }

-  CharSourceRange CharRange =
-    Lexer::getCharSourceRangeFromSourceRange(D->getASTContext().SourceMgr,
-                                             Range);
-
-  return SEWalker.visitDeclReference(D, CharRange, CtorTyRef, ExtDecl, Ty,
-                                     Data);
+  return SEWalker.visitDeclReference(D, Range, CtorTyRef, ExtDecl, Ty, Data);
 }

 bool SemaAnnotator::passReference(ModuleEntity Mod,
@@ -1023,7 +1009,7 @@ bool SourceEntityWalker::walk(ASTNode N) {
  llvm_unreachable("unsupported AST node");
 }

-bool SourceEntityWalker::visitDeclReference(ValueDecl *D, CharSourceRange Range,
+bool SourceEntityWalker::visitDeclReference(ValueDecl *D, SourceRange Range,
                                            TypeDecl *CtorTyRef,
                                            ExtensionDecl *ExtTyRef, Type T,
                                            ReferenceMetaData Data) {
@@ -1031,7 +1017,7 @@ bool SourceEntityWalker::visitDeclReference(ValueDecl *D, CharSourceRange Range,
 }

 bool SourceEntityWalker::visitSubscriptReference(ValueDecl *D,
-                                                 CharSourceRange Range,
+                                                 SourceRange Range,
                                                 ReferenceMetaData Data,
                                                 bool IsOpenBracket) {
  // Most of the clients treat subscript reference the same way as a
@@ -1043,7 +1029,7 @@ bool SourceEntityWalker::visitSubscriptReference(ValueDecl *D,
 }

 bool SourceEntityWalker::visitCallAsFunctionReference(ValueDecl *D,
-                                                      CharSourceRange Range,
+                                                      SourceRange Range,
                                                      ReferenceMetaData Data) {
  return true;
 }
--- a/lib/Index/Index.cpp
+++ b/lib/Index/Index.cpp
@@ -33,6 +33,7 @@
 #include "swift/IDE/SourceEntityWalker.h"
 #include "swift/IDE/Utils.h"
 #include "swift/Markup/Markup.h"
+#include "swift/Parse/Lexer.h"
 #include "swift/Sema/IDETypeChecking.h"
 #include "llvm/ADT/APInt.h"
 #include "llvm/ADT/SmallVector.h"
@@ -875,10 +876,10 @@ private:
    llvm_unreachable("Can't find the generic parameter in the extended type");
  }

-  bool visitDeclReference(ValueDecl *D, CharSourceRange Range,
-                          TypeDecl *CtorTyRef, ExtensionDecl *ExtTyRef, Type T,
+  bool visitDeclReference(ValueDecl *D, SourceRange Range, TypeDecl *CtorTyRef,
+                          ExtensionDecl *ExtTyRef, Type T,
                          ReferenceMetaData Data) override {
-    SourceLoc Loc = Range.getStart();
+    SourceLoc Loc = Range.Start;

    if (Loc.isInvalid() || isSuppressed(Loc))
      return true;
@@ -918,15 +919,18 @@ private:
    // report an occurrence of `foo` in `_foo` and '$foo').
    if (auto *VD = dyn_cast<VarDecl>(D)) {
      if (auto *Wrapped = VD->getOriginalWrappedProperty()) {
-        assert(Range.getByteLength() > 1);
-        if (Range.str().front() == '`') {
-          assert(Range.getByteLength() > 3);
-          assert(Range.str().starts_with("`_") ||
-                 Range.str().starts_with("`$"));
+        CharSourceRange CharRange = Lexer::getCharSourceRangeFromSourceRange(
+            D->getASTContext().SourceMgr, Range);
+        assert(CharRange.getByteLength() > 1);
+        if (CharRange.str().front() == '`') {
+          assert(CharRange.getByteLength() > 3);
+          assert(CharRange.str().starts_with("`_") ||
+                 CharRange.str().starts_with("`$"));
          auto AfterBacktick = Loc.getAdvancedLoc(2);
          reportRef(Wrapped, AfterBacktick, Info, std::nullopt);
        } else {
-          assert(Range.str().front() == '_' || Range.str().front() == '$');
+          assert(CharRange.str().front() == '_' ||
+                 CharRange.str().front() == '$');
          auto AfterDollar = Loc.getAdvancedLoc(1);
          reportRef(Wrapped, AfterDollar, Info, std::nullopt);
        }
@@ -960,7 +964,7 @@ private:
    return finishSourceEntity(Info.symInfo, Info.roles);
  }

-  bool visitCallAsFunctionReference(ValueDecl *D, CharSourceRange Range,
+  bool visitCallAsFunctionReference(ValueDecl *D, SourceRange Range,
                                    ReferenceMetaData Data) override {
    // Index implicit callAsFunction reference.
    return visitDeclReference(D, Range, /*CtorTyRef*/ nullptr,
--- a/lib/Migrator/APIDiffMigratorPass.cpp
+++ b/lib/Migrator/APIDiffMigratorPass.cpp
@@ -468,16 +468,18 @@ struct APIDiffMigratorPass : public ASTMigratorPass, public SourceEntityWalker {
    }
  }

-  bool visitDeclReference(ValueDecl *D, CharSourceRange Range,
-                          TypeDecl *CtorTyRef, ExtensionDecl *ExtTyRef,
-                          Type T, ReferenceMetaData Data) override {
+  bool visitDeclReference(ValueDecl *D, SourceRange Range, TypeDecl *CtorTyRef,
+                          ExtensionDecl *ExtTyRef, Type T,
+                          ReferenceMetaData Data) override {
+    CharSourceRange CharRange = Lexer::getCharSourceRangeFromSourceRange(
+        D->getASTContext().SourceMgr, Range);
    if (Data.isImplicit)
      return true;

    for (auto *Item: getRelatedDiffItems(CtorTyRef ? CtorTyRef: D)) {
      std::string RepText;
-      if (isSimpleReplacement(Item, isDotMember(Range), RepText)) {
-        Editor.replace(Range, RepText);
+      if (isSimpleReplacement(Item, isDotMember(CharRange), RepText)) {
+        Editor.replace(CharRange, RepText);
        return true;
      }
    }
@@ -488,11 +490,12 @@ struct APIDiffMigratorPass : public ASTMigratorPass, public SourceEntityWalker {
    ValueDecl *Target;
    CharSourceRange Result;
    ReferenceCollector(ValueDecl* Target) : Target(Target) {}
-    bool visitDeclReference(ValueDecl *D, CharSourceRange Range,
+    bool visitDeclReference(ValueDecl *D, SourceRange Range,
                            TypeDecl *CtorTyRef, ExtensionDecl *ExtTyRef,
                            Type T, ReferenceMetaData Data) override {
      if (D == Target && !Data.isImplicit && Range.isValid()) {
-        Result = Range;
+        Result = Lexer::getCharSourceRangeFromSourceRange(
+            D->getASTContext().SourceMgr, Range);
        return false;
      }
      return true;
--- a/lib/Refactoring/ExtractExprBase.cpp
+++ b/lib/Refactoring/ExtractExprBase.cpp
@@ -26,8 +26,8 @@ struct ReferenceCollector : public SourceEntityWalker {
  SmallVector<ValueDecl *, 4> References;

  ReferenceCollector(Expr *E) { walk(E); }
-  bool visitDeclReference(ValueDecl *D, CharSourceRange Range,
-                          TypeDecl *CtorTyRef, ExtensionDecl *ExtTyRef, Type T,
+  bool visitDeclReference(ValueDecl *D, SourceRange Range, TypeDecl *CtorTyRef,
+                          ExtensionDecl *ExtTyRef, Type T,
                          ReferenceMetaData Data) override {
    References.emplace_back(D);
    return true;
--- a/tools/SourceKit/lib/SwiftLang/SwiftDocSupport.cpp
+++ b/tools/SourceKit/lib/SwiftLang/SwiftDocSupport.cpp
@@ -1203,21 +1203,24 @@ public:
    return true;
  }

-  bool visitDeclReference(ValueDecl *D, CharSourceRange Range,
-                          TypeDecl *CtorTyRef, ExtensionDecl *ExtTyRef, Type Ty,
+  bool visitDeclReference(ValueDecl *D, SourceRange Range, TypeDecl *CtorTyRef,
+                          ExtensionDecl *ExtTyRef, Type Ty,
                          ReferenceMetaData Data) override {
    if (Data.isImplicit || !Range.isValid())
      return true;
    // Ignore things that don't come from this buffer.
-    if (!SM.getRangeForBuffer(BufferID).contains(Range.getStart()))
+    if (!SM.getRangeForBuffer(BufferID).contains(Range.Start))
      return true;

-    unsigned StartOffset = getOffset(Range.getStart());
-    References.emplace_back(D, StartOffset, Range.getByteLength(), Ty);
+    CharSourceRange CharRange = Lexer::getCharSourceRangeFromSourceRange(
+        D->getASTContext().SourceMgr, Range);
+
+    unsigned StartOffset = getOffset(CharRange.getStart());
+    References.emplace_back(D, StartOffset, CharRange.getByteLength(), Ty);
    return true;
  }

-  bool visitSubscriptReference(ValueDecl *D, CharSourceRange Range,
+  bool visitSubscriptReference(ValueDecl *D, SourceRange Range,
                               ReferenceMetaData Data,
                               bool IsOpenBracket) override {
    // Treat both open and close brackets equally
--- a/tools/SourceKit/lib/SwiftLang/SwiftEditor.cpp
+++ b/tools/SourceKit/lib/SwiftLang/SwiftEditor.cpp
@@ -990,8 +990,8 @@ public:
    }
  }

-  bool visitDeclReference(ValueDecl *D, CharSourceRange Range,
-                          TypeDecl *CtorTyRef, ExtensionDecl *ExtTyRef, Type T,
+  bool visitDeclReference(ValueDecl *D, SourceRange Range, TypeDecl *CtorTyRef,
+                          ExtensionDecl *ExtTyRef, Type T,
                          ReferenceMetaData Data) override {
    if (Data.isImplicit)
      return true;
@@ -1004,9 +1004,12 @@ public:
    if (D->isUnavailable())
      return true;

+    CharSourceRange CharRange = Lexer::getCharSourceRangeFromSourceRange(
+        D->getASTContext().SourceMgr, Range);
+
    auto &SM = D->getASTContext().SourceMgr;
    if (D == D->getASTContext().getOptionalNoneDecl() &&
-        SM.extractText(Range, BufferID) == "nil") {
+        SM.extractText(CharRange, BufferID) == "nil") {
      // If a 'nil' literal occurs in a swift-case statement, it gets replaced
      // by a reference to 'Optional.none' in the AST. We want to continue
      // highlighting 'nil' as a keyword and not as an enum element.
@@ -1015,11 +1018,11 @@ public:

    if (CtorTyRef)
      D = CtorTyRef;
-    annotate(D, /*IsRef=*/true, Range);
+    annotate(D, /*IsRef=*/true, CharRange);
    return true;
  }

-  bool visitSubscriptReference(ValueDecl *D, CharSourceRange Range,
+  bool visitSubscriptReference(ValueDecl *D, SourceRange Range,
                               ReferenceMetaData Data,
                               bool IsOpenBracket) override {
    // We should treat both open and close brackets equally
--- a/tools/swift-ide-test/swift-ide-test.cpp
+++ b/tools/swift-ide-test/swift-ide-test.cpp
@@ -2342,15 +2342,19 @@ private:
    return true;
  }

-  bool visitDeclReference(ValueDecl *D, CharSourceRange Range,
-                          TypeDecl *CtorTyRef, ExtensionDecl *ExtTyRef, Type Ty,
+  bool visitDeclReference(ValueDecl *D, SourceRange Range, TypeDecl *CtorTyRef,
+                          ExtensionDecl *ExtTyRef, Type Ty,
                          ReferenceMetaData Data) override {
-    if (!Data.isImplicit)
-      annotateSourceEntity({ Range, D, CtorTyRef, /*IsRef=*/true });
+    if (Data.isImplicit) {
+      return true;
+    }
+    CharSourceRange CharRange = Lexer::getCharSourceRangeFromSourceRange(
+        D->getASTContext().SourceMgr, Range);
+    annotateSourceEntity({CharRange, D, CtorTyRef, /*IsRef=*/true});
    return true;
  }

-  bool visitSubscriptReference(ValueDecl *D, CharSourceRange Range,
+  bool visitSubscriptReference(ValueDecl *D, SourceRange Range,
                               ReferenceMetaData Data,
                               bool IsOpenBracket) override {
    return visitDeclReference(D, Range, nullptr, nullptr, Type(), Data);
@@ -3909,11 +3913,13 @@ public:
    return true;
  }

-  bool visitDeclReference(ValueDecl *D, CharSourceRange Range,
-                          TypeDecl *CtorTyRef, ExtensionDecl *ExtTyRef, Type T,
+  bool visitDeclReference(ValueDecl *D, SourceRange Range, TypeDecl *CtorTyRef,
+                          ExtensionDecl *ExtTyRef, Type T,
                          ReferenceMetaData Data) override {
+    CharSourceRange CharRange = Lexer::getCharSourceRangeFromSourceRange(
+        D->getASTContext().SourceMgr, Range);
    if (SeenDecls.insert(D).second)
-      tryDemangleDecl(D, Range, /*isRef=*/true);
+      tryDemangleDecl(D, CharRange, /*isRef=*/true);

    if (T) {
      T = T->getRValueType();
@@ -3921,7 +3927,7 @@ public:
                      (NestedDCs.empty()
                       ? D->getDeclContext()
                       : NestedDCs.back()),
-                      Range);
+                      CharRange);
    }
    return true;
  }