ModelView::Utils Namespace Reference

Collection of various widget-related utils. More...

Classes
struct	is_unique_ptr
struct	is_unique_ptr< std::unique_ptr< T, D > >

Functions
template<typename It , typename UnaryFunction >
std::vector< double >	Apply (It begin, It end, UnaryFunction func)
	Returns vector containing results of elemntwise unary function application. More...
MVVM_MODEL_EXPORT bool	AreAlmostEqual (double a, double b, double tolerance_factor=1.0)
	Returns true if two doubles agree within epsilon*tolerance. More...
MVVM_MODEL_EXPORT std::string	base_name (const std::string &path)
	Provide the filename of a file path. More...
MVVM_MODEL_EXPORT void	BeginMacros (const SessionItem *item, const std::string &macro_name)
	Begin undo/redo macros with given name. More...
template<typename T >
std::vector< T * >	CastedItems (const std::vector< SessionItem * > &items)
	Returns vector of items casted to given type. More...
MVVM_VIEWMODEL_EXPORT QVariant	CheckStateRole (const SessionItem &item)
	Returns check state role of given item. More...
MVVM_MODEL_EXPORT SessionItem *	ChildAt (const SessionItem *parent, int index)
	Returns child at given index of parent. More...
MVVM_VIEW_EXPORT QString	ClickableText (const QString &text, const QString &tag={})
	Returns text wrapped into 'href' tag to provide clickable links in QLabel. More...
MVVM_MODEL_EXPORT bool	CompatibleVariantTypes (const Variant &oldValue, const Variant &newValue)
	Returns true if variants has compatible types. More...
template<typename A , typename B >
bool	Contains (const A &container, const B &element)
	Returns true if container contains a given element. More...
MVVM_MODEL_EXPORT int	CopyNumber (const SessionItem *item)
	Returns copy number of given item in it's parent hierarchy. More...
MVVM_MODEL_EXPORT bool	create_directory (const std::string &path)
	Create directory, parent directory must exist. More...
template<typename T = SessionModel>
std::unique_ptr< T >	CreateClone (const T &model)
	Creates exact clone of given model. All item's ID will be preserved. More...
template<typename T = SessionModel>
std::unique_ptr< T >	CreateCopy (const T &model)
	Creates full deep copy of given model. All item's ID will be generated. More...
MVVM_VIEWMODEL_EXPORT QVariant	DecorationRole (const SessionItem &item)
	Returns decoration role for given item. More...
MVVM_MODEL_EXPORT void	DeleteItemFromModel (SessionItem *item)
	Removes and deletes item from its model. More...
MVVM_VIEW_EXPORT QStringList	deserialize (const QByteArray &byteArray)
	Converts byte array to vector of strings. More...
MVVM_MODEL_EXPORT void	EndMacros (const SessionItem *item)
	Finishes undo/redo macros. More...
MVVM_MODEL_EXPORT bool	exists (const std::string &fileName)
	Returns true if file exists. More...
MVVM_MODEL_EXPORT std::vector< std::string >	FindFiles (const std::string &dirname, const std::string &ext)
	Returns list of files with given extention found in given directory. More...
template<typename T = SessionItem>
std::vector< T * >	FindItems (const SessionModel *model)
	Returns all items in a tree of given type. More...
MVVM_VIEW_EXPORT QMainWindow *	FindMainWindow ()
	Finds main window. More...
MVVM_MODEL_EXPORT SessionItem *	FindNextItemToSelect (SessionItem *item)
	Finds next item to select Method is used in the context of next item selection after given item was deleted. More...
MVVM_MODEL_EXPORT SessionItem *	FindNextSibling (SessionItem *item)
	Returns next sibling with same tag. More...
MVVM_MODEL_EXPORT SessionItem *	FindPreviousSibling (SessionItem *item)
	Returns previous sibling with same tag. More...
MVVM_VIEW_EXPORT std::vector< std::string >	fromStringList (const QStringList &string_list)
	Converts vector of strings to QStringList. More...
MVVM_MODEL_EXPORT bool	HasTag (const SessionItem &item, const std::string &tag)
	Returns true if given item has registered tag. More...
MVVM_VIEW_EXPORT int	HeightOfLetterM ()
	Returns height of the letter 'M' deduced from current font metrics. More...
template<typename C >
std::vector< double >	Imag (const C &container)
	Returns vector with imag part of complex numbers. More...
MVVM_MODEL_EXPORT int	IndexOfChild (const SessionItem *parent, const SessionItem *child)
	Returns index in children array corresponding to given child. More...
template<typename C , typename T >
int	IndexOfItem (const C &container, const T &item)
	Returns index corresponding to the first occurance of the item in the container. More...
template<typename It , typename T >
int	IndexOfItem (It begin, It end, const T &item)
	Returns index corresponding to the first occurance of the item in the container. More...
MVVM_MODEL_EXPORT bool	is_empty (const std::string &path)
	Returns true if the file indicated by 'path' refers to empty file or directory. More...
MVVM_MODEL_EXPORT bool	IsBoolVariant (const Variant &variant)
	Returns true in the case of double value based variant. More...
MVVM_MODEL_EXPORT bool	IsColorVariant (const Variant &variant)
	Returns true in the case of QColor based variant. More...
MVVM_MODEL_EXPORT bool	IsComboVariant (const Variant &variant)
	Returns true in the case of double value based variant. More...
MVVM_MODEL_EXPORT bool	IsDoubleVariant (const Variant &variant)
	Returns true in the case of double value based variant. More...
MVVM_MODEL_EXPORT bool	IsDoubleVectorVariant (const Variant &variant)
	Returns true in the case of variant based on std::vector<double>. More...
MVVM_MODEL_EXPORT bool	IsExtPropertyVariant (const Variant &variant)
	Returns true in the case of ExternalProperty based variant. More...
MVVM_MODEL_EXPORT bool	IsIntVariant (const Variant &variant)
	Returns true in the case of double value based variant. More...
MVVM_MODEL_EXPORT bool	IsItemAncestor (const SessionItem *item, const SessionItem *candidate)
	Returns true if 'candidate' is one of ancestor of given item. More...
MVVM_VIEW_EXPORT bool	IsLinuxHost ()
	Returns true if it is Linux. More...
MVVM_VIEW_EXPORT bool	IsMacHost ()
	Returns true if it is Mac. More...
MVVM_MODEL_EXPORT bool	IsRealLimitsVariant (const Variant &variant)
	Returns true in the case of RealLimits based variant. More...
MVVM_MODEL_EXPORT bool	IsSinglePropertyTag (const SessionItem &item, const std::string &tag)
	Returns true if given item has registered tag, and it belongs to single property. More...
MVVM_MODEL_EXPORT bool	IsStdStringVariant (const Variant &variant)
	Returns true in the case of double value based variant. More...
MVVM_MODEL_EXPORT bool	IsTheSame (const Variant &var1, const Variant &var2)
	Returns true if given variants have same type and value. More...
MVVM_VIEW_EXPORT bool	IsWindowsHost ()
	Returns true if it is Windows. More...
MVVM_MODEL_EXPORT SessionItem *	ItemFromPath (const SessionModel &moodel, const Path &path)
	Returns item found in the model following given Path. More...
MVVM_VIEWMODEL_EXPORT QVector< int >	ItemRoleToQtRole (int role)
	Returns vector of Qt roles corresponding to given ItemDataRole. More...
MVVM_VIEWMODEL_EXPORT std::vector< SessionItem * >	ItemsFromIndex (const QModelIndexList &index_list)
	Returns vector of underlying SessionItem's for given index list. More...
MVVM_MODEL_EXPORT void	iterate (SessionItem *item, const std::function< void(SessionItem *)> &fun)
	Iterates through item and all its children. More...
MVVM_MODEL_EXPORT void	iterate_if (const SessionItem *item, const std::function< bool(const SessionItem *)> &fun)
	Iterates through all model indices and calls user function. More...
MVVM_VIEWMODEL_EXPORT void	iterate_model (const QAbstractItemModel *model, const QModelIndex &parent, const std::function< void(const QModelIndex &child)> &fun)
	Iterates through QAbstractItem model. More...
MVVM_MODEL_EXPORT std::string	join (const std::string &part1, const std::string &part2)
	Joins two path elements into the path. More...
MVVM_MODEL_EXPORT void	MoveDown (SessionItem *item)
	Moves item down (increments row of the item). Works on children belonging to single tag. More...
