Module: ReVIEW::Book::Compilable

Includes:
TextUtils
Included in:
Chapter, Part
Defined in:
lib/review/book/compilable.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from TextUtils

#convert_inencoding, #convert_outencoding, #detab, #split_paragraph

Instance Attribute Details

#bookObject (readonly)

Returns the value of attribute book.



17
18
19
# File 'lib/review/book/compilable.rb', line 17

def book
  @book
end

#pathObject (readonly)

Returns the value of attribute path.



18
19
20
# File 'lib/review/book/compilable.rb', line 18

def path
  @path
end

Instance Method Details

#basenameObject



29
30
31
32
# File 'lib/review/book/compilable.rb', line 29

def basename
  return nil unless @path
  File.basename(@path)
end

#bibpaper(id) ⇒ Object



139
140
141
# File 'lib/review/book/compilable.rb', line 139

def bibpaper(id)
  bibpaper_index()[id]
end

#bibpaper_indexObject

Raises:



143
144
145
146
147
# File 'lib/review/book/compilable.rb', line 143

def bibpaper_index
  raise FileNotFound, "no such bib file: #{@book.bib_file}" unless @book.bib_exist?
  @bibpaper_index ||= BibpaperIndex.parse(@book.read_bib.lines.to_a)
  @bibpaper_index
end

#contentObject



67
68
69
70
# File 'lib/review/book/compilable.rb', line 67

def content
  @content = convert_inencoding(File.read(path()),
                                ReVIEW.book.param["inencoding"])
end

#dirnameObject



24
25
26
27
# File 'lib/review/book/compilable.rb', line 24

def dirname
  return nil unless @path
  File.dirname(@path)
end

#envObject



20
21
22
# File 'lib/review/book/compilable.rb', line 20

def env
  @book
end

#footnote(id) ⇒ Object



95
96
97
# File 'lib/review/book/compilable.rb', line 95

def footnote(id)
  footnote_index()[id]
end

#footnote_indexObject



99
100
101
102
# File 'lib/review/book/compilable.rb', line 99

def footnote_index
  @footnote_index ||= FootnoteIndex.parse(lines())
  @footnote_index
end

#headline(caption) ⇒ Object



149
150
151
# File 'lib/review/book/compilable.rb', line 149

def headline(caption)
  headline_index()[caption]
end

#headline_indexObject



153
154
155
# File 'lib/review/book/compilable.rb', line 153

def headline_index
  @headline_index ||= HeadlineIndex.parse(lines(), self)
end

#icon_indexObject



125
126
127
128
129
130
# File 'lib/review/book/compilable.rb', line 125

def icon_index
  @icon_index ||= IconIndex.parse(lines(), id(),
    "#{book.basedir}#{@book.image_dir}",
    @book.image_types)
  @icon_index
end

#image(id) ⇒ Object



104
105
106
107
108
109
# File 'lib/review/book/compilable.rb', line 104

def image(id)
  return image_index()[id] if image_index().has_key?(id)
  return icon_index()[id] if icon_index().has_key?(id)
  return numberless_image_index()[id] if numberless_image_index().has_key?(id)
  indepimage_index()[id]
end

#image_indexObject



118
119
120
121
122
123
# File 'lib/review/book/compilable.rb', line 118

def image_index
  @image_index ||= ImageIndex.parse(lines(), id(),
    "#{book.basedir}#{@book.image_dir}",
    @book.image_types)
  @image_index
end

#indepimage_indexObject



132
133
134
135
136
137
# File 'lib/review/book/compilable.rb', line 132

def indepimage_index
  @indepimage_index ||=
    IndepImageIndex.parse(lines(), id(),
    "#{book.basedir}#{@book.image_dir}",
    @book.image_types)
end

#linesObject



72
73
74
75
# File 'lib/review/book/compilable.rb', line 72

def lines
  # FIXME: we cannot duplicate Enumerator on ruby 1.9 HEAD
  (@lines ||= content().lines.to_a).dup
end

#list(id) ⇒ Object



77
78
79
# File 'lib/review/book/compilable.rb', line 77

def list(id)
  list_index()[id]
end

#list_indexObject



81
82
83
84
# File 'lib/review/book/compilable.rb', line 81

def list_index
  @list_index ||= ListIndex.parse(lines())
  @list_index
end

#nameObject Also known as: id



34
35
36
# File 'lib/review/book/compilable.rb', line 34

def name
  File.basename(@name, '.*')
end

#numberless_image_indexObject



111
112
113
114
115
116
# File 'lib/review/book/compilable.rb', line 111

def numberless_image_index
  @numberless_image_index ||=
    NumberlessImageIndex.parse(lines(), id(),
    "#{book.basedir}#{@book.image_dir}",
    @book.image_types)
end

#open(&block) ⇒ Object



62
63
64
65
# File 'lib/review/book/compilable.rb', line 62

def open(&block)
  return (block_given?() ? yield(@io) : @io) if @io
  File.open(path(), &block)
end

#sizeObject



54
55
56
# File 'lib/review/book/compilable.rb', line 54

def size
  File.size(path())
end

#table(id) ⇒ Object



86
87
88
# File 'lib/review/book/compilable.rb', line 86

def table(id)
  table_index()[id]
end

#table_indexObject



90
91
92
93
# File 'lib/review/book/compilable.rb', line 90

def table_index
  @table_index ||= TableIndex.parse(lines())
  @table_index
end

#titleObject



40
41
42
43
44
45
46
47
48
49
50
51
52
# File 'lib/review/book/compilable.rb', line 40

def title
  @title = ""
  open {|f|
    f.each_line {|l|
      l = convert_inencoding(l, ReVIEW.book.param["inencoding"])
      if l =~ /\A=+/
        @title = l.sub(/\A=+/, '').strip
        break
      end
    }
  }
  @title
end

#volumeObject



58
59
60
# File 'lib/review/book/compilable.rb', line 58

def volume
  @volume ||= Volume.count_file(path())
end