Skip to content

Clean up swift-api-digester: Remove dead code. Fix typos. Fix headers. #5280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 14, 2016
Merged

Clean up swift-api-digester: Remove dead code. Fix typos. Fix headers. #5280

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 54 additions & 68 deletions tools/swift-api-digester/swift-api-digester.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
//===--- swift-api-digester.cpp - API change detector -------===//
////
//// This source file is part of the Swift.org open source project
////
//// Copyright (c) 2014 - 2016 Apple Inc. and the Swift project authors
//// Licensed under Apache License v2.0 with Runtime Library Exception
////
//// See http://swift.org/LICENSE.txt for license information
//// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
////
////===----------------------------------------------------------------------===//
//===--- swift-api-digester.cpp - API change detector ---------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2016 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

// swift-api-digester is a test utility to detect source-breaking API changes
// during the evolution of a swift library. The tool works on two phases:
// (1) dumping library contents as a json file, and (2) comparing two json
// during the evolution of a Swift library. The tool works on two phases:
// (1) dumping library contents as a JSON file, and (2) comparing two JSON
// files textually to report interesting changes.
//
// During phase (1), the api-digester looks up every declarations inside
// a module and outputs a singly-rooted tree that encloses interesting
// details of the API level.
//
// During phase (2), api-digester applies structure-information comparision
// During phase (2), api-digester applies structure-information comparison
// algorithms on two given singly root trees, trying to figure out, as
// precise as possible, the branches/leaves in the trees that differ from
// each other. Further analysis decides whether the changed leaves/branches
Expand Down Expand Up @@ -77,7 +77,7 @@ ModuleNames("module", llvm::cl::ZeroOrMore, llvm::cl::desc("Names of modules"));

static llvm::cl::opt<std::string>
ModuleList("module-list-file",
llvm::cl::desc("File containing new-line separated list of modules"));
llvm::cl::desc("File containing a new-line separated list of modules"));

static llvm::cl::opt<std::string>
OutputFile("o", llvm::cl::desc("Output file"));
Expand Down Expand Up @@ -113,21 +113,21 @@ Action(llvm::cl::desc("Mode:"), llvm::cl::init(ActionType::None),
llvm::cl::values(
clEnumValN(ActionType::DumpSDK,
"dump-sdk",
"Dump SDK content to json file"),
"Dump SDK content to JSON file"),
clEnumValN(ActionType::DumpSwiftModules,
"dump-swift",
"dump swift modules in SDK"),
clEnumValN(ActionType::CompareSDKs,
"compare-sdk",
"Compare SDK content in json file"),
"Compare SDK content in JSON file"),
clEnumValN(ActionType::DiagnoseSDKs,
"diagnose-sdk",
"Diagnose SDK content in json file"),
"Diagnose SDK content in JSON file"),
clEnumValEnd));

static llvm::cl::list<std::string>
SDKJsonPaths("input-paths",
llvm::cl::desc("The SDK contents under conparison"));
llvm::cl::desc("The SDK contents under comparison"));

static llvm::cl::list<std::string>
ApisPrintUsrs("api-usrs",
Expand All @@ -141,7 +141,7 @@ IgnoreRemovedDeclUSRs("ignored-usrs",

static llvm::cl::opt<std::string>
SwiftVersion("swift-version",
llvm::cl::desc("The swift compiler version to invoke"));
llvm::cl::desc("The Swift compiler version to invoke"));
}

