image_paradise 0.1.12

data/doc/TODO_FOR_THE_GTK_GUI.md

@@ -0,0 +1 @@
+- We need to add a pdf-to-png converter.

data/image_paradise.gemspec

@@ -0,0 +1,50 @@
+# =========================================================================== #
+# Gemspec for Project ImageParadise.
+# =========================================================================== #
+require 'image_paradise/version/version.rb'
+
+Gem::Specification.new { |s|
+
+  s.name    = 'image_paradise'
+  s.version = ImageParadise::VERSION
+  s.date    = Time.now.strftime('%Y-%m-%d')
+
+  DESCRIPTION = <<-EOF
+
+This project, called image_paradise, allows you to manipulate images,
+primarily by using ImageMagick.
+
+For a more complete overview, have a look at the documentation, but
+just to give an overview - it is possible to animate .gif files,
+make use of gruff, or batch-generate automatically created
+image files through confree_generator (if you have cfdg 
+installed). Images can be cropped through the toplevel method
+ImageParadise.crop(). class Optimizer can be used to optimize .jpg
+and .png files, if pngquant is installed.
+
+  EOF
+
+  s.summary     = DESCRIPTION
+  s.description = DESCRIPTION
+
+  s.extra_rdoc_files = %w()
+
+  s.authors     = ['Robert A. Heiler']
+  s.email       = 'shevegen@gmail.com'
+  s.files       = Dir['**/*']
+  s.license     = 'GPL-2.0'
+  s.executables = Dir['bin/*'].map { |f| File.basename(f) }
+  s.homepage    = 'https://rubygems.org/gems/image_paradise'
+
+  s.required_ruby_version     = '>= '+RUBY_VERSION
+  s.required_rubygems_version = '>= '+Gem::VERSION
+  s.rubygems_version          = '>= '+Gem::VERSION
+
+  # ========================================================================= #
+  # Dependencies for the project:
+  # ========================================================================= #
+  s.add_dependency 'colours'
+  s.add_dependency 'opn'
+  s.add_dependency 'save_file'
+
+}

data/lib/image_paradise.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'image_paradise/requires/require_the_image_paradise_project.rb'

data/lib/image_paradise/base/base.rb

@@ -0,0 +1,91 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'image_paradise/base/base.rb'
+# < ::ImageParadise::Base
+# =========================================================================== #
+require 'image_paradise/requires/common_base_requires.rb'
+require 'image_paradise/constants.rb'
+require 'image_paradise/toplevel_methods/esystem.rb'
+require 'image_paradise/toplevel_methods/file_related_code.rb'
+require 'image_paradise/toplevel_methods/roebe.rb'
+
+module ImageParadise
+
+class Base # === ImageParadise::Base
+
+  include Colours
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+  end
+
+  # ========================================================================= #
+  # === today
+  # ========================================================================= #
+  def today
+    "#{Time.now.strftime('%d.%m.%Y')}_#{Time.now.strftime('%H:%M:%S.%L')}"
+  end
+
+  # ========================================================================= #
+  # === rds
+  # ========================================================================= #
+  def rds(i)
+    i.squeeze('/')
+  end
+
+  # ========================================================================= #
+  # === chdir
+  # ========================================================================= #
+  def chdir(i)
+    Dir.chdir(i)
+  end
+
+  # ========================================================================= #
+  # === mkdir
+  # ========================================================================= #
+  def mkdir(i)
+    FileUtils.mkdir_p(i) unless File.directory? i
+  end
+
+  # ========================================================================= #
+  # === register_sigint
+  # ========================================================================= #
+  def register_sigint
+    Signal.trap('SIGINT') {
+      e 'Exiting now, as requested.'
+      exit
+    }
+  end
+
+  # ========================================================================= #
+  # === write_what_into
+  # ========================================================================= #
+  def write_what_into(what, into)
+    SaveFile.write_what_into(what, into)
+  end
+
+  # ========================================================================= #
+  # === esystem
+  # ========================================================================= #
+  def esystem(i)
+    ::ImageParadise.esystem(i)
+  end
+
+  # ========================================================================= #
+  # === is_on_roebe?
+  # ========================================================================= #
+  def is_on_roebe?
+    ::ImageParadise.is_on_roebe?
+  end
+
+end; end

