livetext 0.9.14 → 0.9.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9e6ad9c8d933b361da03fadc6cc4d28e0a8b699f8f50e434db9bf41f0b9d66b
-  data.tar.gz: 49e59704162aea72ac92122d69f0006591856b9fe09f2b2fdbf6843b7253b80b
+  metadata.gz: a8d345a0f52ce0d7c62f40f8798793faf5136f8ce72cde8576a0284220c08082
+  data.tar.gz: 4e037527c3abd873c9cf8ca49685d99c68fffab9630a67c1193e898e961c4d48
 SHA512:
-  metadata.gz: 74b1b06e0bc91d976c0f60a2136ed8bb1c4d2d5ba33359620752b44a51918a89fbba2cec9c542ae12a6368de82bdc4db64b30a4d95146caab4e5a290f9c7fa8b
-  data.tar.gz: ed0c0fa3b4da538ddbd31cd799a84f5647d45a369f0f45d729c223f74c7b0f2445bfc0812aa0c319b9a9f5992efa6af521d550eed38a8e2c551b183e28a16722
+  metadata.gz: 5b2957b2fe57d0abeff6029c63e310b7d26d653e1e7848c4026d2c16f43e6c37f6c9bf2fb63f2dfcd4e719cc82113cf549413362da43c14ac12312cafad1a744
+  data.tar.gz: 696a9ff22bff7caae99534e1a9431e9914e9137be4212674598c2ee66a58c11bd37c56bc90c52dd0d0cae3450f8905081202fbdc08f05a6164abd2de2dc5e7ce

data/lib/cmdargs.rb

@@ -0,0 +1,93 @@
+require_relative 'livetext'
+
+=begin
+  Weird concepts to understand here...
+
+    1. A Livetext dot-command (flush left) usually looks like:
+       .foobar
+    2. A dot-command (left-indented) usually looks like:
+           $.foobar
+    3. More generally, it may have any number of parameters (0, 1, ...)
+       .redirect somefile.txt append
+    4. Variables and functions *can* appear (rare in practice??)
+       .redirect somefile$my_suffix $$my_mode
+    5. A trailing # comment may appear 
+       a. Stripped... saved in #raw ? #data ? #comment ? elsewhere?
+       b. NOT the "dot" as a comment!
+    6. .foobar  # This here is a comment
+    7. #data accessor returns all data on the .foo line...
+       a. ...After the initial space
+       b. ...Including spaces
+       c. Including comment??
+       d. .foo This is  o n l y   a test.
+          # #data returns: "This is  o n l y   a test."
+       e. What about formatting???
+       f. What about: comments? variables? functions? 
+
+    7. Some commands have NO body while others have an OPTIONAL or REQUIRED body
+       a. Assume .cmd1 definition forbids a body (then a body is an error)
+          .cmd1   # may NOT have a body
+       b. Assume .cmd2 definition PERMITS a body
+          .cmd2   # may or MAY NOT have body/.end  
+       c. Assume .cmd3 definition PERMITS a body
+          .cmd3   # REQUIRES a body/.end  
+          . stuff...
+          .end
+    8. Inside a body:
+    8a. Leading dot has no special meaning (though the associated method may parse it!)
+    8b. BUG? Currently leading dot is a comment INSIDE a body?
+    8a. No leading char is special (though the associated method may parse it!)
+    8a. No trailing #-comments (though the associated method may parse it!)
+    8c. ?? We should or shouldn't look for variables/functions? or make it an option?
+    8d. .end may naturally not be used (but see .raw where it may)
+    9. the args accessor is a simple array of strings
+
+
+=end
+
+class Livetext::CmdData
+
+  attr_reader :data, :args, :nargs, :arity, :comment, :raw  # , ...?
+
+  def initialize(data, body: false, arity: :N)   # FIXME maybe just add **options ??
+    # arity:  (num)   fixed number 0 or more
+    #        :N       arbitrary number
+    #        n1..n2   range
+    # body:  true => this command has a body + .end
+    # how raw is raw?
+    #   remove comment - always/sometimes/never?
+    #   var_func_parse - always/sometimes/never?
+    #   var_func_parse inside body??
+    @data = data.dup     # comment? vars? funcs?
+    @raw  = data.dup     # comment? vars? funcs?
+    @args  = data.split  # simple array
+    @nargs = nargs       # not really "needed"
+    check_num_args(nargs)
+    
+    # @varfunc = _var_func_parse(data.dup)
+  end
+
+  def check_num_args(num)
+    num_range = /(\d{0,2})(\.\.)(\d{0,2})/
+    min, max = 0, 9999
+    md = num_range.match(@nargs).to_a
+    bad_args = nil
+    case 
+      when @nargs == ":N"          # arbitrary
+        # max already set
+      when md[2] == ".."           # range: 4..6 1.. ..4
+        vmin, vmax = md.values_at(1, 2)
+        min = Integer(vmin) unless vmin.empty?
+        max = Integer(vmax) unless vmax.empty?
+        min, max = Integer(min), Integer(max)
+      when %r[^\d+$] =~ num
+        min = max = Integer(num)  # can raise error
+      else
+        raise "Invalid value or range '#{num.inspect}'"
+    end
+
+    bad_args = @args.size.between?(min, max)
+    raise "Expected #{num} args but found #{@args.size}!" if bad_args
+  end
+
+end