namespace {
Expand Down Expand Up @@ -195,7 +195,6 @@ class SDKNodeVisitor {
struct MatchedNodeListener {
virtual void foundMatch(NodePtr Left, NodePtr Right) = 0;
virtual void foundRemoveAddMatch(NodePtr Removed, NodePtr Added) {}
virtual bool isMatched(NodePtr Left, NodePtr Right) {return false;};
virtual ~MatchedNodeListener() = default;
};

Expand All @@ -208,7 +207,7 @@ struct NodeMatcher {
#define KEY(NAME) static const char* Key_##NAME = #NAME;
#include "DigesterEnums.def"

// The node kind apparing in the tree that describes the content of the SDK
// The node kind appearing in the tree that describes the content of the SDK
enum class SDKNodeKind {
#define NODE_KIND(NAME) NAME,
#include "DigesterEnums.def"
Expand Down Expand Up @@ -300,9 +299,7 @@ class SDKNode {
StringRef getPrintedName() const { return PrintedName; }
void removeChild(ChildIt CI) { Children.erase(CI); }
ChildIt getChildBegin() const { return Children.begin(); }
ChildIt getChildEnd() const { return Children.end(); }
void annotate(NodeAnnotation Anno) { Annotations.insert(Anno); }
bool isName(StringRef N) const { return getName() == N; }
NodePtr getParent() const { return Parent; };
unsigned getChildrenCount() const { return Children.size(); }
NodePtr childAt(unsigned I) const;
Expand Down Expand Up @@ -491,28 +488,28 @@ class SDKNodeVectorViewer {
llvm::function_ref<bool(NodePtr)> Selector;
typedef ArrayRef<SDKNode*>::const_iterator VectorIt;
VectorIt getNext(VectorIt Start);
class ViwerIterator;
class ViewerIterator;

public:
SDKNodeVectorViewer(ArrayRef<SDKNode*> Collection,
llvm::function_ref<bool(NodePtr)> Selector) :
Collection(Collection),
Selector(Selector) {}
ViwerIterator begin();
ViwerIterator end();
ViewerIterator begin();
ViewerIterator end();
};

class SDKNodeVectorViewer::ViwerIterator :
class SDKNodeVectorViewer::ViewerIterator :
public std::iterator<std::input_iterator_tag, VectorIt> {
SDKNodeVectorViewer &Viewer;
VectorIt P;
public:
ViwerIterator(SDKNodeVectorViewer &Viewer, VectorIt P) : Viewer(Viewer), P(P) {}
ViwerIterator(const ViwerIterator& mit) : Viewer(mit.Viewer), P(mit.P) {}
ViwerIterator& operator++();
ViwerIterator operator++(int) {ViwerIterator tmp(*this); operator++(); return tmp;}
bool operator==(const ViwerIterator& rhs) {return P==rhs.P;}
bool operator!=(const ViwerIterator& rhs) {return P!=rhs.P;}
ViewerIterator(SDKNodeVectorViewer &Viewer, VectorIt P) : Viewer(Viewer), P(P) {}
ViewerIterator(const ViewerIterator& mit) : Viewer(mit.Viewer), P(mit.P) {}
ViewerIterator& operator++();
ViewerIterator operator++(int) {ViewerIterator tmp(*this); operator++(); return tmp;}
bool operator==(const ViewerIterator& rhs) {return P==rhs.P;}
bool operator!=(const ViewerIterator& rhs) {return P!=rhs.P;}
const NodePtr& operator*() {return *P;}
};

Expand All @@ -524,18 +521,18 @@ SDKNodeVectorViewer::getNext(VectorIt Start) {
return Collection.end();
}

SDKNodeVectorViewer::ViwerIterator&
SDKNodeVectorViewer::ViwerIterator::operator++() {
SDKNodeVectorViewer::ViewerIterator&
SDKNodeVectorViewer::ViewerIterator::operator++() {
P = Viewer.getNext(P + 1);
return *this;
}

SDKNodeVectorViewer::ViwerIterator SDKNodeVectorViewer::begin() {
return ViwerIterator(*this, getNext(Collection.begin()));
SDKNodeVectorViewer::ViewerIterator SDKNodeVectorViewer::begin() {
return ViewerIterator(*this, getNext(Collection.begin()));
}

SDKNodeVectorViewer::ViwerIterator SDKNodeVectorViewer::end() {
return ViwerIterator(*this, Collection.end());
SDKNodeVectorViewer::ViewerIterator SDKNodeVectorViewer::end() {
return ViewerIterator(*this, Collection.end());
}

class SDKNodeDecl;
Expand Down Expand Up @@ -856,15 +853,6 @@ class SDKNodeDumpVisitor : public SDKNodeVisitor {
SDKNodeDumpVisitor() {};
};

class DumpMatchListener : public MatchedNodeListener {
void foundMatch(NodePtr Left, NodePtr Right) override {
llvm::outs() << Left->getName() << "->" << Right->getName() << "\n";
};
bool isMatched(NodePtr Left, NodePtr Right) override {
return true;
};
};

static StringRef getPrintedName(Type Ty) {
std::string S;
llvm::raw_string_ostream OS(S);
Expand Down Expand Up @@ -997,7 +985,7 @@ case SDKNodeKind::X: \
}

// Recursively construct a node that represents a type, for instance,
// representing the the return value type of a function decl.
// representing the return value type of a function decl.
static NodeUniquePtr constructTypeNode(Type T) {
NodeUniquePtr Root = SDKNodeInitInfo(T).createSDKNode(SDKNodeKind::TypeNominal);

Expand Down Expand Up @@ -1171,15 +1159,15 @@ class SwiftDeclCollector : public VisibleDeclConsumer {
RootNode = std::move(Pair.second);
}

// Serialize the content of all roots to a given file using json format.
// Serialize the content of all roots to a given file using JSON format.
void serialize(StringRef Filename) {
std::error_code EC;
llvm::raw_fd_ostream fs(Filename, EC, llvm::sys::fs::F_None);
emitSDKNodeRoot(fs, RootNode);
}

// After collecting decls, either from imported modules or from a previously
// serialized json file, using this function to get the root of the SDK.
// serialized JSON file, using this function to get the root of the SDK.
NodePtr getSDKRoot() {
return RootNode.get();
}
Expand Down Expand Up @@ -1250,7 +1238,7 @@ class SwiftDeclCollector : public VisibleDeclConsumer {
namespace swift {
namespace json {
// In the namespace of swift::json, we define several functions so that the
// json serializer will know how to interpret and dump types defined in this
// JSON serializer will know how to interpret and dump types defined in this
// file.
template<>
struct ScalarEnumerationTraits<SDKNodeKind> {
Expand Down Expand Up @@ -1384,7 +1372,7 @@ parseJsonEmit(StringRef FileName) {
llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> FileBufOrErr =
llvm::MemoryBuffer::getFileOrSTDIN(FileName);
if (!FileBufOrErr) {
llvm_unreachable("Failed to read json file");
llvm_unreachable("Failed to read JSON file");
}
StringRef Buffer = FileBufOrErr->get()->getBuffer();
llvm::SourceMgr SM;
Expand Down Expand Up @@ -1701,7 +1689,7 @@ class SameNameNodeMatcher : public NodeMatcher {
PrintedNameAndUSR,
};

// Given two sdk nodes, figure out the reason for why they have the same name.
// Given two SDK nodes, figure out the reason for why they have the same name.
Optional<NameMatchKind> getNameMatchKind(SDKNode *L, SDKNode *R) {
if (L->getKind() != R->getKind())
return None;
Expand Down Expand Up @@ -1740,7 +1728,7 @@ class SameNameNodeMatcher : public NodeMatcher {
}
}

// Given a list and a priority, find the best matched candidate sdk node.
// Given a list and a priority, find the best matched candidate SDK node.
SDKNode* findBestNameMatch(ArrayRef<NameMatchCandidate> Candidates,
ArrayRef<NameMatchKind> Kinds) {
for (auto Kind : Kinds)
Expand Down Expand Up @@ -1881,7 +1869,7 @@ static void detectRename(NodePtr L, NodePtr R) {
// This is first pass on two given SDKNode trees. This pass removes the common part
// of two versions of SDK, leaving only the changed part.
class PrunePass : public MatchedNodeListener, public SDKTreeDiffPass {
static void removeCommomChildren(NodePtr Left, NodePtr Right) {
static void removeCommonChildren(NodePtr Left, NodePtr Right) {
llvm::SmallPtrSet<NodePtr, 16> LeftToRemove;
llvm::SmallPtrSet<NodePtr, 16> RightToRemove;
for (auto &LC : Left->getChildren()) {
Expand Down Expand Up @@ -1936,7 +1924,7 @@ class PrunePass : public MatchedNodeListener, public SDKTreeDiffPass {
// If the matched nodes are both modules, remove the contained
// type decls that are identical. If the matched nodes are both type decls,
// remove the contained function decls that are identical.
removeCommomChildren(Left, Right);
removeCommonChildren(Left, Right);
NodeVector LeftChildren;
NodeVector RightChildren;
Left->collectChildren(LeftChildren);
Expand All @@ -1952,7 +1940,7 @@ class PrunePass : public MatchedNodeListener, public SDKTreeDiffPass {
case SDKNodeKind::TypeAlias:
case SDKNodeKind::TypeFunc:
case SDKNodeKind::TypeNominal: {
// If mactched nodes are both function/var/TypeAlias decls, mapping their
// If matched nodes are both function/var/TypeAlias decls, mapping their
// parameters sequentially.
SequentialNodeMatcher(Left->getChildren(),
Right->getChildren(), *this).match();
Expand Down Expand Up @@ -2074,8 +2062,6 @@ class TypeMemberDiffFinder : public SDKNodeVisitor {

};

typedef std::unique_ptr<NodePairVector> RenamedNodes;

// Given a condition, search whether a node satisfies that condition exists
// in a tree.
class SearchVisitor : public SDKNodeVisitor {
Expand Down Expand Up @@ -2210,12 +2196,12 @@ class ChangeRefinementPass : public SDKTreeDiffPass, public SDKNodeVisitor {
}
};

// DiffItem describes how an element in sdk evolves in a way that migrator can
// read conveniently. Each DiffItem corresponds to one json element and contains
// DiffItem describes how an element in SDK evolves in a way that migrator can
// read conveniently. Each DiffItem corresponds to one JSON element and contains
// sub fields explaining how migrator can assist client code to cope with such
// sdk change. For instance, the following first json element describes an unwrap
// SDK change. For instance, the following first JSON element describes an unwrap
// optional change in the first parameter of function "c:@F@CTTextTabGetOptions".
// Similarly, the second json element describes a type parameter down cast in the
// Similarly, the second JSON element describes a type parameter down cast in the
// second parameter of function "c:objc(cs)NSXMLDocument(im)insertChildren:atIndex:".
// We keep both usrs because in the future this may support auto-rename.
class DiffItem {
Expand Down Expand Up @@ -3334,21 +3320,21 @@ static int prepareForDump(const char *Main,
}

if (Modules.empty()) {
llvm::errs() << "Need to specifiy -include-all or -module <name>\n";
llvm::errs() << "Need to specify -include-all or -module <name>\n";
return 1;
}
return 0;
}

static void readIgnoredUsrs(llvm::StringSet<> &IgoredUsrs) {
static void readIgnoredUsrs(llvm::StringSet<> &IgnoredUsrs) {
StringRef Path = options::IgnoreRemovedDeclUSRs;
if (Path.empty())
return;
if (!fs::exists(Path)) {
llvm::errs() << Path << " does not exist.\n";
return;
}
readFileLineByLine(Path, IgoredUsrs);
readFileLineByLine(Path, IgnoredUsrs);
}

int main(int argc, char *argv[]) {
Expand Down