MVVM_MODEL_EXPORT void	MoveUp (SessionItem *item)
	Moves item up (decrements row of the item). Works on children belonging to single tag. More...
MVVM_MODEL_EXPORT std::string	parent_path (const std::string &path)
	Returns the path to the parent directory. More...
MVVM_VIEWMODEL_EXPORT std::vector< SessionItem * >	ParentItemsFromIndex (const QModelIndexList &index_list)
	Returns vector of parent items from given index list. More...
MVVM_MODEL_EXPORT Path	PathFromItem (const SessionItem *item)
	Constructs path to find given item. Item must belong to a model. More...
MVVM_MODEL_EXPORT void	PopulateEmptyModel (const JsonModelConverterInterface *converter, const SessionModel &source, SessionModel &target)
	Populate empty model with content of target model using provided converter. More...
MVVM_VIEW_EXPORT QString	ProjectWindowTitle (const QString &project_dir, bool is_modified)
	Returns a title composed from last part of project path, and is_modified flag. More...
MVVM_MODEL_EXPORT double	RandDouble (double low, double high)
	Produces random FLOAT values uniformly distributed on the interval [low, high). More...
MVVM_MODEL_EXPORT int	RandInt (int low, int high)
	Produces random integer values uniformly distributed on the closed interval [low, high]. More...
MVVM_VIEW_EXPORT QColor	RandomColor ()
	Returns random color. More...
MVVM_VIEW_EXPORT std::string	RandomNamedColor ()
	Returns the name of random color. More...
template<typename C >
std::vector< double >	Real (const C &container)
	Returns vector with real part of complex numbers. More...
MVVM_MODEL_EXPORT void	Redo (SessionModel &model)
	Redo model operation which was undone just before. If not undo/redo enabled, will do nothing. More...
MVVM_MODEL_EXPORT std::vector< std::string >	RegisteredTags (const SessionItem &item)
	Returns vector of strings containing all registered tags of the given item. More...
MVVM_MODEL_EXPORT std::vector< std::string >	RegisteredUniversalTags (const SessionItem &item)
	Returns vector of strings containing all registered universal tags of the given item. More...
MVVM_MODEL_EXPORT bool	remove (const std::string &path)
	Removes file or empty directory. More...
MVVM_MODEL_EXPORT void	remove_all (const std::string &path)
	Removes directory with all its content. More...
MVVM_VIEW_EXPORT void	ScaleLabelFont (QLabel *label, double scale)
	Set label's font size to system font size scaled by given factor. More...
MVVM_VIEW_EXPORT QByteArray	serialize (const QStringList &data)
	Converts vector of strings to byte array. More...
MVVM_VIEW_EXPORT void	SetLogarithmicScale (QCPAxis *axis, bool is_log_scale)
	Switch axis to logarithmic scale mode. More...
MVVM_VIEW_EXPORT void	SetLogarithmicScale (QCPColorScale *axis, bool is_log_scale)
	Switch axis to logarithmic scale mode. More...
MVVM_MODEL_EXPORT std::vector< SessionItem * >	SinglePropertyItems (const SessionItem &item)
	Returns vector of children representing property items. More...
MVVM_VIEW_EXPORT QSize	SizeOfLetterM ()
	Returns size corresponding to actual size of letter M basing on current font metrics. More...
MVVM_VIEW_EXPORT int	SystemPointSize ()
	Returns size in points of default system font. More...
MVVM_VIEWMODEL_EXPORT QVariant	TextColorRole (const SessionItem &item)
	Returns text color for given item. More...
MVVM_MODEL_EXPORT Variant	toCustomVariant (const Variant &standard)
	Converts Qt variant to custom variant on board of SessionItem. More...
MVVM_VIEWMODEL_EXPORT QVariant	ToolTipRole (const SessionItem &item)
	Returns tooltip role for given item. More...
template<typename T = SessionItem>
T *	TopItem (const SessionModel *model)
	Returns top level item of given type. More...
template<typename T = SessionItem>
std::vector< T * >	TopItems (const SessionModel *model)
	Returns all top level items of given type. More...
MVVM_MODEL_EXPORT std::vector< SessionItem * >	TopLevelItems (const SessionItem &item)
	Returns vector of children representing top level items. More...
MVVM_MODEL_EXPORT Variant	toQtVariant (const Variant &custom)
	Converts custom variant to standard variant which Qt views will understand. More...
MVVM_VIEW_EXPORT QStringList	toStringList (const std::vector< std::string > &vec)
	Converts vector of strings to QStringList. More...
MVVM_MODEL_EXPORT void	Undo (SessionModel &model)
	Undo last model operation. If not undo/redo enabled, will do nothing. More...
MVVM_MODEL_EXPORT std::vector< SessionItem * >	UniqueItems (const std::vector< SessionItem * > &items)
	Returns vector with duplicates and 'nullptr' filtered out. More...
MVVM_VIEWMODEL_EXPORT std::vector< SessionItem * >	UniqueItemsFromIndex (const QModelIndexList &index_list)
	Returns vector of underlying SessionItem's for given index list. Removes repetitions. More...
template<typename C >
C	UniqueWithOrder (const C &container)
	Returns copy of container with all duplicated elements filtered our. The order is preserved. More...
MVVM_MODEL_EXPORT std::string	VariantName (const Variant &variant)
	Returns name of variant. More...
MVVM_MODEL_EXPORT int	VariantType (const Variant &variant)
	Returns type of variant (additionally checks for user type). More...
MVVM_VIEW_EXPORT int	WidthOfLetterM ()
	Returns width of the letter 'M' deduced from current font metrics. More...
MVVM_VIEW_EXPORT QString	WithTildeHomePath (const QString &path)
	Returns a string where Linux path to the file is striped using '~/'. More...

Detailed Description

Collection of various widget-related utils.

Function Documentation

Apply()

template<typename It , typename UnaryFunction >

std::vector<double> ModelView::Utils::Apply	(	It	begin,
		It	end,
		UnaryFunction	func
	)

Returns vector containing results of elemntwise unary function application.

Definition at line 63 of file containerutils.h.

{
    std::vector<double> result;
    std::transform(begin, end, std::back_inserter(result), func);
    return result;
}

Referenced by Imag(), and Real().

AreAlmostEqual()

bool ModelView::Utils::AreAlmostEqual	(	double	a,
		double	b,
		double	tolerance_factor = 1.0
	)

Returns true if two doubles agree within epsilon*tolerance.

Definition at line 23 of file numericutils.cpp.

{
    constexpr double eps = std::numeric_limits<double>::epsilon();
    return std::abs(a - b)
           <= eps * std::max(tolerance * eps, std::max(1., tolerance) * std::abs(b));
}

Referenced by ModelView::DoubleEditor::onEditingFinished(), ModelView::ScientificDoubleEditor::onEditingFinished(), ModelView::ScientificSpinBoxEditor::onEditingFinished(), and TEST_F().

base_name()

std::string ModelView::Utils::base_name

(

const std::string &

path

)

Provide the filename of a file path.

Definition at line 78 of file fileutils.cpp.

{
#ifdef ENABLE_FILESYSTEM
    return std::filesystem::path(path).stem().string();
#else
    return QFileInfo(QString::fromStdString(path)).completeBaseName().toStdString();
#endif
}

Referenced by IParametricComponent::registerVector(), IParametricComponent::removeVector(), IParametricComponent::setVectorValue(), TEST_F(), IParametricComponent::XComponentName(), IParametricComponent::YComponentName(), and IParametricComponent::ZComponentName().

BeginMacros()

void ModelView::Utils::BeginMacros	(	const SessionItem *	item,
		const std::string &	macro_name
	)

Begin undo/redo macros with given name.

Works only if item belongs to the model, and model has undo/redo enabled. Otherwise, do nothing.

Definition at line 91 of file modelutils.cpp.

{
    if (!item->model())
        return;
 
    if (auto stack = item->model()->undoStack(); stack)
        stack->beginMacro(macro_name);
}

References ModelView::SessionItem::model(), and ModelView::SessionModel::undoStack().

Referenced by ModelView::ViewportItem::setViewportToContent().

Here is the call graph for this function:

CastedItems()

template<typename T >

std::vector<T*> ModelView::Utils::CastedItems

(

const std::vector< SessionItem * > &

items

)

Returns vector of items casted to given type.

Definition at line 90 of file itemutils.h.

{
    std::vector<T*> result;
    for (auto item : items)
        if (auto casted_item = dynamic_cast<T*>(item); casted_item)
            result.push_back(casted_item);
 
    return result;
}

