pdf_paradise 0.1.66

data/lib/pdf_paradise/gui/shared_code/statistics_widget/statistics_widget_module.rb

@@ -0,0 +1,349 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === PdfParadise::GUI::Gtk::StatisticsWidgetModule
+# =========================================================================== #
+# require 'pdf_paradise/gui/shared_code/statistics_widget/statistics_widget_module.rb'
+# include ::PdfParadise::GUI::Gtk::StatisticsWidgetModule
+# =========================================================================== #
+module PdfParadise
+
+module GUI
+
+module Gtk
+
+module StatisticsWidgetModule
+
+  require 'gtk_paradise/requires/require_the_base_module.rb'
+  include ::Gtk::BaseModule
+
+  require 'pdf_paradise/pdf_file_n_total_pages.rb'
+  require 'pdf_paradise/toplevel_methods/automatic_pdf_title.rb'
+  require 'pdf_paradise/toplevel_methods/query_pdf_title.rb'
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === 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 = 1820
+
+  # ========================================================================= #
+  # === HEIGHT
+  # ========================================================================= #
+  HEIGHT = 840
+
+  # ========================================================================= #
+  # === initialize
+  #
+  # The first argument is assumed to be the parent-widget.
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    super(:vertical) # Vertical box in style.
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    abort_on_exception
+    reset_the_internal_variables
+    # ======================================================================= #
+    # === @configuration
+    # ======================================================================= #
+    @configuration = [true, __dir__, NAMESPACE]
+    # ======================================================================= #
+    # === @title
+    # ======================================================================= #
+    @title  = TITLE
+    # ======================================================================= #
+    # === @width
+    # ======================================================================= #
+    set_width(WIDTH)
+    set_height(HEIGHT)
+    set_use_this_font(USE_THIS_FONT)
+    use_gtk_paradise_project_css_file
+  end
+
+  # ========================================================================= #
+  # === padding?
+  # ========================================================================= #
+  def padding?
+    0
+  end
+
+  # ========================================================================= #
+  # === parent_widget?
+  # ========================================================================= #
+  def parent_widget?
+    @commandline_arguments.first
+  end
+
+  # ========================================================================= #
+  # === main_entry?
+  # ========================================================================= #
+  def main_entry?
+    @gtk_entry
+  end
+
+  # ========================================================================= #
+  # === create_the_buttons                          (buttons tag, button tag)
+  # ========================================================================= #
+  def create_the_buttons
+    # ======================================================================= #
+    # === @button_choose_file
+    # ======================================================================= #
+    @button_choose_file = gtk_file_chooser_button
+    @button_choose_file.hint = 'Click on this button to open a '\
+      'local <b>.pdf</b> file.'
+    @button_choose_file.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 = gtk_button('_Analyse the .pdf file')
+    @button_analyse.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 = gtk_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 = gtk_button('Open via a pdf-reader')
+    @button_open_via_a_pdf_reader.hint = 'This will open the .pdf '\
+      'file in a pdf-reader.'
+    @button_open_via_a_pdf_reader.on_clicked {
+      do_open_the_local_pdf_file_in_the_pdf_reader
+    }
+    return_all_buttons.each {|this_button|
+      this_button.bblack1
+    }
+    @button_auto_title.bblack3
+  end
+
+  # ========================================================================= #
+  # === create_skeleton                                          (create tag)
+  # ========================================================================= #
+  def create_skeleton
+    create_the_entries
+    create_the_buttons
+    # ======================================================================= #
+    # === @label
+    #
+    # This label-widget resides on the bottom of the application.
+    # ======================================================================= #
+    @label = gtk_left_aligned_label
+    @label.set_font(USE_THIS_FONT_FOR_THE_DISPLAY_AREA)
+
+    @label.make_selectable
+    @hbox_containing_the_entry = gtk_hbox
+
+    @arrow_right = emoji(:arrow_right)
+    @event_box_arrow_right = gtk_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
+
+  # ========================================================================= #
+  # === 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
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    create_skeleton_then_connect_skeleton
+    show_all
+    Thread.new {
+      sleep 0.001
+      main_entry?.do_focus
+    }
+  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
+
+  # ========================================================================= #
+  # === connect_skeleton                      (connect skeleton, connect tag)
+  # ========================================================================= #
+  def connect_skeleton
+    _ = top_bar
+    _.add(@button_auto_title)
+    _.add(@button_open_via_a_pdf_reader)
+    minimal(_)
+    minimal(
+      gtk_left_aligned_label(
+        'This small widget will show some information about '\
+        'the .pdf file at hand.'
+      ), 8
+    )
+    minimal(@hbox_containing_the_entry, 8)
+    button_box = gtk_button_box(
+      @button_choose_file,
+      @button_analyse
+    ) {{ layout:  :horizontal,
+         padding: 2 }}
+    button_box.spacing = 2
+    button_box.layout = :expand
+    minimal(button_box,                 4)
+    minimal(@label,                     4)
+  end
+
+  # ========================================================================= #
+  # === create_the_entries
+  # ========================================================================= #
+  def create_the_entries
+    # ======================================================================= #
+    # === @gtk_entry
+    # ======================================================================= #
+    @gtk_entry = gtk_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
+
+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

