Implement a resource system.
Currently, icons, fonts, etc are converted to C structures at compile
time and are hardcoded to the binary. This presents several problems:
* Cross-compilation is complicated. Right now, it is necessary
to be able to run executables for the target platform; this
happens to work with wine-binfmt installed, but is rather ugly.
* Icons can only have one resolution. On OS X, modern software is
expected to take advantage of high-DPI ("Retina") screens and
use so-called @2x assets when ran in high-DPI mode.
* Localization is complicated. Win32 and OS X provide built-in
support for loading the resource appropriate for the user's
locale.
* Embedding strings can only be done as raw strings, using C++'s
R"(...)" literals. This precludes embedding sizable strings,
e.g. JavaScript libraries as used in Three.js export, and makes
git history less useful. Not embedding the libraries means we
have to rely on external CDNs, which requires an Internet
connection and adds a glaring point of failure.
* Linux distribution guidelines are violated. All architecture-
independent data, especially large data such as fonts, is
expected to be in /usr/share, not in the binary.
* Customization is impossible without recompilation. Minor
modifications like adding a few missing vector font characters
or adjusting localization require a complete development
environment, which is unreasonable to expect from users of
a mechanical CAD.
As such, this commit adds a resource system that bundles (and
sometimes builds) resources with the executable. Where they go is
platform-dependent:
* on Win32: into resources of the executable, which allows us to
keep distributing one file;
* on OS X: into the app bundle;
* on other *nix: into /usr/share/solvespace/ or ../res/ (relative
to the executable path), the latter allowing us to run freshly
built executables without installation.
It also subsides the platform-specific resources that are in src/.
The resource system is not yet used for anything; this will be added
in later commits.
2016-04-21 15:54:18 +00:00
|
|
|
# First, set up registration functions for the kinds of resources we handle.
|
|
|
|
|
set(resource_root ${CMAKE_CURRENT_SOURCE_DIR}/)
|
|
|
|
|
set(resource_list)
|
|
|
|
|
if(WIN32)
|
|
|
|
|
set(rc_file ${CMAKE_CURRENT_BINARY_DIR}/resources.rc)
|
|
|
|
|
file(WRITE ${rc_file} "// Autogenerated; do not edit\n")
|
|
|
|
|
|
|
|
|
|
function(add_resource name)
|
|
|
|
|
set(source ${CMAKE_CURRENT_SOURCE_DIR}/${name})
|
|
|
|
|
|
|
|
|
|
list(GET "${ARGN}" 0 id)
|
|
|
|
|
if(id STREQUAL NOTFOUND)
|
|
|
|
|
string(REPLACE ${resource_root} "" id ${source})
|
|
|
|
|
endif()
|
|
|
|
|
list(GET "${ARGN}" 1 type)
|
|
|
|
|
if(type STREQUAL NOTFOUND)
|
|
|
|
|
set(type RCDATA)
|
|
|
|
|
endif()
|
|
|
|
|
file(SHA512 "${source}" hash)
|
|
|
|
|
file(APPEND ${rc_file} "${id} ${type} \"${source}\" // ${hash}\n")
|
|
|
|
|
# CMake doesn't track file dependencies across directories, so we force
|
|
|
|
|
# a reconfigure (which changes the RC file because of the hash above)
|
|
|
|
|
# every time a resource is changed.
|
|
|
|
|
set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS "${source}")
|
|
|
|
|
endfunction()
|
|
|
|
|
elseif(APPLE)
|
|
|
|
|
set(app_resource_dir ${CMAKE_BINARY_DIR}/src/solvespace.app/Contents/Resources)
|
|
|
|
|
|
|
|
|
|
function(add_resource name)
|
|
|
|
|
set(source ${CMAKE_CURRENT_SOURCE_DIR}/${name})
|
|
|
|
|
set(target ${app_resource_dir}/${name})
|
|
|
|
|
set(resource_list "${resource_list};${target}" PARENT_SCOPE)
|
|
|
|
|
|
|
|
|
|
get_filename_component(target_dir ${target} DIRECTORY)
|
|
|
|
|
add_custom_command(
|
|
|
|
|
OUTPUT ${target}
|
|
|
|
|
COMMAND ${CMAKE_COMMAND} -E make_directory ${target_dir}
|
|
|
|
|
COMMAND ${CMAKE_COMMAND} -E copy ${source} ${target}
|
|
|
|
|
COMMENT "Copying resource ${name}"
|
|
|
|
|
DEPENDS ${source}
|
|
|
|
|
VERBATIM)
|
|
|
|
|
endfunction()
|
|
|
|
|
|
|
|
|
|
function(add_xib name)
|
|
|
|
|
set(source ${CMAKE_CURRENT_SOURCE_DIR}/${name})
|
|
|
|
|
get_filename_component(basename ${name} NAME_WE)
|
|
|
|
|
set(target ${app_resource_dir}/${basename}.nib)
|
|
|
|
|
set(resource_list "${resource_list};${target}" PARENT_SCOPE)
|
|
|
|
|
|
|
|
|
|
add_custom_command(
|
|
|
|
|
OUTPUT ${target}
|
|
|
|
|
COMMAND ${CMAKE_COMMAND} -E make_directory ${app_resource_dir}
|
|
|
|
|
COMMAND ibtool --errors --warnings --notices --output-format human-readable-text
|
|
|
|
|
--compile ${target} ${source}
|
|
|
|
|
COMMENT "Building Interface Builder file ${name}"
|
|
|
|
|
DEPENDS ${source}
|
|
|
|
|
VERBATIM)
|
|
|
|
|
endfunction()
|
|
|
|
|
|
|
|
|
|
function(add_iconset name)
|
|
|
|
|
set(source ${CMAKE_CURRENT_SOURCE_DIR}/${name})
|
|
|
|
|
get_filename_component(basename ${name} NAME_WE)
|
|
|
|
|
set(target ${app_resource_dir}/${basename}.icns)
|
|
|
|
|
set(resource_list "${resource_list};${target}" PARENT_SCOPE)
|
|
|
|
|
|
|
|
|
|
add_custom_command(
|
|
|
|
|
OUTPUT ${target}
|
|
|
|
|
COMMAND ${CMAKE_COMMAND} -E make_directory ${app_resource_dir}
|
|
|
|
|
COMMAND iconutil -c icns -o ${target} ${source}
|
|
|
|
|
COMMENT "Building icon set ${name}"
|
|
|
|
|
DEPENDS ${source}
|
|
|
|
|
VERBATIM)
|
|
|
|
|
endfunction()
|
|
|
|
|
else() # Unix
|
|
|
|
|
include(GNUInstallDirs)
|
|
|
|
|
|
|
|
|
|
set(app_resource_dir ${CMAKE_BINARY_DIR}/res)
|
|
|
|
|
|
|
|
|
|
function(add_resource name)
|
|
|
|
|
set(source ${CMAKE_CURRENT_SOURCE_DIR}/${name})
|
|
|
|
|
set(target ${app_resource_dir}/${name})
|
|
|
|
|
set(resource_list "${resource_list};${target}" PARENT_SCOPE)
|
|
|
|
|
|
|
|
|
|
get_filename_component(target_dir ${target} DIRECTORY)
|
|
|
|
|
add_custom_command(
|
|
|
|
|
OUTPUT ${target}
|
|
|
|
|
COMMAND ${CMAKE_COMMAND} -E make_directory ${target_dir}
|
|
|
|
|
COMMAND ${CMAKE_COMMAND} -E copy ${source} ${target}
|
|
|
|
|
COMMENT "Copying resource ${name}"
|
|
|
|
|
DEPENDS ${source}
|
|
|
|
|
VERBATIM)
|
|
|
|
|
|
|
|
|
|
get_filename_component(name_dir ${name} DIRECTORY)
|
|
|
|
|
install(FILES ${source}
|
|
|
|
|
DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/solvespace/${name_dir})
|
|
|
|
|
endfunction()
|
|
|
|
|
endif()
|
|
|
|
|
|
2016-04-22 13:35:22 +00:00
|
|
|
function(add_resources)
|
|
|
|
|
foreach(name ${ARGN})
|
|
|
|
|
add_resource(${name})
|
|
|
|
|
set(resource_list "${resource_list}" PARENT_SCOPE)
|
|
|
|
|
endforeach()
|
|
|
|
|
endfunction()
|
|
|
|
|
|
Implement a resource system.
Currently, icons, fonts, etc are converted to C structures at compile
time and are hardcoded to the binary. This presents several problems:
* Cross-compilation is complicated. Right now, it is necessary
to be able to run executables for the target platform; this
happens to work with wine-binfmt installed, but is rather ugly.
* Icons can only have one resolution. On OS X, modern software is
expected to take advantage of high-DPI ("Retina") screens and
use so-called @2x assets when ran in high-DPI mode.
* Localization is complicated. Win32 and OS X provide built-in
support for loading the resource appropriate for the user's
locale.
* Embedding strings can only be done as raw strings, using C++'s
R"(...)" literals. This precludes embedding sizable strings,
e.g. JavaScript libraries as used in Three.js export, and makes
git history less useful. Not embedding the libraries means we
have to rely on external CDNs, which requires an Internet
connection and adds a glaring point of failure.
* Linux distribution guidelines are violated. All architecture-
independent data, especially large data such as fonts, is
expected to be in /usr/share, not in the binary.
* Customization is impossible without recompilation. Minor
modifications like adding a few missing vector font characters
or adjusting localization require a complete development
environment, which is unreasonable to expect from users of
a mechanical CAD.
As such, this commit adds a resource system that bundles (and
sometimes builds) resources with the executable. Where they go is
platform-dependent:
* on Win32: into resources of the executable, which allows us to
keep distributing one file;
* on OS X: into the app bundle;
* on other *nix: into /usr/share/solvespace/ or ../res/ (relative
to the executable path), the latter allowing us to run freshly
built executables without installation.
It also subsides the platform-specific resources that are in src/.
The resource system is not yet used for anything; this will be added
in later commits.
2016-04-21 15:54:18 +00:00
|
|
|
# Second, register all resources.
|
2016-04-21 16:59:13 +00:00
|
|
|
if(WIN32)
|
|
|
|
|
add_resource(win32/icon.ico RT_ICON_GROUP APP_ICON)
|
|
|
|
|
add_resource(win32/manifest.xml RT_MANIFEST APP_MANIFEST)
|
2016-04-21 17:15:38 +00:00
|
|
|
elseif(APPLE)
|
2016-04-21 17:36:20 +00:00
|
|
|
add_iconset (cocoa/AppIcon.iconset)
|
|
|
|
|
add_xib (cocoa/MainMenu.xib)
|
|
|
|
|
add_xib (cocoa/SaveFormatAccessory.xib)
|
2016-04-21 17:15:38 +00:00
|
|
|
else()
|
|
|
|
|
install(FILES freedesktop/solvespace.desktop
|
|
|
|
|
DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/applications)
|
|
|
|
|
|
|
|
|
|
foreach(SIZE 16x16 24x24 32x32 48x48)
|
|
|
|
|
install(FILES freedesktop/solvespace-${SIZE}.png
|
|
|
|
|
DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/${SIZE}/apps
|
|
|
|
|
RENAME solvespace.png)
|
|
|
|
|
install(FILES freedesktop/solvespace-${SIZE}.png
|
|
|
|
|
DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/icons/hicolor/${SIZE}/mimetypes
|
|
|
|
|
RENAME application.x-solvespace.png)
|
|
|
|
|
endforeach()
|
2016-04-21 16:59:13 +00:00
|
|
|
endif()
|
2016-04-22 13:35:22 +00:00
|
|
|
|
|
|
|
|
add_resources(
|
|
|
|
|
banner.txt
|
|
|
|
|
icons/graphics-window/angle.png
|
|
|
|
|
icons/graphics-window/arc.png
|
|
|
|
|
icons/graphics-window/assemble.png
|
|
|
|
|
icons/graphics-window/bezier.png
|
|
|
|
|
icons/graphics-window/circle.png
|
|
|
|
|
icons/graphics-window/construction.png
|
|
|
|
|
icons/graphics-window/equal.png
|
|
|
|
|
icons/graphics-window/extrude.png
|
|
|
|
|
icons/graphics-window/horiz.png
|
|
|
|
|
icons/graphics-window/in3d.png
|
|
|
|
|
icons/graphics-window/lathe.png
|
|
|
|
|
icons/graphics-window/length.png
|
|
|
|
|
icons/graphics-window/line.png
|
|
|
|
|
icons/graphics-window/ontoworkplane.png
|
|
|
|
|
icons/graphics-window/other-supp.png
|
|
|
|
|
icons/graphics-window/parallel.png
|
|
|
|
|
icons/graphics-window/perpendicular.png
|
|
|
|
|
icons/graphics-window/pointonx.png
|
|
|
|
|
icons/graphics-window/point.png
|
|
|
|
|
icons/graphics-window/rectangle.png
|
|
|
|
|
icons/graphics-window/ref.png
|
|
|
|
|
icons/graphics-window/same-orientation.png
|
|
|
|
|
icons/graphics-window/sketch-in-3d.png
|
|
|
|
|
icons/graphics-window/sketch-in-plane.png
|
|
|
|
|
icons/graphics-window/step-rotate.png
|
|
|
|
|
icons/graphics-window/step-translate.png
|
|
|
|
|
icons/graphics-window/symmetric.png
|
|
|
|
|
icons/graphics-window/tangent-arc.png
|
|
|
|
|
icons/graphics-window/text.png
|
|
|
|
|
icons/graphics-window/trim.png
|
|
|
|
|
icons/graphics-window/vert.png
|
|
|
|
|
icons/text-window/constraint.png
|
|
|
|
|
icons/text-window/edges.png
|
|
|
|
|
icons/text-window/faces.png
|
|
|
|
|
icons/text-window/hidden-lines.png
|
|
|
|
|
icons/text-window/mesh.png
|
|
|
|
|
icons/text-window/normal.png
|
|
|
|
|
icons/text-window/outlines.png
|
|
|
|
|
icons/text-window/point.png
|
|
|
|
|
icons/text-window/shaded.png
|
2016-04-23 04:37:42 +00:00
|
|
|
icons/text-window/workplane.png
|
|
|
|
|
fonts/unifont.hex.gz
|
|
|
|
|
fonts/private/0-check-false.png
|
|
|
|
|
fonts/private/1-check-true.png
|
|
|
|
|
fonts/private/2-radio-false.png
|
|
|
|
|
fonts/private/3-radio-true.png
|
|
|
|
|
fonts/private/4-stipple-dot.png
|
|
|
|
|
fonts/private/5-stipple-dash-long.png
|
|
|
|
|
fonts/private/6-stipple-dash.png
|
2016-04-24 22:35:23 +00:00
|
|
|
fonts/private/7-stipple-zigzag.png
|
|
|
|
|
fonts/unicode.lff.gz)
|
Implement a resource system.
Currently, icons, fonts, etc are converted to C structures at compile
time and are hardcoded to the binary. This presents several problems:
* Cross-compilation is complicated. Right now, it is necessary
to be able to run executables for the target platform; this
happens to work with wine-binfmt installed, but is rather ugly.
* Icons can only have one resolution. On OS X, modern software is
expected to take advantage of high-DPI ("Retina") screens and
use so-called @2x assets when ran in high-DPI mode.
* Localization is complicated. Win32 and OS X provide built-in
support for loading the resource appropriate for the user's
locale.
* Embedding strings can only be done as raw strings, using C++'s
R"(...)" literals. This precludes embedding sizable strings,
e.g. JavaScript libraries as used in Three.js export, and makes
git history less useful. Not embedding the libraries means we
have to rely on external CDNs, which requires an Internet
connection and adds a glaring point of failure.
* Linux distribution guidelines are violated. All architecture-
independent data, especially large data such as fonts, is
expected to be in /usr/share, not in the binary.
* Customization is impossible without recompilation. Minor
modifications like adding a few missing vector font characters
or adjusting localization require a complete development
environment, which is unreasonable to expect from users of
a mechanical CAD.
As such, this commit adds a resource system that bundles (and
sometimes builds) resources with the executable. Where they go is
platform-dependent:
* on Win32: into resources of the executable, which allows us to
keep distributing one file;
* on OS X: into the app bundle;
* on other *nix: into /usr/share/solvespace/ or ../res/ (relative
to the executable path), the latter allowing us to run freshly
built executables without installation.
It also subsides the platform-specific resources that are in src/.
The resource system is not yet used for anything; this will be added
in later commits.
2016-04-21 15:54:18 +00:00
|
|
|
|
|
|
|
|
# Third, distribute the resources.
|
|
|
|
|
add_custom_target(resources
|
|
|
|
|
DEPENDS ${resource_list})
|
|
|
|
|
if(WIN32)
|
|
|
|
|
set_property(TARGET resources PROPERTY EXTRA_SOURCES ${rc_file})
|
|
|
|
|
endif()
|