data/lib/formatline.rb

@@ -1,7 +1,7 @@
 # Class FormatLine handles the parsing of comments, dot commands, and 
 # simple formatting characters.
 
-class FormatLine
+class FormatLine < StringParser
   SimpleFormats     = {}
   SimpleFormats[:b] = %w[<b> </b>]
   SimpleFormats[:i] = %w[<i> </i>]
@@ -24,20 +24,11 @@ class FormatLine
 
   Syms = { "*" => :b, "_" => :i, "`" => :t, "~" => :s }
 
-  def terminate?(terminators, ch)
-    if terminators.is_a? Regexp
-      terminators === ch
-    else
-      terminators.include?(ch)
-    end
-  end
-
   attr_reader :out
   attr_reader :tokenlist
 
   def initialize(line)
-    @line = line
-    @i = -1
+    super
     @token = Null.dup
     @tokenlist = []
   end
@@ -45,26 +36,27 @@ class FormatLine
   def self.parse!(line)
     return nil if line.nil?
     x = self.new(line.chomp)
-    t = x.tokenize(line)
+    t = x.tokenize
+# TTY.puts "tokens = \n#{t.inspect}\n "
     x.evaluate
   end
 
-  def tokenize(line)
-    grab
+  def tokenize
+#   add grab
     loop do 
-      case curr
-        when Escape; grab; add curr; grab; add curr
+      case peek
+        when Escape; grab; add peek; grab; add peek
         when "$"
           dollar
         when "*", "_", "`", "~"
-          marker curr
-          add curr
+          marker peek
+          add peek
         when LF
           break if @i >= line.size - 1
         when nil
           break
         else
-          add curr
+          add peek
       end
       grab
     end
@@ -72,24 +64,33 @@ class FormatLine
     @tokenlist
   end
 
+  def terminate?(terminators, ch)
+    if terminators.is_a? Regexp
+      terminators === ch
+    else
+      terminators.include?(ch)
+    end
+  end
+
   def self.var_func_parse(str)
     return nil if str.nil?
     x = self.new(str.chomp)
-    x.grab
-    loop do 
-      case x.curr
-        when Escape; x.grab; x.add x.curr; x.grab
-        when "$"
-          x.dollar
-        when LF, nil
-          break
-        else
-          x.add x.curr
-      end
-      x.grab
+    char = x.peek
+    loop do
+      char = x.grab
+      break if char == LF || char == nil
+      x.handle_escaping if char == Escape
+      x.dollar if char == "$"
+      x.add char
     end
     x.add_token(:str)
-    x.evaluate
+    result = x.evaluate
+    result
+  end
+
+  def handle_escaping
+    grab
+    add grab
   end
 
   def embed(sym, str)
@@ -130,27 +131,6 @@ class FormatLine
     @out
   end
 
-  def curr
-    @line[@i]
-  end
-
-  def prev
-    return nil if @i <= 0
-    @line[@i-1]
-  end
-
-  def next!
-    @line[@i+1]
-  end
-
-  def grab
-    @line[@i+=1]
-  end
-
-  def ungrab
-    @line[@i-=1]
-  end
-
   def grab_colon_param
     grab  # grab :
     param = ""