CheckStateRole()

QVariant ModelView::Utils::CheckStateRole

(

const SessionItem &

item

)

Returns check state role of given item.

Definition at line 73 of file viewmodelutils.cpp.

{
    auto value = item.data<QVariant>();
    if (Utils::IsBoolVariant(value))
        return value.value<bool>() ? Qt::Checked : Qt::Unchecked;
    return QVariant();
}

References ModelView::SessionItem::data(), and IsBoolVariant().

Referenced by ModelView::ViewDataItem::data(), and TEST_F().

Here is the call graph for this function:

ChildAt()

SessionItem * ModelView::Utils::ChildAt	(	const SessionItem *	parent,
		int	index
	)

Returns child at given index of parent.

No tags are involved, index is considered as global index in the combined array of all children.

Definition at line 70 of file itemutils.cpp.

{
    if (!parent)
        return nullptr;
 
    auto container = parent->children();
    return index >= 0 && static_cast<size_t>(index) < container.size()
               ? container[static_cast<size_t>(index)]
               : nullptr;
}

References ModelView::SessionItem::children().

Referenced by ItemFromPath(), and TEST_F().

Here is the call graph for this function:

ClickableText()

QString ModelView::Utils::ClickableText	(	const QString &	text,
		const QString &	tag = {}
	)

Returns text wrapped into 'href' tag to provide clickable links in QLabel.

Example: text, if 'tag' is empty, 'text' will be used instead.

Definition at line 136 of file widgetutils.cpp.

{
    return QString("<a href=\"%1\">%2</a>").arg(tag.isEmpty() ? text : tag, text);
}

Referenced by gui2::OpenProjectWidget::createLinkedLabelLayout(), and TEST_F().

CompatibleVariantTypes()

bool ModelView::Utils::CompatibleVariantTypes	(	const Variant &	oldValue,
		const Variant &	newValue
	)

Returns true if variants has compatible types.

Definition at line 39 of file customvariants.cpp.

{
    // Invalid variant can be rewritten by any variant.
    // Valid Variant can be replaced by invalid variant.
    // In other cases types of variants should coincide to be compatible.
 
    if (!oldValue.isValid() || !newValue.isValid())
        return true;
 
    return Utils::VariantType(oldValue) == Utils::VariantType(newValue);
}

References VariantType().

Referenced by ModelView::SessionItemData::assure_validity(), and TEST_F().

Here is the call graph for this function:

Contains()

template<typename A , typename B >

bool ModelView::Utils::Contains	(	const A &	container,
		const B &	element
	)

Returns true if container contains a given element.

Definition at line 103 of file containerutils.h.

{
    return std::find(container.begin(), container.end(), element) != container.end();
}

Referenced by ModelView::TagInfo::isValidChild(), ModelView::ComboProperty::setStringOfValues(), ModelView::ComboProperty::setValue(), ModelView::ComboProperty::setValues(), TEST_F(), ModelView::SelectableComboBoxEditor::update_components(), and gui2::DataHandler::updateRawData().

CopyNumber()

int ModelView::Utils::CopyNumber

(

const SessionItem *

item

)

Returns copy number of given item in it's parent hierarchy.

Takes into account only items with same modelType.

Definition at line 49 of file itemutils.cpp.

{
    int result(-1);
 
    if (!item)
        return result;
 
    int count(0);
    auto model_type = item->modelType();
    if (auto parent = item->parent()) {
        for (auto child : parent->children()) {
            if (child == item)
                result = count;
            if (child->modelType() == model_type)
                ++count;
        }
    }
 
    return count > 1 ? result : -1;
}

References ModelView::SessionItem::modelType(), and ModelView::SessionItem::parent().

Referenced by ModelView::CompoundItem::displayName(), and TEST_F().

Here is the call graph for this function:

create_directory()

bool ModelView::Utils::create_directory

(

const std::string &

path

)

Create directory, parent directory must exist.

If path resolves to existing directory, no error reported.

Definition at line 47 of file fileutils.cpp.

{
#ifdef ENABLE_FILESYSTEM
    return std::filesystem::create_directory(path);
#else
    QDir dir(QString::fromStdString(path));
    return dir.mkpath(".");
#endif
}

Referenced by FileSystemUtils::createDirectory(), FolderBasedTest::createEmptyDir(), TestUtils::CreateTestDirectory(), and TEST_F().

CreateClone()

template<typename T = SessionModel>

std::unique_ptr<T> ModelView::Utils::CreateClone

(

const T &

model

)

Creates exact clone of given model. All item's ID will be preserved.

Definition at line 90 of file modelutils.h.

{
    auto result = std::make_unique<T>();
    auto converter = CreateModelCloneConverter();
    PopulateEmptyModel(converter.get(), model, *result.get());
    return result;
}

References ModelView::CreateModelCloneConverter(), and PopulateEmptyModel().

Referenced by TEST_F().

Here is the call graph for this function:

CreateCopy()

template<typename T = SessionModel>

std::unique_ptr<T> ModelView::Utils::CreateCopy

(

const T &

model

)

Creates full deep copy of given model. All item's ID will be generated.

Definition at line 81 of file modelutils.h.

{
    auto result = std::make_unique<T>();
    auto converter = CreateModelCopyConverter();
    PopulateEmptyModel(converter.get(), model, *result.get());
    return result;
}

References ModelView::CreateModelCopyConverter(), and PopulateEmptyModel().

Referenced by TEST_F().

Here is the call graph for this function:

DecorationRole()

QVariant ModelView::Utils::DecorationRole

(

const SessionItem &

item

)

Returns decoration role for given item.

Definition at line 81 of file viewmodelutils.cpp.

{
    auto value = item.data<QVariant>();
    if (Utils::IsColorVariant(value))
        return value;
    else if (Utils::IsExtPropertyVariant(value))
        return value.value<ExternalProperty>().color();
    return QVariant();
}

References ModelView::ExternalProperty::color(), ModelView::SessionItem::data(), IsColorVariant(), and IsExtPropertyVariant().

Referenced by ModelView::ViewDataItem::data(), and TEST_F().

Here is the call graph for this function:

DeleteItemFromModel()

void ModelView::Utils::DeleteItemFromModel

(

SessionItem *

item

)

Removes and deletes item from its model.

Definition at line 54 of file modelutils.cpp.

{
    auto model = item->model();
    if (!model)
        return;
 
    model->removeItem(item->parent(), item->tagRow());
}

References ModelView::SessionItem::model(), ModelView::SessionItem::parent(), ModelView::SessionModel::removeItem(), and ModelView::SessionItem::tagRow().

Referenced by gui2::LayerEditorActions::onRemove(), gui2::MaterialEditorActions::onRemoveMaterial(), gui2::JobItem::removeDifferenceGraph(), gui2::JobItem::removeReferenceGraph(), and TEST_F().

Here is the call graph for this function:

deserialize()

QStringList ModelView::Utils::deserialize

(

const QByteArray &

byteArray

)

Converts byte array to vector of strings.

Definition at line 172 of file widgetutils.cpp.

{
    QByteArray array = byteArray;
    QStringList result;
    QDataStream in(&array, QIODevice::ReadOnly);
    in >> result;
    return result;
}

Referenced by gui2::DataViewModel::dropMimeData(), and TEST_F().

EndMacros()

void ModelView::Utils::EndMacros

(

const SessionItem *

item

)

Finishes undo/redo macros.

Works only if item belongs to the model, and model has undo/redo enabled. Otherwise, do nothing.

Definition at line 100 of file modelutils.cpp.

{
    if (!item->model())
        return;
 
    if (auto stack = item->model()->undoStack(); stack)
        stack->endMacro();
}

References ModelView::SessionItem::model(), and ModelView::SessionModel::undoStack().

Referenced by ModelView::ViewportItem::setViewportToContent().

Here is the call graph for this function:

exists()

bool ModelView::Utils::exists

(

const std::string &

fileName

)

Returns true if file exists.

Definition at line 27 of file fileutils.cpp.

{
#ifdef ENABLE_FILESYSTEM
    return std::filesystem::exists(fileName);
#else
    QFileInfo info(QString::fromStdString(fileName));
    return info.exists();
#endif
}

References ProjectUtils::exists().

Referenced by ModelView::Project::ProjectImpl::process(), gui2::RecentProjectSettings::recentProjects(), and TEST_F().

Here is the call graph for this function:

