require 'vedeu/configuration/configuration'
require 'vedeu/support/esc'
require 'vedeu/support/log'

module Vedeu

  # This class currently provides the means to trace each method call which
  # occurs inside Vedeu. This is very useful (to me!) for debugging. Running
  # this will make your application less responsive, and the tests
  # excruciatingly slow to run.
  #
  class Trace

    # @todo
    #   Replace this class with this:
    #
    # def self.trace
    #   trace = TracePoint.new(:call) do |tp|
    #     if tp.defined_class.to_s.match(/Troo/)
    #       Vedeu.log(type: :debug, message: [tp.defined_class.to_s, tp.method_id.to_s].join(' '))
    #     end
    #   end
    #   trace.enable
    # end

    # @param options [Hash]
    # @option option event [Symbol]
    # @option option trace [Boolean]
    # @return [void]
    def self.call(options = {})
      new(options).trace
    end

    # @param options [Hash]
    # @return [Trace]
    def initialize(options = {})
      @options = options
    end

    # Performs the trace operation. Building strings which include:
    # - (class_count) a count of classes registered with Vedeu,
    # - (classname) the class name being traced,
    # - (id) the method name being traced,
    # - (vars) any local variables belonging to the method.
    #
    # @todo Deprecate, and use TracePoint instead.
    #
    # @return [NilClass|String]
    def trace
      set_trace_func proc { |event, _file, _line, id, binding, classname|
        if event == watched && id != :log && classes.include?(classname.to_s)
          vars = variables(binding)

          if vars.empty?
            log_this(sprintf("%s %-25s #%-20s",
              class_count, classname, id))

          else
            log_this(sprintf("%s %-25s #%-20s\n%s\n",
              class_count, classname, id, vars))

          end
        end
      } if trace?
    end

    private

    # Writes the message to the log file.
    #
    # @param message [String]
    # @return [String]
    def log_this(message)
      Vedeu::Log.logger.debug(message)

      message
    end

    # Provides inspection of the local variables set within the method being
    # traced. Makes the log file extremely noisy, but very useful for hunting
    # down bugs.
    #
    # @param binding [Class]
    # @return [String]
    def variables(binding)
      entries = []
      binding.eval('local_variables').each do |var|
        variable = var.to_s
        value    = binding.local_variable_get(var)
        valclass = value.class.to_s
        output   = (value.is_a?(Proc)) ? '#<Proc:...' : value.inspect

        content  = Esc.send(class_colour.fetch(valclass, :white)) { output }

        entries << sprintf("%33s %-10s = %s %s", " ",
                                                 Esc.green { variable },
                                                 Esc.magenta { valclass },
                                                 content)
      end
      entries.join("\n")
    end

    # @return [String]
    def watched
      options[:event]
    end

    # @return [Boolean]
    def trace?
      options[:trace]
    end

    # @return [Hash]
    def options
      defaults.merge!(@options)
    end

    # The default values for a new instance of this class.
    #
    # @return [Hash]
    def defaults
      {
        trace: Vedeu::Configuration.trace?,
        event: 'call',
      }
    end

    # @return [Hash]
    def class_colour
      {
        'Array'    => :yellow,
        'Fixnum'   => :cyan,
        'Hash'     => :blue,
        'NilClass' => :red,
        'String'   => :green,
        'Symbol'   => :magenta,
      }
    end

    # Returns the number of Vedeu classes/modules. (Useful for debugging.)
    #
    # @return [String]
    def class_count
      @count ||= "(#{classes.size}/#{vedeu_classes.size})"
    end

    # Returns the classes to be traced, without exceptions or ignored classes.
    #
    # @return [Set]
    def classes
      @classes ||= vedeu_classes - vedeu_exceptions - ignored_classes
    end

    # Returns all the classes defined within Vedeu.
    #
    # @return [Set]
    def vedeu_classes
      @vedeu_classes ||= Vedeu.constants.collect do |c|
        Vedeu.const_get(c).to_s
      end.to_set
    end

    # Returns all the exceptions defined within Vedeu.
    #
    # @todo Vedeu should produce this set.
    #
    # @return [Set]
    def vedeu_exceptions
      Vedeu::Exceptions.to_set
    end

    # Returns a set of classes to ignore during tracing.
    #
    # @todo Make this configurable at runtime.
    #
    # @return [Set]
    def ignored_classes
      Set.new [
        # 'Vedeu::API',
        # 'Vedeu::Application',
        # 'Vedeu::Background',
        # 'Vedeu::Bindings',
        # 'Vedeu::Border',
        # 'Vedeu::BoundingArea',
        # 'Vedeu::Buffer',
        # 'Vedeu::Char',
        # 'Vedeu::Chars',
        'Vedeu::Coercions',
        'Vedeu::Colour',
        'Vedeu::Common',
        # 'Vedeu::Composition',
        # 'Vedeu::Compositor',
        # 'Vedeu::Config::API',
        # 'Vedeu::Config::CLI',
        'Vedeu::Configuration',
        # 'Vedeu::Console',
        # 'Vedeu::ContentGeometry',
        # 'Vedeu::Coordinate',
        # 'Vedeu::Cursor',
        # 'Vedeu::DisplayBuffer',
        # 'Vedeu::DSL::Border',
        # 'Vedeu::DSL::Colour',
        # 'Vedeu::DSL::Composition',
        # 'Vedeu::DSL::Geometry',
        # 'Vedeu::DSL::Interface',
        # 'Vedeu::DSL::Keymap',
        # 'Vedeu::DSL::Line',
        # 'Vedeu::DSL::Menu',
        # 'Vedeu::DSL::Stream',
        # 'Vedeu::DSL::Style',
        # 'Vedeu::DSL::Text',
        # 'Vedeu::DSL::Use',
        # 'Vedeu::DSL::View',
        'Vedeu::Esc',
        'Vedeu::Event',
        # 'Vedeu::Focus',
        # 'Vedeu::Foreground',
        'Vedeu::Geometry',
        # 'Vedeu::Grid',
        # 'Vedeu::Group',
        # 'Vedeu::Input',
        # 'Vedeu::Interface',
        # 'Vedeu::Interfaces',
        # 'Vedeu::Keymap',
        # 'Vedeu::Keys',
        # 'Vedeu::Key',
        # 'Vedeu::Launcher',
        # 'Vedeu::Line',
        # 'Vedeu::Lines',
        'Vedeu::Log',
        # 'Vedeu::Mapper',
        # 'Vedeu::Menu',
        # 'Vedeu::Menus',
        # 'Vedeu::Model',
        # 'Vedeu::Model::Collection',
        # 'Vedeu::MoveCursor',
        # 'Vedeu::Node',
        # 'Vedeu::Output',
        'Vedeu::Position',
        # 'Vedeu::PositionValidator',
        'Vedeu::Presentation',
        # 'Vedeu::Read',
        # 'Vedeu::Refresh',
        # 'Vedeu::Render',
        'Vedeu::Repository',
        # 'Vedeu::Sentence',
        'Vedeu::Stream',
        # 'Vedeu::Streams',
        'Vedeu::Style',
        'Vedeu::Terminal',
        # 'Vedeu::Text',
        # 'Vedeu::ToggleCursor',
        'Vedeu::Trace',
        'Vedeu::Translator',
        # 'Vedeu::Traps',
        # 'Vedeu::Trigger',
        # 'Vedeu::View',
        # 'Vedeu::Viewport',
        # 'Vedeu::Visible',
        # 'Vedeu::Write',
        # 'Vedeu::Writer',
      ]
    end

  end # Trace

end # Vedeu