mirror of
https://github.com/revng/revng
synced 2026-06-21 14:07:57 +00:00
Ivan Krysak
107 lines
3.9 KiB
C++
107 lines
3.9 KiB
C++
#pragma once
|
|
|
|
//
|
|
// This file is distributed under the MIT License. See LICENSE.md for details.
|
|
//
|
|
|
|
#include "revng/GraphLayout/Traits.h"
|
|
|
|
namespace yield::cfg {
|
|
|
|
struct Configuration {
|
|
public:
|
|
/// Specifies the minimum possible distance between two edges.
|
|
layout::Dimension EdgeMarginSize;
|
|
|
|
/// Specifies the distance between the node margin and its contents.
|
|
layout::Dimension InternalNodeMarginSize;
|
|
|
|
/// Specifies the minimum possible distance between two nodes.
|
|
layout::Dimension ExternalNodeMarginSize;
|
|
|
|
/// Specifies the relation between the horizontal size of a single character
|
|
/// to the size of the font.
|
|
///
|
|
/// \note: Only monospace fonts should be used. For other fonts, it's possible
|
|
/// to select a value for this factor that look decent for most cases, but
|
|
/// even then corner cases are unavoidable (e.g. "WWWW" is wider than "IIII").
|
|
///
|
|
/// \note: the easiest way to measure this value is to use a browser to render
|
|
/// a long line of text (the longer the line, the more accurate the value),
|
|
/// let it report the final length of the said line.
|
|
/// This factor is equal to the size of the line divided by the number of
|
|
/// characters in it and the size of the font used.
|
|
layout::Dimension HorizontalFontFactor;
|
|
|
|
/// Specifies the relation between the vertical size of a single character
|
|
/// to the size of the font.
|
|
///
|
|
/// \note: the easiest way to measure this value is to use a browser to render
|
|
/// many lines of text (this value highly depends on the `line-height` css
|
|
/// property, so it's recommended to set a consistent value for both the value
|
|
/// measuring case, and the final result. Note that different browsers use
|
|
/// different defaults, so it's recommended to set this value explicitly in
|
|
/// all cases) and let it report the final size of that paragraph.
|
|
/// This factor is equal to the height of the paragraph divided by the number
|
|
/// of lines in it and the size of the font used.
|
|
layout::Dimension VerticalFontFactor;
|
|
|
|
/// Specifies the size of the font used.
|
|
layout::Dimension FontSize;
|
|
|
|
/// Specifies the number of pixels to leave in-between lines
|
|
layout::Dimension PaddingBetweenLines;
|
|
|
|
/// Specifies the degree to which node corners should be rounded.
|
|
size_t NodeCornerRoundingFactor;
|
|
|
|
/// Specifies whether orthogonal bends should be used.
|
|
bool UseOrthogonalBends;
|
|
|
|
/// Specifies whether an empty node should be added to denote entry points
|
|
bool AddEntryNode;
|
|
|
|
/// Specifies whether an empty node should be added to denote exit points
|
|
bool AddExitNode;
|
|
|
|
/// Specifies the size of an empty node.
|
|
///
|
|
/// \note that vertical and horizontal sizes are not separate, as such this
|
|
/// node will always be a square (with potentially rounded corner, see
|
|
/// \ref NodeCornerRoundingFactor).
|
|
layout::Dimension EmptyNodeSize;
|
|
|
|
/// Specifies whether linear segments should be preserved (for more
|
|
/// information see layouter documentation).
|
|
bool PreserveLinearSegments;
|
|
|
|
/// Specifies the relative weight of virtual nodes (for more
|
|
/// information see layouter documentation).
|
|
float VirtualNodeWeight;
|
|
|
|
public:
|
|
constexpr static Configuration getDefault() {
|
|
return Configuration{ .EdgeMarginSize = 20.f,
|
|
.InternalNodeMarginSize = 12.f,
|
|
.ExternalNodeMarginSize = 40.f,
|
|
|
|
.HorizontalFontFactor = 0.6f,
|
|
.VerticalFontFactor = 1.25f,
|
|
|
|
.FontSize = 18.f,
|
|
.PaddingBetweenLines = 4.f,
|
|
|
|
.NodeCornerRoundingFactor = 5,
|
|
|
|
.UseOrthogonalBends = true,
|
|
.AddEntryNode = true,
|
|
.AddExitNode = false,
|
|
.EmptyNodeSize = 30,
|
|
|
|
.PreserveLinearSegments = true,
|
|
.VirtualNodeWeight = 0.1f };
|
|
}
|
|
};
|
|
|
|
} // namespace yield::cfg
|