FindFiles()

std::vector< std::string > ModelView::Utils::FindFiles	(	const std::string &	dirname,
		const std::string &	ext
	)

Returns list of files with given extention found in given directory.

Definition at line 87 of file fileutils.cpp.

{
#ifdef ENABLE_FILESYSTEM
    std::vector<std::string> result;
    for (const auto& entry : std::filesystem::directory_iterator(dirname)) {
        const auto filenameStr = entry.path().filename().string();
        if (entry.is_regular_file() && entry.path().extension() == ext)
            result.push_back(entry.path().string());
    }
    return result;
#else
    std::vector<std::string> result;
    QDir dir(QString::fromStdString(dirname));
    if (dir.exists()) {
        QStringList filters = {QString::fromStdString("*" + ext)};
        for (auto entry : dir.entryList(filters)) {
            auto name = dir.filePath(entry);
            result.push_back(name.toStdString());
        }
    }
    return result;
#endif
}

References RealSpace::Particles::name().

Referenced by ModelView::ProjectUtils::IsPossibleProjectDir(), and TEST_F().

Here is the call graph for this function:

FindItems()

template<typename T = SessionItem>

std::vector<T*> ModelView::Utils::FindItems

(

const SessionModel *

model

)

Returns all items in a tree of given type.

Definition at line 55 of file modelutils.h.

{
    std::vector<T*> result;
 
    auto func = [&result](SessionItem* item) {
        if (auto concrete = dynamic_cast<T*>(item); concrete)
            result.push_back(concrete);
    };
 
    iterate(model->rootItem(), func);
 
    return result;
}

References iterate(), and ModelView::SessionModel::rootItem().

Here is the call graph for this function:

FindMainWindow()

QMainWindow * ModelView::Utils::FindMainWindow

(

)

Finds main window.

Definition at line 127 of file widgetutils.cpp.

{
    for (auto widget : qApp->topLevelWidgets()) {
        if (auto result = dynamic_cast<QMainWindow*>(widget); result)
            return result;
    }
    return nullptr;
}

Referenced by gui2::ProjectHandler::updateCurrentProjectName().

FindNextItemToSelect()

SessionItem * ModelView::Utils::FindNextItemToSelect

(

SessionItem *

item

)

Finds next item to select Method is used in the context of next item selection after given item was deleted.

Definition at line 149 of file itemutils.cpp.

{
    auto next = FindNextSibling(item);
    auto closest = next ? next : FindPreviousSibling(item);
    return closest ? closest : item->parent();
}

References FindNextSibling(), FindPreviousSibling(), and ModelView::SessionItem::parent().

Referenced by TEST_F().

Here is the call graph for this function:

FindNextSibling()

SessionItem * ModelView::Utils::FindNextSibling

(

SessionItem *

item

)

Returns next sibling with same tag.

Definition at line 131 of file itemutils.cpp.

{
    auto parent = item ? item->parent() : nullptr;
    if (!parent)
        return nullptr;
    auto tagrow = item->tagRow();
    return parent->getItem(tagrow.tag, tagrow.row + 1);
}

References ModelView::SessionItem::parent(), and ModelView::SessionItem::tagRow().

Referenced by FindNextItemToSelect(), gui2::LayerEditorActions::onRemove(), and TEST_F().

Here is the call graph for this function:

FindPreviousSibling()

SessionItem * ModelView::Utils::FindPreviousSibling

(

SessionItem *

item

)

Returns previous sibling with same tag.

Definition at line 140 of file itemutils.cpp.

{
    auto parent = item ? item->parent() : nullptr;
    if (!parent)
        return nullptr;
    auto tagrow = parent->tagRowOfItem(item);
    return parent->getItem(tagrow.tag, tagrow.row - 1);
}

References ModelView::SessionItem::parent(), and ModelView::SessionItem::tagRowOfItem().

Referenced by FindNextItemToSelect(), gui2::LayerEditorActions::onRemove(), and TEST_F().

Here is the call graph for this function:

fromStringList()

std::vector< std::string > ModelView::Utils::fromStringList

(

const QStringList &

string_list

)

Converts vector of strings to QStringList.

Definition at line 156 of file widgetutils.cpp.

{
    std::vector<std::string> result;
    for (const auto& x : string_list)
        result.push_back(x.toStdString());
    return result;
}

Referenced by gui2::DataLoaderDialog::onLoadFilesRequest(), and TEST_F().

HasTag()

bool ModelView::Utils::HasTag	(	const SessionItem &	item,
		const std::string &	tag
	)

Returns true if given item has registered tag.

Definition at line 86 of file itemutils.cpp.

{
    return item.itemTags()->isTag(tag);
}

References ModelView::SessionItemTags::isTag(), and ModelView::SessionItem::itemTags().

Referenced by gui2::MaterialBaseItem::external_property(), and TEST_F().

Here is the call graph for this function:

HeightOfLetterM()

int ModelView::Utils::HeightOfLetterM

(

)

Returns height of the letter 'M' deduced from current font metrics.

Definition at line 111 of file widgetutils.cpp.

{
    return ModelView::Utils::SizeOfLetterM().height();
}

References SizeOfLetterM().

Referenced by ModelView::CollapsibleBar::CollapsibleBar(), and gui2::FancyTab::FancyTab().

Here is the call graph for this function:

Imag()

template<typename C >

std::vector<double> ModelView::Utils::Imag

(

const C &

container

)

Returns vector with imag part of complex numbers.

Definition at line 80 of file containerutils.h.

{
    return Apply(std::begin(container), std::end(container),
                 [](const auto& x) { return std::imag(x); });
}

References Apply().

Referenced by TEST_F().

Here is the call graph for this function:

IndexOfChild()

int ModelView::Utils::IndexOfChild	(	const SessionItem *	parent,
		const SessionItem *	child
	)

Returns index in children array corresponding to given child.

No tags are involved, index is considered as global index in the combined array of all children.

Definition at line 81 of file itemutils.cpp.

{
    return Utils::IndexOfItem(parent->children(), child);
}

References ModelView::SessionItem::children(), and IndexOfItem().

Referenced by PathFromItem(), and TEST_F().

Here is the call graph for this function:

IndexOfItem() [1/2]

template<typename C , typename T >

int ModelView::Utils::IndexOfItem	(	const C &	container,
		const T &	item
	)

Returns index corresponding to the first occurance of the item in the container.

If item doesn't exist, will return -1. Works with containers containing unique_ptr.

Definition at line 55 of file containerutils.h.

{
    return IndexOfItem(container.begin(), container.end(), item);
}

References IndexOfItem().

Here is the call graph for this function:

IndexOfItem() [2/2]

template<typename It , typename T >

int ModelView::Utils::IndexOfItem	(	It	begin,
		It	end,
		const T &	item
	)

Returns index corresponding to the first occurance of the item in the container.

If item doesn't exist, will return -1. Works with containers containing unique_ptr.

Definition at line 41 of file containerutils.h.

{
    It pos;
    if constexpr (is_unique_ptr<typename std::iterator_traits<It>::value_type>::value)
        pos = find_if(begin, end, [&item](const auto& x) { return x.get() == item; });
    else
        pos = find_if(begin, end, [&item](const auto& x) { return x == item; });
 
    return pos == end ? -1 : static_cast<int>(std::distance(begin, pos));
}

Referenced by gui2::ImportDataEditor::canvasInfo(), ModelView::ViewItem::ViewItemImpl::index_of_child(), IndexOfChild(), IndexOfItem(), ModelView::SessionItemContainer::indexOfItem(), ModelView::ViewModelController::ViewModelControllerImpl::insert_view(), ModelView::GroupItem::setCurrentType(), ModelView::ComboProperty::setSelected(), ModelView::ComboProperty::setStringOfValues(), ModelView::ComboProperty::setValue(), ModelView::ComboProperty::setValues(), and TEST_F().

is_empty()

bool ModelView::Utils::is_empty

(

const std::string &

path

)

Returns true if the file indicated by 'path' refers to empty file or directory.

Definition at line 121 of file fileutils.cpp.

{
#ifdef ENABLE_FILESYSTEM
    return std::filesystem::is_empty(path);
#else
    QFileInfo info(QString::fromStdString(path));
    if (info.isDir()) {
        QDir dir(QString::fromStdString(path));
        return dir.isEmpty();
    } else {
        return info.size() == 0;
    }
    return false;
#endif
}

