pdf_paradise 0.3.20

data/lib/pdf_paradise/gui/universal_widgets/statistics_widget/statistics_widget.rb

@@ -0,0 +1,407 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === PdfParadise::GUI::UniversalWidgets::StatisticsWidget
+#
+# Usage example:
+#
+#   PdfParadise::GUI::UniversalWidgets::StatisticsWidget.new(ARGV)
+#
+# =========================================================================== #
+# require 'pdf_paradise/gui/universal_widgets/statistics_widget/statistics_widget.rb'
+# =========================================================================== #
+require 'pdf_paradise/base/base.rb'
+
+module PdfParadise
+
+module GUI
+
+module UniversalWidgets
+
+class StatisticsWidget < ::PdfParadise::Base # === PdfParadise::GUI::UniversalWidgets::StatisticsWidget
+
+  require 'universal_widgets/base_module/base_module.rb'
+  include ::UniversalWidgets::BaseModule
+
+  require 'pdf_paradise/utility_scripts/pdf_file_n_total_pages.rb'
+  require 'pdf_paradise/toplevel_methods/automatic_pdf_title.rb'
+  require 'pdf_paradise/toplevel_methods/query_pdf_title.rb'
+
+  # ========================================================================= #
+  # === TITLE
+  # ========================================================================= #
+  TITLE = 'Show statistics about the .pdf file at hand'
+
+  # ========================================================================= #
+  # === FONT_SIZE
+  # ========================================================================= #
+  FONT_SIZE = 18
+
+  # ========================================================================= #
+  # === USE_THIS_FONT
+  # ========================================================================= #
+  USE_THIS_FONT = "Liberation serif #{FONT_SIZE}"
+
+  # ========================================================================= #
+  # === USE_THIS_FONT_FOR_THE_DISPLAY_AREA
+  # ========================================================================= #
+  USE_THIS_FONT_FOR_THE_DISPLAY_AREA = 'DejaVu Sans Mono 18' # :hack_18
+
+  # ========================================================================= #
+  # === WIDTH
+  # ========================================================================= #
+  WIDTH = '95% or minimum 1820px'
+
+  # ========================================================================= #
+  # === HEIGHT
+  # ========================================================================= #
+  HEIGHT = '35% or minimum 840px'
+
+  # ========================================================================= #
+  # === LARGER_FONT
+  # ========================================================================= #
+  LARGER_FONT   = :hack_24
+
+  # ========================================================================= #
+  # === SMALLER_FONT
+  # ========================================================================= #
+  SMALLER_FONT  = :hack_28
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    super(:vertical) if use_gtk3?
+    determine_the_GUI_to_be_used(commandline_arguments) # This must come first, even before reset().
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super() if respond_to?(:super)
+    reset_the_base_module
+    reset_the_internal_variables
+    infer_the_namespace
+    # ======================================================================= #
+    # === @configuration
+    # ======================================================================= #
+    @configuration = [true, __dir__, namespace?]
+    # ======================================================================= #
+    # === Set the title, width, height and the font in use.
+    # ======================================================================= #
+    title_width_height_font(TITLE, WIDTH, HEIGHT, USE_THIS_FONT)
+    if use_gtk3?
+      append_project_css_file 
+      use_gtk_paradise_project_css_file
+    end  
+    infer_the_size_automatically
+  end
+
+  # ========================================================================= #
+  # === do_create_a_new_file_chooser_dialog_and_then_set_the_main_entry_to
+  # ========================================================================= #
+  def do_create_a_new_file_chooser_dialog_and_then_set_the_main_entry_to(
+      i = main_file?.to_s
+    )
+    create_a_new_file_chooser_dialog(parent_widget?) {{
+      filter:             '.pdf',
+      additional_folders: '/Depot/j/',
+      start_directory:    '/Depot/'
+    }}
+    _ = assigned_main_file?.to_s
+    if _ and !_.empty?
+      main_entry?.set_text(_)
+      do_analyse_the_pdf_file
+    end
+  end
+
+  # ========================================================================= #
+  # === create_skeleton                            (create tag, skeleton tag)
+  # ========================================================================= #
+  def create_the_skeleton
+    create_the_entries
+    create_the_buttons
+    # ======================================================================= #
+    # === @label
+    #
+    # This label-widget resides on the bottom of the application.
+    # ======================================================================= #
+    @label = left_aligned_label
+    @label.set_font(USE_THIS_FONT_FOR_THE_DISPLAY_AREA)
+
+    @label.make_selectable
+    @hbox_containing_the_entry = create_hbox
+
+    @arrow_right = emoji(:arrow_right)
+    @event_box_arrow_right = create_eventbox(@arrow_right)
+    @event_box_arrow_right.on_clicked {
+      do_create_a_new_file_chooser_dialog_and_then_set_the_main_entry_to(main_file?)
+    }
+    @hbox_containing_the_entry.minimal(
+      @event_box_arrow_right
+    )
+    @hbox_containing_the_entry.maximal(@gtk_entry)
+  end
+
+  # ========================================================================= #
+  # === parent_widget?
+  # ========================================================================= #
+  def parent_widget?
+    @commandline_arguments.first
+  end
+
+  # ========================================================================= #
+  # === create_the_buttons                          (buttons tag, button tag)
+  # ========================================================================= #
+  def create_the_buttons
+    # ======================================================================= #
+    # === @button_choose_file
+    # ======================================================================= #
+    @button_choose_file = file_chooser_button
+    @button_choose_file.hint = 'Click on this button to open a '\
+      'local <b>.pdf</b> file.'
+    @button_choose_file.on_hover(:lightgreen)
+    @button_choose_file.on_clicked {
+      do_create_a_new_file_chooser_dialog_and_then_set_the_main_entry_to(main_file?)
+    }
+    # ======================================================================= #
+    # === @button_analyse
+    # ======================================================================= #
+    @button_analyse = button('_Analyse the .pdf file')
+    @button_analyse.on_hover(:lightgreen)
+    @button_analyse.hint =
+      'Click this button to obtain some information about '\
+      'the .pdf file at hand.'
+    @button_analyse.on_clicked {
+      do_analyse_the_pdf_file
+    }
+    # ======================================================================= #
+    # === @button_auto_title
+    # ======================================================================= #
+    @button_auto_title = button('Automatic Title')
+    @button_auto_title.hint = 'Click on this button to automatically '\
+      'determine the title for this .pdf file, based on the filename.'
+    @button_auto_title.on_clicked {
+      do_automatically_determine_the_title_for_the_pdf_file_at_hand
+    }
+    # ======================================================================= #
+    # === @button_open_via_a_pdf_reader
+    # ======================================================================= #
+    @button_open_via_a_pdf_reader = button('_Open via a pdf-reader', self, :use_mnemonics) {
+      :do_open_the_local_pdf_file_in_the_pdf_reader
+    }
+    @button_open_via_a_pdf_reader.hint = 'This will open the '\
+                                         '.pdf file in a pdf-reader.'
+    return_all_buttons.each {|this_button|
+      this_button.bblack1
+    }
+    @button_auto_title.bblack3
+  end
+
+  # ========================================================================= #
+  # === main_entry?
+  # ========================================================================= #
+  def main_entry?
+    @gtk_entry
+  end
+
+  # ========================================================================= #
+  # === connect_the_skeleton                                    (connect tag)
+  # ========================================================================= #
+  def connect_the_skeleton
+    abort_on_exception
+
+    outer_vbox = create_vbox
+    
+    _ = top_bar
+    _.add(@button_auto_title)
+    _.add(@button_open_via_a_pdf_reader)
+    outer_vbox.minimal(_)
+    outer_vbox.minimal(
+      left_aligned_label(
+        'This small widget will show some information about '\
+        'the .pdf file at hand.'
+      ), 8
+    )
+    outer_vbox.minimal(@hbox_containing_the_entry, 8)
+    button_box = button_box(
+      @button_choose_file,
+      @button_analyse
+    ) {{ layout:  :horizontal,
+         padding: 2 }}
+    button_box.spacing = 2
+    button_box.layout = :expand
+    outer_vbox.minimal(button_box,                 4)
+    outer_vbox.minimal(@label,                     4)
+
+    window = create_window_or_runner(
+      widget: outer_vbox,
+      width:  width?,
+      height: height?,
+      title:  title?,
+      font:   font?
+    )
+
+    window.set_padding(padding?)
+    window.set_border_size(border_size?)
+    window.show_all
+    Thread.new {
+      sleep 0.001
+      main_entry?.do_focus
+    }
+    run_main
+  end
+
+  # ========================================================================= #
+  # === create_the_entries
+  # ========================================================================= #
+  def create_the_entries
+    # ======================================================================= #
+    # === @gtk_entry
+    # ======================================================================= #
+    @gtk_entry = create_entry
+    @gtk_entry.yellow_background
+    @gtk_entry.bblack1
+    @gtk_entry.css_class('pad4px')
+    @gtk_entry.enable_all_events
+    @gtk_entry.on_the_enter_key_was_pressed {
+      do_analyse_the_pdf_file
+    }
+  end
+
+  # ========================================================================= #
+  # === do_analyse_the_pdf_file
+  #
+  # This is the method that will analyse the .pdf file at hand.
+  # ========================================================================= #
+  def do_analyse_the_pdf_file
+    this_pdf_file = main_entry?.text.to_s
+    _ = ''.dup
+    _ << "This .pdf file has the following characteristics:\n\n"
+    _ << '    <b>n pages</b>: '+::PdfParadise.n_pages?(this_pdf_file).to_s
+    _ << "\n"
+    use_this_title = ::PdfParadise.title?(this_pdf_file).to_s
+    if use_this_title.empty?
+      use_this_title = '(This .pdf file has no title)'
+    end
+    _ << "    <b>title</b>: #{use_this_title}"
+    _ << "\n"
+    @label.set_text(_)
+    @label.do_markify
+  end
+
+  # ========================================================================= #
+  # === do_automatically_determine_the_title_for_the_pdf_file_at_hand
+  # ========================================================================= #
+  def do_automatically_determine_the_title_for_the_pdf_file_at_hand
+    this_pdf_file = main_entry?.text.to_s
+    if this_pdf_file and !this_pdf_file.empty?
+      ::PdfParadise.automatic_pdf_title(this_pdf_file)
+      do_analyse_the_pdf_file
+    else
+      popup_over_this_widget(
+        main_entry?,
+        'Please first assign a .pdf file, before '\
+        'this functionality can be used.'
+      )
+    end
+  end
+
+  # ========================================================================= #
+  # === do_open_the_local_pdf_file_in_the_pdf_reader
+  # ========================================================================= #
+  def do_open_the_local_pdf_file_in_the_pdf_reader
+    this_pdf_file = main_entry?.text.to_s
+    if this_pdf_file and !this_pdf_file.empty?
+      Thread.new {
+        esystem("evince #{this_pdf_file}")
+      }
+    else
+      popup_over_this_widget(
+        main_entry?,
+        'Please first assign a .pdf file, before '\
+        'this functionality can be used.'
+      )
+    end
+  end
+
+  # ========================================================================= #
+  # === padding?
+  # ========================================================================= #
+  def padding?
+    0
+  end
+
+  # ========================================================================= #
+  # === border_size?
+  # ========================================================================= #
+  def border_size?
+    2
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    run_super
+  end
+
+  # ========================================================================= #
+  # === PdfParadise::GUI::Gtk::StatisticsWidget.run
+  # ========================================================================= #
+  def self.run(
+      i = ARGV
+    )
+    require 'gtk_paradise/run'
+    _ = ::PdfParadise::GUI::Gtk::StatisticsWidget.new(i)
+    r = ::Gtk.run
+    r << _
+    r.automatic_size
+    r.automatic_title
+    r.top_left_then_run
+  end
+
+  # ========================================================================= #
+  # === PdfParadise::GUI::UniversalWidgets::StatisticsWidget[]
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i)
+  end
+
+end; end; end
+
+# =========================================================================== #
+# === PdfParadise.start_gtk_gui_statistics_widget
+# =========================================================================== #
+def self.start_gtk_gui_statistics_widget
+  require 'gtk_paradise/run'
+  r = ::Gtk.run
+  _ = PdfParadise::GUI::Gtk::StatisticsWidget.new(r)
+  r << _
+  r.automatic_size
+  r.automatic_title
+  r.top_left_then_run
+end
+
+# =========================================================================== #
+# === PdfParadise.return_widget_about_this_pdf_file
+# =========================================================================== #
+def self.return_widget_about_this_pdf_file
+  ::PdfParadise::GUI::Gtk::StatisticsWidget.new
+end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  PdfParadise::GUI::UniversalWidgets::StatisticsWidget.new(ARGV)
+end # gtk_todo_viewer