mo2/modorganizer-preview_base
0
0
Fork 0
mirror of https://github.com/ModOrganizer2/modorganizer-preview_base.git synced 2026-07-27 14:01:41 -07:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #11 from ModOrganizer2/dev/modernize_repo

Browse Source 
Formatting + CI
This commit is contained in:
Mikaël Capelle
2024-07-11 11:48:54 +02:00
committed by GitHub
parent f47d910bd2 ed9f6d9b63
commit 23c4ce331a
8 changed files with 333 additions and 280 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.clang-format
+41
View File
@@ -0,0 +1,41 @@
---
# We'll use defaults from the LLVM style, but with 4 columns indentation.
BasedOnStyle: LLVM
IndentWidth: 2
---
Language: Cpp
DeriveLineEnding: false
UseCRLF: true
DerivePointerAlignment: false
PointerAlignment: Left
AlignConsecutiveAssignments: true
AllowShortFunctionsOnASingleLine: Inline
AllowShortIfStatementsOnASingleLine: Never
AllowShortLambdasOnASingleLine: Empty
AlwaysBreakTemplateDeclarations: Yes
AccessModifierOffset: -2
AlignTrailingComments: true
SpacesBeforeTrailingComments: 2
NamespaceIndentation: Inner
MaxEmptyLinesToKeep: 1
BreakBeforeBraces: Custom
BraceWrapping:
AfterCaseLabel: false
AfterClass: true
AfterControlStatement: false
AfterEnum: true
AfterFunction: true
AfterNamespace: true
AfterStruct: true
AfterUnion: true
AfterExternBlock: true
BeforeCatch: false
BeforeElse: false
BeforeLambdaBody: false
BeforeWhile: false
IndentBraces: false
SplitEmptyFunction: false
SplitEmptyRecord: false
SplitEmptyNamespace: true
ColumnLimit: 88
ForEachMacros: ['Q_FOREACH', 'foreach']
.git-blame-ignore-revs
+1
View File
@@ -0,0 +1 @@
01daa7e9c9f396f83451703fc6cdc046a4e87b16
.gitattributes
+7
View File
@@ -0,0 +1,7 @@
# Set the default behavior, in case people don't have core.autocrlf set.
* text=auto
# Explicitly declare text files you want to always be normalized and converted
# to native line endings on checkout.
*.cpp text eol=crlf
*.h text eol=crlf
.github/workflows/build.yml
+16
View File
@@ -0,0 +1,16 @@
name: Build Preview Base Plugin
on:
push:
branches: master
pull_request:
types: [opened, synchronize, reopened]
jobs:
build:
runs-on: windows-2022
steps:
- name: Build Preview Base Plugin
uses: ModOrganizer2/build-with-mob-action@master
with:
mo2-dependencies: cmake_common uibase
.github/workflows/linting.yml
+16
View File
@@ -0,0 +1,16 @@
name: Lint Preview Base Plugin
on:
push:
pull_request:
types: [opened, synchronize, reopened]
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Check format
uses: ModOrganizer2/check-formatting-action@master
with:
check-path: "."
appveyor.yml
-42
View File
@@ -1,42 +0,0 @@
version: 1.0.{build}
skip_branch_with_pr: true
image: Visual Studio 2019
environment:
WEBHOOK_URL:
secure: gOKbXaZM9ImtMD5XrYITvdyZUW/az082G9OIN1EC1Vbg57wBaeLhi49uGjxPw5GVujHku6kxN6ab89zhbS5GVeluR76GM83IbKV4Sh7udXzoYZZdg6YudtYHzdhCgUeiedpswbuczTq9ceIkkfSEWZuh/lMAAVVwvcGsJAnoPFw=
build:
parallel: true
build_script:
- pwsh: >-
$ErrorActionPreference = 'Stop'
git clone --depth=1 --no-single-branch https://github.com/ModOrganizer2/modorganizer-umbrella.git c:\projects\modorganizer-umbrella
New-Item -ItemType Directory -Path c:\projects\modorganizer-build
cd c:\projects\modorganizer-umbrella
($env:APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCH -eq $null) ? ($branch = $env:APPVEYOR_REPO_BRANCH) : ($branch = $env:APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCH)
git checkout $(git show-ref --verify --quiet refs/remotes/origin/${branch} || echo '-b') ${branch}
C:\Python37-x64\python.exe unimake.py -d c:\projects\modorganizer-build -s Appveyor_Build=True ${env:APPVEYOR_PROJECT_NAME}
if($LastExitCode -ne 0) { $host.SetShouldExit($LastExitCode ) }
artifacts:
- path: vsbuild\src\RelWithDebInfo\preview_base.dll
name: preview_base_dll
- path: vsbuild\src\RelWithDebInfo\preview_base.pdb
name: preview_base_pdb
- path: vsbuild\src\RelWithDebInfo\preview_base.lib
name: preview_base_lib
on_success:
- ps: Set-Location -Path $env:APPVEYOR_BUILD_FOLDER
- ps: Invoke-RestMethod https://raw.githubusercontent.com/DiscordHooks/appveyor-discord-webhook/master/send.ps1 -o send.ps1
- ps: ./send.ps1 success $env:WEBHOOK_URL
on_failure:
- ps: Set-Location -Path $env:APPVEYOR_BUILD_FOLDER
- ps: Push-AppveyorArtifact ${env:APPVEYOR_BUILD_FOLDER}\stdout.log
- ps: Push-AppveyorArtifact ${env:APPVEYOR_BUILD_FOLDER}\stderr.log
- ps: Invoke-RestMethod https://raw.githubusercontent.com/DiscordHooks/appveyor-discord-webhook/master/send.ps1 -o send.ps1
- ps: ./send.ps1 failure $env:WEBHOOK_URL
src/previewbase.cpp
+183 -172
View File
@@ -1,172 +1,183 @@
/*
Copyright (C) 2014 Sebastian Herbord. All rights reserved.
This file is part of Base Preview plugin for MO
Base Preview plugin is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Base Preview plugin is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Base Preview plugin. If not, see <http://www.gnu.org/licenses/>.
*/
#include "previewbase.h"
#include <utility.h>
#include <QImageReader>
#include <QFileInfo>
#include <QLabel>
#include <QTextEdit>
#include <QtPlugin>
#include <QApplication>
#include <QScreen>
using namespace MOBase;
PreviewBase::PreviewBase()
: m_MOInfo(nullptr)
{
}
bool PreviewBase::init(IOrganizer *moInfo)
{
m_MOInfo = moInfo;
const QStringList& blacklist = m_MOInfo->pluginSetting(name(), "blacklisted_extensions").toString().toLower().split(',');
// set up image reader to be used for all image types qt (the current installation) supports
auto imageReader = std::bind(&PreviewBase::genImagePreview, this, std::placeholders::_1, std::placeholders::_2, std::placeholders::_3);
foreach(const QByteArray & fileType, QImageReader::supportedImageFormats()) {
auto strFileType = QString(fileType).toLower();
// skip dds as that one is handled by the dds preview plugin.
if (strFileType == "dds" || blacklist.contains(strFileType))
continue;
m_PreviewGenerators[strFileType] = imageReader;
}
const QStringList supportedTextFormats = { "txt", "ini", "json", "log", "cfg", "psc" };
auto textReader = std::bind(&PreviewBase::genTxtPreview, this, std::placeholders::_1, std::placeholders::_2, std::placeholders::_3);
foreach(const QString fileType, supportedTextFormats) {
// skip blacklisted ones
if (blacklist.contains(fileType))
continue;
m_PreviewGenerators[fileType] = textReader;
}
return true;
}
QString PreviewBase::name() const
{
return "Preview Base";
}
QString PreviewBase::localizedName() const
{
return tr("Preview Base");
}
QString PreviewBase::author() const
{
return "Tannin";
}
QString PreviewBase::description() const
{
return tr("Supports previewing various types of data files");
}
MOBase::VersionInfo PreviewBase::version() const
{
return VersionInfo(1, 1, 0, VersionInfo::RELEASE_FINAL);
}
QList<MOBase::PluginSetting> PreviewBase::settings() const
{
QList<PluginSetting> result;
result.push_back(PluginSetting("enabled", tr("Enable previewing of basic file types, such as images and text files."), QVariant(true)));
result.push_back(PluginSetting("blacklisted_extensions", tr("Specify a list of comma separated extensions (without \".\") "
"that should not be previewed by this plugin."), QVariant("")));
return result;
}
std::set<QString> PreviewBase::supportedExtensions() const
{
std::set<QString> extensions;
for (const auto &generator : m_PreviewGenerators) {
extensions.insert(generator.first);
}
return extensions;
}
QWidget* PreviewBase::genFilePreview(const QString &fileName, const QSize &maxSize) const
{
return genDataPreview(nullptr, fileName, maxSize);
}
QWidget* PreviewBase::genDataPreview(const QByteArray& fileData, const QString& fileName,
const QSize& maxSize) const
{
auto iter = m_PreviewGenerators.find(QFileInfo(fileName).suffix().toLower());
if (iter != m_PreviewGenerators.end()) {
return iter->second(fileName, maxSize, fileData);
} else {
return nullptr;
}
}
QWidget *PreviewBase::genImagePreview(const QString &fileName, const QSize&, const QByteArray& fileData) const
{
QLabel *label = new QLabel();
QPixmap pic;
if (fileData == nullptr) {
pic = QPixmap(fileName);
} else {
pic.loadFromData(fileData);
}
QSize screenSize = QApplication::primaryScreen()->geometry().size();
// ensure the output image is no more than 80% of the screen height.
// If the aspect ratio is higher than that of the screen this would still allow the image to extend
// beyond the screen but it ensures you can drag the window and close it
int maxHeight = static_cast<int>(screenSize.height() * 0.8f);
if (pic.size().height() > maxHeight) {
pic = pic.scaledToHeight(maxHeight, Qt::SmoothTransformation);
}
label->setPixmap(pic);
return label;
}
QWidget *PreviewBase::genTxtPreview(const QString &fileName, const QSize&, const QByteArray& fileData) const
{
QTextEdit *edit = new QTextEdit();
if (fileData == nullptr) {
edit->setText(MOBase::readFileText(fileName));
} else {
edit->setText(MOBase::decodeTextData(fileData));
}
edit->setReadOnly(true);
return edit;
}
#if QT_VERSION < QT_VERSION_CHECK(5,0,0)
Q_EXPORT_PLUGIN2(previewBase, PreviewBase)
#endif
/*
Copyright (C) 2014 Sebastian Herbord. All rights reserved.
This file is part of Base Preview plugin for MO
Base Preview plugin is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Base Preview plugin is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Base Preview plugin. If not, see <http://www.gnu.org/licenses/>.
*/
#include "previewbase.h"
#include <QApplication>
#include <QFileInfo>
#include <QImageReader>
#include <QLabel>
#include <QScreen>
#include <QTextEdit>
#include <QtPlugin>
#include <utility.h>
using namespace MOBase;
PreviewBase::PreviewBase() : m_MOInfo(nullptr) {}
bool PreviewBase::init(IOrganizer* moInfo)
{
m_MOInfo = moInfo;
const QStringList& blacklist =
m_MOInfo->pluginSetting(name(), "blacklisted_extensions")
.toString()
.toLower()
.split(',');
// set up image reader to be used for all image types qt (the current installation)
// supports
auto imageReader =
std::bind(&PreviewBase::genImagePreview, this, std::placeholders::_1,
std::placeholders::_2, std::placeholders::_3);
foreach (const QByteArray& fileType, QImageReader::supportedImageFormats()) {
auto strFileType = QString(fileType).toLower();
// skip dds as that one is handled by the dds preview plugin.
if (strFileType == "dds" || blacklist.contains(strFileType))
continue;
m_PreviewGenerators[strFileType] = imageReader;
}
const QStringList supportedTextFormats = {"txt", "ini", "json", "log", "cfg", "psc"};
auto textReader = std::bind(&PreviewBase::genTxtPreview, this, std::placeholders::_1,
std::placeholders::_2, std::placeholders::_3);
foreach (const QString fileType, supportedTextFormats) {
// skip blacklisted ones
if (blacklist.contains(fileType))
continue;
m_PreviewGenerators[fileType] = textReader;
}
return true;
}
QString PreviewBase::name() const
{
return "Preview Base";
}
QString PreviewBase::localizedName() const
{
return tr("Preview Base");
}
QString PreviewBase::author() const
{
return "Tannin";
}
QString PreviewBase::description() const
{
return tr("Supports previewing various types of data files");
}
MOBase::VersionInfo PreviewBase::version() const
{
return VersionInfo(1, 1, 0, VersionInfo::RELEASE_FINAL);
}
QList<MOBase::PluginSetting> PreviewBase::settings() const
{
QList<PluginSetting> result;
result.push_back(PluginSetting(
"enabled",
tr("Enable previewing of basic file types, such as images and text files."),
QVariant(true)));
result.push_back(
PluginSetting("blacklisted_extensions",
tr("Specify a list of comma separated extensions (without \".\") "
"that should not be previewed by this plugin."),
QVariant("")));
return result;
}
std::set<QString> PreviewBase::supportedExtensions() const
{
std::set<QString> extensions;
for (const auto& generator : m_PreviewGenerators) {
extensions.insert(generator.first);
}
return extensions;
}
QWidget* PreviewBase::genFilePreview(const QString& fileName,
const QSize& maxSize) const
{
return genDataPreview(nullptr, fileName, maxSize);
}
QWidget* PreviewBase::genDataPreview(const QByteArray& fileData,
const QString& fileName,
const QSize& maxSize) const
{
auto iter = m_PreviewGenerators.find(QFileInfo(fileName).suffix().toLower());
if (iter != m_PreviewGenerators.end()) {
return iter->second(fileName, maxSize, fileData);
} else {
return nullptr;
}
}
QWidget* PreviewBase::genImagePreview(const QString& fileName, const QSize&,
const QByteArray& fileData) const
{
QLabel* label = new QLabel();
QPixmap pic;
if (fileData == nullptr) {
pic = QPixmap(fileName);
} else {
pic.loadFromData(fileData);
}
QSize screenSize = QApplication::primaryScreen()->geometry().size();
// ensure the output image is no more than 80% of the screen height.
// If the aspect ratio is higher than that of the screen this would still allow the
// image to extend beyond the screen but it ensures you can drag the window and close
// it
int maxHeight = static_cast<int>(screenSize.height() * 0.8f);
if (pic.size().height() > maxHeight) {
pic = pic.scaledToHeight(maxHeight, Qt::SmoothTransformation);
}
label->setPixmap(pic);
return label;
}
QWidget* PreviewBase::genTxtPreview(const QString& fileName, const QSize&,
const QByteArray& fileData) const
{
QTextEdit* edit = new QTextEdit();
if (fileData == nullptr) {
edit->setText(MOBase::readFileText(fileName));
} else {
edit->setText(MOBase::decodeTextData(fileData));
}
edit->setReadOnly(true);
return edit;
}
#if QT_VERSION < QT_VERSION_CHECK(5, 0, 0)
Q_EXPORT_PLUGIN2(previewBase, PreviewBase)
#endif
src/previewbase.h
+69 -66
View File
@@ -1,66 +1,69 @@
/*
Copyright (C) 2014 Sebastian Herbord. All rights reserved.
This file is part of Base Preview plugin for MO
Base Preview plugin is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Base Preview plugin is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Base Preview plugin. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef PREVIEWBASE_H
#define PREVIEWBASE_H
#include <ipluginpreview.h>
#include <functional>
class PreviewBase : public MOBase::IPluginPreview
{
Q_OBJECT
Q_INTERFACES(MOBase::IPlugin MOBase::IPluginPreview)
#if QT_VERSION >= QT_VERSION_CHECK(5,0,0)
Q_PLUGIN_METADATA(IID "org.tannin.PreviewBase" FILE "previewbase.json")
#endif
public:
PreviewBase();
public:
virtual bool init(MOBase::IOrganizer *moInfo) override;
virtual QString name() const override;
virtual QString localizedName() const override;
virtual QString author() const override;
virtual QString description() const override;
virtual MOBase::VersionInfo version() const override;
virtual QList<MOBase::PluginSetting> settings() const override;
public:
virtual std::set<QString> supportedExtensions() const;
virtual bool supportsArchives() const override { return true; }
virtual QWidget* genFilePreview(const QString &fileName, const QSize &maxSize) const;
virtual QWidget* genDataPreview(const QByteArray& fileData, const QString& fileName,
const QSize& maxSize) const override;
private:
QWidget *genImagePreview(const QString &fileName, const QSize &maxSize, const QByteArray& fileData) const;
QWidget* genTxtPreview(const QString& fileName, const QSize& maxSize, const QByteArray& fileData) const;
private:
std::map<QString, std::function<QWidget*(const QString&, const QSize&, const QByteArray&)> > m_PreviewGenerators;
private:
const MOBase::IOrganizer* m_MOInfo;
};
#endif // PREVIEWBASE_H
/*
Copyright (C) 2014 Sebastian Herbord. All rights reserved.
This file is part of Base Preview plugin for MO
Base Preview plugin is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Base Preview plugin is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Base Preview plugin. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef PREVIEWBASE_H
#define PREVIEWBASE_H
#include <functional>
#include <ipluginpreview.h>
class PreviewBase : public MOBase::IPluginPreview
{
Q_OBJECT
Q_INTERFACES(MOBase::IPlugin MOBase::IPluginPreview)
#if QT_VERSION >= QT_VERSION_CHECK(5, 0, 0)
Q_PLUGIN_METADATA(IID "org.tannin.PreviewBase" FILE "previewbase.json")
#endif
public:
PreviewBase();
public:
virtual bool init(MOBase::IOrganizer* moInfo) override;
virtual QString name() const override;
virtual QString localizedName() const override;
virtual QString author() const override;
virtual QString description() const override;
virtual MOBase::VersionInfo version() const override;
virtual QList<MOBase::PluginSetting> settings() const override;
public:
virtual std::set<QString> supportedExtensions() const;
virtual bool supportsArchives() const override { return true; }
virtual QWidget* genFilePreview(const QString& fileName, const QSize& maxSize) const;
virtual QWidget* genDataPreview(const QByteArray& fileData, const QString& fileName,
const QSize& maxSize) const override;
private:
QWidget* genImagePreview(const QString& fileName, const QSize& maxSize,
const QByteArray& fileData) const;
QWidget* genTxtPreview(const QString& fileName, const QSize& maxSize,
const QByteArray& fileData) const;
private:
std::map<QString,
std::function<QWidget*(const QString&, const QSize&, const QByteArray&)>>
m_PreviewGenerators;
private:
const MOBase::IOrganizer* m_MOInfo;
};
#endif // PREVIEWBASE_H