Referenced by ModelView ::Compatibility::IsCompatibleUniversalTag(), gui2::UserInteractor::onCreateDirRequest(), and TEST_F().

IsBoolVariant()

bool ModelView::Utils::IsBoolVariant

(

const Variant &

variant

)

Returns true in the case of double value based variant.

Definition at line 92 of file customvariants.cpp.

{
    return variant.type() == Variant::Bool;
}

Referenced by ModelView::DefaultCellDecorator::cellText(), CheckStateRole(), and TEST_F().

IsColorVariant()

bool ModelView::Utils::IsColorVariant

(

const Variant &

variant

)

Returns true in the case of QColor based variant.

Definition at line 122 of file customvariants.cpp.

{
    return variant.type() == Variant::Color;
}

Referenced by ModelView::DefaultCellDecorator::cellText(), DecorationRole(), TEST_F(), and ModelView::ColorEditor::update_components().

IsComboVariant()

bool ModelView::Utils::IsComboVariant

(

const Variant &

variant

)

Returns true in the case of double value based variant.

Definition at line 107 of file customvariants.cpp.

{
    return variant.canConvert<ComboProperty>();
}

Referenced by ModelView::DefaultCellDecorator::cellText(), and TEST_F().

IsDoubleVariant()

bool ModelView::Utils::IsDoubleVariant

(

const Variant &

variant

)

Returns true in the case of double value based variant.

Definition at line 102 of file customvariants.cpp.

{
    return variant.type() == Variant::Double;
}

Referenced by ModelView::DefaultCellDecorator::cellText(), and TEST_F().

IsDoubleVectorVariant()

bool ModelView::Utils::IsDoubleVectorVariant

(

const Variant &

variant

)

Returns true in the case of variant based on std::vector<double>.

Definition at line 117 of file customvariants.cpp.

{
    return variant.typeName() == Constants::vector_double_type_name;
}

References ModelView::Constants::vector_double_type_name.

Referenced by TEST_F(), and toQtVariant().

IsExtPropertyVariant()

bool ModelView::Utils::IsExtPropertyVariant

(

const Variant &

variant

)

Returns true in the case of ExternalProperty based variant.

Definition at line 127 of file customvariants.cpp.

{
    return variant.canConvert<ExternalProperty>();
}

Referenced by ModelView::DefaultCellDecorator::cellText(), gui2::CustomLayerTreeEditorFactory::createEditor(), gui2::CustomBeamPropertyEditorFactory::createEditor(), DecorationRole(), TEST_F(), and ModelView::ExternalPropertyEditor::update_components().

IsIntVariant()

bool ModelView::Utils::IsIntVariant

(

const Variant &

variant

)

Returns true in the case of double value based variant.

Definition at line 97 of file customvariants.cpp.

{
    return variant.type() == Variant::Int;
}

Referenced by TEST_F().

IsItemAncestor()

bool ModelView::Utils::IsItemAncestor	(	const SessionItem *	item,
		const SessionItem *	candidate
	)

Returns true if 'candidate' is one of ancestor of given item.

Definition at line 156 of file itemutils.cpp.

{
    if (!item || !candidate)
        return false;
    const SessionItem* parent = item->parent();
    while (parent) {
        if (parent == candidate)
            return true;
        else
            parent = parent->parent();
    }
    return false;
}

References ModelView::SessionItem::parent().

Referenced by ModelView::ViewModelController::onAboutToRemoveItem(), and TEST_F().

Here is the call graph for this function:

IsLinuxHost()

bool ModelView::Utils::IsLinuxHost

(

)

Returns true if it is Linux.

Definition at line 70 of file widgetutils.cpp.

{
#if defined(Q_OS_LINUX)
    return true;
#else
    return false;
#endif
}

IsMacHost()

bool ModelView::Utils::IsMacHost

(

)

Returns true if it is Mac.

Definition at line 61 of file widgetutils.cpp.

{
#if defined(Q_OS_MAC)
    return true;
#else
    return false;
#endif
}

IsRealLimitsVariant()

bool ModelView::Utils::IsRealLimitsVariant

(

const Variant &

variant

)

Returns true in the case of RealLimits based variant.

Definition at line 132 of file customvariants.cpp.

{
    return variant.canConvert<RealLimits>();
}

Referenced by TEST_F().

IsSinglePropertyTag()

bool ModelView::Utils::IsSinglePropertyTag	(	const SessionItem &	item,
		const std::string &	tag
	)

Returns true if given item has registered tag, and it belongs to single property.

Definition at line 91 of file itemutils.cpp.

{
    return item.itemTags()->isSinglePropertyTag(tag);
}

References ModelView::SessionItemTags::isSinglePropertyTag(), and ModelView::SessionItem::itemTags().

Referenced by ModelView::MoveItemCommand::MoveItemCommand(), RegisteredUniversalTags(), SinglePropertyItems(), TEST_F(), and TopLevelItems().

Here is the call graph for this function:

IsStdStringVariant()

bool ModelView::Utils::IsStdStringVariant

(

const Variant &

variant

)

Returns true in the case of double value based variant.

Definition at line 112 of file customvariants.cpp.

{
    return variant.canConvert<std::string>();
}

Referenced by TEST_F().

IsTheSame()

bool ModelView::Utils::IsTheSame	(	const Variant &	var1,
		const Variant &	var2
	)

Returns true if given variants have same type and value.

Definition at line 51 of file customvariants.cpp.

{
    // variants of different type are always reported as not the same
    if (VariantType(var1) != VariantType(var2))
        return false;
 
    // variants of same type are compared by value
    return var1 == var2;
}

References SessionItemUtils::VariantType().

Referenced by ModelView::DataRole::operator==(), ModelView::SessionItemData::setData(), and TEST_F().

Here is the call graph for this function:

IsWindowsHost()

bool ModelView::Utils::IsWindowsHost

(

)

Returns true if it is Windows.

Definition at line 52 of file widgetutils.cpp.

{
#if defined(Q_OS_WIN)
    return true;
#else
    return false;
#endif
}

Referenced by TEST_F(), and WithTildeHomePath().

ItemFromPath()

SessionItem * ModelView::Utils::ItemFromPath	(	const SessionModel &	moodel,
		const Path &	path
	)

Returns item found in the model following given Path.

Definition at line 36 of file modelutils.cpp.

{
    SessionItem* result(model.rootItem());
    for (const auto& x : path) {
        result = Utils::ChildAt(result, x);
        if (!result)
            break;
    }
    return result;
}

References ChildAt(), and ModelView::SessionModel::rootItem().

Referenced by ModelView::ViewModelController::ViewModelController(), ModelView::AbstractItemCommand::itemFromPath(), and TEST_F().

Here is the call graph for this function:

ItemRoleToQtRole()

QVector< int > ModelView::Utils::ItemRoleToQtRole

(

int

role

)

Returns vector of Qt roles corresponding to given ItemDataRole.

Translates SessionItem's data role to vector of Qt roles.

Definition at line 50 of file viewmodelutils.cpp.

{
    QVector<int> result;
    // In Qt when we are editing the data in a view two roles are emmited.
    if (role == ItemDataRole::DISPLAY || role == ItemDataRole::DATA)
        result = {Qt::DisplayRole, Qt::EditRole};
    else if (role == ItemDataRole::APPEARANCE)
#if QT_VERSION >= QT_VERSION_CHECK(5, 13, 0)
        result = {Qt::ForegroundRole};
#else
        result = {Qt::TextColorRole};
#endif
    else if (role == ItemDataRole::TOOLTIP)
        result = {Qt::ToolTipRole};
 
    return result;
}

References ModelView::ItemDataRole::APPEARANCE, ModelView::ItemDataRole::DATA, ModelView::ItemDataRole::DISPLAY, SessionItemUtils::ForegroundRole(), TextColorRole(), ModelView::ItemDataRole::TOOLTIP, and SessionItemUtils::ToolTipRole().

Referenced by ModelView::ViewModelController::onDataChange(), and TEST_F().

Here is the call graph for this function:

ItemsFromIndex()

std::vector< SessionItem * > ModelView::Utils::ItemsFromIndex

(

const QModelIndexList &

index_list

)

Returns vector of underlying SessionItem's for given index list.

Definition at line 97 of file viewmodelutils.cpp.

{
    if (index_list.empty())
        return {};
 
    std::vector<SessionItem*> result;
 
    if (auto model = dynamic_cast<const ViewModelBase*>(index_list.front().model()))
        std::transform(index_list.begin(), index_list.end(), std::back_inserter(result),
                       [model](auto index) { return model->itemFromIndex(index)->item(); });
 
    return result;
}

