class PNG_LINK_GENERATOR

(source code)

description

Generates links in an output folder to all PNG files >= 128x128 in size.

If the PNG path has the structure

/usr/share/a/b/c/file.png

then the output path relative to /usr/share is abbreviated to

a/b/file.png

If there are icons with duplicate relative paths, then only the icon with the largest size has a link created.

note
	description: "[
		Generates links in an output folder to all PNG files >= 128x128 in size.

		If the PNG path has the structure
		
			/usr/share/a/b/c/file.png
			
		then the output path relative to `/usr/share' is abbreviated to
		
			a/b/file.png

		If there are icons with duplicate relative paths, then only the icon with the
		largest size has a link created.
	]"

	author: "Finnian Reilly"
	copyright: "Copyright (c) 2001-2022 Finnian Reilly"
	contact: "finnian at eiffel hyphen loop dot com"

	license: "MIT license (See: en.wikipedia.org/wiki/MIT_License)"
	date: "2024-09-22 16:42:51 GMT (Sunday 22nd September 2024)"
	revision: "9"

class
	PNG_LINK_GENERATOR

inherit
	EL_APPLICATION_COMMAND

	EL_MODULE_COMMAND; EL_MODULE_FILE; EL_MODULE_LIO

	EL_MODULE_OS; EL_MODULE_TRACK

create
	make

feature {EL_COMMAND_CLIENT} -- Initialization

	make (a_source_dir, a_output_dir: DIR_PATH; step_list: STRING; a_minimum_width: INTEGER)
		do
			source_dir := a_source_dir; output_dir := a_output_dir; exclude_list := step_list
			minimum_width := a_minimum_width
			output_dir.expand
			remove_step_count := source_dir.step_count.min (3)
			create size_table.make (1000)
		end

feature -- Basic operations

	execute
		local
			link_path: FILE_PATH; counter_table: EL_COUNTER_TABLE [DIR_PATH]
			size: STRING
		do
			fill_size_table

			OS.File_system.make_directory (output_dir)
			create counter_table.make (size_table.count // 10)
			across size_table as list loop
				counter_table.put (list.key.parent)
			end
			lio.put_integer_field ("Creating links", size_table.count)
			lio.put_new_line
			across size_table as list loop
				if counter_table.has_key (list.key.parent) and then counter_table.found_count.item <= 2 then
					link_path := (output_dir #+ "other") + list.key.base
				else
					link_path := output_dir + list.key
				end
				size := Dimensions #$ [list.item.width, list.item.height]
				lio.put_index_labeled_string (list, "%S. " + size, list.key.to_string)
				lio.put_new_line
				OS.File_system.make_directory (link_path.parent)
				if not link_path.exists
					and then attached Command.new_link_file (list.item.file_path, link_path) as cmd
				then
					cmd.execute
				end
			end
		end

feature {NONE} -- Implementation

	extend_size_table (file_path: FILE_PATH; size: ZSTRING)
		do
		-- Square icons > `minimum_width' in width
			if attached new_png_info (file_path, size) as png
				and then png.width >= minimum_width and then png.width = png.height
			then
				if attached new_short_path (file_path) as path then
					if size_table.has_key (path) then
						if size_table.found_item.width > png.width then
							size_table [path] := png
						end
					else
						size_table.extend (png, path)
					end
				end
			end
		end

	fill_size_table
		local
			has_small_step: EL_PREDICATE_FIND_CONDITION
		do
			has_small_step := agent path_has_small_size_step
			if attached OS.find_directories_command (source_dir) as cmd then
				cmd.set_filter (not has_small_step)
				cmd.set_follow_symbolic_links (False)
				cmd.execute
--				iterate_directories (cmd.path_list)
				Track.progress (Console_display, cmd.path_list.count, agent iterate_directories (cmd.path_list))
			end
		end

	iterate_directories (path_list: EL_ARRAYED_LIST [DIR_PATH])
		local
			index: INTEGER; png_path: FILE_PATH; str, size: ZSTRING
		do
			across path_list as list loop
				if attached Png_info_command as info_cmd then
					info_cmd.put_path (Var_path, list.item + "*.png")
					info_cmd.execute
					across info_cmd.lines as line loop
						str := line.item
						index := 1
						index := str.substring_index (Dot_png, index)
						if index > 0 then
							index := index + Dot_png.count - 1
							png_path := str.substring (1, index)
							if png_path.exists and then not File.is_symlink (png_path)
								and then across exclude_list as step all not png_path.has_step (step.item) end
								and then attached str.substring_to_from ('G', $index)
							then
								index := index + 1
--								lio.put_line (png_path)
								size := str.substring_to_from (' ', $index)
								extend_size_table (png_path, size)
							end
						end
					end
				end
				Track.progress_listener.notify_tick
			end
		end

	new_png_info (file_path: FILE_PATH; str: ZSTRING): TUPLE [file_path: FILE_PATH; width, height: INTEGER]
		do
			create Result
			Result.file_path := file_path
			if str.is_integer then
				Result.width := str.to_integer
				Result.height := Result.width
			else
				size_list.fill (str, 'x', 0)
				if attached Size_list as list and then list.count = 2 then
					from list.start until list.after loop
						if list.item_is_number then
							inspect list.index
								when 1 then
									Result.width := list.integer_32_item
							else
								Result.height := list.integer_32_item
							end
						end
						list.forth
					end
				end
			end
		end

	new_short_path (file_path: FILE_PATH): FILE_PATH
		local
			steps: EL_PATH_STEPS
		do
			steps := file_path
			if steps.count >= remove_step_count + 2 then
				steps.remove_head (remove_step_count)
				from until steps.count <= 3 loop
					steps.remove (steps.count - 1)
				end
			end
			Result := steps
		end

	path_has_small_size_step (path: ZSTRING): BOOLEAN
		do
			Result := False
			across path.split ('/') as split until Result loop
				if attached split.item as step and then attached new_png_info (Empty_path, step) as png
					and then (png.width > 0 and png.width = png.height)
					and then png.width < minimum_width
				then
					Result := True
				end
			end
		end

feature {NONE} -- Internal attributes

	exclude_list: EL_ZSTRING_LIST

	minimum_width: INTEGER

	output_dir: DIR_PATH

	remove_step_count: INTEGER

	size_table: EL_HASH_TABLE [like new_png_info, FILE_PATH]

	source_dir: DIR_PATH

feature {NONE} -- Constants

	Description: STRING = "[
		Generates links in an output folder to PNG files >= a minimum width
	]"

	Dot_png: ZSTRING
		once
			Result := ".png"
		end

	Empty_path: FILE_PATH
		once
			create Result
		end

	Png_info_command: EL_CAPTURED_OS_COMMAND
		once
			create Result.make ("identify $PATH")
		end

	Size_list: EL_SPLIT_STRING_8_LIST
		once
			create Result.make_empty
		end

	Dimensions: ZSTRING
		once
			Result := "%Sx%S"
		end

	Var_path: STRING = "PATH"

end