# This program source code file is part of KICAD, a free EDA CAD application. # # Copyright (C) 2011 SoftPLC Corporation, Dick Hollenbeck # 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. # Plan for three sizes of bitmaps: # SMALL - for menus - 16 x 16 # MID - for toolbars - 26 x 26 # BIG - for program icons - 48 x 48 # which are given on three basename lists: BMAPS_SMALL, BMAPS_MID,a nd 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 folder 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_noconnect question_mark refresh small_down small_edit small_library small_plus small_up trash tree_nosel tree_sel visibility visibility_off www ) # image basenames that go into the toolbar sized destinations, i.e. 26x26 set( BMAPS_MID about add_arc add_board add_bus2bus add_bus add_circle add_component add_corner add_dashed_line add_dimension add_document add_gerber add_glabel add_graphical_segments add_graphical_polygon add_hierarchical_label add_hierar_pin add_hierarchical_subsheet add_junction add_keepout_area add_library add_line2bus add_line_label add_line add_pcb_target add_power add_rectangle 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_associe auto_delete_track auto_track_width autoplace_fields axis3d_back axis3d_bottom axis3d_front axis3d_left axis3d_right axis3d_top axis3d bitmap2component bom break_bus break_line browse_files bus_definition_tool calculator cancel change_entry_orient change_lib_symbols_in_schematic contrast_mode curved_ratsnest create_cmp_file checked_ok color_materials component_select_unit component_select_alternate_shape config copy copy_pad_settings copper_layers_setup cursor_shape cursor custom_pad_to_primitives cut cvpcb datasheet delete_association delete_gerber delete_sheet delete directory directory_browser display_options distribute_horizontal distribute_vertical down drag drag_segment_withslope drc_off drc duplicate edit_comp_footprint edit_comp_ref edit_comp_value edit_module editor edit_cmp_symb_links edit_text edit edge_to_copper_clearance eeschema enter_sheet ercerr erc_green ercwarn erc exit exchange export3d export_dsn export_idf export_footprint_names export_module export_part export_step export fabrication file_footprint fill_zone find find_replace flag flag_remove flip_board fonts footprint_text gbr_select_mode0 gbr_select_mode1 gbr_select_mode2 gerber_file gerber_job_file gerbview_show_negative_objects gerbview_drill_file gerbview_clear_layers general_deletions general_ratsnest go_down go_up green grid_select grid_select_axis grid hammer help hidden_pin hierarchy_nav highlight_remove hotkeys hole_to_hole_clearance html icon icon_cvpcb_small icon_gerbview_small 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 invisible_text kicad_icon_small label language layers_manager leave_sheet left libedit lib_next lib_previous library_browse library_archive library_archive_as library library_table lines90 list_nets load_gerber load_module_board local_ratsnest lock_unlock locked measurement minus pcb_target mirror_h mirror_v mode_module mode_track module_check module_editor module_wizard module_filtered_list module_full_list module_options module_pin_filtered_list module_library_list module_name_filtered_list module modview_icon morgan1 morgan2 move_exactly move move_relative mw_add_gap mw_add_line mw_add_shape mw_add_stub_arc mw_add_stub mw_toolbar net_highlight net_highlight_schematic netlist net_locked net_unlocked new_board new_component new_cvpcb new_document new_footprint new_library new_generic new_page_layout new_project new_project_with_template noconn normal online_help 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_load pagelayout_normal_view_mode pagelayout_special_view_mode palette part_properties paste pcbnew pcbcalculator pcb_offset pin2pin pin_size_to pin_show_etype pin_table pin plot plot_svg plus polar_coord post_compo post_drill post_module preference primitives_to_custom_pad print_button ps_router ps_diff_pair ps_diff_pair_gap ps_diff_pair_tune_length ps_diff_pair_tune_phase ps_diff_pair_via_gap ps_tune_length push_pad_settings py_script ratsnest read_setup recent redo red reload2 reload render_mode reset_text resize_sheet 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_neg_x rotate_pos_x rotate_neg_y rotate_pos_y rotate_neg_z rotate_pos_z save_as save_symbol_to_schematic save_fp_to_board save select_grid 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 sim_settings search_tree setcolor_3d_bg setcolor_silkscreen setcolor_soldermask setcolor_solderpaste setcolor_copper setcolor_board_body show_dcodenumber show_footprint show_mod_edge show_graphics_mode 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 spreadsheet svg_file swap_layer switch_corner_rounding_shape text text_sketch three_d tool_ratsnest tools track_locked track_sketch track_unlocked undelete undo unit_inch unit_mm unknown unlocked unzip up update_fields update_pcb_from_sch update_sch_from_pcb update_lib_symbols_in_schematic use_3D_copper_thickness via via_annulus via_buried via_microvia via_sketch via_diameter via_hole_diameter warning width_track_via width_track wizard_add_fplib_small zip zone_duplicate zone_fillet zone_unfill zoom zoom_area zoom_auto_fit_in_page zoom_fit_in_page zoom_center_on_screen zoom_in zoom_out zoom_redraw zoom_selection ) # 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_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 viewlibs_icon icon_pagelayout_editor wizard_add_fplib_icon ) set( BMAPS_OTHER 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 false ) 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() get_filename_component( bmn ${inputFile} NAME_WE ) 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} # 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() get_filename_component( bmn ${inputFile} NAME_WE ) 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}/PNG2cpp.cmake DEPENDS ${inputFile} ${CMAKE_MODULE_PATH}/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 ) set( cppDir "${CMAKE_CURRENT_SOURCE_DIR}/cpp_${pngHeight}" ) set( pngDir "${CMAKE_CURRENT_SOURCE_DIR}/png_${pngHeight}" ) file( MAKE_DIRECTORY ${pngDir} ${cppDir} ) #file( REMOVE_RECURSE ${TMP_DIR} ) file( MAKE_DIRECTORY ${TMP_DIR} ) #svg2png( inputFile outFile pngWidth pngHeight ) foreach( bmn ${bmapList} ) set( pngFile "${pngDir}/${bmn}.png" ) set( cppFile "${cppDir}/${bmn}.cpp" ) set( tmpFile "${TMP_DIR}/${bmn}.png" ) #svg2png( inputFile outFile pngWidth pngHeight ) svg2png( ${CMAKE_CURRENT_SOURCE_DIR}/sources/${bmn}.svg ${tmpFile} ${pngWidth} ${pngHeight} ) #png2png( inputFile outFile ) png2png( ${tmpFile} ${pngFile} ) #png2cpp( inputFile outFile ) png2cpp( ${pngFile} ${cppFile} ) endforeach() endfunction() 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 ) # these 3 cmake commands for each desired bitmap size set, repeat as needed: bitmap_dir( 16 16 "${BMAPS_SMALL}" ) bitmap_dir( 26 26 "${BMAPS_MID}" ) bitmap_dir( 48 48 "${BMAPS_BIG}" ) endif( MAINTAIN_PNGS ) #message( "CPP_LIST: ${CPP_LIST}" ) # a target with no output, just so changes get built #add_custom_target( make_cpp_files ALL DEPENDS ${CPP_LIST} ) set( CPP_LIST "" ) foreach( bmn ${BMAPS_SMALL} ) #message( "library add cpp_16/${bmn}.cpp" ) list( APPEND CPP_LIST cpp_16/${bmn}.cpp ) endforeach() foreach( bmn ${BMAPS_MID} ) #message( "library add cpp_26/${bmn}.cpp" ) list( APPEND CPP_LIST cpp_26/${bmn}.cpp ) endforeach() foreach( bmn ${BMAPS_BIG} ) #message( "library add cpp_48/${bmn}.cpp" ) list( APPEND CPP_LIST cpp_48/${bmn}.cpp ) endforeach() foreach( bmn ${BMAPS_OTHER} ) #message( "library add cpp_other/${bmn}.cpp" ) list( APPEND CPP_LIST cpp_other/${bmn}.cpp ) endforeach() #add_library( bitmaps SHARED ${CPP_LIST} ) add_library( bitmaps STATIC ${CPP_LIST} ) target_include_directories( bitmaps PUBLIC include )