Referenced by ParentItemsFromIndex(), gui2::DataSelectionModel::selectedItems(), TEST_F(), and UniqueItemsFromIndex().

iterate()

void ModelView::Utils::iterate	(	SessionItem *	item,
		const std::function< void(SessionItem *)> &	fun
	)

Iterates through item and all its children.

Definition at line 24 of file itemutils.cpp.

{
    if (item)
        fun(item);
    else
        return;
 
    for (auto child : item->children())
        iterate(child, fun);
}

References ModelView::SessionItem::children(), and ModelUtils::iterate().

Referenced by FindItems(), and TEST_F().

Here is the call graph for this function:

iterate_if()

void ModelView::Utils::iterate_if	(	const SessionItem *	item,
		const std::function< bool(const SessionItem *)> &	fun
	)

Iterates through all model indices and calls user function.

If function returns false for given index, iteration will not go down to children.

Definition at line 35 of file itemutils.cpp.

{
    bool proceed_with_children(true);
 
    if (item)
        proceed_with_children = fun(item);
 
    if (!item || !proceed_with_children)
        return;
 
    for (auto child : item->children())
        iterate_if(child, fun);
}

References ModelView::SessionItem::children(), and ModelUtils::iterate_if().

Referenced by TEST_F().

Here is the call graph for this function:

iterate_model()

void ModelView::Utils::iterate_model	(	const QAbstractItemModel *	model,
		const QModelIndex &	parent,
		const std::function< void(const QModelIndex &child)> &	fun
	)

Iterates through QAbstractItem model.

Definition at line 29 of file viewmodelutils.cpp.

{
    if (!model)
        return;
 
    for (int row = 0; row < model->rowCount(parent); ++row) {
        for (int col = 0; col < model->columnCount(parent); ++col) {
            auto index = model->index(row, col, parent);
            if (index.isValid())
                fun(index);
        }
        for (int col = 0; col < model->columnCount(parent); ++col) {
            auto index = model->index(row, col, parent);
            iterate_model(model, index, fun);
        }
    }
}

Referenced by ModelView::ViewModelController::ViewModelControllerImpl::findViews(), and TEST_F().

join()

std::string ModelView::Utils::join	(	const std::string &	part1,
		const std::string &	part2
	)

Joins two path elements into the path.

Definition at line 37 of file fileutils.cpp.

{
#ifdef ENABLE_FILESYSTEM
    auto path = std::filesystem::path(part1) / std::filesystem::path(part2);
    return path.string();
#else
    return part1 + std::string("/") + part2;
#endif
}

Referenced by FolderBasedTest::createEmptyDir(), ModelView::Project::ProjectImpl::process(), and TEST_F().

MoveDown()

void ModelView::Utils::MoveDown

(

SessionItem *

item

)

Moves item down (increments row of the item). Works on children belonging to single tag.

Definition at line 71 of file modelutils.cpp.

{
    auto tagrow = item->tagRow();
    if (tagrow.row == item->parent()->itemCount(tagrow.tag) - 1)
        return; // item already at the buttom
    item->model()->moveItem(item, item->parent(), tagrow.next());
}

References ModelView::SessionItem::itemCount(), ModelView::SessionItem::model(), ModelView::SessionModel::moveItem(), ModelView::SessionItem::parent(), and ModelView::SessionItem::tagRow().

Referenced by gui2::LayerEditorActions::onMoveDown(), gui2::MaterialEditorActions::onMoveDown(), and TEST_F().

Here is the call graph for this function:

MoveUp()

void ModelView::Utils::MoveUp

(

SessionItem *

item

)

Moves item up (decrements row of the item). Works on children belonging to single tag.

Definition at line 63 of file modelutils.cpp.

{
    auto tagrow = item->tagRow();
    if (tagrow.row == 0)
        return; // item already at the top
    item->model()->moveItem(item, item->parent(), tagrow.prev());
}

References ModelView::SessionItem::model(), ModelView::SessionModel::moveItem(), ModelView::SessionItem::parent(), and ModelView::SessionItem::tagRow().

Referenced by gui2::LayerEditorActions::onMoveUp(), gui2::MaterialEditorActions::onMoveUp(), and TEST_F().

Here is the call graph for this function:

parent_path()

std::string ModelView::Utils::parent_path

(

const std::string &

path

)

Returns the path to the parent directory.

Definition at line 111 of file fileutils.cpp.

{
#ifdef ENABLE_FILESYSTEM
    return std::filesystem::path(path).parent_path().string();
#else
    QFileInfo info(QString::fromStdString(path));
    return info.dir().path().toStdString();
#endif
}

Referenced by TEST_F(), gui2::ImportFileWidget::updateCurrentWorkdir(), and gui2::RecentProjectSettings::updateWorkdirFromSelection().

ParentItemsFromIndex()

std::vector< SessionItem * > ModelView::Utils::ParentItemsFromIndex

(

const QModelIndexList &

index_list

)

Returns vector of parent items from given index list.

Finds all SessionItems corresponding to given index list and collect their parents. Function is usefull in the context of table-like views when we want to find compound items (i.e. Layers) from table cells containing LayerItem's properties (i.e. thickness).

Definition at line 116 of file viewmodelutils.cpp.

{
    std::set<SessionItem*> unique_parents;
    for (auto item : ItemsFromIndex(index_list))
        if (item)
            unique_parents.insert(item->parent());
 
    std::vector<SessionItem*> result;
    std::copy(unique_parents.begin(), unique_parents.end(), std::back_inserter(result));
    return result;
}

References ItemsFromIndex().

Referenced by gui2::MaterialSelectionModel::selectedMaterials(), and TEST_F().

Here is the call graph for this function:

PathFromItem()

Path ModelView::Utils::PathFromItem

(

const SessionItem *

item

)

Constructs path to find given item. Item must belong to a model.

Definition at line 22 of file modelutils.cpp.

{
    if (!item || !item->model())
        return {};
 
    Path result;
    const SessionItem* current(item);
    while (current && current->parent()) {
        result.prepend(Utils::IndexOfChild(current->parent(), current));
        current = current->parent();
    }
    return result;
}

References IndexOfChild(), ModelView::SessionItem::model(), ModelView::SessionItem::parent(), and ModelView::Path::prepend().

Referenced by ModelView::AbstractItemCommand::pathFromItem(), ModelView::ViewModelController::ViewModelControllerImpl::setRootSessionItemIntern(), and TEST_F().

Here is the call graph for this function:

PopulateEmptyModel()

void ModelView::Utils::PopulateEmptyModel	(	const JsonModelConverterInterface *	converter,
		const SessionModel &	source,
		SessionModel &	target
	)

Populate empty model with content of target model using provided converter.

Serves as auxiliary function for model copying and cloning.

Definition at line 47 of file modelutils.cpp.

{
    QJsonObject object = converter->to_json(source);
    converter->from_json(object, target);
}

References ModelView::JsonModelConverterInterface::from_json(), and ModelView::JsonModelConverterInterface::to_json().

Referenced by CreateClone(), and CreateCopy().

Here is the call graph for this function:

ProjectWindowTitle()

QString ModelView::Utils::ProjectWindowTitle	(	const QString &	project_dir,
		bool	is_modified
	)

Returns a title composed from last part of project path, and is_modified flag.

Project without projectDir will be "Untitled", modified project will be "*Untitled".

Project with projectDir in "/home/user/project1" will get title "project1".

Definition at line 98 of file widgetutils.cpp.

{
    auto pos = project_dir.lastIndexOf('/');
    auto project_name = (pos == -1) ? untitled_name : project_dir.mid(pos + 1);
    auto unsaved_status = is_modified ? QString("*") : QString();
    return unsaved_status + project_name;
}

Referenced by gui2::ProjectPaneWidget::setCurrentProject(), TEST_F(), and gui2::ProjectHandler::updateCurrentProjectName().

RandDouble()

double ModelView::Utils::RandDouble	(	double	low,
		double	high
	)

Produces random FLOAT values uniformly distributed on the interval [low, high).

Definition at line 38 of file numericutils.cpp.

{
    std::random_device rd;
    std::mt19937 gen(rd());
    std::uniform_real_distribution<> uniform_real(low, high);
    return uniform_real(gen);
}

RandInt()

int ModelView::Utils::RandInt	(	int	low,
		int	high
	)

Produces random integer values uniformly distributed on the closed interval [low, high].

