Class: Livetext::UserAPI

Inherits:
Object show all
Defined in:
lib/livetext/userapi.rb

Overview

Encapsulate the UserAPI as a class

Constant Summary collapse

KBD = 
File.new("/dev/tty", "r")
TTY = 
File.new("/dev/tty", "w")
DotSpace =

Livetext::Sigil + Livetext::Space

". "

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(live) ⇒ UserAPI

Returns a new instance of UserAPI.



15
16
17
18
19
20
 
# File 'lib/livetext/userapi.rb', line 15

def initialize(live)
  @live = live
  @vars = live.vars
  @html = HTML.new(self)
  @expander = Livetext::Expansion.new(live)
end

Instance Attribute Details

#args ⇒ Object

Returns the value of attribute args.



13
14
15
 
# File 'lib/livetext/userapi.rb', line 13

def args
  @args
end

#data ⇒ Object

Returns the value of attribute data.



13
14
15
 
# File 'lib/livetext/userapi.rb', line 13

def data
  @data
end

Instance Method Details

#api ⇒ Object 



22
23
24
 
# File 'lib/livetext/userapi.rb', line 22

def api
  @live.api
end

#body(raw = false) ⇒ Object 



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/livetext/userapi.rb', line 117

def body(raw=false)
  lines = []
  end_found = false
  loop do
    @line = @live.nextline
    break if @line.nil?
    @line.chomp!
    break if end?(@line)
    next if comment?(@line)
    @line = format(@line) unless raw
    lines << @line
  end
  raise "Expected .end, found end of file" unless end?(@line)  # use custom exception
  optional_blank_line   # FIXME Delete this??
  return lines unless block_given?
  lines.each {|line| yield line }   # FIXME what about $. ?
end

#body_text(raw = false) ⇒ Object 



135
136
137
 
# File 'lib/livetext/userapi.rb', line 135

def body_text(raw=false)
  raw_body.join("\n")
end

#check_existence(file, msg) ⇒ Object 



59
60
61
 
# File 'lib/livetext/userapi.rb', line 59

def check_existence(file, msg)
  STDERR.puts msg unless File.exist?(file)
end

#comment?(str) ⇒ Boolean

Returns:

  • (Boolean) 


89
90
91
 
# File 'lib/livetext/userapi.rb', line 89

def comment?(str)
  str.index(DotSpace) == 0
end

#debug(*args) ⇒ Object 



200
201
202
 
# File 'lib/livetext/userapi.rb', line 200

def debug(*args)
  TTY.puts *args if @live.debug
end

#debug=(val) ⇒ Object 



196
197
198
 
# File 'lib/livetext/userapi.rb', line 196

def debug=(val)
  @live.debug = val
end

#dot ⇒ Object 



30
31
32
 
# File 'lib/livetext/userapi.rb', line 30

def dot
  @live
end

#end?(str) ⇒ Boolean

Returns:

  • (Boolean) 


98
99
100
101
 
# File 'lib/livetext/userapi.rb', line 98

def end?(str)
  return true if str == ".end" || str =~ / *\$\.end/
  return false
end

#err(*args) ⇒ Object 



184
185
186
 
# File 'lib/livetext/userapi.rb', line 184

def err(*args)
  STDERR.puts *args
end

#expand_functions(str) ⇒ Object 



43
44
45
 
# File 'lib/livetext/userapi.rb', line 43

def expand_functions(str)
  @expander.expand_functions(str)
end

#expand_variables(str) ⇒ Object 



39
40
41
 
# File 'lib/livetext/userapi.rb', line 39

def expand_variables(str)
  @expander.expand_variables(str)
end

#format(line) ⇒ Object 



151
152
153
154
 
# File 'lib/livetext/userapi.rb', line 151

def format(line)
  line2 = @expander.format(line)
  line2
end

#handle_escapes(str, set) ⇒ Object 



143
144
145
146
147
148
149
 
# File 'lib/livetext/userapi.rb', line 143

def handle_escapes(str, set)
  str = str.dup
  set.each_char do |ch|
    str.gsub!("\\#{ch}", ch)
  end
  str
end

#html ⇒ Object 



26
27
28
 
# File 'lib/livetext/userapi.rb', line 26

def html
  @html
end

#include_file(file) ⇒ Object 



34
35
36
37
 
# File 'lib/livetext/userapi.rb', line 34

def include_file(file)
  api.data = file
  api.dot_include
end

#optional_blank_line ⇒ Object 



82
83
84
85
86
87
 
# File 'lib/livetext/userapi.rb', line 82

def optional_blank_line
  peek = @live.peek_nextline  # ???
  return if peek.nil?
  @line = @live.nextline if peek =~ /^ *$/
  return true  # This way, dot commands will usually return true
end

#out(str = "", file = nil) ⇒ Object 



169
170
171
172
173
174
 
# File 'lib/livetext/userapi.rb', line 169

def out(str = "", file = nil)
  return if str.nil?
  return file.puts str unless file.nil?
  @live.body << str
  @live.body << "\n" unless str.end_with?("\n")
end

#out!(str = "") ⇒ Object 



176
177
178
 
# File 'lib/livetext/userapi.rb', line 176

def out!(str = "")
  @live.body << str  # no newline
end

#passthru(line) ⇒ Object 



156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/livetext/userapi.rb', line 156

def passthru(line)
  return if @live.nopass
  if line == "\n"
    unless @live.nopara
      out "<p>" 
      out
    end
  else
    text = @expander.format(line.chomp)
    out text
  end
end

#print(*args) ⇒ Object 



192
193
194
 
# File 'lib/livetext/userapi.rb', line 192

def print(*args)
  @live.output.print *args
end

#puts(*args) ⇒ Object 



188
189
190
 
# File 'lib/livetext/userapi.rb', line 188

def puts(*args)
  @live.output.puts *args
end

#raw_body(tag = "__EOF__") ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/livetext/userapi.rb', line 103

def raw_body(tag = "__EOF__")
  lines = []
  @live.save_location = @live.sources.last
  loop do
    @line = @live.nextline
    break if @line.nil?
    break if @line.chomp.strip == tag
    lines << @line
  end
  optional_blank_line
  return lines unless block_given?
  lines.each {|line| yield line }
end

#raw_body! ⇒ Object 



139
140
141
 
# File 'lib/livetext/userapi.rb', line 139

def raw_body!
  raw_body(Livetext::Sigil).join("\n")
end

#setvar(var, val) ⇒ Object

FIXME



47
48
49
 
# File 'lib/livetext/userapi.rb', line 47

def setvar(var, val)   # FIXME
  @live.vars.set(var, val)
end

#setvars(pairs) ⇒ Object 



51
52
53
54
55
56
57
 
# File 'lib/livetext/userapi.rb', line 51

def setvars(pairs)
  # STDERR.puts "#{__method__}: pairs = #{pairs.inspect} (#{pairs.class})"
  pairs = pairs.to_a   # could be Hash or Variables
  pairs.each do |var, value|
    @live.vars.set(var, value)
  end
end

#trailing?(char) ⇒ Boolean

Returns:

  • (Boolean) 


93
94
95
96
 
# File 'lib/livetext/userapi.rb', line 93

def trailing?(char)
  return true if ["\n", " ", nil].include?(char)
  return false
end

#tty(*args) ⇒ Object 



180
181
182
 
# File 'lib/livetext/userapi.rb', line 180

def tty(*args)
  TTY.puts *args
end

#vars ⇒ Object 



78
79
80
 
# File 'lib/livetext/userapi.rb', line 78

def vars
  @vars
end