Module: ICO

Extended by:
ICO
Included in:
ICO
Defined in:
lib/ico.rb,
lib/ico/utils.rb,
lib/ico/version.rb,
lib/ico/icon_dir.rb,
lib/ico/icon_image.rb,
lib/ico/icon_dir_entry.rb

Overview

See Also:

Defined Under Namespace

Modules: Utils Classes: IconDir, IconDirEntry, IconImage

Constant Summary collapse

VERSION = 
'0.1.2'

Instance Method Summary collapse

Instance Method Details

#new(filename_array) ⇒ BitStruct

create ICO object

Parameters:

  • filename_array (String, Array<String>) —

    filename, or array of filenames

Returns:

  • (BitStruct)

Raises:

  • (ArgumentError) 


26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/ico.rb', line 26

def new(filename_array)
  raise ArgumentError unless (filename_array.is_a?(Array) || filename_array.is_a?(String))

  # ensure non-nested array
  fn_array = [filename_array].flatten

  # ensure .png extensions
  raise "more than PNG format files in #{filename_array.inspect}" if ICO::Utils.contains_other_than_ext?(fn_array, :png)

  fn_array_length       = fn_array.length
  icon_dir              = ICO::IconDir.new
  icon_dir.image_count  = fn_array.length
  offset                = ICO::IconDir::LENGTH_IN_BYTES + (fn_array_length * ICO::IconDirEntry::LENGTH_IN_BYTES)
  entries               = Array.new(fn_array_length) {ICO::IconDirEntry.new}
  images                = Array.new(fn_array_length) {ICO::IconImage.new}
  # reorder by image size
  images_array          = ICO::Utils.sizes_hash(fn_array, true, true).values

  images_array.each_with_index do |fn,i| 
    img                 = ChunkyPNG::Image.from_file(fn)
    #img_hash            = BMP::Utils.parse_image(img, ICO::IconImage::HEADER_SIZE_IN_BYTES)
    img_hash            = BMP::Utils.parse_image(img)
    mask_size           = img_hash[:image_width] * 4
    mask                = "\x00\x00\x00\x00" * img_hash[:image_width]
    image_size          = (img_hash[:image_width] * img_hash[:image_height] * 4) + mask_size
    file_size           = image_size + ICO::IconImage::HEADER_SIZE_IN_BYTES 

    entry               = entries[i]
    entry.width         = img_hash[:image_width] 
    entry.height        = img_hash[:image_height] 
    entry.bytes_in_res  = file_size
    entry.image_offset  = offset

    image               = images[i]
    image.width         = img_hash[:image_width]
    image.height        = (img_hash[:image_height] * 2)
    image.size_image    = image_size
    image.data          = img_hash[:pixel_array] + mask

    offset              += file_size
  end

  # IconDirEntry + IconImage section as binary data string
  icon_dir.data         =  entries.join + images.join

  icon_dir
end

#png_resize_to_ico(input_filename, sizes_array, output_filename) ⇒ String

PNG to resized PNGs to ICO

Parameters:

  • input_filename (String) —

    “/path/to/example.png”

  • sizes_array (Array<Array<Integer,Integer]>) —

    , Array<Integer>]

    rectangles use Array with XY: ‘[x,y]` squares use single Integer N mixed indices is valid example: `[24, [24,24], [480,270], 888] # a => 24x24; a => 24x24; a => 480x270; a => 888x888`

  • output_filename (String) —

    “/path/to/example.ico”

Returns:

  • (String) —

    filename of generated ico



107
108
109
110
111
 
# File 'lib/ico.rb', line 107

def png_resize_to_ico(input_filename, sizes_array, output_filename)
  output_dir = ICO::Utils.png_to_sizes(input_filename, sizes_array)
  filename_array = Dir.glob(File.join(output_dir, '**/*'))
  png_to_ico(filename_array, output_filename)
end

#png_to_ico(filename_array, output_filename, overwrite = false) ⇒ String

PNG to ICO

Parameters:

  • input_filename (Array<String>, String) —

    “/path/to/example.png” OR [“/path/to/example.png”, …]

  • output_filename (String) —

    “/path/to/example_generated.ico”

Returns:

  • (String) —

    filename of generated ico



80
81
82
83
84
85
86
87
88
 
# File 'lib/ico.rb', line 80

def png_to_ico(filename_array, output_filename, overwrite=false)
  ico =  ICO.new(filename_array)
  
  unless overwrite
    raise "File exists: #{output_filename}" if File.exist?(output_filename)
  end

  IO.write(output_filename, ico) 
end

#png_to_ico!(filename_array, output_filename) ⇒ Object

PNG to ICO force overwrite output_filename



92
93
94
 
# File 'lib/ico.rb', line 92

def png_to_ico!(filename_array, output_filename)
  png_to_ico(filename_array, output_filename, true)
end