Definition at line 30 of file numericutils.cpp.

{
    std::random_device rd;
    std::mt19937 gen(rd());
    std::uniform_int_distribution<int> uniform_int(low, high);
    return uniform_int(gen);
}

Referenced by RandomColor().

RandomColor()

QColor ModelView::Utils::RandomColor

(

)

Returns random color.

Definition at line 41 of file widgetutils.cpp.

{
    auto rndm = []() -> int { return ModelView::Utils::RandInt(0, 255); };
    return QColor(rndm(), rndm(), rndm());
}

References RandInt().

Referenced by RandomNamedColor().

Here is the call graph for this function:

RandomNamedColor()

std::string ModelView::Utils::RandomNamedColor

(

)

Returns the name of random color.

Definition at line 47 of file widgetutils.cpp.

{
    return RandomColor().name().toStdString();
}

References RandomColor().

Here is the call graph for this function:

Real()

template<typename C >

std::vector<double> ModelView::Utils::Real

(

const C &

container

)

Returns vector with real part of complex numbers.

Definition at line 72 of file containerutils.h.

{
    return Apply(std::begin(container), std::end(container),
                 [](const auto& x) { return std::real(x); });
}

References Apply().

Referenced by gui2::SpecularToySimulation::sld_profile(), and TEST_F().

Here is the call graph for this function:

Redo()

void ModelView::Utils::Redo

(

SessionModel &

model

)

Redo model operation which was undone just before. If not undo/redo enabled, will do nothing.

Definition at line 85 of file modelutils.cpp.

{
    if (auto stack = model.undoStack(); stack)
        stack->redo();
}

References ModelView::SessionModel::undoStack().

Here is the call graph for this function:

RegisteredTags()

std::vector< std::string > ModelView::Utils::RegisteredTags

(

const SessionItem &

item

)

Returns vector of strings containing all registered tags of the given item.

Definition at line 96 of file itemutils.cpp.

{
    std::vector<std::string> result;
    for (const auto container : *item.itemTags())
        result.push_back(container->name());
    return result;
}

References ModelView::SessionItem::itemTags().

Referenced by RegisteredUniversalTags(), and TEST_F().

Here is the call graph for this function:

RegisteredUniversalTags()

std::vector< std::string > ModelView::Utils::RegisteredUniversalTags

(

const SessionItem &

item

)

Returns vector of strings containing all registered universal tags of the given item.

A universal tag is a tag that is usually empty after item construction and serves for later children's insertion.

Definition at line 104 of file itemutils.cpp.

{
    std::vector<std::string> result;
    for (const auto& tag : RegisteredTags(item))
        if (!IsSinglePropertyTag(item, tag))
            result.push_back(tag);
    return result;
}

References IsSinglePropertyTag(), and RegisteredTags().

Referenced by TEST_F().

Here is the call graph for this function:

remove()

bool ModelView::Utils::remove

(

const std::string &

path

)

Removes file or empty directory.

Definition at line 57 of file fileutils.cpp.

{
#ifdef ENABLE_FILESYSTEM
    return std::filesystem::remove(path);
#else
    QFile file(QString::fromStdString(path));
    return file.remove();
#endif
}

Referenced by LayoutUtils::removeColumn(), ParameterPool::removeParameter(), LayoutUtils::removeRow(), and TEST_F().

remove_all()

void ModelView::Utils::remove_all

(

const std::string &

path

)

Removes directory with all its content.

Definition at line 67 of file fileutils.cpp.

{
#ifdef ENABLE_FILESYSTEM
    std::filesystem::remove_all(path);
#else
    QDir dir(QString::fromStdString(path));
    if (dir.exists())
        dir.removeRecursively();
#endif
}

Referenced by FolderBasedTest::createEmptyDir(), and TEST_F().

ScaleLabelFont()

void ModelView::Utils::ScaleLabelFont	(	QLabel *	label,
		double	scale
	)

Set label's font size to system font size scaled by given factor.

Definition at line 141 of file widgetutils.cpp.

{
    QFont font = label->font();
    font.setPointSize(ModelView::Utils::SystemPointSize() * scale);
    label->setFont(font);
}

References SystemPointSize().

Referenced by gui2::FancyTab::FancyTab(), gui2::RecentProjectWidget::createCurrentProjectLayout(), gui2::OpenProjectWidget::createLinkedLabelLayout(), gui2::OpenProjectWidget::createProjectTitleLayout(), and gui2::RecentProjectWidget::createRecentProjectLayout().

Here is the call graph for this function:

serialize()

QByteArray ModelView::Utils::serialize

(

const QStringList &

data

)

Converts vector of strings to byte array.

Definition at line 164 of file widgetutils.cpp.

{
    QByteArray byteArray;
    QDataStream out(&byteArray, QIODevice::WriteOnly);
    out << data;
    return byteArray;
}

Referenced by gui2::DataViewModel::mimeData(), and TEST_F().

SetLogarithmicScale() [1/2]

void ModelView::Utils::SetLogarithmicScale	(	QCPAxis *	axis,
		bool	is_log_scale
	)

Switch axis to logarithmic scale mode.

Definition at line 29 of file customplotutils.cpp.

{
    if (is_log_scale) {
        axis->setNumberFormat("eb");
        axis->setNumberPrecision(0);
        axis->setScaleType(QCPAxis::stLogarithmic);
        QSharedPointer<QCPAxisTicker> ticker(new QCPAxisTickerLog);
        axis->setTicker(ticker);
    } else {
        axis->setNumberFormat("g");
        axis->setNumberPrecision(6);
        axis->setScaleType(QCPAxis::stLinear);
        QSharedPointer<QCPAxisTicker> ticker(new QCPAxisTicker);
        axis->setTicker(ticker);
    }
}

SetLogarithmicScale() [2/2]

void ModelView::Utils::SetLogarithmicScale	(	QCPColorScale *	axis,
		bool	is_log_scale
	)

Switch axis to logarithmic scale mode.

Definition at line 18 of file customplotutils.cpp.

{
    if (is_log_scale && axis->dataScaleType() != QCPAxis::stLogarithmic)
        axis->setDataScaleType(QCPAxis::stLogarithmic);
 
    else if (!is_log_scale && axis->dataScaleType() != QCPAxis::stLinear)
        axis->setDataScaleType(QCPAxis::stLinear);
 
    SetLogarithmicScale(axis->axis(), is_log_scale);
}

Referenced by ModelView::ViewportAxisPlotController::AxesPlotControllerImpl::setAxisLogScaleFromItem().

SinglePropertyItems()

std::vector< SessionItem * > ModelView::Utils::SinglePropertyItems

(

const SessionItem &

item

)

Returns vector of children representing property items.

Definition at line 122 of file itemutils.cpp.

{
    std::vector<SessionItem*> result;
    for (auto child : item.children())
        if (IsSinglePropertyTag(item, item.tagRowOfItem(child).tag))
            result.push_back(child);
    return result;
}

References ModelView::SessionItem::children(), IsSinglePropertyTag(), ModelView::TagRow::tag, and ModelView::SessionItem::tagRowOfItem().

Referenced by ModelView::PropertyItemsStrategy::children(), ModelView::PropertyItemsFlatStrategy::children(), ModelView::PropertiesRowStrategy::constructRow(), and TEST_F().

Here is the call graph for this function:

SizeOfLetterM()

QSize ModelView::Utils::SizeOfLetterM

(

)

Returns size corresponding to actual size of letter M basing on current font metrics.

Definition at line 116 of file widgetutils.cpp.

{
    static QSize result = FindSizeOfLetterM();
    return result;
}

Referenced by gui2::OpenProjectWidget::OpenProjectWidget(), gui2::RecentProjectWidget::createRecentProjectScrollArea(), HeightOfLetterM(), and WidthOfLetterM().

SystemPointSize()

int ModelView::Utils::SystemPointSize

(

)

Returns size in points of default system font.

Definition at line 122 of file widgetutils.cpp.

{
    return QApplication::font().pointSize();
}

Referenced by gui2::ImportTextView::ImportTextView(), and ScaleLabelFont().

TextColorRole()

QVariant ModelView::Utils::TextColorRole

(

const SessionItem &

item

)

Returns text color for given item.

Definition at line 68 of file viewmodelutils.cpp.

{
    return item.isEnabled() ? QVariant() : QColor(Qt::gray);
}

References ModelView::SessionItem::isEnabled().

