mirror of
https://github.com/reactos/CMake.git
synced 2024-11-24 12:09:48 +00:00
553658393c
* Added a fairly comprehensive test suite
* Separated the graph traversal logic from the Graphviz generation
code by introducing a new class, cmLinkItemsGraphVisitor{.h,cxx}
* Made the graph traversal logic less ad-hoc by using existing
methods in the GlobalGenerator; this fixed a few bugs
* Added support for new target types: custom targets, object
and unknown libraries
* Improved support for ALIAS libraries by showing the alias(es)
in the graph
* Introduced new flags to control those new libraries (consistent
with existing flags)
* Updated the documentation
* Removed useless setting to set graph type in dot file
* Improved the node/edge shapes (nicer, more consistent)
* Added a legend to the graph
* Some refactoring and cleanup of the Graphviz generation code
* Added test and fix for issue 19746
112 lines
3.3 KiB
C++
112 lines
3.3 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file Copyright.txt or https://cmake.org/licensing for details. */
|
|
#ifndef CMGRAPHVIZWRITER_H
|
|
#define CMGRAPHVIZWRITER_H
|
|
|
|
#include "cmConfigure.h" // IWYU pragma: keep
|
|
|
|
#include <map>
|
|
#include <memory>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
#include "cmsys/RegularExpression.hxx"
|
|
|
|
#include "cmGeneratedFileStream.h"
|
|
#include "cmLinkItemGraphVisitor.h"
|
|
#include "cmStateTypes.h"
|
|
|
|
class cmLinkItem;
|
|
class cmGlobalGenerator;
|
|
|
|
/** This class implements writing files for graphviz (dot) for graphs
|
|
* representing the dependencies between the targets in the project. */
|
|
class cmGraphVizWriter : public cmLinkItemGraphVisitor
|
|
{
|
|
public:
|
|
cmGraphVizWriter(std::string const& fileName,
|
|
const cmGlobalGenerator* globalGenerator);
|
|
~cmGraphVizWriter() override;
|
|
|
|
void VisitGraph(std::string const& name) override;
|
|
|
|
void OnItem(cmLinkItem const& item) override;
|
|
|
|
void OnDirectLink(cmLinkItem const& depender, cmLinkItem const& dependee,
|
|
DependencyType dt) override;
|
|
|
|
void OnIndirectLink(cmLinkItem const& depender,
|
|
cmLinkItem const& dependee) override;
|
|
|
|
void ReadSettings(const std::string& settingsFileName,
|
|
const std::string& fallbackSettingsFileName);
|
|
|
|
void Write();
|
|
|
|
private:
|
|
using FileStreamMap =
|
|
std::map<std::string, std::unique_ptr<cmGeneratedFileStream>>;
|
|
|
|
void VisitLink(cmLinkItem const& depender, cmLinkItem const& dependee,
|
|
bool isDirectLink, std::string const& scopeType = "");
|
|
|
|
void WriteHeader(cmGeneratedFileStream& fs, std::string const& name);
|
|
|
|
void WriteFooter(cmGeneratedFileStream& fs);
|
|
|
|
void WriteLegend(cmGeneratedFileStream& fs);
|
|
|
|
void WriteNode(cmGeneratedFileStream& fs, cmLinkItem const& item);
|
|
|
|
void CreateTargetFile(FileStreamMap& fileStreamMap, cmLinkItem const& target,
|
|
std::string const& fileNameSuffix = "");
|
|
|
|
void WriteConnection(cmGeneratedFileStream& fs,
|
|
cmLinkItem const& dependerTargetName,
|
|
cmLinkItem const& dependeeTargetName,
|
|
std::string const& edgeStyle);
|
|
|
|
bool ItemExcluded(cmLinkItem const& item);
|
|
bool ItemNameFilteredOut(std::string const& itemName);
|
|
bool TargetTypeEnabled(cmStateEnums::TargetType targetType) const;
|
|
|
|
std::string ItemNameWithAliases(std::string const& itemName) const;
|
|
|
|
static std::string GetEdgeStyle(DependencyType dt);
|
|
|
|
static std::string EscapeForDotFile(std::string const& str);
|
|
|
|
static std::string PathSafeString(std::string const& str);
|
|
|
|
std::string FileName;
|
|
cmGeneratedFileStream GlobalFileStream;
|
|
FileStreamMap PerTargetFileStreams;
|
|
FileStreamMap TargetDependersFileStreams;
|
|
|
|
std::string GraphName;
|
|
std::string GraphHeader;
|
|
std::string GraphNodePrefix;
|
|
|
|
std::vector<cmsys::RegularExpression> TargetsToIgnoreRegex;
|
|
|
|
cmGlobalGenerator const* GlobalGenerator;
|
|
|
|
int NextNodeId;
|
|
// maps from the actual item names to node names in dot:
|
|
std::map<std::string, std::string> NodeNames;
|
|
|
|
bool GenerateForExecutables;
|
|
bool GenerateForStaticLibs;
|
|
bool GenerateForSharedLibs;
|
|
bool GenerateForModuleLibs;
|
|
bool GenerateForInterfaceLibs;
|
|
bool GenerateForObjectLibs;
|
|
bool GenerateForUnknownLibs;
|
|
bool GenerateForCustomTargets;
|
|
bool GenerateForExternals;
|
|
bool GeneratePerTarget;
|
|
bool GenerateDependers;
|
|
};
|
|
|
|
#endif
|