//===--- Symbol.h- Symbol Graph Node --------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2017 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 SWIFT_SYMBOLGRAPHGEN_SYMBOL_H
#define SWIFT_SYMBOLGRAPHGEN_SYMBOL_H

#include "llvm/Support/JSON.h"
#include "swift/AST/Attr.h"
#include "swift/Basic/LLVM.h"
#include "swift/Markup/Markup.h"

namespace swift {
namespace symbolgraphgen {

struct AvailabilityDomain;
struct SymbolGraphASTWalker;

/**
 An identifier for a symbol that provides a globally unique identifier suitable for
 internal lookups and a locally unique path for human use, such as a URL.
 */
struct SymbolIdentifier {
  /**
   A string that uniquely identifies a symbol within a module in the event of
   ambiguities. A precise identifier need not be human readable.
   */
  StringRef PreciseIdentifier;
  
  /**
   The components for a "fully qualified" identifier.
   */
  ArrayRef<StringRef> SimpleComponents;

  SymbolIdentifier(llvm::StringRef PreciseIdentifier,
                   ArrayRef<StringRef> SimpleComponents)
    : PreciseIdentifier(PreciseIdentifier),
    SimpleComponents(SimpleComponents) {
      assert(!PreciseIdentifier.empty());
    }

  void serialize(llvm::json::OStream &OS) const {
    OS.object([&](){
      OS.attribute("precise", PreciseIdentifier);
      OS.attributeArray("simpleComponents", [&](){
        for (auto Component : SimpleComponents) {
          OS.value(Component);
        }
      });
    });
  }
  
  bool operator==(const SymbolIdentifier &Other) const {
    return PreciseIdentifier == Other.PreciseIdentifier &&
      SimpleComponents == Other.SimpleComponents;
  }
};

/// A symbol from a module: a node in a graph.
struct Symbol {
  const ValueDecl *VD;

  void serializeKind(StringRef Identifier, StringRef DisplayName,
                     llvm::json::OStream &OS) const;

  void serializeKind(llvm::json::OStream &OS) const;

  void serializeIdentifier(SymbolGraphASTWalker &Walker,
                           llvm::json::OStream &OS) const;

  void serializeNames(SymbolGraphASTWalker &Walker,
                      llvm::json::OStream &OS) const;

  void serializePosition(StringRef Key, unsigned Line, unsigned ByteOffset,
                         llvm::json::OStream &OS) const;

  void serializeRange(size_t InitialIdentation,
                      SourceRange Range, SourceManager &SourceMgr,
                      llvm::json::OStream &OS) const;

  void serializeDocComment(SymbolGraphASTWalker &Walker,
                           llvm::json::OStream &OS) const;

  void serializeFunctionSignature(SymbolGraphASTWalker &Walker,
                                  llvm::json::OStream &OS) const;

  void serializeGenericParam(const swift::GenericTypeParamType &Param,
                             llvm::json::OStream &OS) const;

  void serializeGenericRequirement(const swift::Requirement &Req,
                                   llvm::json::OStream &OS) const;

  void serializeSwiftGenericMixin(llvm::json::OStream &OS) const;

  void serializeSwiftExtensionMixin(SymbolGraphASTWalker &Walker,
                                    llvm::json::OStream &OS) const;

  void serializeDeclarationFragmentMixin(SymbolGraphASTWalker &Walker,
                                         llvm::json::OStream &OS) const;

  void serializeAccessLevelMixin(llvm::json::OStream &OS) const;

  llvm::Optional<StringRef>
  getDomain(PlatformAgnosticAvailabilityKind AgnosticKind,
            PlatformKind Kind) const;

  void serializeAvailabilityMixin(llvm::json::OStream &OS) const;

  void serialize(SymbolGraphASTWalker &Walker,
                 llvm::json::OStream &OS) const;
  
  bool operator==(const Symbol &Other) const {
    return VD == Other.VD;
  }
};

} // end namespace symbolgraphgen
} // end namespace swift 

#endif // SWIFT_SYMBOLGRAPHGEN_SYMBOL_H