Referenced by ModelView::PropertyFlatView::PropertyFlatViewImpl::connect_model(), ModelView::ViewItem::data(), ItemRoleToQtRole(), and TEST_F().

Here is the call graph for this function:

toCustomVariant()

Variant ModelView::Utils::toCustomVariant

(

const Variant &

standard

)

Converts Qt variant to custom variant on board of SessionItem.

Definition at line 79 of file customvariants.cpp.

{
    if (!standard.isValid())
        return standard;
 
    // converts variant based on std::string to variant based on QString
    if (standard.typeName() == qstring_name)
        return Variant::fromValue(standard.toString().toStdString());
 
    // in other cases returns unchanged variant
    return standard;
}

Referenced by ModelView::ViewItem::setData(), and TEST_F().

ToolTipRole()

QVariant ModelView::Utils::ToolTipRole

(

const SessionItem &

item

)

Returns tooltip role for given item.

Definition at line 91 of file viewmodelutils.cpp.

{
    return item.hasData(ItemDataRole::TOOLTIP) ? Variant(QString::fromStdString(item.toolTip()))
                                               : QVariant();
}

References ModelView::SessionItem::hasData(), ModelView::ItemDataRole::TOOLTIP, and ModelView::SessionItem::toolTip().

Referenced by ModelView::ViewItem::data(), and TEST_F().

Here is the call graph for this function:

TopItem()

template<typename T = SessionItem>

T* ModelView::Utils::TopItem

(

const SessionModel *

model

)

Returns top level item of given type.

Definition at line 47 of file modelutils.h.

{
    auto items = TopItems<T>(model);
    return items.empty() ? nullptr : items.front();
}

TopItems()

template<typename T = SessionItem>

std::vector<T*> ModelView::Utils::TopItems

(

const SessionModel *

model

)

Returns all top level items of given type.

Definition at line 34 of file modelutils.h.

{
    std::vector<T*> result;
    for (auto child : model->rootItem()->children()) {
        if (auto item = dynamic_cast<T*>(child); item)
            result.push_back(item);
    }
 
    return result;
}

References ModelView::SessionItem::children(), and ModelView::SessionModel::rootItem().

Here is the call graph for this function:

TopLevelItems()

std::vector< SessionItem * > ModelView::Utils::TopLevelItems

(

const SessionItem &

item

)

Returns vector of children representing top level items.

Definition at line 113 of file itemutils.cpp.

{
    std::vector<SessionItem*> result;
    for (auto child : item.children())
        if (!IsSinglePropertyTag(item, item.tagRowOfItem(child).tag))
            result.push_back(child);
    return result;
}

References ModelView::SessionItem::children(), IsSinglePropertyTag(), ModelView::TagRow::tag, and ModelView::SessionItem::tagRowOfItem().

Referenced by ModelView::TopItemsStrategy::children(), and TEST_F().

Here is the call graph for this function:

toQtVariant()

Variant ModelView::Utils::toQtVariant

(

const Variant &

custom

)

Converts custom variant to standard variant which Qt views will understand.

Definition at line 61 of file customvariants.cpp.

{
    if (!custom.isValid())
        return custom;
 
    // converts variant based on std::string to variant based on QString
    if (custom.typeName() == Constants::string_type_name) {
        return Variant(QString::fromStdString(custom.value<std::string>()));
    } else if (IsDoubleVectorVariant(custom)) {
        QString str =
            QString("vector of %1 elements").arg(custom.value<std::vector<double>>().size());
        return Variant(str);
    }
 
    // in other cases returns unchanged variant
    return custom;
}

References IsDoubleVectorVariant(), and ModelView::Constants::string_type_name.

Referenced by ModelView::ViewItem::data(), and TEST_F().

Here is the call graph for this function:

toStringList()

QStringList ModelView::Utils::toStringList

(

const std::vector< std::string > &

vec

)

Converts vector of strings to QStringList.

Definition at line 148 of file widgetutils.cpp.

{
    QStringList result;
    for (const auto& x : vec)
        result.push_back(QString::fromStdString(x));
    return result;
}

Referenced by gui2::DataLoaderDialog::setTargetCanvas(), and TEST_F().

Undo()

void ModelView::Utils::Undo

(

SessionModel &

model

)

Undo last model operation. If not undo/redo enabled, will do nothing.

Definition at line 79 of file modelutils.cpp.

{
    if (auto stack = model.undoStack(); stack)
        stack->undo();
}

References ModelView::SessionModel::undoStack().

Here is the call graph for this function:

UniqueItems()

std::vector< SessionItem * > ModelView::Utils::UniqueItems

(

const std::vector< SessionItem * > &

items

)

Returns vector with duplicates and 'nullptr' filtered out.

Definition at line 170 of file itemutils.cpp.

{
    auto filtered = Utils::UniqueWithOrder(items);
    std::vector<SessionItem*> result;
    std::copy_if(filtered.begin(), filtered.end(), std::back_inserter(result),
                 [](auto x) { return x != nullptr; });
    return result;
}

References UniqueWithOrder().

Referenced by gui2::DataSelectionModel::selectedItems(), TEST_F(), and UniqueItemsFromIndex().

Here is the call graph for this function:

UniqueItemsFromIndex()

std::vector< SessionItem * > ModelView::Utils::UniqueItemsFromIndex

(

const QModelIndexList &

index_list

)

Returns vector of underlying SessionItem's for given index list. Removes repetitions.

Definition at line 111 of file viewmodelutils.cpp.

{
    return Utils::UniqueItems(Utils::ItemsFromIndex(index_list));
}

References ItemsFromIndex(), and UniqueItems().

Referenced by gui2::DataViewModel::mimeData(), and TEST_F().

Here is the call graph for this function:

UniqueWithOrder()

template<typename C >

C ModelView::Utils::UniqueWithOrder

(

const C &

container

)

Returns copy of container with all duplicated elements filtered our. The order is preserved.

Definition at line 88 of file containerutils.h.

{
    C result;
 
    using valueType = typename C::value_type;
    std::unordered_set<valueType> unique;
 
    std::copy_if(container.begin(), container.end(), std::back_inserter(result),
                 [&unique](auto x) { return unique.insert(x).second; });
 
    return result;
}

Referenced by TEST_F(), and UniqueItems().

VariantName()

std::string ModelView::Utils::VariantName

(

const Variant &

variant

)

Returns name of variant.

Definition at line 26 of file customvariants.cpp.

{
    return variant.isValid() ? variant.typeName() : Constants::invalid_type_name;
}

References ModelView::Constants::invalid_type_name.

Referenced by ModelView::VariantDependentEditorFactory::createEditor(), ModelView::JsonVariantConverter::get_json(), and TEST_F().

VariantType()

int ModelView::Utils::VariantType

(

const Variant &

variant

)

Returns type of variant (additionally checks for user type).

Definition at line 31 of file customvariants.cpp.

{
    auto result = static_cast<int>(variant.type());
    if (result == Variant::UserType)
        result = variant.userType();
    return result;
}

Referenced by CompatibleVariantTypes(), and TEST_F().

WidthOfLetterM()

int ModelView::Utils::WidthOfLetterM

(

)

Returns width of the letter 'M' deduced from current font metrics.

Definition at line 106 of file widgetutils.cpp.

{
    return ModelView::Utils::SizeOfLetterM().width();
}

References SizeOfLetterM().

Referenced by gui2::SettingsView::SettingsView(), gui2::ParserPropertyWidget::addCustomSeparatorRow(), gui2::OpenProjectWidget::createLinkedLabelLayout(), gui2::SettingsView::init_list_selector(), and ModelView::StatusLabel::paintEvent().

Here is the call graph for this function:

WithTildeHomePath()

QString ModelView::Utils::WithTildeHomePath

(

const QString &

path

)

Returns a string where Linux path to the file is striped using '~/'.

Definition at line 79 of file widgetutils.cpp.

{
    if (ModelView::Utils::IsWindowsHost())
        return path;
 
    static const QString homePath = QDir::homePath();
 
    QFileInfo fi(QDir::cleanPath(path));
    QString outPath = fi.absoluteFilePath();
    if (outPath.startsWith(homePath))
        outPath = QLatin1Char('~') + outPath.mid(homePath.size());
    else
        outPath = path;
    return outPath;
}

References IsWindowsHost().

Referenced by gui2::ActionManager::aboutToShowFileMenu(), gui2::ProjectPaneWidget::setCurrentProject(), and TEST_F().

Here is the call graph for this function: