haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add KICAD_BUILD_{NIGHTLY_,}FLATPAK CMake options to 7.0

This commit is contained in:
Johannes Maibaum 2023-08-02 22:14:25 +00:00 committed by Ian McInerney
parent 74fc8f6db0
commit 342b8b157b
10 changed files with 137 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
CMakeLists.txt
View File

@ -53,6 +53,13 @@ set( CMAKE_EXPORT_COMPILE_COMMANDS ON )
set( KICAD_CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake" ) set( KICAD_CMAKE_MODULE_PATH "${PROJECT_SOURCE_DIR}/cmake" )
set( CMAKE_MODULE_PATH "${KICAD_CMAKE_MODULE_PATH}" ) set( CMAKE_MODULE_PATH "${KICAD_CMAKE_MODULE_PATH}" )
# Create a flag to identify the non-Apple unix systems
if( UNIX AND NOT APPLE )
set( UNIX_NOT_APPLE ON )
else()
set( UNIX_NOT_APPLE OFF )
endif()
# On Windows, binaries created by link option -g3 are very large (more than 1Gb for pcbnew, # On Windows, binaries created by link option -g3 are very large (more than 1Gb for pcbnew,
# and more than 3Gb for the full kicad suite) # and more than 3Gb for the full kicad suite)
# This option create binaries using link option -g1 that create much smaller files, but # This option create binaries using link option -g1 that create much smaller files, but
@ -93,6 +100,17 @@ option( KICAD_I18N_UNIX_STRICT_PATH
"Use standard Unix locale lookup path (default OFF)." "Use standard Unix locale lookup path (default OFF)."
OFF ) OFF )
# Options to build with flatpak platform defaults (only on Linux)
cmake_dependent_option( KICAD_BUILD_FLATPAK
"Build KiCad with metadata, launchers, icons, and MIME info following flatpak conventions"
OFF "UNIX_NOT_APPLE"
OFF )
cmake_dependent_option( KICAD_BUILD_NIGHTLY_FLATPAK
"Build a Nightly flatpak (requires KICAD_BUILD_FLATPAK=ON)"
OFF "UNIX_NOT_APPLE"
OFF )
# Not supported by all platforms (for instance mingw) # Not supported by all platforms (for instance mingw)
option( KICAD_SANITIZE_ADDRESS option( KICAD_SANITIZE_ADDRESS
"Build KiCad with sanitizer options. WARNING: Not compatible with gold linker" "Build KiCad with sanitizer options. WARNING: Not compatible with gold linker"

137
resources/CMakeLists.txt
View File

@ -5,6 +5,30 @@ if( APPLE )
#TODO Generate this at runtime as well #TODO Generate this at runtime as well
include( ${KICAD_CMAKE_MODULE_PATH}/WritePlatformMetadata_macos.cmake ) include( ${KICAD_CMAKE_MODULE_PATH}/WritePlatformMetadata_macos.cmake )
elseif( UNIX ) elseif( UNIX )
# Default values for regular builds
set( KICAD_REVERSE_DOMAIN "org.kicad" )
set( KICAD_APP_NAME "${KICAD_REVERSE_DOMAIN}.kicad" )
set( KICAD_APP_PREFIX "${KICAD_REVERSE_DOMAIN}" )
set( KICAD_ICON_PREFIX "" )
set( KICAD_DESKTOP_FILE_ICON_PREFIX "" )
set( KICAD_DESKTOP_FILE_ICON_KICAD "kicad" )
set( KICAD_MIME_FILE_PREFIX "kicad" )
set( KICAD_MIME_ICON_PREFIX "" )
# Override default values from above if we are building a flatpak
if( KICAD_BUILD_FLATPAK )
set( KICAD_APP_NAME "${KICAD_REVERSE_DOMAIN}.KiCad" )
if( KICAD_BUILD_NIGHTLY_FLATPAK )
set( KICAD_APP_NAME "${KICAD_APP_NAME}.Nightly" )
endif()
set( KICAD_APP_PREFIX "${KICAD_APP_NAME}" )
set( KICAD_ICON_PREFIX "${KICAD_APP_NAME}" )
set( KICAD_DESKTOP_FILE_ICON_PREFIX "${KICAD_APP_PREFIX}." )
set( KICAD_DESKTOP_FILE_ICON_KICAD "${KICAD_APP_NAME}" )
set( KICAD_MIME_FILE_PREFIX "${KICAD_APP_PREFIX}" )
set( KICAD_MIME_ICON_PREFIX "${KICAD_APP_PREFIX}." )
endif()
# Add the command to configure the linux metainfo file with the version information # Add the command to configure the linux metainfo file with the version information
add_custom_command( add_custom_command(
OUTPUT ${PROJECT_BINARY_DIR}/resources/linux/metainfo/org.kicad.kicad.metainfo.xml.in OUTPUT ${PROJECT_BINARY_DIR}/resources/linux/metainfo/org.kicad.kicad.metainfo.xml.in
@ -12,6 +36,7 @@ elseif( UNIX )
-DSRC_PATH=${PROJECT_SOURCE_DIR} -DSRC_PATH=${PROJECT_SOURCE_DIR}
-DBUILD_PATH=${PROJECT_BINARY_DIR} -DBUILD_PATH=${PROJECT_BINARY_DIR}
-DKICAD_CMAKE_MODULE_PATH=${PROJECT_SOURCE_DIR}/cmake -DKICAD_CMAKE_MODULE_PATH=${PROJECT_SOURCE_DIR}/cmake
-DKICAD_APP_NAME=${KICAD_APP_NAME}
-P ${KICAD_CMAKE_MODULE_PATH}/BuildSteps/WritePlatformMetadata_linux.cmake -P ${KICAD_CMAKE_MODULE_PATH}/BuildSteps/WritePlatformMetadata_linux.cmake
DEPENDS ${KICAD_CMAKE_MODULE_PATH}/BuildSteps/WritePlatformMetadata_linux.cmake DEPENDS ${KICAD_CMAKE_MODULE_PATH}/BuildSteps/WritePlatformMetadata_linux.cmake
COMMENT "Configuring Linux metainfo" COMMENT "Configuring Linux metainfo"
@ -20,60 +45,114 @@ elseif( UNIX )
# Read the metainfo from the binary directory because it has been configured by Cmake already # Read the metainfo from the binary directory because it has been configured by Cmake already
# to have the version string in it # to have the version string in it
linux_metadata_translation( ${PROJECT_BINARY_DIR}/resources/linux/metainfo/org.kicad.kicad.metainfo.xml.in linux_metadata_translation( ${PROJECT_BINARY_DIR}/resources/linux/metainfo/org.kicad.kicad.metainfo.xml.in
${PROJECT_BINARY_DIR}/resources/linux/metainfo/org.kicad.kicad.metainfo.xml ${PROJECT_BINARY_DIR}/resources/linux/metainfo/${KICAD_APP_NAME}.metainfo.xml
${PROJECT_SOURCE_DIR}/translation/pofiles ) ${PROJECT_SOURCE_DIR}/translation/pofiles )
# All the desktop files are read from the source directory # All the desktop files take two passes: First they are configured to replace the variables,
linux_metadata_translation( ${PROJECT_SOURCE_DIR}/resources/linux/launchers/org.kicad.bitmap2component.desktop.in # then they are translated from the binary directory
${PROJECT_BINARY_DIR}/resources/linux/launchers/org.kicad.bitmap2component.desktop configure_file( ${PROJECT_SOURCE_DIR}/resources/linux/launchers/org.kicad.bitmap2component.desktop.in
${PROJECT_BINARY_DIR}/resources/linux/launchers/org.kicad.bitmap2component.desktop.in
@ONLY )
linux_metadata_translation( ${PROJECT_BINARY_DIR}/resources/linux/launchers/org.kicad.bitmap2component.desktop.in
${PROJECT_BINARY_DIR}/resources/linux/launchers/${KICAD_APP_PREFIX}.bitmap2component.desktop
${PROJECT_SOURCE_DIR}/translation/pofiles ) ${PROJECT_SOURCE_DIR}/translation/pofiles )
linux_metadata_translation( ${PROJECT_SOURCE_DIR}/resources/linux/launchers/org.kicad.eeschema.desktop.in configure_file( ${PROJECT_SOURCE_DIR}/resources/linux/launchers/org.kicad.eeschema.desktop.in
${PROJECT_BINARY_DIR}/resources/linux/launchers/org.kicad.eeschema.desktop ${PROJECT_BINARY_DIR}/resources/linux/launchers/org.kicad.eeschema.desktop.in
@ONLY )
linux_metadata_translation( ${PROJECT_BINARY_DIR}/resources/linux/launchers/org.kicad.eeschema.desktop.in
${PROJECT_BINARY_DIR}/resources/linux/launchers/${KICAD_APP_PREFIX}.eeschema.desktop
${PROJECT_SOURCE_DIR}/translation/pofiles ) ${PROJECT_SOURCE_DIR}/translation/pofiles )
linux_metadata_translation( ${PROJECT_SOURCE_DIR}/resources/linux/launchers/org.kicad.gerbview.desktop.in configure_file( ${PROJECT_SOURCE_DIR}/resources/linux/launchers/org.kicad.gerbview.desktop.in
${PROJECT_BINARY_DIR}/resources/linux/launchers/org.kicad.gerbview.desktop ${PROJECT_BINARY_DIR}/resources/linux/launchers/org.kicad.gerbview.desktop.in
@ONLY )
linux_metadata_translation( ${PROJECT_BINARY_DIR}/resources/linux/launchers/org.kicad.gerbview.desktop.in
${PROJECT_BINARY_DIR}/resources/linux/launchers/${KICAD_APP_PREFIX}.gerbview.desktop
${PROJECT_SOURCE_DIR}/translation/pofiles ) ${PROJECT_SOURCE_DIR}/translation/pofiles )
linux_metadata_translation( ${PROJECT_SOURCE_DIR}/resources/linux/launchers/org.kicad.kicad.desktop.in configure_file( ${PROJECT_SOURCE_DIR}/resources/linux/launchers/org.kicad.kicad.desktop.in
${PROJECT_BINARY_DIR}/resources/linux/launchers/org.kicad.kicad.desktop ${PROJECT_BINARY_DIR}/resources/linux/launchers/org.kicad.kicad.desktop.in
@ONLY )
linux_metadata_translation( ${PROJECT_BINARY_DIR}/resources/linux/launchers/org.kicad.kicad.desktop.in
${PROJECT_BINARY_DIR}/resources/linux/launchers/${KICAD_APP_NAME}.desktop
${PROJECT_SOURCE_DIR}/translation/pofiles ) ${PROJECT_SOURCE_DIR}/translation/pofiles )
linux_metadata_translation( ${PROJECT_SOURCE_DIR}/resources/linux/launchers/org.kicad.pcbcalculator.desktop.in configure_file( ${PROJECT_SOURCE_DIR}/resources/linux/launchers/org.kicad.pcbcalculator.desktop.in
${PROJECT_BINARY_DIR}/resources/linux/launchers/org.kicad.pcbcalculator.desktop ${PROJECT_BINARY_DIR}/resources/linux/launchers/org.kicad.pcbcalculator.desktop.in
@ONLY )
linux_metadata_translation( ${PROJECT_BINARY_DIR}/resources/linux/launchers/org.kicad.pcbcalculator.desktop.in
${PROJECT_BINARY_DIR}/resources/linux/launchers/${KICAD_APP_PREFIX}.pcbcalculator.desktop
${PROJECT_SOURCE_DIR}/translation/pofiles ) ${PROJECT_SOURCE_DIR}/translation/pofiles )
linux_metadata_translation( ${PROJECT_SOURCE_DIR}/resources/linux/launchers/org.kicad.pcbnew.desktop.in configure_file( ${PROJECT_SOURCE_DIR}/resources/linux/launchers/org.kicad.pcbnew.desktop.in
${PROJECT_BINARY_DIR}/resources/linux/launchers/org.kicad.pcbnew.desktop ${PROJECT_BINARY_DIR}/resources/linux/launchers/org.kicad.pcbnew.desktop.in
@ONLY )
linux_metadata_translation( ${PROJECT_BINARY_DIR}/resources/linux/launchers/org.kicad.pcbnew.desktop.in
${PROJECT_BINARY_DIR}/resources/linux/launchers/${KICAD_APP_PREFIX}.pcbnew.desktop
${PROJECT_SOURCE_DIR}/translation/pofiles ) ${PROJECT_SOURCE_DIR}/translation/pofiles )
# Translate the MIME info, which are read from the source directory # Translate the MIME info, which are read from the source directory...
linux_metadata_translation( ${PROJECT_SOURCE_DIR}/resources/linux/mime/kicad-gerbers.xml.in linux_metadata_translation( ${PROJECT_SOURCE_DIR}/resources/linux/mime/kicad-gerbers.xml.in
${PROJECT_BINARY_DIR}/resources/linux/mime/kicad-gerbers.xml ${PROJECT_BINARY_DIR}/resources/linux/mime/${KICAD_MIME_FILE_PREFIX}-gerbers.xml
${PROJECT_SOURCE_DIR}/translation/pofiles ) ${PROJECT_SOURCE_DIR}/translation/pofiles )
linux_metadata_translation( ${PROJECT_SOURCE_DIR}/resources/linux/mime/kicad-kicad.xml.in # ...except for the KiCad MIME info, which is also configured first to replace variables
${PROJECT_BINARY_DIR}/resources/linux/mime/kicad-kicad.xml configure_file( ${PROJECT_SOURCE_DIR}/resources/linux/mime/kicad-kicad.xml.in
${PROJECT_BINARY_DIR}/resources/linux/mime/kicad-kicad.xml.in
@ONLY )
linux_metadata_translation( ${PROJECT_BINARY_DIR}/resources/linux/mime/kicad-kicad.xml.in
${PROJECT_BINARY_DIR}/resources/linux/mime/${KICAD_MIME_FILE_PREFIX}-kicad.xml
${PROJECT_SOURCE_DIR}/translation/pofiles ) ${PROJECT_SOURCE_DIR}/translation/pofiles )
add_custom_target( metadata ALL add_custom_target( metadata ALL
DEPENDS ${PROJECT_BINARY_DIR}/resources/linux/metainfo/org.kicad.kicad.metainfo.xml DEPENDS ${PROJECT_BINARY_DIR}/resources/linux/metainfo/${KICAD_APP_NAME}.metainfo.xml
${PROJECT_BINARY_DIR}/resources/linux/launchers/org.kicad.bitmap2component.desktop ${PROJECT_BINARY_DIR}/resources/linux/launchers/${KICAD_APP_PREFIX}.bitmap2component.desktop
${PROJECT_BINARY_DIR}/resources/linux/launchers/org.kicad.eeschema.desktop ${PROJECT_BINARY_DIR}/resources/linux/launchers/${KICAD_APP_PREFIX}.eeschema.desktop
${PROJECT_BINARY_DIR}/resources/linux/launchers/org.kicad.gerbview.desktop ${PROJECT_BINARY_DIR}/resources/linux/launchers/${KICAD_APP_PREFIX}.gerbview.desktop
${PROJECT_BINARY_DIR}/resources/linux/launchers/org.kicad.kicad.desktop ${PROJECT_BINARY_DIR}/resources/linux/launchers/${KICAD_APP_NAME}.desktop
${PROJECT_BINARY_DIR}/resources/linux/launchers/org.kicad.pcbcalculator.desktop ${PROJECT_BINARY_DIR}/resources/linux/launchers/${KICAD_APP_PREFIX}.pcbcalculator.desktop
${PROJECT_BINARY_DIR}/resources/linux/launchers/org.kicad.pcbnew.desktop ${PROJECT_BINARY_DIR}/resources/linux/launchers/${KICAD_APP_PREFIX}.pcbnew.desktop
${PROJECT_BINARY_DIR}/resources/linux/mime/kicad-gerbers.xml ${PROJECT_BINARY_DIR}/resources/linux/mime/${KICAD_MIME_FILE_PREFIX}-gerbers.xml
${PROJECT_BINARY_DIR}/resources/linux/mime/kicad-kicad.xml ${PROJECT_BINARY_DIR}/resources/linux/mime/${KICAD_MIME_FILE_PREFIX}-kicad.xml
) )
# Install icons # Copy icons to binary dir, where they can be renamed for flatpak, if needed
install( DIRECTORY ${PROJECT_SOURCE_DIR}/resources/linux/icons/ file( COPY ${PROJECT_SOURCE_DIR}/resources/linux/icons/
DESTINATION ${PROJECT_BINARY_DIR}/resources/linux/icons
FILES_MATCHING
PATTERN "*.png"
PATTERN "*.svg"
)
if( KICAD_BUILD_FLATPAK )
# Rename all icons to start with KICAD_ICON_PREFIX
file( GLOB_RECURSE _ALL_ICONS
LIST_DIRECTORIES false
${PROJECT_BINARY_DIR}/resources/linux/icons/*.png
${PROJECT_BINARY_DIR}/resources/linux/icons/*.svg
)
foreach( _ICON ${_ALL_ICONS} )
get_filename_component( _ICON_PATH ${_ICON} DIRECTORY )
get_filename_component( _ICON_NAME ${_ICON} NAME_WE )
get_filename_component( _ICON_EXT ${_ICON} EXT )
if( _ICON_NAME STREQUAL "kicad" )
set( _RENAMED_ICON "${_ICON_PATH}/${KICAD_APP_NAME}${_ICON_EXT}" )
else()
set( _RENAMED_ICON "${_ICON_PATH}/${KICAD_ICON_PREFIX}.${_ICON_NAME}${_ICON_EXT}" )
endif()
file( RENAME ${_ICON} ${_RENAMED_ICON} )
endforeach()
endif()
# Install icons from binary dir, as they might have been renamed above
install( DIRECTORY ${PROJECT_BINARY_DIR}/resources/linux/icons/
DESTINATION ${CMAKE_INSTALL_DATADIR}/icons DESTINATION ${CMAKE_INSTALL_DATADIR}/icons
COMPONENT resources COMPONENT resources
FILES_MATCHING
PATTERN "${KICAD_ICON_PREFIX}*.png"
PATTERN "${KICAD_ICON_PREFIX}*.svg"
) )
# Install MIME type files # Install MIME type files

2
resources/linux/launchers/org.kicad.bitmap2component.desktop.in
View File

@ -1,7 +1,7 @@
[Desktop Entry] [Desktop Entry]
Version=1.0 Version=1.0
Terminal=false Terminal=false
Icon=bitmap2component Icon=@KICAD_DESKTOP_FILE_ICON_PREFIX@bitmap2component
Type=Application Type=Application
Categories=Science;Electronics; Categories=Science;Electronics;
Exec=bitmap2component %f Exec=bitmap2component %f

2
resources/linux/launchers/org.kicad.eeschema.desktop.in
View File

@ -1,7 +1,7 @@
[Desktop Entry] [Desktop Entry]
Version=1.0 Version=1.0
Terminal=false Terminal=false
Icon=eeschema Icon=@KICAD_DESKTOP_FILE_ICON_PREFIX@eeschema
Type=Application Type=Application
Categories=Science;Electronics; Categories=Science;Electronics;
Exec=eeschema %f Exec=eeschema %f

2
resources/linux/launchers/org.kicad.gerbview.desktop.in
View File

@ -1,7 +1,7 @@
[Desktop Entry] [Desktop Entry]
Version=1.0 Version=1.0
Terminal=false Terminal=false
Icon=gerbview Icon=@KICAD_DESKTOP_FILE_ICON_PREFIX@gerbview
Type=Application Type=Application
Categories=Science;Electronics; Categories=Science;Electronics;
Exec=gerbview %F Exec=gerbview %F

2
resources/linux/launchers/org.kicad.kicad.desktop.in
View File

@ -1,7 +1,7 @@
[Desktop Entry] [Desktop Entry]
Version=1.0 Version=1.0
Terminal=false Terminal=false
Icon=kicad Icon=@KICAD_DESKTOP_FILE_ICON_KICAD@
Type=Application Type=Application
Categories=Science;Electronics; Categories=Science;Electronics;
Exec=kicad %f Exec=kicad %f

2
resources/linux/launchers/org.kicad.pcbcalculator.desktop.in
View File

@ -1,7 +1,7 @@
[Desktop Entry] [Desktop Entry]
Version=1.0 Version=1.0
Terminal=false Terminal=false
Icon=pcbcalculator Icon=@KICAD_DESKTOP_FILE_ICON_PREFIX@pcbcalculator
Type=Application Type=Application
Categories=Science;Electronics; Categories=Science;Electronics;
Exec=pcb_calculator Exec=pcb_calculator

2
resources/linux/launchers/org.kicad.pcbnew.desktop.in
View File

@ -1,7 +1,7 @@
[Desktop Entry] [Desktop Entry]
Version=1.0 Version=1.0
Terminal=false Terminal=false
Icon=pcbnew Icon=@KICAD_DESKTOP_FILE_ICON_PREFIX@pcbnew
Type=Application Type=Application
Categories=Science;Electronics; Categories=Science;Electronics;
Exec=pcbnew %f Exec=pcbnew %f

4
resources/linux/metainfo/org.kicad.kicad.metainfo.xml.in
View File

@ -2,10 +2,10 @@
<!-- Copyright (C) 2016-2017 Lubomir Rintel <lkundrak@v3.sk> --> <!-- Copyright (C) 2016-2017 Lubomir Rintel <lkundrak@v3.sk> -->
<!-- Copyright (C) 2016-2021 KiCad Developers, see AUTHORS.txt for contributors. --> <!-- Copyright (C) 2016-2021 KiCad Developers, see AUTHORS.txt for contributors. -->
<component type="desktop"> <component type="desktop">
<id>org.kicad.kicad</id> <id>@KICAD_APP_NAME@</id>
<name>KiCad</name> <name>KiCad</name>
<launchable type="desktop-id">org.kicad.kicad.desktop</launchable> <launchable type="desktop-id">@KICAD_APP_NAME@.desktop</launchable>
<project_license>GPL-3.0-or-later</project_license> <project_license>GPL-3.0-or-later</project_license>
<metadata_license>CC-BY-SA-4.0</metadata_license> <metadata_license>CC-BY-SA-4.0</metadata_license>

6
resources/linux/mime/kicad-kicad.xml.in
View File

@ -3,14 +3,14 @@
<mime-type type="application/x-kicad-project"> <mime-type type="application/x-kicad-project">
<sub-class-of type="text/plain"/> <sub-class-of type="text/plain"/>
<comment>KiCad Project</comment> <comment>KiCad Project</comment>
<generic-icon name="application-x-kicad-project"/> <generic-icon name="@KICAD_MIME_ICON_PREFIX@application-x-kicad-project"/>
<glob pattern="*.pro" weight="40"/> <glob pattern="*.pro" weight="40"/>
<glob pattern="*.kicad_pro" weight="50"/> <glob pattern="*.kicad_pro" weight="50"/>
</mime-type> </mime-type>
<mime-type type="application/x-kicad-schematic"> <mime-type type="application/x-kicad-schematic">
<sub-class-of type="text/plain"/> <sub-class-of type="text/plain"/>
<comment>KiCad Schematic</comment> <comment>KiCad Schematic</comment>
<generic-icon name="application-x-kicad-schematic"/> <generic-icon name="@KICAD_MIME_ICON_PREFIX@application-x-kicad-schematic"/>
<glob pattern="*.sch" weight="40"/> <glob pattern="*.sch" weight="40"/>
<glob pattern="*.kicad_sch" weight="50"/> <glob pattern="*.kicad_sch" weight="50"/>
<magic priority="50"> <magic priority="50">
@ -25,7 +25,7 @@
<mime-type type="application/x-kicad-pcb"> <mime-type type="application/x-kicad-pcb">
<sub-class-of type="text/plain"/> <sub-class-of type="text/plain"/>
<comment>KiCad Printed Circuit Board</comment> <comment>KiCad Printed Circuit Board</comment>
<generic-icon name="application-x-kicad-pcb"/> <generic-icon name="@KICAD_MIME_ICON_PREFIX@application-x-kicad-pcb"/>
<glob pattern="*.kicad_pcb" weight="50"/> <glob pattern="*.kicad_pcb" weight="50"/>
<magic priority="50"> <magic priority="50">
<!--The new board file (.kicad_pcb) header--> <!--The new board file (.kicad_pcb) header-->