realAscot/kicad-source
1
0
Fork 0
mirror of https://gitlab.com/kicad/code/kicad.git synced 2025-09-14 02:03:12 +02:00
Code Issues Packages Projects Releases Wiki Activity
kicad-source/bitmaps_png/CMakeLists.txt
Jon Evans 18037e2f65 Rework bitmap system to load from archived PNGs 
Bitmaps are now identified by an enum class instead of by pointers.
Bitmap loading and caching is now handled by a class in common, and
we no longer compile most bitmaps into the binary, so there is no
longer a bitmaps static library.

Instead, bitmaps are archived to a .tar.gz file which is installed
in ${KICAD_DATA}/resources/images.tar.gz

The source PNGs are checked in to Git as the original CPP files were,
so that people can build without the required dependencies to convert
SVGs to PNGs.

Initial support is also added for dark theme icons, although this
is not yet exposed in the GUI.

Stubs are present for multi-resolution image resources, but this is
not fully-baked yet and could use some refinement.
2021-03-11 08:37:35 -05:00

830 lines
20 KiB
CMake
Raw Blame History

# This program source code file is part of KICAD, a free EDA CAD application.
#
# Copyright (C) 2011 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
# Copyright (C) 2011-2018 Kicad Developers, see AUTHORS.txt for contributors.
#
# 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, you may find one here:
# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
# or you may search the http://www.gnu.org website for the version 2 license,
# or you may write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
#
# In this directory, a number of different processes are managed:
#
# 1) PNG files are created from SVG files
# 2) CPP files are created from PNG files.
# 3) Object files are created from CPP files.
# 4) A static library is created from the object files
# Step 3) is universal and is done for any builder, whereas steps 1) and 2) are
# optional and depend on MAINTAIN_PNGS being defined in CMake. The reason we
# can skip 1) and 2) is that the *.CPP files are part of the source tree so
# do not need to rebuilt by a typical builder. However, because the *.CPP files
# are part of the source tree, and subject to version control, they should be built
# only when needed, otherwise this results in a diff for the version control system.
# Therefore steps 1) and 2) are driven by CMake (if MAINTAIN_PNGS) which gives
# us conditional *.CPP building based on an edit to the respective *.SVG file.
# If MAINTAIN_PNGS is not defined, then you are a normal builder and no special
# tools are required. If MAINTAIN_PNG is defined, then you are a PNG maintainer
# and will need the following tools findable in your PATH:
#
# 1) inkscape - command line mode is used, must be on your PATH
# 2) pngcrush - this program must be on your PATH
#
# lower case is used for local variables, uppercase for global variables
option( MAINTAIN_PNGS
"Set to true if you are a PNG maintainer and have the required tools given in the bitmaps_png/CMakeLists.txt file (default OFF)."
OFF)
# Used Only to maintain PNG files (and therefore to recreate .cpp files)
# The png2cpp creates files with native End of Line format.
set( THEMES
light
dark )
# Plan for three sizes of bitmaps:
# SMALL - for menus - 16 x 16
# MID - for toolbars - 24 x 24
# BIG - for program icons - 48 x 48
# which are given on three basename lists: BMAPS_SMALL, BMAPS_MID,and BMAPS_BIG
# respectively. The basename is without file extension and without path.
# A corresponding ${basename}.svg file must exist in 'sources' dir below here.
# small icons (16x16) needed in listboxes and dialog buttons
set( BMAPS_SMALL
icon_bitmap2component_16
icon_eeschema_16
icon_gerbview_16
icon_kicad_16
icon_libedit_16
icon_modedit_16
icon_pagelayout_editor_16
icon_pcbcalculator_16
icon_pcbnew_16
list_nets_16
options_generic_16
pinorient_right
pinorient_left
pinorient_up
pinorient_down
pinshape_normal
pinshape_invert
pinshape_clock_normal
pinshape_clock_invert
pinshape_active_low_input
pinshape_clock_active_low
pinshape_active_low_output
pinshape_clock_fall
pinshape_nonlogic
pintype_input
pintype_output
pintype_bidi
pintype_3states
pintype_passive
pintype_notspecif
pintype_powerinput
pintype_poweroutput
pintype_opencoll
pintype_openemit
pintype_nic
pintype_noconnect
small_down
small_edit
small_folder
small_library
small_plus
small_refresh
small_trash
small_up
small_warning
tree_nosel
tree_sel
triangle_down
triangle_right
visibility
visibility_off
www
)
# image basenames that go into the toolbar sized destinations, i.e. 24x24
set( BMAPS_MID
about
add_aligned_dimension
add_arc
add_board
add_bus2bus
add_bus
add_center_dimension
add_circle
add_component
add_corner
add_dashed_line
add_document
add_glabel
add_graphical_segments
add_graphical_polygon
add_hierarchical_label
add_hierar_pin
add_hierarchical_subsheet
add_junction
add_keepout_area
add_label
add_leader
add_library
add_line2bus
add_line_label
add_line
add_orthogonal_dimension
add_pcb_target
add_power
add_rectangle
add_symbol_to_schematic
add_tracks
add_via
add_zone_cutout
add_zone
align_items
align_items_left
align_items_right
align_items_top
align_items_bottom
align_items_center
align_items_middle
anchor
annotate_down_right
annotate_right_down
annotate
apply_pad_settings
array
auto_associate
auto_track_width
autoplace_fields
axis3d_back
axis3d_bottom
axis3d_front
axis3d_left
axis3d_right
axis3d_top
axis3d
break_line
bug
bus_definition_tool
cancel
change_entry_orient
contrast_mode
curved_ratsnest
checked_ok
color_materials
component_select_unit
config
convert
copy
copy_pad_settings
cursor_shape
cursor
custom_pad_to_primitives
cut
datasheet
delete_association
delete_cursor
delete_gerber
delete_sheet
directory
directory_browser
directory_open
distribute_horizontal
distribute_vertical
down
drag
drag_segment_withslope
drc
duplicate
edit_comp_footprint
edit_comp_ref
edit_comp_value
editor
edit_cmp_symb_links
edit
edge_to_copper_clearance
enter_sheet
ercerr
erc_green
ercwarn
erc
exit
exchange
export3d
export_cmp
export_dsn
export_idf
export_file
export_footprint_names
export_module
export_part
export_png
export_step
export_svg
export_to_pcbnew
fabrication
file_bom
file_drl
file_dsn
file_gbr
file_gerber_job
file_html
file_idf
file_pdf
file_pos
file_svg
fill_zone
filter
find
find_replace
flag
flip_board
gbr_select_mode2
gerbview_show_negative_objects
general_deletions
general_ratsnest
grid_select
grid_select_axis
grid
group
group_enter
group_leave
group_remove
group_ungroup
help
help_online
hidden_pin
hide_ratsnest
hierarchy_nav
hotkeys
hole_to_hole_clearance
hole_to_copper_clearance
icon_cvpcb_24
icon_footprint_browser
icon_gerbview_24
import3d
image
import_brd_file
import_document
import_footprint_names
import_hierarchical_label
import_module
import_part
import_project
import_vector
import
info
insert_module_board
language
layers_manager
leave_sheet
left
libedit
lib_next
lib_previous
library_browser
library_archive
library_archive_as
library
library_table
lines90
list_nets
load_drill
load_gerber
load_module_board
lock_unlock
locked
measurement
pcb_target
mirror_h
mirror_v
mode_module
module_editor
module_wizard
module_filtered_list
module_options
module_pin_filtered_list
module_library_list
module
morgan1
morgan2
move_exactly
move
move_relative
mw_add_gap
mw_add_line
mw_add_shape
mw_add_stub_arc
mw_add_stub
net_highlight
net_highlight_schematic
netlist
new_component
new_footprint
new_generic
new_library
new_project
noconn
normal
open_project
options_3drender
options_board
options_generic
options_pad
options_schematic
opt_show_polygon
ortho
pad_sketch
pad
pad_enumerate
pad_number
pads_mask_layers
pads_remove
path
pagelayout_normal_view_mode
pagelayout_special_view_mode
part_properties
paste
pin2pin
pin_size_to
pin_show_etype
pin_table
pin
plot
polar_coord
post_bom
post_compo
post_d356
post_drill
post_gencad
post_gerber
post_rpt
preference
print_button
project
project_close
project_kicad
ps_diff_pair
ps_diff_pair_gap
ps_diff_pair_tune_length
ps_diff_pair_tune_phase
ps_tune_length
push_pad_settings
puzzle_piece
py_script
recent
redo
refresh
reload
render_mode
rescue
right
router_len_tuner
router_len_tuner_setup
router_len_tuner_amplitude_decr
router_len_tuner_amplitude_incr
router_len_tuner_dist_decr
router_len_tuner_dist_incr
rotate_ccw
rotate_cw
rotate_ccw_x
rotate_cw_x
rotate_ccw_y
rotate_cw_y
rotate_ccw_z
rotate_cw_z
save_as
save
select_layer_pair
select_w_layer
select_same_sheet
shape_3d
shape_3d_back
sheetset
simulator
sim_run
sim_stop
sim_tune
sim_probe
sim_add_signal
search_tree
set_origin
show_dcodenumber
show_footprint
show_mod_edge
show_ratsnest
showtrack
show_zone
show_zone_disable
show_zone_outline_only
show_all_layers
show_no_layers
show_no_copper_layers
show_all_copper_layers
show_all_front_layers
show_all_back_layers
show_front_assembly_layers
show_back_assembly_layers
special_tools
spreadsheet
swap_layer
switch_corner_rounding_shape
text
text_sketch
three_d
tool_ratsnest
tools
trash
undo
unit_inch
unit_mil
unit_mm
unknown
unlocked
unzip
up
update_pcb_from_sch
update_sch_from_pcb
via
via_annulus
via_buried
via_microvia
via_sketch
via_diameter
via_hole_diameter
width_track_via
width_track
zip
zone_duplicate
zone_fillet
zone_unfill
zoom_area
zoom_auto_fit_in_page
zoom_fit_in_page
zoom_fit_to_objects
zoom_center_on_screen
zoom_in
zoom_out
zoom_selection
)
# 24 x 24 for internal icons
set( BMAPS_24
icon_bitmap2component_24
icon_eeschema_24
icon_gerbview_24
icon_libedit_24
icon_modedit_24
icon_pagelayout_editor_24
icon_pcbcalculator_24
icon_pcbnew_24
)
# 32 x 32 for icon sets
set( BMAPS_32
icon_bitmap2component_32
icon_eeschema_32
icon_gerbview_32
icon_kicad_32
icon_libedit_32
icon_modedit_32
icon_pagelayout_editor_32
icon_pcbcalculator_32
icon_pcbnew_32
)
# 48 x 48 for now
set( BMAPS_BIG
dialog_warning
icon_3d
icon_cvpcb
icon_eeschema
icon_gerbview
icon_kicad
icon_libedit
icon_modedit
icon_pcbnew
icon_bitmap2component
icon_pagelayout_editor
icon_pcbcalculator
reannotate_down_left
reannotate_down_right
reannotate_left_down
reannotate_left_up
reannotate_right_down
reannotate_right_up
reannotate_up_left
reannotate_up_right
icon_pagelayout_editor
wizard_add_fplib_icon
)
# 64 x 64 for icon sets
set( BMAPS_64
icon_cvpcb
icon_eeschema
icon_gerbview
icon_kicad
icon_libedit
icon_modedit
icon_pcbnew
icon_pagelayout_editor
icon_bitmap2component
icon_pcbcalculator
)
# 128 x 128 for icon sets
set( BMAPS_128
icon_cvpcb
icon_eeschema
icon_gerbview
icon_kicad
icon_libedit
icon_modedit
icon_pcbnew
icon_pagelayout_editor
icon_bitmap2component
icon_pcbcalculator
)
set( BMAPS_OTHER
pads_npth
pads_npth_top_bottom
pads_npth_top
pads_npth_bottom
pads_remove_unused
pads_remove_unused_keep_bottom
pads_reset_unused
stroke_dash
stroke_dashdot
stroke_dot
stroke_solid
tune_diff_pair_length_legend
tune_diff_pair_skew_legend
tune_single_track_length_legend
)
# @todo keep these in sync with .bzrignore
set( TMP_DIR "${CMAKE_CURRENT_BINARY_DIR}/tmp" )
# true to generate log files, false to build icon files only
# generate logs is useful only if you have problems
set( CREATE_LOG_FILES true )
set( BITMAP_INFO_FILE "${CMAKE_SOURCE_DIR}/include/bitmaps/bitmap_info.h" )
set( BITMAP_INFO_TEMP_FILE ${TMP_DIR}/bitmap_info_contents.h )
set( ALL_PNGS "" )
function( svg2png inputFile outFile pngWidth pngHeight )
#message( "svg2png( inputFile: ${inputFile} outFile: ${outFile} pngWidth: ${pngWidth} pngHeight: ${pngHeight})")
if( CREATE_LOG_FILES )
set( logfile "${TMP_DIR}/${bmn}.inkscape.log" )
else()
set( logfile "null" )
endif()
add_custom_command(
OUTPUT ${outFile}
# this Inkscape command line is for old Inkscape version < 1.0
# COMMAND ${Inkscape_EXECUTABLE} --without-gui --export-area-snap -f ${inputFile} --export-png ${outFile} -w ${pngWidth} -h ${pngHeight} > ${logfile}
# this Inkscape command line is for Inkscape >= 1.0
COMMAND ${Inkscape_EXECUTABLE} --export-area-snap --export-type="png" ${inputFile} --export-filename ${outFile}
-w ${pngWidth} -h ${pngHeight} > ${logfile}
DEPENDS ${inputFile}
COMMENT "Creating ${pngHeight} pixel tall ${outFile}"
)
endfunction()
# Function png2png
# converts a basic PNG to one
function( png2png inputFile outFile )
if( CREATE_LOG_FILES )
set( logfile "${TMP_DIR}/${bmn}.pngcrush.log" )
else()
set( logfile "null" )
endif()
add_custom_command(
OUTPUT ${outFile}
# pngcrush all icons without background to remove any extraneous text records.
COMMAND ${pngcrush_EXECUTABLE} -rem alla ${inputFile} ${outFile} > ${logfile}
DEPENDS ${inputFile}
COMMENT "Creating cleaned file ${outFile}"
)
endfunction()
# Function png2cpp
# converts a single *.png to *.cpp
function( png2cpp inputFile outFile )
add_custom_command(
OUTPUT ${outFile}
COMMAND ${CMAKE_COMMAND} -DinputFile=${inputFile} -DoutCppFile=${outFile}
-P ${CMAKE_MODULE_PATH}/BuildSteps/PNG2cpp.cmake
DEPENDS ${inputFile} ${CMAKE_MODULE_PATH}/BuildSteps/PNG2cpp.cmake
COMMENT "Creating ${outFile}"
)
endfunction()
# Function bitmap_dir
# converts all the basenames in bmapList found in hardcoded 'sources' dir
# and and puts them into cpp_${pngHeight} and png_${pngHeight} directories.
function( bitmap_dir pngWidth pngHeight bmapList theme )
set( pngDir "${CMAKE_CURRENT_SOURCE_DIR}/png" )
file( MAKE_DIRECTORY ${pngDir} )
#file( REMOVE_RECURSE ${TMP_DIR} )
file( MAKE_DIRECTORY ${TMP_DIR} )
foreach( theme ${THEMES} )
if( NOT ${theme} STREQUAL "light" )
set( themeTag "_${theme}" )
else()
set( themeTag "" )
endif()
foreach( bmn ${bmapList} )
set( svgFile "${CMAKE_CURRENT_SOURCE_DIR}/sources/${theme}/${bmn}.svg" )
set( pngFile "${bmn}${themeTag}_${pngHeight}.png" )
set( pngPath "${pngDir}/${pngFile}" )
set( tmpFile "${TMP_DIR}/${pngFile}" )
if( NOT EXISTS ${svgFile} )
continue()
endif()
#svg2png( inputFile outFile pngWidth pngHeight )
svg2png( ${svgFile} ${tmpFile} ${pngWidth} ${pngHeight} )
#png2png( inputFile outFile )
png2png( ${tmpFile} ${pngPath} )
set( bitmapInfo " { BITMAPS::${bmn}, wxT( \"${pngFile}\" ), "
"${pngHeight}, wxT( \"${theme}\" ) },\n" )
file( APPEND ${BITMAP_INFO_TEMP_FILE} ${bitmapInfo} )
list( APPEND ALL_PNGS ${pngPath} )
endforeach()
endforeach()
set( ALL_PNGS ${ALL_PNGS} PARENT_SCOPE )
endfunction()
# Creates the bitmap_info header file after creating all PNGs
function( generate_bitmap_info inputFile outputFile )
add_custom_command(
OUTPUT ${outputFile}
COMMAND ${CMAKE_COMMAND} -DinputFile=${inputFile} -DoutputFile=${outputFile}
-P ${CMAKE_MODULE_PATH}/BuildSteps/CreateBitmapInfo.cmake
DEPENDS ${inputFile} ${CMAKE_MODULE_PATH}/BuildSteps/CreateBitmapInfo.cmake
COMMENT "Creating ${outputFile}"
VERBATIM
)
endfunction()
include( FindUnixCommands )
set( BITMAP_ARCHIVE_PATH ${CMAKE_BINARY_DIR}/resources/images.tar.gz )
if( NOT ALL_PNGS )
file( GLOB_RECURSE ALL_PNGS ${CMAKE_CURRENT_SOURCE_DIR}/png/*.png )
endif()
if( MINGW )
# This seems like a huge hack, but I can't find a better way. If anyone else does, please
# feel free to replace this with it...
file( TO_CMAKE_PATH "${BITMAP_ARCHIVE_PATH}" TAR_OUTPUT_FILE )
string( REGEX REPLACE "^([a-zA-Z]):/" "/\\1/" TAR_OUTPUT_FILE "${TAR_OUTPUT_FILE}" )
else()
set( TAR_OUTPUT_FILE "${BITMAP_ARCHIVE_PATH}" )
endif()
add_custom_target( bitmap_archive ALL
COMMAND ${TAR} cfz "${TAR_OUTPUT_FILE}" .
DEPENDS ${ALL_PNGS}
BYPRODUCTS ${BITMAP_ARCHIVE_PATH}
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/png
COMMENT "Creating image archive ${TAR_OUTPUT_FILE}"
VERBATIM
)
install( FILES ${BITMAP_ARCHIVE_PATH}
DESTINATION ${KICAD_DATA}/resources
)
if( MAINTAIN_PNGS )
# Inkscape is required to convert SVG files to PNG files.
set( Inkscape_FOUND FALSE )
if( NOT Inkscape_FOUND )
find_program( Inkscape_EXECUTABLE inkscape
PATHS "[HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows\\CurrentVersion\\Uninstall\\Inkscape;InstallDir]"
DOC "Inkscape vector drawing program." )
if( NOT Inkscape_EXECUTABLE )
message( FATAL_ERROR "Could not find the Inkscape vector drawing program." )
else( NOT Inkscape_EXECUTABLE )
set( Inkscape_FOUND TRUE )
set( Inkscape_EXECUTABLE ${Inkscape_EXECUTABLE}
CACHE FILEPATH "Path and file name of the Inkscape program." )
message( STATUS "The Inkscape vector drawing program found." )
endif( NOT Inkscape_EXECUTABLE )
endif( NOT Inkscape_FOUND )
# pngcrush is required to reduce the size of the converted PNG files.
set( pngcrush_FOUND FALSE )
if( NOT pngcrush_FOUND )
find_program( pngcrush_EXECUTABLE pngcrush DOC "The PNG size reduction program." )
if( NOT pngcrush_EXECUTABLE )
message( FATAL_ERROR "Could not find the pngcrush PNG size reduction program." )
else( NOT pngcrush_EXECUTABLE )
set( pngcrush_FOUND TRUE )
set( pngcrush_EXECUTABLE ${pngcrush_EXECUTABLE}
CACHE FILEPATH "Path and file name of the pngcrush program." )
message( STATUS "The pngcrush PNG size reduction program found." )
endif( NOT pngcrush_EXECUTABLE )
endif( NOT pngcrush_FOUND )
if( NOT KICAD_ICON_THEME )
set( KICAD_ICON_THEME "light" CACHE STRING "Name of the theme directory for icon sources" )
endif()
message( STATUS "Creating icons for ${KICAD_ICON_THEME} theme" )
file( WRITE ${BITMAP_INFO_TEMP_FILE} )
# these 3 cmake commands for each desired bitmap size set, repeat as needed:
bitmap_dir( 16 16 "${BMAPS_SMALL}" ${KICAD_ICON_THEME} )
bitmap_dir( 24 24 "${BMAPS_MID}" ${KICAD_ICON_THEME} )
bitmap_dir( 32 32 "${BMAPS_32}" ${KICAD_ICON_THEME} )
bitmap_dir( 22 22 "${BMAPS_22}" ${KICAD_ICON_THEME} )
bitmap_dir( 24 24 "${BMAPS_24}" ${KICAD_ICON_THEME} )
bitmap_dir( 64 64 "${BMAPS_64}" ${KICAD_ICON_THEME} )
bitmap_dir( 128 128 "${BMAPS_128}" ${KICAD_ICON_THEME} )
bitmap_dir( 48 48 "${BMAPS_BIG}" ${KICAD_ICON_THEME} )
generate_bitmap_info( ${BITMAP_INFO_TEMP_FILE} ${BITMAP_INFO_FILE} )
add_custom_target( generate_pngs ALL
DEPENDS ${ALL_PNGS}
COMMENT "Creating PNGs from SVGs"
)
add_custom_target( bitmap_info ALL
DEPENDS ${BITMAP_INFO_FILE}
COMMENT "Creating bitmap_info header"
)
add_dependencies( bitmap_archive generate_pngs bitmap_info )
endif( MAINTAIN_PNGS )
Reference in New Issue View Git Blame Copy Permalink