@@ -187,7 +167,7 @@ class FormatLine
       end
     end
 
-    add curr
+    add peek
     grab
     param = nil if param.empty?
     param
@@ -207,8 +187,8 @@ class FormatLine
     str = Null.dup
     grab
     loop do
-      break if curr.nil?
-      str << curr
+      break if eos?
+      str << peek
       break if terminate?(NoAlpha, next!)
       grab
     end
@@ -219,8 +199,8 @@ class FormatLine
     str = Null.dup
     grab
     loop do
-      break if curr.nil?
-      str << curr
+      break if eos?   # peek.nil?
+      str << peek
       break if terminate?(NoAlphaDot, next!)
       grab
     end
@@ -229,7 +209,7 @@ class FormatLine
 
   def dollar
     grab
-    case curr
+    case peek
       when LF;  add "$";  add_token :str
       when " "; add "$ "; add_token :str
       when nil; add "$";  add_token :str
@@ -237,10 +217,10 @@ class FormatLine
 #     when "."; dollar_dot
       when /[A-Za-z]/
        add_token :str
-        var = curr + grab_alpha_dot
+        var = peek + grab_alpha_dot
         add_token(:var, var)
     else 
-      add "$" + curr
+      add "$" + peek
       add_token(:string)
     end
   end
@@ -258,7 +238,7 @@ class FormatLine
           when "["; param = grab_func_param; add_token(:brackets, param)
         end
       else
-        grab; add_token :str, "$$" + curr; return
+        grab; add_token :str, "$$" + peek; return
     end
   end
 
@@ -275,7 +255,7 @@ class FormatLine
     end
 
     grab
-    case curr
+    case peek
       when Space
         add char + " "
         add_token :str
@@ -286,7 +266,7 @@ class FormatLine
       when char;   double_marker(char)
       when LBrack; long_marker(char)
     else
-      str = curr + collect!(sym, Blank)
+      str = peek + collect!(sym, Blank)
       add str
       add_token sym, str
       grab
@@ -319,21 +299,19 @@ class FormatLine
     str = Null.dup   # next is not " ","*","["
     grab   # ZZZ
     loop do
-      if curr == Escape
-        str << grab # ch = escaped char
+      if peek == Escape
         grab
+        str << grab
         next
       end
-      if terminate?(terminators, curr)
+      if terminate?(terminators, peek)
         break 
       end
-                  # STDERR.puts "#{curr.inspect} is not a terminator"
-      str << curr    # not a terminator
+      str << peek    # not a terminator
       grab
-                  # STDERR.puts "After grab, curr is #{curr.inspect}"
     end
 
-    if curr == "]" # skip right bracket
+    if peek == "]" # skip right bracket
       grab 
     end
     add str
@@ -344,8 +322,8 @@ class FormatLine
   end
 
   def escaped
-    ch = grab
     grab
+    ch = grab
     ch
   end
 
@@ -356,15 +334,15 @@ class FormatLine
     grab   # ZZZ
     loop do
       case
-        when curr.nil?
+        when peek.nil?
           return str
-        when curr == Escape
+        when peek == Escape
           str << escaped
           next
-        when terminate?(terminators, curr)
+        when terminate?(terminators, peek)
           break 
       else
-        str << curr    # not a terminator
+        str << peek    # not a terminator
       end
       grab
     end
@@ -376,17 +354,14 @@ class FormatLine
     STDERR.puts "=== str = #{str.inspect}"
   end
 
-############
-
-  ### From FormatLine:
-
   def funcall(name, param)
+    err = "[Error evaluating $$#{name}(#{param})]"
     result = 
       if self.respond_to?("func_" + name.to_s)
         self.send("func_" + name.to_s, param)
       else
         fobj = ::Livetext::Functions.new
-        fobj.send(name, param)
+        fobj.send(name, param) rescue err
       end
     result
   end
@@ -396,8 +371,6 @@ class FormatLine
     result
   end
 
-  #####
-
   def embedded?
     ! (['"', "'", " ", nil].include? prev)
   end

data/lib/helpers.rb

@@ -1,10 +1,86 @@
 
 module Helpers
 