data/lib/pdf_paradise/gui/shared_code/to_pdf/to_pdf_module.rb

@@ -0,0 +1,281 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === PdfParadise::GUI::Gtk::ToPdfModule
+# =========================================================================== #
+# require 'pdf_paradise/gui/shared_code/to_pdf/to_pdf_module.rb'
+# include ::PdfParadise::GUI::Gtk::ToPdfModule
+# =========================================================================== #
+module PdfParadise
+
+module GUI
+
+module Gtk
+
+module ToPdfModule
+
+  require 'gtk_paradise/requires/require_the_base_module.rb'
+  include ::Gtk::BaseModule
+
+  require 'pdf_paradise/toplevel_methods/to_pdf.rb'
+
+  begin
+    require 'pdf-reader' # Add an optional dependency here.
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === TITLE
+  # ========================================================================= #
+  TITLE = 'Convert to .pdf'
+
+  # ========================================================================= #
+  # === WIDTH
+  # ========================================================================= #
+  WIDTH = 1540
+
+  # ========================================================================= #
+  # === HEIGHT
+  # ========================================================================= #
+  HEIGHT = 400
+
+  # ========================================================================= #
+  # === USE_THIS_FONT
+  #
+  # Set a default font here.
+  # ========================================================================= #
+  USE_THIS_FONT = 'Sans 20'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = ARGV,
+      run_already           = true
+    )
+    super(:vertical)
+    reset
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    reset_the_internal_variables
+    # ======================================================================= #
+    # === @configuration
+    # ======================================================================= #
+    @configuration = [true, __dir__, NAMESPACE]
+    # ======================================================================= #
+    # === @title
+    # ======================================================================= #
+    @title  = TITLE
+    # ======================================================================= #
+    # === @width
+    # ======================================================================= #
+    set_width(WIDTH)
+    # ======================================================================= #
+    # === @height
+    # ======================================================================= #
+    set_height(HEIGHT)
+    set_use_this_font(USE_THIS_FONT)
+    use_gtk_paradise_project_css_file
+  end
+
+  # ========================================================================= #
+  # === create_skeleton
+  # ========================================================================= #
+  def create_skeleton
+    create_buttons
+    create_the_statusbar
+  end
+
+  # ========================================================================= #
+  # === create_the_statusbar
+  # ========================================================================= #
+  def create_the_statusbar
+    @statusbar = gtk_statusbar_with_handle
+    @status_bar_context_id = @statusbar.get_context_id('to_pdf')
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    create_skeleton
+    chdir('/Depot/j/') if File.directory? '/Depot/j/'
+    vbox = gtk_vbox
+    vbox.minimal(
+      gtk_label('Input the filename that you wish to convert here:'), 1
+    )
+    create_the_entry_filename
+    vbox.minimal(@entry_filename, 1)
+    minimal(vbox, 1)
+    pack_without_expand(@button_choose_file, 1)
+    pack_without_expand(@button_do_convert,  1)
+    hbox = gtk_hbox
+    hbox.maximal(@statusbar, 1)
+    hbox.minimal(@button_open_the_converted_file, 1)
+    add(hbox)
+    @text_buffer = gtk_text_buffer
+    @text_view = gtk_text_view(@text_buffer)
+    @scrolled_window = gtk_scrolled_window(@text_view) { :top_to_bottom }
+    @scrolled_window.bblack1
+    @scrolled_window.css_class('pad4px')
+    @scrolled_window.width_height(500, 400)
+    minimal(@scrolled_window)
+    do_style_all_buttons_in_a_uniform_manner
+  end
+
+  # ========================================================================= #
+  # === do_style_all_buttons_in_a_uniform_manner
+  # ========================================================================= #
+  def do_style_all_buttons_in_a_uniform_manner
+    return_all_buttons.each {|entry|
+      entry.bblack1
+      entry.css_class('pad2px')
+    }
+  end
+
+  # ========================================================================= #
+  # === padding?
+  # ========================================================================= #
+  def padding?
+    0
+  end
+
+  # ========================================================================= #
+  # === favicon?
+  # ========================================================================= #
+  def favicon?
+    :tabble
+  end
+
+  # ========================================================================= #
+  # === do_open_the_converted_file_via_a_pdf_reader
+  # ========================================================================= #
+  def do_open_the_converted_file_via_a_pdf_reader
+    stored_here = stored_where?
+    if File.exist? stored_here
+      system 'evince '+stored_here
+    else
+      e 'No file exists at '+sfile(stored_here)+'.'
+    end
+  end
+
+  # ========================================================================= #
+  # === stored_where?
+  # ========================================================================= #
+  def stored_where?(
+      i = @entry_filename.text?
+    )
+    _ = PdfParadise.to_pdf(i)
+    _ = _.dup
+    _ = _.join(' ').strip if _.is_a? Array
+    _.delete_suffix!(File.extname(i))
+    _ << '.pdf' unless _.end_with? '.pdf' 
+    return _.to_s
+  end
+
+  # ========================================================================= #
+  # === do_convert_the_given_file
+  #
+  # This is the method that will convert the target file into the
+  # .pdf file, usually by using "soffice".
+  # ========================================================================= #
+  def do_convert_the_given_file
+    _ = stored_where?
+    @statusbar.display(
+      'Stored the file at: '+_, :default, @status_bar_context_id
+    ) if File.exist? _
+    # ======================================================================= #
+    # Read in the .pdf file if it exists and if the PDF::Reader namespace
+    # exists.
+    # ======================================================================= #
+    if File.exist?(_) and
+       Object.const_defined?(:PDF) and PDF.const_defined?(:Reader)
+      reader = PDF::Reader.new(_)
+      page   = reader.page(1)
+      use_this_text = page.text.to_s
+      @scrolled_window.set_text(use_this_text.to_s)
+    end
+  end
+
+  # ========================================================================= #
+  # === PdfParadise::GUI::Gtk::ToPdfModule.run
+  # ========================================================================= #
+  def self.run(i = ARGV)
+    require 'gtk_paradise/run'
+    r = ::Gtk.run
+    _ = PdfParadise::GUI::Gtk::ToPdf.new(r)
+    r << _
+    r.automatic
+    r.easy_exit_top_left_then_run
+  end
+
+  # ========================================================================= #
+  # === entry_filename?
+  # ========================================================================= #
+  def entry_filename?
+    @entry_filename
+  end; alias main_entry? entry_filename? # === main_entry?
+
+  # ========================================================================= #
+  # === create_the_entry_filename
+  # ========================================================================= #
+  def create_the_entry_filename
+    @entry_filename = gtk_entry
+    @entry_filename.clear_background
+    @entry_filename.bblack1
+    @entry_filename.yellow_background
+  end
+
+  # ========================================================================= #
+  # === create_buttons                              (buttons tag, button tag)
+  # ========================================================================= #
+  def create_buttons
+    # ======================================================================= #
+    # === @button_do_convert
+    # ======================================================================= #
+    @button_do_convert = gtk_button('_Convert it to .pdf format')
+    #@button_do_convert.disallow_resizing
+    @button_do_convert.css_class('clear_background')
+    @button_do_convert.steelblue
+    @button_do_convert.css_class('BG_lightblue')
+    @button_do_convert.hint = 'This will use libreoffice '\
+      'to convert the file at hand into a <b>.pdf file</b>.'
+    @button_do_convert.on_clicked {
+      do_convert_the_given_file
+    }
+    # ======================================================================= #
+    # === @button_choose_file                                      (open tag)
+    #
+    # This is the "Open File" button.
+    # ======================================================================= #
+    @button_choose_file = gtk_file_chooser_button
+    @button_choose_file.on_clicked {
+      create_a_new_file_chooser_dialog
+      main_entry?.set_text(main_file?.to_s)
+    }
+    # ======================================================================= #
+    # === @button_open_the_converted_file
+    # ======================================================================= #
+    @button_open_the_converted_file = gtk_button('_Open the converted file')
+    @button_open_the_converted_file.hint = 'Click to open the '\
+      'converted file via main .pdf reader.'
+    @button_open_the_converted_file.on_clicked {
+      do_open_the_converted_file_via_a_pdf_reader
+    }
+  end
+
+end; end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  PdfParadise::GUI::Gtk::ToPdfModule.run
+end