commit 96e258b0600c8683d63a6a7bbbfd8676f18c25c3 Author: Martchus Date: Wed Sep 8 19:53:14 2021 +0200 Initial import diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3991c1d --- /dev/null +++ b/.gitignore @@ -0,0 +1,44 @@ +# C++ objects and libs + +*.slo +*.lo +*.o +*.a +*.la +*.lai +*.so +*.dll +*.dylib + +# Qt-es + +/.qmake.cache +/.qmake.stash +*.pro.user +*.txt.user +*.pro.user.* +*.qbs.user +*.qbs.user.* +*.moc +moc_*.cpp +qrc_*.cpp +ui_*.h +Makefile* +*-build-* + +# QtCreator + +*.autosave + +#QtCtreator Qml +*.qmlproject.user +*.qmlproject.user.* + +# Dolphin +.directory + +# documentation +/doc + +# clang-format +/.clang-format diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..245f2c2 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,117 @@ +cmake_minimum_required(VERSION 3.3.0 FATAL_ERROR) + +# meta data +set(META_PROJECT_NAME qtforkawesome) +set(META_PROJECT_VARNAME QT_FORK_AWESOME) +set(META_APP_NAME "Qt ForkAwesome") +set(META_APP_AUTHOR "Martchus") +set(META_APP_URL "https://github.com/${META_APP_AUTHOR}/${META_PROJECT_NAME}") +set(META_APP_DESCRIPTION "Library that bundles ForkAwesome for use within Qt applications") +set(META_VERSION_MAJOR 0) +set(META_VERSION_MINOR 0) +set(META_VERSION_PATCH 1) +set(META_APP_VERSION ${META_VERSION_MAJOR}.${META_VERSION_MINOR}.${META_VERSION_PATCH}) +set(META_PUBLIC_QT_MODULES Core Gui) +set(META_ADD_DEFAULT_CPP_UNIT_TEST_APPLICATION OFF) + +project(${META_PROJECT_NAME}) + +# add project files +set(HEADER_FILES qtforkawesome.h) +set(SRC_FILES qtforkawesome.cpp) +set(QT_TESTS rendering) +set(DOC_FILES README.md) + +# find/download ForkAwesome's font file and icon definitions +set(FORK_AWESOME_VERSION + "1.2.0" + CACHE STRING "specifies the version of ForkAwesome") +set(FORK_AWESOME_REPO_URL "https://raw.githubusercontent.com/ForkAwesome/Fork-Awesome/${FORK_AWESOME_VERSION}") +set(FORK_AWESOME_FONT_FILE + "${FORK_AWESOME_REPO_URL}/fonts/forkawesome-webfont.woff2" + CACHE STRING "specifies the location of ForkAwesome's font file") +set(FORK_AWESOME_ICON_DEFINITIONS + "${FORK_AWESOME_REPO_URL}/src/icons/icons.yml" + CACHE STRING "specifies the location of ForkAwesome's icon definitions file") +set(DOWNLOAD_DIR "${CMAKE_CURRENT_BINARY_DIR}/download") +file(MAKE_DIRECTORY "${DOWNLOAD_DIR}") +function (checkout_file VARIABLE) + if ("${${VARIABLE}}" MATCHES "http(s)?:.+") + get_filename_component(FILE_NAME "${${VARIABLE}}" NAME) + if (NOT EXISTS "${DOWNLOAD_DIR}/${FILE_NAME}") + message(STATUS "Downloading ${${VARIABLE}}") + file(DOWNLOAD "${${VARIABLE}}" "${DOWNLOAD_DIR}/${FILE_NAME}" SHOW_PROGRESS) + endif () + set("${VARIABLE}" + "${DOWNLOAD_DIR}/${FILE_NAME}" + PARENT_SCOPE) + elseif (NOT EXISTS "${${VARIABLE}}") + message(FATAL_ERROR "${VARIABLE} is set to \"${${VARIABLE}}\" which does not exist.") + endif () +endfunction () +checkout_file(FORK_AWESOME_FONT_FILE) +checkout_file(FORK_AWESOME_ICON_DEFINITIONS) + +# configure font file +get_filename_component(META_FONT_FILE_NAME "${FORK_AWESOME_FONT_FILE}" NAME) +set(META_CUSTOM_CONFIG + "#define META_FONT_FILE_NAME \"${META_FONT_FILE_NAME}\"\n#define META_FORK_AWESOME_VERSION \"${FORK_AWESOME_VERSION}\"\n" +) +set(RES_FILE_PATH "${CMAKE_CURRENT_BINARY_DIR}/font.qrc") +set(RES_FILE_DATA "${META_FONT_FILE_NAME}") +file(CREATE_LINK "${FORK_AWESOME_FONT_FILE}" "${CMAKE_CURRENT_BINARY_DIR}/${META_FONT_FILE_NAME}") +file(WRITE "${RES_FILE_PATH}" "${RES_FILE_DATA}") +list(APPEND RES_FILES "${RES_FILE_PATH}") + +# create rule for generating header file +find_program(PERL perl) +set(GENERATED_HEADERS_PATH "${CMAKE_CURRENT_BINARY_DIR}/headers") +set(ICONS_HEADER_FILE "${GENERATED_HEADERS_PATH}/icons.h") +list(APPEND SRC_FILES "${ICONS_HEADER_FILE}") +file(MAKE_DIRECTORY "${GENERATED_HEADERS_PATH}") +add_custom_command( + OUTPUT "${ICONS_HEADER_FILE}" + COMMAND "${PERL}" "${CMAKE_CURRENT_SOURCE_DIR}/scripts/yaml2enum.pl" "${FORK_AWESOME_ICON_DEFINITIONS}" + "${ICONS_HEADER_FILE}" + DEPENDS "${FORK_AWESOME_ICON_DEFINITIONS}" + COMMENT "Icon header") + +# find c++utilities and qtutilities +set(CONFIGURATION_PACKAGE_SUFFIX + "" + CACHE STRING "sets the suffix for c++utilities") +set(CONFIGURATION_PACKAGE_SUFFIX_QTUTILITIES + "${CONFIGURATION_PACKAGE_SUFFIX}" + CACHE STRING "sets the suffix for qtutilities") +find_package(c++utilities${CONFIGURATION_PACKAGE_SUFFIX} 5.5.0 REQUIRED) +find_package(qtutilities${CONFIGURATION_PACKAGE_SUFFIX_QTUTILITIES} 6.3.0 REQUIRED) +use_cpp_utilities(ONLY_HEADERS VISIBILITY PUBLIC) +use_qt_utilities(ONLY_HEADERS VISIBILITY PRIVATE) + +# use Qt Gui module +list(APPEND ADDITIONAL_QT_MODULES Gui) + +# include modules to apply configuration +include(BasicConfig) +include(QtConfig) +include(WindowsResources) +include(LibraryTarget) +include(Doxygen) +include(ConfigHeader) + +# configure test target +include(TestUtilities) +set(QT_TEST_LIBRARIES ${CPP_UTILITIES_LIB} ${META_TARGET_NAME}) +use_qt_module(LIBRARIES_VARIABLE "QT_TEST_LIBRARIES" PREFIX "${QT_PACKAGE_PREFIX}" MODULE "Test") +foreach (TEST ${QT_TESTS}) + configure_test_target(TEST_NAME "${TEST}_tests" SRC_FILES "tests/${TEST}.cpp" LIBRARIES "${QT_TEST_LIBRARIES}") +endforeach () + +# ensure generated header can be found during build +target_include_directories(${META_TARGET_NAME} PUBLIC $) + +# install generated header +install( + FILES "${ICONS_HEADER_FILE}" + DESTINATION "${INCLUDE_SUBDIR}/${META_PROJECT_NAME}" + COMPONENT header) diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8cdb845 --- /dev/null +++ b/LICENSE @@ -0,0 +1,340 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + {description} + Copyright (C) {year} {fullname} + + This program 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 2 of the License, or + (at your option) any later version. + + This program 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 this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + {signature of Ty Coon}, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. + diff --git a/README.md b/README.md new file mode 100644 index 0000000..c3702af --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# qtforkawesome +Library that bundles ForkAwesome for use within Qt applications + +## Build instructions +The library depends on the following Qt modules (version 5.6 or higher): +`core`, `gui` + +At build time `qtutilities` and `c++utilities` are required. This library is +built in the same way as these libraries so checkout the `c++utilities` +repository for detailed instructions. + +To generate the header with icon definitions, Perl and the module `YAML::XS` (or +`YAML`) are required. + +Of course the font file and icon definitions for ForkAwesome also need to be +supplied as well. +Just download it from https://github.com/ForkAwesome/Fork-Awesome/releases +and specify its path via the CMake variables `FORK_AWESOME_FONT_FILE` +and `FORK_AWESOME_ICON_DEFINITIONS`, e.g. add +`-DFORK_AWESOME_FONT_FILE=/path/to/Fork-Awesome-1.2.0/fonts/forkawesome-webfont.woff2` +and +`-DFORK_AWESOME_ICON_DEFINITIONS=/path/to/Fork-Awesome-1.2.0/src/icons/icons.yml` +to the CMake invocation. The font file will be built into the library and +is hence only required at build time. If none of the variables are specified, +the build system will attempt to download the files from GitHub. + +Note that Web Open Font Format 2 support might require FreeType2 to be +configured with Brotli support. + +## Usage +The installation provides a CMake find module and a pkg-config file. Once +configured, the library is fairly simple to use: + +``` +#include + +auto renderer = QtForkAwesome::Renderer(); +renderer.pixmap(QtForkAwesome::Icon::Globe, QSize(64, 64), Qt::black); +``` + +There's also `renderer.render(…)` which takes a `QPainter` directly. diff --git a/global.h b/global.h new file mode 100644 index 0000000..8ac60ce --- /dev/null +++ b/global.h @@ -0,0 +1,27 @@ +// Created via CMake from template global.h.in +// WARNING! Any changes to this file will be overwritten by the next CMake run! + +#ifndef QT_FORK_AWESOME_GLOBAL +#define QT_FORK_AWESOME_GLOBAL + +#include + +#ifdef QT_FORK_AWESOME_STATIC +#define QT_FORK_AWESOME_EXPORT +#define QT_FORK_AWESOME_IMPORT +#else +#define QT_FORK_AWESOME_EXPORT CPP_UTILITIES_GENERIC_LIB_EXPORT +#define QT_FORK_AWESOME_IMPORT CPP_UTILITIES_GENERIC_LIB_IMPORT +#endif + +/*! + * \def QT_FORK_AWESOME_EXPORT + * \brief Marks the symbol to be exported by the qtforkawesome library. + */ + +/*! + * \def QT_FORK_AWESOME_IMPORT + * \brief Marks the symbol to be imported from the qtforkawesome library. + */ + +#endif // QT_FORK_AWESOME_GLOBAL diff --git a/qtforkawesome.cpp b/qtforkawesome.cpp new file mode 100644 index 0000000..d7ddad5 --- /dev/null +++ b/qtforkawesome.cpp @@ -0,0 +1,108 @@ +#include "./qtforkawesome.h" + +#include "resources/config.h" + +#include +#include +#include + +/// \brief Contains classes provided by the QtForkAwesome library. +namespace QtForkAwesome { + +/// \cond + +struct Renderer::InternalData { + explicit InternalData(int id); + static constexpr int invalidId = -1; + + int id; + QStringList fontFamilies; +}; + +Renderer::InternalData::InternalData(int id) + : id(id) + , fontFamilies(id != invalidId ? QFontDatabase::applicationFontFamilies(id) : QStringList()) +{ +} + +/// \endcond + +/*! + * + * \class QtForkAwesome::Renderer + * \brief Allows rendering a QtForkAwesome::Icon. + */ + +/*! + * \brief Constructs a new renderer with the given \a fontFileName. + * \remarks If \a fontFileName is empty, the bundled font file will be used. + */ +Renderer::Renderer(const QString &fontFileName) + : m_d(std::make_unique( + QFontDatabase::addApplicationFont(fontFileName.isEmpty() ? QStringLiteral(":/" META_FONT_FILE_NAME) : fontFileName))) +{ +} + +/*! + * \brief Constructs a new renderer with the given \a fontData. + */ +Renderer::Renderer(const QByteArray &fontData) + : m_d(std::make_unique(QFontDatabase::addApplicationFont(fontData))) +{ +} + +/*! + * \brief Destructs the renderer. + */ +Renderer::~Renderer() +{ + if (m_d->id != InternalData::invalidId) { + QFontDatabase::removeApplicationFont(m_d->id); + } +} + +/*! + * \brief Returns whether the render could be initialized correctly. + */ +Renderer::operator bool() const +{ + return !m_d->fontFamilies.empty(); +} + +/*! + * \brief Renders the specified \a icon using the specified \a painter. + */ +void Renderer::render(Icon icon, QPainter *painter, const QRect &rect, const QColor &color) +{ + if (!*this) { + return; + } + auto font = QFont(m_d->fontFamilies.front()); + font.setPixelSize(rect.height()); + painter->save(); + painter->setFont(font); + painter->setPen(color); + painter->drawText(rect, QString(QChar(static_cast(icon))), QTextOption(Qt::AlignCenter)); + painter->restore(); +} + +/*! + * \brief Renders the specified \a icon as pixmap of the specified \a size. + */ +QPixmap QtForkAwesome::Renderer::pixmap(Icon icon, const QSize &size, const QColor &color) +{ + const auto scaleFactor = +#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0)) + !QCoreApplication::testAttribute(Qt::AA_UseHighDpiPixmaps) ? 1.0 : +#endif + qGuiApp->devicePixelRatio(); + const auto scaledSize = QSize(size * scaleFactor); + auto pm = QPixmap(scaledSize); + pm.fill(QColor(Qt::transparent)); + auto painter = QPainter(&pm); + render(icon, &painter, QRect(QPoint(), scaledSize), color); + pm.setDevicePixelRatio(scaleFactor); + return pm; +} + +} // namespace QtForkAwesome diff --git a/qtforkawesome.h b/qtforkawesome.h new file mode 100644 index 0000000..4498551 --- /dev/null +++ b/qtforkawesome.h @@ -0,0 +1,43 @@ +#ifndef QT_FORK_AWESOME_MAIN +#define QT_FORK_AWESOME_MAIN + +#include "./global.h" + +#include + +#include + +QT_FORWARD_DECLARE_CLASS(QByteArray) +QT_FORWARD_DECLARE_CLASS(QColor) +QT_FORWARD_DECLARE_CLASS(QPainter) +QT_FORWARD_DECLARE_CLASS(QRect) +QT_FORWARD_DECLARE_CLASS(QSize) +QT_FORWARD_DECLARE_CLASS(QPixmap) + +namespace QtForkAwesome { + +using IconBaseType = std::remove_reference_t; + +enum class Icon : IconBaseType { +#include "icons.h" +}; + +class QT_FORK_AWESOME_EXPORT Renderer { + struct InternalData; + +public: + explicit Renderer(const QString &fontFileName = QString()); + explicit Renderer(const QByteArray &fontData); + ~Renderer(); + + operator bool() const; + void render(Icon icon, QPainter *painter, const QRect &rect, const QColor &color); + QPixmap pixmap(Icon icon, const QSize &size, const QColor &color); + +private: + std::unique_ptr m_d; +}; + +} // namespace QtForkAwesome + +#endif // QT_FORK_AWESOME_MAIN diff --git a/scripts/yaml2enum.pl b/scripts/yaml2enum.pl new file mode 100755 index 0000000..3b93d8f --- /dev/null +++ b/scripts/yaml2enum.pl @@ -0,0 +1,48 @@ +#!/usr/bin/perl +use strict; +use warnings; +use utf8; +use feature 'signatures'; +no warnings 'experimental::signatures'; + +# use either YAML::XS or YAML +my $parse_yaml + = eval { require YAML::XS; \&YAML::XS::Load } + // eval { require YAML; \&YAML::Load }; +die "Unable to locate YAML::XS or YAML: $@" if $@; + +# read CLI args +my $yaml_file = $ARGV[0] // ''; +my $output_file = $ARGV[1] // ''; +die "The specified file \"$yaml_file\" does not exist.\n" unless -f $yaml_file; +die "No output file specified.\n" unless $output_file; +print "$yaml_file -> $output_file\n"; + +# read input file manually (instead of using LoadFile) to fix screwed indentation +open my $yaml_fh, '<', $yaml_file or die "Can't open \"$yaml_file\": $!"; +read $yaml_fh, my $yaml, -s $yaml_fh; +$yaml =~ s/ - name:/ - name:/g; + +# parse YAML +my $icon_defs = $parse_yaml->($yaml); +my $icons = ref $icon_defs eq 'HASH' ? $icon_defs->{icons} : []; +die "No icons present in \"$yaml_file\".\n" unless ref $icons eq 'ARRAY' && @$icons; +open my $output, '>:encoding(UTF-8)', $output_file or die "Can't open output file \"$output_file\": $!\n"; + +# define function to camelize IDs +sub camelize ($s) { $s =~ s/(-)?([\w']+)/\u\L$2/g; $s } + +# generate enum values +for my $icon (@$icons) { + my $id = $icon->{id}; + my $name = $icon->{name}; + my $unicode = $icon->{unicode}; + my $created = $icon->{created} // '?'; + my $categories = ref $icon->{categories} eq 'ARRAY' ? $icon->{categories} : []; + die "Icon definition in \"$yaml_file\" is incomplete.\n" unless $id && $name && $unicode; + + my $category = join ',', @$categories; + my $camelized_id = camelize $id; + $camelized_id = "Icon$camelized_id" if $camelized_id =~ qr/^\d+.*/; + print $output "$camelized_id = 0x$unicode, /**< $id: name: $name, created: $created, category: $category */\n"; +} diff --git a/tests/rendering.cpp b/tests/rendering.cpp new file mode 100644 index 0000000..a3a24f1 --- /dev/null +++ b/tests/rendering.cpp @@ -0,0 +1,37 @@ +#include "../qtforkawesome.h" + +#include + +#include +#include +#include + +using namespace CppUtilities; + +class RendererTests : public QObject { + Q_OBJECT + +private Q_SLOTS: + void testRender(); +}; + +void RendererTests::testRender() +{ + // render two random icons + auto renderer = QtForkAwesome::Renderer(); + const auto globe = renderer.pixmap(QtForkAwesome::Icon::Globe, QSize(80, 64), Qt::green); + QCOMPARE(globe.width(), 80 * globe.devicePixelRatio()); + QCOMPARE(globe.height(), 64 * globe.devicePixelRatio()); + const auto hashtag = renderer.pixmap(QtForkAwesome::Icon::Hashtag, QSize(50, 64), Qt::blue); + QCOMPARE(hashtag.width(), 50 * hashtag.devicePixelRatio()); + QCOMPARE(hashtag.height(), 64 * hashtag.devicePixelRatio()); + + // save the icons as PNGs to check manually whether they look as expected + const auto workingDirectory = QString::fromStdString(TestApplication().workingDirectory()); + QDir().mkpath(workingDirectory); + globe.save(workingDirectory + QStringLiteral("/globe.png")); + hashtag.save(workingDirectory + QStringLiteral("/hashtag.png")); +} + +QTEST_MAIN(RendererTests) +#include "rendering.moc"