+  Space = " "
+  Sigil = "." # Can't change yet
+
+  def self.rx(str, space=nil)
+    Regexp.compile("^" + Regexp.escape(str) + "#{space}")
+  end
+
+  Comment  = rx(Sigil, Space)
+  Dotcmd   = rx(Sigil)
+  Ddotcmd  = /^ *\$\.[A-Za-z]/
+
+## FIXME process_file[!] should call process[_text]
+
+  def process_file(fname, btrace=false)
+    setfile(fname)
+    text = File.readlines(fname)
+    enum = text.each
+    @backtrace = btrace
+    @main.source(enum, fname, 0)
+    line = nil
+    loop do 
+      line = @main.nextline
+      break if line.nil?
+      process_line(line)
+    end
+    val = @main.finalize if @main.respond_to? :finalize
+    @body
+  end
+
+  def process_line(line)  # FIXME inefficient?
+    nomarkup = true
+    case line  # must apply these in order
+      when Comment
+        handle_scomment(line)
+      when Dotcmd
+        handle_dotcmd(line)
+      when Ddotcmd
+        indent = line.index("$") + 1
+        @indentation.push(indent)
+        line.sub!(/^ *\$/, "")
+        handle_dotcmd(line)
+        indentation.pop
+    else
+      @main._passthru(line)
+    end
+  end
+
+  def handle_dotcmd(line, indent = 0)
+    indent = @indentation.last # top of stack
+    line = line.sub(/# .*$/, "")
+    name = get_name(line).to_sym
+    result = nil
+    case
+      when name == :end   # special case
+        puts @body
+        raise EndWithoutOpening()
+      when @main.respond_to?(name)
+        result = @main.send(name)
+    else
+      puts @body  # earlier correct output, not flushed yet
+      raise "Name '#{name}' is unknown"
+      return
+    end
+    result
+  end
+
+  def handle_scomment(line)
+  end
+
+  def get_name(line)
+    name, data = line.split(" ", 2)
+    name = name[1..-1]  # chop off sigil
+    name = "dot_" + name if %w[include def].include?(name)
+    @main.data = data
+    @main.check_disallowed(name)
+    name
+  end
+
   def check_disallowed(name)
-    # raise "Illegal name '#{name}'" if _disallowed?(name)
-    # FIXME use custom exception
-    raise DisallowedName, name if _disallowed?(name)
+    raise DisallowedName(name) if disallowed?(name)
   end
 
   def check_file_exists(file)
@@ -14,7 +90,7 @@ module Helpers
   def set_variables(pairs)
     pairs.each do |pair|
       var, value = *pair
-      @parent._setvar(var, value)
+      @parent.setvar(var, value)
     end
   end
 
@@ -22,4 +98,66 @@ module Helpers
     File.read(fname)
   end
 
+  def search_upward(file)
+    value = nil
+    return file if File.exist?(file)
+
+    count = 1
+    loop do
+      front = "../" * count
+      count += 1
+      here = Pathname.new(front).expand_path.dirname.to_s
+      break if here == "/"
+      path = front + file
+      value = path if File.exist?(path)
+      break if value
+    end
+    STDERR.puts "Cannot find #{file.inspect} from #{Dir.pwd}" unless value
+	  return value
+  rescue
+    STDERR.puts "Can't find #{file.inspect} from #{Dir.pwd}"
+	  return nil
+  end
+
+  def include_file(file)
+    @_args = [file]
+    dot_include
+  end
+
+  def onoff(arg)   # helper
+    arg ||= "on"
+    raise ExpectedOnOff unless String === arg
+    case arg.downcase
+      when "on"
+        return true
+      when "off"
+        return false
+    else
+      raise ExpectedOnOff
+    end
+  end
+
+  def setvar(var, val)
+    str, sym = var.to_s, var.to_sym
+    Livetext::Vars[str] = val
+    Livetext::Vars[sym] = val
+    @_vars[str] = val
+    @_vars[sym] = val
+  end
+
+  def setfile(file)
+    if file
+      setvar(:File, file)
+      dir = File.dirname(File.expand_path(file))
+      setvar(:FileDir, dir)
+    else
+      setvar(:File,    "[no file]")
+      setvar(:FileDir, "[no dir]")
+    end
+  end
+
+  def setfile!(file)  # FIXME why does this variant exist?
+    setvar(:File, file)
+  end
+
 end