data/lib/image_paradise/black_white.rb

@@ -0,0 +1,89 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === ImageParadise::BlackWhite
+#
+# This class can turn an image into a black-white image.
+#
+# Usage example:
+#   ImageParadise::BlackWhite.new
+# =========================================================================== #
+# require 'image_paradise/black_white.rb'
+# =========================================================================== #
+require 'image_paradise/base/base.rb'
+
+module ImageParadise
+
+class BlackWhite < ::ImageParadise::Base # === ImageParadise::BlackWhite
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    reset
+    set_input(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+  end
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(i = ARGV)
+    i = [i] unless i.is_a? Array
+    @input = i
+  end
+
+  # ========================================================================= #
+  # === input?
+  # ========================================================================= #
+  def input?
+    @input
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    input?.each {|filename|
+      _ = 'convert '+filename+' -colorspace Gray OUTPUT_'+filename
+      Esystem.esystem(_)
+    }
+  end
+
+  # ========================================================================= #
+  # === []
+  # ========================================================================= #
+  def self.[](i = '')
+    self.new(i)
+  end
+
+end
+
+# =========================================================================== #
+# === ImageParadise.black_white
+# =========================================================================== #
+def self.black_white(i = ARGV)
+  if i.is_a? Array
+    i.each {|entry|
+      ImageParadise.black_white(entry)
+    }
+  else
+    ImageParadise::BlackWhite.new(i)
+  end
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  ImageParadise::BlackWhite.new(ARGV)
+end # black_white

data/lib/image_paradise/confree_generator/class.rb

@@ -0,0 +1,614 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === ImageParadise::ConfreeGenerator
+#
+# The task of this class is to generate a .cfdg file or more than one.
+#
+# Usage examples:
+#
+#   ImageParadise::ConfreeGenerator.new(ARGV)
+#
+# =========================================================================== #
+# require 'image_paradise/confree_generator/class.rb'
+# ImageParadise.confreegenerator
+# =========================================================================== #
+require 'image_paradise/base/base.rb'
+require 'image_paradise/confree_generator/reset.rb'
+require 'image_paradise/confree_generator/shared/shared.rb'
+
+module ImageParadise
+
+class ConfreeGenerator < ::ImageParadise::Base # === ImageParadise::ConfreeGenerator
+
+  begin
+    require 'web_object/toplevel_methods/standalone_drag_and_drop_this_image.rb'
+  rescue LoadError; end
+
+  begin
+    require 'html_tags' # For .html generation.
+    include HtmlTags
+  rescue LoadError; end
+
+  include ImageParadise::ConfreeGenerator::Shared # This one is part of shared/shared.rb
+
+  attr_accessor :n_confree_files # How many confree files we will process.
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    register_sigint
+    reset
+    set_input(i)
+    if block_given?
+      yielded = yield
+      case yielded
+      # ===================================================================== #
+      # === :do_not_open_via_the_browser
+      # ===================================================================== #
+      when :do_not_open_via_the_browser
+        @try_to_open_the_generated_image_in_the_browser = false
+      end
+    end
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === name_of_output_file?
+  # ========================================================================= #
+  def name_of_output_file?
+    ConfreeGenerator::NAME_OF_OUTPUT_FILE
+  end
+
+  # ========================================================================= #
+  # === set_location_of_output_file
+  #
+  # This tells us where we store the output file.
+  # ========================================================================= #
+  def set_location_of_output_file(
+      i = DIRECTORY_WITH_CFDG_IMAGES+name_of_output_file?
+    )
+    i = DIRECTORY_WITH_CFDG_IMAGES+name_of_output_file? if i.nil?
+    i = Dir.pwd+'/'+i unless i.include? '/'
+    @location_of_output_file = i
+  end; alias set_output_location set_location_of_output_file # === set_output_location
+       alias set_output          set_location_of_output_file # === set_output
+
+  # ========================================================================= #
+  # === br
+  # ========================================================================= #
+  def br
+    HtmlTags.br
+  end
+
+  # ========================================================================= #
+  # === random_name
+  #
+  # This method will return a string which consists of the input-string
+  # and 8 more random characters. We assume that for 8 random characters,
+  # there will be no double names.
+  # 
+  # The result of this method is, for instance:
+  #    "tube_map_jblhelce.png"
+  # ========================================================================= #
+  def random_name(i)
+    copy = i.to_s.dup
+    alphabet = ALPHABET # Build up the alphabet.
+    copy.gsub!(/\.cfdg/,'') # Don't like file ending here.
+    copy = File.basename(copy).dup
+    copy << '_'
+    10.times { copy << alphabet.sample }
+    return copy
+  end
+
+  # ========================================================================= #
+  # === eparse
+  # ========================================================================= #
+  def eparse(i)
+    Colours.eparse(i)
+  end
+
+  # ========================================================================= #
+  # === toggle_generate_image
+  #
+  # This toggle switches between when we want to generate the image,
+  # and when we don't. 
+  # ========================================================================= #
+  def toggle_generate_image
+    if generate_the_image?
+      e 'Setting to false - dont create images.'
+    else
+      e 'Setting to true - do create images.'
+    end
+    @generate_the_image = ! @generate_the_image
+  end; alias change_flag toggle_generate_image # === change_flag
+
+  # ========================================================================= #
+  # === generate_the_image?
+  # ========================================================================= #
+  def generate_the_image?
+    @generate_the_image
+  end
+
+  # ========================================================================= #
+  # === show_welcome_message
+  # ========================================================================= #
+  def show_welcome_message
+    opnn; efancy ' => Starting the Confreegenerator now.'
+    opnn; e 'Welcome!'
+  end
+
+  # ========================================================================= #
+  # === check_whether_cfdg_is_installed
+  # ========================================================================= #
+  def check_whether_cfdg_is_installed
+    _ = `cfdg 2>&1` # => "sh: cfdg: command not found\n"
+    if _.include? 'cfdg: command not found'
+      e 'Note that you do not seem to have cfdg installed.'
+      e 'We will still continue nonetheless.'
+    end
+  end
+
+  # ========================================================================= #
+  # === start_gui                                                   (gui tag)
+  #
+  # This method will start the GUI component.
+  # ========================================================================= #
+  def start_gui
+    require 'confreegenerator/gui/gtk_confree_generator.rb'
+    @gtk_confreegenerator = GtkConfreeGenerator.new
+  end
+
+  # ========================================================================= #
+  # === check_input_given                                          (menu tag)
+  #
+  # Usage examples:
+  #
+  #   confgen change_flag
+  #
+  # Regular use:
+  #
+  #   rfree $CFDG/spiral_star.cfdg
+  #   rfree $CFDG/star.cfdg
+  #
+  # ========================================================================= #
+  def menu
+    _ = @input.shift # Return the first element and also remove it.
+    case _ # case tag
+    # ======================================================================= #
+    # === confree_generator --batch
+    # ======================================================================= #
+    when /^-?-?batch$/,
+         'batchmode','b','2'
+      run_in_batch_mode
+    # ======================================================================= #
+    # === confree_generator --html
+    # ======================================================================= #
+    when /^-?-?html$/i,
+         /^-?-?html(_|-)?gallery$/i,
+         'gallery','default','4'
+      create_html_gallery # Always create the html gallery.
+    # ======================================================================= #
+    # === confree_generator --gui
+    # ======================================================================= #
+    when /^-?-?gui$/i,'startgui','start_gui','3'
+      start_gui
+    # ======================================================================= #
+    # === confree_generator --toggle
+    # ======================================================================= #
+    when '--toggle','change','change_flag','c','flag','f','fl',
+         'fla','generate_image','toggle','1'
+      toggle_generate_image
+    # ======================================================================= #
+    # === confree_generator --gallery_only
+    # ======================================================================= #
+    when '--gallery_only','gallery_only'
+      @create_image = false # We skip creating the images anew.
+      create_html_gallery
+    # ======================================================================= #
+    # === confree_generator --help
+    # ======================================================================= #
+    when 'HELP','help','--help'
+      show_help; exit
+    else # else tag
+      set_input(_)
+      show_welcome_message
+      create_html_gallery if @create_html_gallery
+    end
+  end; alias check_input_given menu # === check_input_given
+
+  # ======================================================================= #
+  # === set_width_then_height
+  #
+  # This method will first set the width, then the height.
+  # ======================================================================= #
+  def set_width_then_height(
+      width  = 55,
+      height = nil
+    )
+    height = width if height.nil?
+    set_width(width)
+    set_height(height)
+  end
+
+  # ========================================================================= #
+  # === append_to_html_file
+  #
+  # Use this method to append into a html file.
+  # ========================================================================= #
+  def append_to_html_file(i = nil)
+    append_what_into(i, html_file?) if i
+  end; alias my_append append_to_html_file # === my_append
+
+  # ========================================================================= #
+  # === html_file?
+  # ========================================================================= #
+  def html_file?
+    @html_file
+  end
+
+  # ========================================================================= #
+  # === start_batch_processing                                    (batch tag)
+  # ========================================================================= #
+  def start_batch_processing
+    @file_listing = get_all_cfdg_files
+    # Let's order it randomly:
+    @file_listing = @file_listing.sort_by { rand }
+    # Obtain how many we have:
+    @n_confree_files = @file_listing.size
+    set_input @file_listing
+    @input.each {|entry|
+      _ = TEMP_IMAGES+random_name(entry)+'.png'
+      e _
+      set_output_location(_)
+      create_image_from_cfdg(entry)
+    }
+  end
+
+  # ========================================================================= #
+  # === run_in_batch_mode
+  # ========================================================================= #
+  def run_in_batch_mode
+    @batch_mode = true
+  end
+
+  # ========================================================================= #
+  # === create_html_gallery                  (html tag, img tag, gallery tag)
+  #
+  # Run this method here to create the HTML gallery.
+  #
+  # To invoke this method from the commandline, try:
+  #
+  #   confree_generator --html
+  #
+  # ========================================================================= #
+  def create_html_gallery
+    ::ImageParadise.remove_file(html_file?) # Always ensure that the html_file was removed.
+    opnn; e "We will save into `#{sfile(html_file?)}`."
+    mkdir(File.dirname(html_file?))
+    _ = '<html>'.dup
+    _ << '<title>'+html_file?+' CFDG Image Collection'+'</title>'
+    _ << HtmlTags.body
+    # ======================================================================= #
+    # After here, we have added <html>, <title> and <body>
+    # ======================================================================= #
+    append_to_html_file(_)
+    img_counter = 0
+    if @create_image
+      these_files = get_all_cfdg_files
+    else
+      these_files = Dir[save_files_where?+'*.png']
+    end
+    be_verbose = @create_image
+    # ======================================================================= #
+    # Next, we add all the images that we found:
+    # ======================================================================= #
+    these_files.each {|cfdg_file|
+      if @create_image
+        _ = TEMP_IMAGES+random_name(cfdg_file)+'.png'
+      else
+        _ = cfdg_file
+      end
+      set_output_location(_)
+      if @create_image
+        opnn; e 'Now processing file `'+sfile(cfdg_file)+'` into `'+sfile(_)+'`.'
+      end
+      img_counter += 1 # at which img pos are we?
+      @n_confree_files += 1 
+      tmp_var = img_counter % 9
+      set_width_then_height(320) # This is the same size for both.
+      create_image_from_cfdg_file(cfdg_file, true) if @create_image
+      # ===================================================================== #
+      # Next we will create the file, but we will store it into a html table.
+      # Data points 1,2,3 - 4,5,6 -7,8,9 come into a table.
+      # ===================================================================== #
+      case tmp_var # case tag
+      when 0
+        my_append(TD+N)
+        write_entry( i.sub(/\/Users\/x\/DATA\/IMG/,'$IMG'),
+          img_counter,  be_verbose )
+        my_append(ctd)
+        my_append(ctr+N+N)
+        my_append(ctable+N+N)
+        # Reset the img_counter every 9 iteration.
+        img_counter = 0
+      when 1
+        my_append(TABLE+TR+TD+N)
+        write_entry(cfdg_file, img_counter, be_verbose)
+        my_append(ctd)
+      when 3,6
+        _ = td+cfdg_file+img_counter.to_s+ctd+
+            ctr+N+N+tr
+        my_append(_)
+      else # bei 2,4,5,7,8
+        my_append(TD+N)
+        write_entry(cfdg_file, img_counter, be_verbose)
+        my_append(ctd)      
+      end
+    }
+    # ======================================================================= #
+    # Last but not least, we close the table.
+    # ======================================================================= #
+    my_append(ctr)
+    my_append(ctable)
+    my_append(br+'Find more examples ')
+    my_append('<a href="http://chriscoyne.com/gallery/view.php"><b>here</b></a>')
+    my_append(br+' '+@n_confree_files.to_s+' images files should be listed here.'+N)
+    my_append(br+cbody+chtml)
+    opnn; e "Finished appending into `#{sfile(html_file?)}`."
+  end
+
+  # ========================================================================= #
+  # === save_files_where?
+  # ========================================================================= #
+  def save_files_where?
+    TEMP_IMAGES
+  end
+
+  # ========================================================================= #
+  # === opnn
+  # ========================================================================= #
+  def opnn
+    Opn.opn(namespace: NAMESPACE)
+  end
+
+  # ========================================================================= #
+  # === show_help                                                  (help tag)
+  #
+  # To invoke this help menu, do:
+  #
+  #   congen HELP
+  #
+  # ========================================================================= #
+  def show_help
+    e
+    e ::Colours::YEL+'Currently this script has this usage:'+::Colours.rev
+    e
+    eparse '  confreegen name_of_cfdg_file.cfdg'
+    e
+    eparse '  toggle       # Toggle whether we want to create the image or not.'
+    eparse '  batch        # run everything in batch mode (batch processing)'
+    eparse '  gallery_only # generate only the gallery'
+    eparse '  html         # create a html gallery'
+    eparse '  gui          # start the GUI component of this project'
+    e
+  end
+
+  # ========================================================================= #
+  # === write_entry
+  #
+  # A helper method to log stuff into the html file. We use the project
+  # HtmlTags for the html here.
+  # ========================================================================= #
+  def write_entry(
+      i, counter = 0, be_verbose = true
+    )
+    my_append(
+      HtmlTags.comment(counter.to_s)
+    )
+    my_append(
+      span('The CFDG-File Name is:','','','font-size:0.95em')+br+N
+    ) if be_verbose
+    my_append(
+      b(i)+br+N
+    )
+    # ======================================================================= #
+    # Add the <img> tag here.
+    # ======================================================================= #
+    id_for_this_image_file = File.basename(@location_of_output_file).
+                             sub(/#{File.extname(@location_of_output_file)}$/,'')
+    my_append(
+      N+N+img( # <- This will actually call HtmlTags.img().
+        @location_of_output_file,
+        '','','margin:5px; border:1px solid black;'
+      )+
+      WebObject.standalone_drag_and_drop_this_image(id_for_this_image_file)+
+      N # img tag here.
+    )
+  end
+
+  # ========================================================================= #
+  # === process_input                                           (process tag)
+  #
+  # This method will process the .cfdg file at hand.
+  # ========================================================================= #
+  def process_input(
+      i = @input
+    )
+    if @batch_mode # Run all images here.
+      start_batch_processing
+    else
+      unless i.empty?
+        e ' => Processing the given input next.'
+        i.each_with_index {|entry, index| index += 1
+          opnn; e ("#{index})").rjust(4)+' '+entry
+          create_image_from_cfdg(entry)
+        }
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === create_image_from_cfdg                                   (system tag)
+  #
+  # This is the method that will shell out to "cfdg" and actually create
+  # the image in question. Additionally, we may also optimize the
+  # generated .png file, via "pngquant", to minimize the size.
+  # ========================================================================= #
+  def create_image_from_cfdg(
+      i,
+      generate_the_image = @generate_the_image
+    )
+    if File.exist? i
+      scan_this_file_for_width_and_height_values(i)
+    end
+    _ = 'cfdg '+i.to_s
+    _ << ' -b 1' # This means border size. For now this is hardcoded.
+    _ << ' -w '+@height.to_s
+    _ << ' -h '+@width.to_s
+    # _ << '-a 10'
+    _ << ' '+@location_of_output_file
+    e _
+    if generate_the_image
+      system(_)
+      # ===================================================================== #
+      # === Optimize via pngquant
+      # ===================================================================== #
+      if OPTIMIZE_PNG_FILES
+        # =================================================================== #
+        # Do a bit of clean-up first:
+        # =================================================================== #
+        # _ = 'output-fs8.png'
+        # File.delete(_) if File.exist? _
+        # =================================================================== #
+        # Optimize the generated .png file.
+        # =================================================================== #
+        optimize_string = 'pngquant '+@location_of_output_file
+        e "Next running #{sfancy('pngquant')} to reduce the size "\
+          "of the .png file at hand."
+        e
+        e sfancy("  #{optimize_string}")
+        e
+        system(optimize_string)
+      end
+      if @try_to_open_the_generated_image_in_the_browser
+        if File.exist? @location_of_output_file
+          require 'open_in_browser'
+          OpenInBrowser[@location_of_output_file]
+        end
+      end
+    end
+  end; alias create_image_from_cfdg_file create_image_from_cfdg # === create_image_from_cfdg_file
+
+  # ========================================================================= #
+  # === scan_this_file_for_width_and_height_values
+  # ========================================================================= #
+  def scan_this_file_for_width_and_height_values(i)
+    File.readlines(i).each {|line|
+      if    line.include? ' WIDTH: '
+        # =================================================================== #
+        # Set the width next:
+        # =================================================================== #
+        set_width(line.delete('#:').strip.sub(/WIDTH/,''))
+      elsif line.include? ' HEIGHT: '
+        # =================================================================== #
+        # Set the height next:
+        # =================================================================== #
+        set_height(line.delete('#:').strip.sub(/HEIGHT/,''))
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === set_height
+  # ========================================================================= #
+  def set_height(i)
+    if i.is_a? String
+      i = i.dup if i.frozen?
+      i.strip!
+    end
+    @height = i.to_i
+  end
+
+  # ========================================================================= #
+  # === set_width
+  # ========================================================================= #
+  def set_width(i)
+    if i.is_a? String
+      i = i.dup if i.frozen?
+      i.strip!
+    end
+    @width = i.to_i
+  end
+
+  # ========================================================================= #
+  # === set_input
+  #
+  # Whenever this is called, we immediately run sanitize_input.
+  # ========================================================================= #
+  def set_input(i = '')
+    unless i.is_a? Array # We want an array here.
+      i = [i.to_s]
+    end
+    @input = i # <- This is typically a .cfdg file such as "moon_explorations.cfdg"
+    sanitize_input
+  end
+
+  # ========================================================================= #
+  # === sanitize_input                                         (sanitize tag)
+  # ========================================================================= #
+  def sanitize_input
+    @input.map! {|entry|
+      entry = get_random_cfdg_file if entry == 'RANDOM' # Turn RANDOM into something meaningful here.
+      entry = entry.dup if entry.frozen?
+      unless entry.end_with? '.cfdg'
+        entry << '.cfdg'
+      end
+      unless File.exist? entry
+        try_this_target = "#{HARDCODED_PATH_TO_THE_CFDG_IMAGES_DIRECTORY}#{entry}"
+        if File.exist?(try_this_target)
+          entry = try_this_target
+        end
+      end
+      entry
+    }
+    @input.flatten!
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    check_whether_cfdg_is_installed
+    check_input_given
+    process_input
+  end
+
+end
+
+# =========================================================================== #
+# === ImageParadise.confreegenerator
+# =========================================================================== #
+def self.confreegenerator(
+    i = ARGV
+  )
+  ::ImageParadise::ConfreeGenerator.new(i)
+end
+
+# =========================================================================== #
+# === ImageParadise.batch_generate_the_cfdg_files
+# =========================================================================== #
+def self.batch_generate_the_cfdg_files
+  ::ImageParadise::ConfreeGenerator.new('--batch')
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  ImageParadise::ConfreeGenerator.new(ARGV)
+end # confree_generator